/users

Provides endpoints which allow the manipulation of users.

post get

post

Create a new user.

get

Load multiple users and return a paged list response.

Create a new user.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
adminfalsebooleanFlag which indicates whether the user is an admin.
emailAddressfalsestringEmail address of the user.
firstnamefalsestringFirstname of the user.
forcedPasswordChangefalsebooleanWhen true, the user needs to change their password on the next login.
groupUuidfalsestringOptional group id for the user. If provided the user will automatically be assigned to the identified group.
lastnamefalsestringLastname of the user.
nodeReferencefalseobjectNew node reference of the user. This can also explicitly set to null in order to remove the assigned node from the user
passwordtruestringPassword of the new user.
usernametruestringUsername of the user.

Example:

{
  "username" : "newuser",
  "emailAddress" : "j.doe@nowhere.com",
  "lastname" : "Doe",
  "firstname" : "Joe",
  "groupUuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d",
  "password" : "iesiech0eewinioghaRa",
  "nodeReference" : {
    "projectName" : "dummy",
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "schema" : {
      "name" : "vehicle",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    }
  }
}

HTTP status code 201

User response of the created user.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
adminfalsebooleanFlag which indicates whether the user is an admin.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
emailAddressfalsestringEmail address of the user
enabledtruebooleanFlag which indicates whether the user is enabled or disabled. Disabled users can no longer log into Gentics Mesh. Deleting a user user will not remove it. Instead the user will just be disabled.
firstnamefalsestringFirstname of the user.
forcedPasswordChangetruebooleanWhen true, the user needs to change their password on the next login.
groupstruearrayList of group references to which the user belongs.
lastnamefalsestringLastname of the user.
nodeReferencefalseobjectOptional node reference of the user. Users can directly reference a single node. This can be used to store additional data that is user related.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolesHashtruestringHashsum of user roles which can be used for user permission caching.
usernametruestringUsername of the user.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "589319933be24ec79319933be24ec7fe",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "lastname" : "Doe",
  "firstname" : "Joe",
  "username" : "newuser",
  "emailAddress" : "j.doe@nowhere.com",
  "nodeReference" : {
    "projectName" : "dummy",
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "schema" : {
      "name" : "vehicle",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    }
  },
  "enabled" : true,
  "groups" : [ {
    "name" : "editors",
    "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Load multiple users and return a paged list response.

Query Parameters

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

User list response which may also contain an expanded node references.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Doe",
    "firstname" : "Joe",
    "username" : "jdoe",
    "emailAddress" : "j.doe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Roe",
    "firstname" : "Jane",
    "username" : "jroe",
    "emailAddress" : "j.roe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "webclient",
      "uuid" : "4267d8bf30824e36a7d8bf3082de36a3"
    }, {
      "name" : "editors",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    } ],
    "admin" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post get delete

post

Update the user with the given uuid. The user is created if no user with the specified uuid could be found.

get

Read the user with the given uuid

delete

Deactivate the user with the given uuid. Please note that users can't be deleted since they are needed to construct creator/editor information.

Update the user with the given uuid. The user is created if no user with the specified uuid could be found.

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

Query Parameters

  • token: (string)

    Token code which can be used to update the user even if the connection is not authenticated. This can be used to implement a password recovery feature.

    Example:

    FDrbBDWRY3aS

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
adminfalsebooleanFlag which indicates whether the user is an admin.
emailAddressfalsestringNew email address of the user
firstnamefalsestringNew firstname of the user
forcedPasswordChangefalsebooleanWhen true, the user needs to change their password on the next login.
lastnamefalsestringNew lastname of the user
nodeReferencefalseobjectNew node reference of the user. This can also explicitly set to null in order to remove the assigned node from the user
passwordfalsestringNew password of the user
usernamefalsestringNew username of the user

Example:

{
  "password" : "iesiech0eewinioghaRa",
  "lastname" : "Doe",
  "firstname" : "Joe",
  "username" : "jdoe42",
  "emailAddress" : "j.doe@nowhere.com",
  "nodeReference" : {
    "projectName" : "dummy",
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "schema" : {
      "name" : "vehicle",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    }
  }
}

HTTP status code 200

Updated user response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
adminfalsebooleanFlag which indicates whether the user is an admin.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
emailAddressfalsestringEmail address of the user
enabledtruebooleanFlag which indicates whether the user is enabled or disabled. Disabled users can no longer log into Gentics Mesh. Deleting a user user will not remove it. Instead the user will just be disabled.
firstnamefalsestringFirstname of the user.
forcedPasswordChangetruebooleanWhen true, the user needs to change their password on the next login.
groupstruearrayList of group references to which the user belongs.
lastnamefalsestringLastname of the user.
nodeReferencefalseobjectOptional node reference of the user. Users can directly reference a single node. This can be used to store additional data that is user related.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolesHashtruestringHashsum of user roles which can be used for user permission caching.
usernametruestringUsername of the user.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "589319933be24ec79319933be24ec7fe",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "lastname" : "Doe",
  "firstname" : "Joe",
  "username" : "jdoe42",
  "emailAddress" : "j.doe@nowhere.com",
  "nodeReference" : {
    "projectName" : "dummy",
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "schema" : {
      "name" : "vehicle",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    }
  },
  "enabled" : true,
  "groups" : [ {
    "name" : "editors",
    "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Read the user with the given uuid

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

Query Parameters

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

User response which may also contain an expanded node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
adminfalsebooleanFlag which indicates whether the user is an admin.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
emailAddressfalsestringEmail address of the user
enabledtruebooleanFlag which indicates whether the user is enabled or disabled. Disabled users can no longer log into Gentics Mesh. Deleting a user user will not remove it. Instead the user will just be disabled.
firstnamefalsestringFirstname of the user.
forcedPasswordChangetruebooleanWhen true, the user needs to change their password on the next login.
groupstruearrayList of group references to which the user belongs.
lastnamefalsestringLastname of the user.
nodeReferencefalseobjectOptional node reference of the user. Users can directly reference a single node. This can be used to store additional data that is user related.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolesHashtruestringHashsum of user roles which can be used for user permission caching.
usernametruestringUsername of the user.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "589319933be24ec79319933be24ec7fe",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "lastname" : "Doe",
  "firstname" : "Joe",
  "username" : "jdoe",
  "emailAddress" : "j.doe@nowhere.com",
  "nodeReference" : {
    "projectName" : "dummy",
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "schema" : {
      "name" : "vehicle",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    }
  },
  "enabled" : true,
  "groups" : [ {
    "name" : "editors",
    "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Deactivate the user with the given uuid. Please note that users can't be deleted since they are needed to construct creator/editor information.

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 204

User was deactivated.

get

get

Read the user permissions on the element that can be located by the specified path. Requires READ permission on the user.

Read the user permissions on the element that can be located by the specified path. Requires READ permission on the user.

URI Parameters

  • path: required (string)

    Path to the element from which the permissions should be loaded.

    Example:

    projects/:projectUuid/schemas
  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 200

Response which contains the loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruebooleanFlag which indicates whether the create permission is granted.
deletetruebooleanFlag which indicates whether the delete permission is granted.
publishfalsebooleanFlag which indicates whether the publish permission is granted.
readtruebooleanFlag which indicates whether the read permission is granted.
readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
updatetruebooleanFlag which indicates whether the update permission is granted.

Example:

{
  "create" : true,
  "read" : true,
  "update" : true,
  "delete" : true
}

post

post

Return a one time token which can be used by any user to update a user (e.g.: Reset the password). Requires CREATE permission on the user.

Return a one time token which can be used by any user to update a user (e.g.: Reset the password). Requires CREATE permission on the user.

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 200

User token response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 date of the creation date for the provided token
tokentruestringJSON Web Token which was issued by the API.

Example:

{
  "token" : "FDrbBDWRY3aS",
  "created" : "2018-11-20T20:12:01.084Z"
}

get post delete

get

Get the permissions on the user for all roles.

post

Grant permissions on the user to multiple roles.

delete

Revoke permissions on the user from multiple roles.

Get the permissions on the user for all roles.

URI Parameters

  • userUuid: required (string)

    Uuid of the user

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the user to multiple roles.

URI Parameters

  • userUuid: required (string)

    Uuid of the user

    Example:

    589319933be24ec79319933be24ec7fe

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "b8275bbddbbd432eb2268682c0a94809"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the user from multiple roles.

URI Parameters

  • userUuid: required (string)

    Uuid of the user

    Example:

    589319933be24ec79319933be24ec7fe

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

post delete

post

Return API token which can be used to authenticate the user. Store the key somewhere save since you won't be able to retrieve it later on. This invalidates all tokens previously issued for this user. Requires UPDATE permission on the user.

delete

Invalidate the issued API token.

Return API token which can be used to authenticate the user. Store the key somewhere save since you won't be able to retrieve it later on. This invalidates all tokens previously issued for this user. Requires UPDATE permission on the user.

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 200

The User API token response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
previousIssueDatetruestringDate of the last time the API token was issued.
tokentruestringIssued client API token.

Example:

{
  "token" : "30fa3e4ae00c4ad6ba3e4ae00cfad6cc"
}

Invalidate the issued API token.

URI Parameters

  • userUuid: required (string)

    Uuid of the user.

    Example:

    589319933be24ec79319933be24ec7fe

HTTP status code 200

Message confirming the invalidation of the API token. Requires DELETE permission on the user.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

/roles

Provides endpoints which allow the manipulation of roles.

post get

post

Create a new role.

get

Load multiple roles and return a paged list response

Create a new role.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the role

Example:

{
  "name" : "New role"
}

HTTP status code 201

Created role.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
groupstruearrayList of groups which are assigned to the role.
nametruestringName of the role.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "ddcddceb33d648318ddceb33d618314f",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New role",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "groups" : [ ]
}

Load multiple roles and return a paged list response

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded list of roles.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "ddcddceb33d648318ddceb33d618314f",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Reader role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ ]
  }, {
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Admin role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "clients",
      "uuid" : "df81c23d9ff1450081c23d9ff195005e"
    } ]
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Load the role with the given uuid.

post

Update the role with the given uuid. The role is created if no role with the specified uuid could be found.

delete

Delete the role with the given uuid

Load the role with the given uuid.

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

Query Parameters

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

HTTP status code 200

Loaded role.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
groupstruearrayList of groups which are assigned to the role.
nametruestringName of the role.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "ddcddceb33d648318ddceb33d618314f",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Admin Role",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "groups" : [ ]
}

Update the role with the given uuid. The role is created if no role with the specified uuid could be found.

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the role

Example:

{
  "name" : "New role name"
}

HTTP status code 200

Updated role.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
groupstruearrayList of groups which are assigned to the role.
nametruestringName of the role.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "ddcddceb33d648318ddceb33d618314f",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New role name",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "groups" : [ ]
}

Delete the role with the given uuid

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

HTTP status code 204

Role was deleted.

post get

post

Set the permissions between role and the targeted element.

get

Load the permissions between given role and the targeted element.

Set the permissions between role and the targeted element.

URI Parameters

  • path: required (string)

    API path to the element.

    Example:

    projects/217f8c981ada4642bf8c981adaa642c3
projects/217f8c981ada4642bf8c981adaa642c3/nodes/adaf48da8c124049af48da8c12a0493e
  • roleUuid: required (string)

    Uuid of the role.

    Example:

    ddcddceb33d648318ddceb33d618314f

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
permissionstrueobjectSet of permissions which should be applied.
recursivefalsebooleanFlag which indicates whether the permission update should be applied recursively.

Example:

{
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "recursive" : false
}

HTTP status code 200

Permissions were set.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Load the permissions between given role and the targeted element.

URI Parameters

  • path: required (string)

    API path to the element.

    Example:

    projects/217f8c981ada4642bf8c981adaa642c3
projects/217f8c981ada4642bf8c981adaa642c3/nodes/adaf48da8c124049af48da8c12a0493e
  • roleUuid: required (string)

    Uuid of the role.

    Example:

    ddcddceb33d648318ddceb33d618314f

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruebooleanFlag which indicates whether the create permission is granted.
deletetruebooleanFlag which indicates whether the delete permission is granted.
publishfalsebooleanFlag which indicates whether the publish permission is granted.
readtruebooleanFlag which indicates whether the read permission is granted.
readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
updatetruebooleanFlag which indicates whether the update permission is granted.

Example:

{
  "create" : true,
  "read" : true,
  "update" : true,
  "delete" : true,
  "publish" : false,
  "readPublished" : false
}

get post delete

get

Get the permissions on the role for all roles.

post

Grant permissions on the role to multiple roles.

delete

Revoke permissions on the role from multiple roles.

Get the permissions on the role for all roles.

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the role to multiple roles.

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "c2f68c860ab44961bcf502cdd1243ad8"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the role from multiple roles.

URI Parameters

  • roleUuid: required (string)

    Uuid of the role

    Example:

    ddcddceb33d648318ddceb33d618314f

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

/groups

Provides endpoints which allow the manipulation of groups.

post get

post

Create a new group.

get

Read multiple groups and return a paged list response.

Create a new group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringName of the group.

Example:

{
  "name" : "New group"
}

HTTP status code 201

Created group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the group
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolestruearrayList of role references
uuidtruestringUuid of the element

Example:

{
  "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New group",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "roles" : [ {
    "name" : "admin",
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
  } ]
}

Read multiple groups and return a paged list response.

Query Parameters

  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List response which contains the found groups.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Admin Group",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "roles" : [ {
      "name" : "admin",
      "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
    } ]
  }, {
    "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d",
    "name" : "Editor Group",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "roles" : [ ]
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Read the group with the given uuid.

post

Update the group with the given uuid. The group is created if no group with the specified uuid could be found.

delete

Delete the given group.

Read the group with the given uuid.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group which should be deleted.

    Example:

    e728c2fc5a0146a2a8c2fc5a0186a28d

Query Parameters

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef

HTTP status code 200

Loaded group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the group
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolestruearrayList of role references
uuidtruestringUuid of the element

Example:

{
  "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Admin Group",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "roles" : [ {
    "name" : "admin",
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
  } ]
}

Update the group with the given uuid. The group is created if no group with the specified uuid could be found.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group which should be deleted.

    Example:

    e728c2fc5a0146a2a8c2fc5a0186a28d

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the group

Example:

{
  "name" : "New group name"
}

HTTP status code 200

Updated group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the group
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolestruearrayList of role references
uuidtruestringUuid of the element

Example:

{
  "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New group name",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "roles" : [ {
    "name" : "admin",
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
  } ]
}

Delete the given group.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group which should be deleted.

    Example:

    e728c2fc5a0146a2a8c2fc5a0186a28d

HTTP status code 204

Group was deleted.

get post delete

get

Get the permissions on the group for all roles.

post

Grant permissions on the group to multiple roles.

delete

Revoke permissions on the group from multiple roles.

Get the permissions on the group for all roles.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group

    Example:

    df81c23d9ff1450081c23d9ff195005e

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the group to multiple roles.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group

    Example:

    df81c23d9ff1450081c23d9ff195005e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "dc0583469d2b4a20865c5ce746bc074b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the group from multiple roles.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group

    Example:

    df81c23d9ff1450081c23d9ff195005e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

get

get

Load multiple roles that are assigned to the group. Return a paged list response.

Load multiple roles that are assigned to the group. Return a paged list response.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of roles which were assigned to the group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "ddcddceb33d648318ddceb33d618314f",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Reader role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ ]
  }, {
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Admin role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "clients",
      "uuid" : "df81c23d9ff1450081c23d9ff195005e"
    } ]
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post delete

post

Add the specified role to the group.

delete

Remove the given role from the group.

Add the specified role to the group.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e
  • roleUuid: required (string)

    Uuid of the role.

    Example:

    ddcddceb33d648318ddceb33d618314f

HTTP status code 200

Loaded role.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the group
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolestruearrayList of role references
uuidtruestringUuid of the element

Example:

{
  "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Group name",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "roles" : [ {
    "name" : "admin",
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
  } ]
}

Remove the given role from the group.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e
  • roleUuid: required (string)

    Uuid of the role.

    Example:

    ddcddceb33d648318ddceb33d618314f

HTTP status code 204

Role was removed from the group.

get

get

Load a list of users which have been assigned to the group.

Load a list of users which have been assigned to the group.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of users which belong to the group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Doe",
    "firstname" : "Joe",
    "username" : "jdoe",
    "emailAddress" : "j.doe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Roe",
    "firstname" : "Jane",
    "username" : "jroe",
    "emailAddress" : "j.roe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "webclient",
      "uuid" : "4267d8bf30824e36a7d8bf3082de36a3"
    }, {
      "name" : "editors",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    } ],
    "admin" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post delete

post

Add the given user to the group

delete

Remove the given user from the group.

Add the given user to the group

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e
  • userUuid: required (string)

    Uuid of the user which should be removed from the group.

    Example:

    4267d8bf30824e36a7d8bf3082de36a3

HTTP status code 200

Updated group.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the group
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rolestruearrayList of role references
uuidtruestringUuid of the element

Example:

{
  "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Group name",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "roles" : [ {
    "name" : "admin",
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
  } ]
}

Remove the given user from the group.

URI Parameters

  • groupUuid: required (string)

    Uuid of the group.

    Example:

    df81c23d9ff1450081c23d9ff195005e
  • userUuid: required (string)

    Uuid of the user which should be removed from the group.

    Example:

    4267d8bf30824e36a7d8bf3082de36a3

HTTP status code 204

User was removed from the group.

/projects

Provides endpoints which allow the manipulation of projects.

post get

post

Create a new project.

get

Load multiple projects and return a paged response.

Create a new project.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
hostnamefalsestringThe hostname of the project can be used to generate links across multiple projects. The hostname will be stored along the initial branch of the project.
nametruestringName of the project
pathPrefixfalsestringOptional path prefix for webroot path and rendered links.
schematrueobjectReference to the schema of the root node. Creating a project will also automatically create the base node of the project and link the schema to the initial branch of the project.
sslfalsebooleanSSL flag of the project which will be used to generate links across multiple projects. The flag will be stored along the intial branch of the project.

Example:

{
  "name" : "New project",
  "schema" : {
    "name" : "folder",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82"
  },
  "hostname" : "getmesh.io",
  "ssl" : true
}

HTTP status code 201

Created project.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
languagesfalsearrayProject's languages.
nametruestringThe name of the project.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rootNodetrueobjectThe project root node. All futher nodes are children of this node.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New Project",
  "rootNode" : {
    "uuid" : "adaf48da8c124049af48da8c12a0493e"
  },
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Load multiple projects and return a paged response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded project list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Dummy project",
    "rootNode" : {
      "uuid" : "adaf48da8c124049af48da8c12a0493e"
    },
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "217f8c981ada4642bf8c981adaa642c3",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Dummy Project (Mobile)",
    "rootNode" : {
      "uuid" : "adaf48da8c124049af48da8c12a0493e"
    },
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Load the project with the given uuid.

post

Update the project with the given uuid. The project is created if no project with the specified uuid could be found.

delete

Delete the project and all attached nodes, tagfamiles and branches.

Load the project with the given uuid.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project.

    Example:

    217f8c981ada4642bf8c981adaa642c3

Query Parameters

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef

HTTP status code 200

Loaded project.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
languagesfalsearrayProject's languages.
nametruestringThe name of the project.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rootNodetrueobjectThe project root node. All futher nodes are children of this node.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Project name",
  "rootNode" : {
    "uuid" : "adaf48da8c124049af48da8c12a0493e"
  },
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the project with the given uuid. The project is created if no project with the specified uuid could be found.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project.

    Example:

    217f8c981ada4642bf8c981adaa642c3

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the project

Example:

{
  "name" : "New project name"
}

HTTP status code 200

Updated project.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
languagesfalsearrayProject's languages.
nametruestringThe name of the project.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rootNodetrueobjectThe project root node. All futher nodes are children of this node.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "New project name",
  "rootNode" : {
    "uuid" : "adaf48da8c124049af48da8c12a0493e"
  },
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Delete the project and all attached nodes, tagfamiles and branches.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project.

    Example:

    217f8c981ada4642bf8c981adaa642c3

HTTP status code 204

Project was deleted.

post

post

Invoke a version purge of the project.

Invoke a version purge of the project.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project.

    Example:

    217f8c981ada4642bf8c981adaa642c3

Query Parameters

  • before: (string)

    Limit the purge operation to versions which are older than the given date.

    Example:

    2019-04-20T18:00Z

HTTP status code 200

Project versions purge job added.

get post delete

get

Get the permissions on the project for all roles.

post

Grant permissions on the project to multiple roles.

delete

Revoke permissions on the project from multiple roles.

Get the permissions on the project for all roles.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project

    Example:

    217f8c981ada4642bf8c981adaa642c3

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the project to multiple roles.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project

    Example:

    217f8c981ada4642bf8c981adaa642c3

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "97888ad94f194b5da68f6b8d667063e4"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the project from multiple roles.

URI Parameters

  • projectUuid: required (string)

    Uuid of the project

    Example:

    217f8c981ada4642bf8c981adaa642c3

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

/schemas

Provides endpoints which allow the manipulation of schemas.

get post

get

Read multiple schemas and return a paged list response.

post

Create a new schema.

Read multiple schemas and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded list of schemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

Create a new schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should create new versions.
containerfalsebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
descriptionfalsestringDescription of the schema
displayFieldfalsestringName of the display field.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldsfalsearrayList of schema fields
nametruestringName of the schema
noIndexfalseboolean'Exclude from indexing' flag.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.

Example:

{
  "displayField" : "name",
  "segmentField" : "name",
  "container" : true,
  "description" : "Some description text",
  "name" : "video",
  "fields" : [ {
    "name" : "name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  } ],
  "microschema" : false
}

HTTP status code 201

Created schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

get post delete

get

Load the schema with the given uuid.

post

Update the schema.

delete

Delete the schema with the given uuid.

Load the schema with the given uuid.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Query Parameters

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

Loaded schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the schema.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Query Parameters

  • updateAssignedBranches: (boolean - default: true)

    Update the schema version for all branches which already utilize the schema.

  • updateBranchNames: (string)

    List of branch names which should be included in the update process. By default all branches which use the schema will be updated. You can thus use this parameter to only include a subset of branch in the update.

    Example:

    summerBranch,winterBranch
  • strictValidation: (boolean)

    Validate the Elasticsearch settings in the schema. When this parameter is set, a schema update or creation will fail, when the respective Elasticsearch index cannot be created.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should create new versions.
containerfalsebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
descriptionfalsestringNew description of the schema.
displayFieldfalsestringName of the display field.
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalseboolean'Exclude from indexing' schema flag.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
versionfalsestringVersion of the schema.

Example:

{
  "description" : "New description",
  "name" : "extended-content",
  "fields" : [ ],
  "microschema" : false
}

HTTP status code 200

Updated schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Delete the schema with the given uuid.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

HTTP status code 204

Schema was successfully deleted.

post

post

Apply the posted changes to the schema. The schema migration will not automatically be started.

Apply the posted changes to the schema. The schema migration will not automatically be started.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
changes.items.operationfalsestringType of operation for this change
changes.items.uuidfalsestringUuid of the change entry

Example:

{
  "changes" : [ {
    "operation" : "ADDFIELD",
    "properties" : {
      "field" : "listFieldToBeAddedField",
      "elasticsearch" : "{\"key\":\"value\"}",
      "label" : "Field Label Value",
      "type" : "list",
      "listType" : "html"
    }
  }, {
    "operation" : "CHANGEFIELDTYPE",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "type" : "string"
    }
  }, {
    "operation" : "REMOVEFIELD",
    "properties" : {
      "field" : "fieldToBeRemoved"
    }
  }, {
    "operation" : "UPDATEFIELD",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "displayFieldname" : "newDisplayField",
      "label" : "newLabel"
    }
  }, {
    "operation" : "UPDATESCHEMA",
    "properties" : { }
  } ]
}

HTTP status code 200

Schema changes have been applied.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Compare the given schema with the stored schema and create a changeset.

Compare the given schema with the stored schema and create a changeset.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 200

List of schema changes that were detected by comparing the posted schema and the current version.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
changes.items.operationfalsestringType of operation for this change
changes.items.uuidfalsestringUuid of the change entry

Example:

{
  "changes" : [ {
    "operation" : "ADDFIELD",
    "properties" : {
      "field" : "listFieldToBeAddedField",
      "elasticsearch" : "{\"key\":\"value\"}",
      "label" : "Field Label Value",
      "type" : "list",
      "listType" : "html"
    }
  }, {
    "operation" : "CHANGEFIELDTYPE",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "type" : "string"
    }
  }, {
    "operation" : "REMOVEFIELD",
    "properties" : {
      "field" : "fieldToBeRemoved"
    }
  }, {
    "operation" : "UPDATEFIELD",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "displayFieldname" : "newDisplayField",
      "label" : "newLabel"
    }
  }, {
    "operation" : "UPDATESCHEMA",
    "properties" : { }
  } ]
}

get post delete

get

Get the permissions on the schema for all roles.

post

Grant permissions on the schema to multiple roles.

delete

Revoke permissions on the schema from multiple roles.

Get the permissions on the schema for all roles.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the schema to multiple roles.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "5090c6e65e174c9790931268569b73e7"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the schema from multiple roles.

URI Parameters

  • schemaUuid: required (string)

    Uuid of the schema

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

/microschemas

Endpoint which provides methods to manipulate microschemas.

post get

post

Create a new microschema.

get

Read multiple microschemas and return a paged list response.

Create a new microschema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
descriptionfalsestringDescription of the microschema
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldsfalsearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.

Example:

{
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true
}

HTTP status code 201

Created microschema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the microschema
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element
versiontruestringVersion of the microschema

Example:

{
  "uuid" : "2715307deafc4ecc95307deafccecc10",
  "version" : "1.0",
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Read multiple microschemas and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of miroschemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Read the microschema with the given uuid.

post

Update the microschema with the given uuid.

delete

Delete the microschema with the given uuid.

Read the microschema with the given uuid.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

Query Parameters

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

Loaded microschema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the microschema
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element
versiontruestringVersion of the microschema

Example:

{
  "uuid" : "2715307deafc4ecc95307deafccecc10",
  "version" : "1.0",
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the microschema with the given uuid.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
descriptionfalsestringDescription of the microschema
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldsfalsearrayList of microschema fields
namefalsestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.
versionfalsestringVersion of the microschema

Example:

{
  "name" : "geolocation-renamed",
  "fields" : [ ],
  "microschema" : true
}

HTTP status code 200

Migration message.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Delete the microschema with the given uuid.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

HTTP status code 204

Microschema was deleted.

post

post

Apply the provided changes on the latest version of the schema and migrate all nodes which are based on the schema. Please note that this operation is non-blocking and will continue to run in the background.

Apply the provided changes on the latest version of the schema and migrate all nodes which are based on the schema. Please note that this operation is non-blocking and will continue to run in the background.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
changes.items.operationfalsestringType of operation for this change
changes.items.uuidfalsestringUuid of the change entry

Example:

{
  "changes" : [ {
    "operation" : "ADDFIELD",
    "properties" : {
      "field" : "listFieldToBeAddedField",
      "elasticsearch" : "{\"key\":\"value\"}",
      "label" : "Field Label Value",
      "type" : "list",
      "listType" : "html"
    }
  }, {
    "operation" : "CHANGEFIELDTYPE",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "type" : "string"
    }
  }, {
    "operation" : "REMOVEFIELD",
    "properties" : {
      "field" : "fieldToBeRemoved"
    }
  }, {
    "operation" : "UPDATEFIELD",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "displayFieldname" : "newDisplayField",
      "label" : "newLabel"
    }
  }, {
    "operation" : "UPDATESCHEMA",
    "properties" : { }
  } ]
}

HTTP status code 200

Microschema migration was invoked.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Compare the provided schema with the schema which is currently stored and generate a set of changes that have been detected.

Compare the provided schema with the schema which is currently stored and generate a set of changes that have been detected.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
descriptionfalsestringDescription of the microschema
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldsfalsearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.

Example:

{
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true
}

HTTP status code 200

Found difference between both microschemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
changes.items.operationfalsestringType of operation for this change
changes.items.uuidfalsestringUuid of the change entry

Example:

{
  "changes" : [ {
    "operation" : "ADDFIELD",
    "properties" : {
      "field" : "listFieldToBeAddedField",
      "elasticsearch" : "{\"key\":\"value\"}",
      "label" : "Field Label Value",
      "type" : "list",
      "listType" : "html"
    }
  }, {
    "operation" : "CHANGEFIELDTYPE",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "type" : "string"
    }
  }, {
    "operation" : "REMOVEFIELD",
    "properties" : {
      "field" : "fieldToBeRemoved"
    }
  }, {
    "operation" : "UPDATEFIELD",
    "properties" : {
      "field" : "fieldToBeUpdated",
      "displayFieldname" : "newDisplayField",
      "label" : "newLabel"
    }
  }, {
    "operation" : "UPDATESCHEMA",
    "properties" : { }
  } ]
}

get post delete

get

Get the permissions on the microschema for all roles.

post

Grant permissions on the microschema to multiple roles.

delete

Revoke permissions on the microschema from multiple roles.

Get the permissions on the microschema for all roles.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema

    Example:

    2715307deafc4ecc95307deafccecc10

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the microschema to multiple roles.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema

    Example:

    2715307deafc4ecc95307deafccecc10

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "d7500b125fd648baa0993744b5edd209"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the microschema from multiple roles.

URI Parameters

  • microschemaUuid: required (string)

    Uuid of the microschema

    Example:

    2715307deafc4ecc95307deafccecc10

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

/admin

Collection of administrative endpoints which usually require admin permission

delete

delete

Clear all internal caches (cluster wide).

get post

get

Loads the cluster configuration.

post

Update the cluster configuration.

Update the cluster configuration.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
readQuorumfalseintegerGlobal read quorum setting.
serversfalsearrayList of server configurations.
writeQuorumfalsestringGlobal write quorum setting. Allowed values are numbers and 'all', 'majority'.

Example:

{
  "servers" : [ {
    "name" : "master-1",
    "role" : "MASTER"
  }, {
    "name" : "replica-1",
    "role" : "REPLICA"
  }, {
    "name" : "replica-2",
    "role" : "REPLICA"
  } ],
  "writeQuorum" : "1",
  "readQuorum" : 1
}

HTTP status code 200

Updated cluster configuration.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
readQuorumfalseintegerGlobal read quorum setting.
serversfalsearrayList of server configurations.
writeQuorumfalsestringGlobal write quorum setting. Allowed values are numbers and 'all', 'majority'.

Example:

{
  "servers" : [ {
    "name" : "master-1",
    "role" : "MASTER"
  }, {
    "name" : "replica-1",
    "role" : "REPLICA"
  }, {
    "name" : "replica-2",
    "role" : "REPLICA"
  } ],
  "writeQuorum" : "majority",
  "readQuorum" : 1
}

get

get

Loads the cluster status information.

get post

get

Retrieves the currently active local configuration of this instance.

post

Sets the currently active local configuration of this instance.

Sets the currently active local configuration of this instance.

HTTP status code 200

The currently active local configuration

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
readOnlyfalsebooleanIf true, mutating requests to this instance are not allowed.

Example:

{
  "readOnly" : false
}

get

get

Invokes a consistency check of the graph database without attempting to repairing the found issues. A list of found issues will be returned. When an async=true query parameter is used, a new consistency check Job is queued, and the check results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job].Please note that some checks do require an async flag set.

post

post

Invokes a consistency check and repair of the graph database and returns a list of found issues and their state. When an async=true query parameter is used, a new consistency repair Job is queued, and the repair results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job]. Please note that some repairs do require an async flag set.

Invokes a consistency check and repair of the graph database and returns a list of found issues and their state. When an async=true query parameter is used, a new consistency repair Job is queued, and the repair results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job]. Please note that some repairs do require an async flag set.

Query Parameters

  • async: (boolean)

    Specifiy whether the consistency check should be executed asynchronously (as job). Please note that some checks do require this flag set!

    Example:

    true

HTTP status code 200

Consistency check and repair report

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
inconsistenciestruearrayList of found inconsistencies.
outputTruncatedtruebooleanFlag which indicates whether the output was truncated because more than 250 have been found.
repairCounttrueobjectCounter for repair operations
resulttruestringResult of the consistency check.

Example:

{
  "outputTruncated" : false,
  "result" : "INCONSISTENT",
  "repairCount" : { },
  "inconsistencies" : [ {
    "description" : "A dangling field container has been found.",
    "severity" : "LOW",
    "elementUuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "repaired" : true,
    "repairAction" : "DELETE"
  } ]
}

get post

get

Returns the currently active coordination configuration.

post

Update the coordinator configuration of this instance. Note that the updated config will not be persisted.

Update the coordinator configuration of this instance. Note that the updated config will not be persisted.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
modefalsestringCoordinator mode which can be set to DISABLED to disable coordination, to CUD to handle only modifying requests or to ALL to handle all requests.

Example:

{
  "mode" : "DISABLED"
}

HTTP status code 200

The currently active config on this instance.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
modefalsestringCoordinator mode which can be set to DISABLED to disable coordination, to CUD to handle only modifying requests or to ALL to handle all requests.

Example:

{
  "mode" : "CUD"
}

get post

get

Returns information on the elected coordinator master.

post

Make this instance the coordination master.

Make this instance the coordination master.

HTTP status code 200

Election status message.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

Downloads a zip file of various debug information files.

post

post

Invoke a graph database backup and dump the data to the configured backup location. Note that this operation will block all current operation. Irrelevant for non-OrientDB server.

Invoke a graph database backup and dump the data to the configured backup location. Note that this operation will block all current operation. Irrelevant for non-OrientDB server.

Query Parameters

  • consistencyCheck: (boolean)

    Specify whether the consistency check should be run before running the backup.

    Example:

    true

HTTP status code 200

Incremental backup was invoked.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoke a orientdb graph database export. Irrelevant for non-OrientDB server.

Invoke a orientdb graph database export. Irrelevant for non-OrientDB server.

HTTP status code 200

Export process was invoked.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoke a orientdb graph database import. The latest import file from the import directory will be used for this operation. Irrelevant for non-OrientDB server.

Invoke a orientdb graph database import. The latest import file from the import directory will be used for this operation. Irrelevant for non-OrientDB server.

HTTP status code 200

Database import command was invoked.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoke a graph database restore. The latest dump from the backup directory will be inserted. Please note that this operation will block all current operation and effectively destroy all previously stored data. Irrelevant for non-OrientDB server.

Invoke a graph database restore. The latest dump from the backup directory will be inserted. Please note that this operation will block all current operation and effectively destroy all previously stored data. Irrelevant for non-OrientDB server.

HTTP status code 200

Database restore command was invoked.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

List all currently queued jobs.

get delete

get

Load a specific job.

delete

Deletes the job. Note that it is only possible to delete failed jobs

Load a specific job.

URI Parameters

  • jobUuid: required (string)

    Uuid of the job.

    Example:

    afacd93df77a44a2acd93df77a54a27b

HTTP status code 200

Job information.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
completionCounttrueintegerThe completion count of the job. This indicates how many items the job has processed.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
errorDetailfalsestringThe detailed error information of the job.
errorMessagefalsestringThe error message of the job.
nodeNamefalsestringName of the Gentics Mesh instance on which the job was executed.
propertiestrueobjectProperties of the job.
startDatetruestringThe start date of the job.
statustruestringMigration status.
stopDatetruestringThe stop date of the job.
typetruestringThe type of the job.
uuidtruestringUuid of the element
warningsfalsearrayList of warnings which were encoutered while executing the job.

Example:

{
  "uuid" : "afacd93df77a44a2acd93df77a54a27b",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-11-20T20:12:01.084Z",
  "type" : "branch",
  "properties" : {
    "fromVersion" : "1.0",
    "branchUuid" : "39f69bee0baa415eb69bee0baa115e82",
    "schemaUuid" : "2aa83a2b3cba40a1a83a2b3cba90a1de",
    "toVersion" : "2.0"
  },
  "completionCount" : 0,
  "warnings" : [ ]
}

Deletes the job. Note that it is only possible to delete failed jobs

URI Parameters

  • jobUuid: required (string)

    Uuid of the job.

    Example:

    afacd93df77a44a2acd93df77a54a27b

delete

delete

Deletes error state from the job. This will make it possible to execute the job once again.

Deletes error state from the job. This will make it possible to execute the job once again.

URI Parameters

  • jobUuid: required (string)

    Uuid of the job.

    Example:

    afacd93df77a44a2acd93df77a54a27b

post

post

Process the job. Failed jobs will be automatically reset and put in queued state.

Process the job. Failed jobs will be automatically reset and put in queued state.

URI Parameters

  • jobUuid: required (string)

    Uuid of the job.

    Example:

    afacd93df77a44a2acd93df77a54a27b

post get

post

Deploys the plugin using the provided deployment information.

get

Loads deployment information for all deployed plugins.

Deploys the plugin using the provided deployment information.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
pathtruestringDeployment path of the plugin which is relative to the plugin directory.

Example:

{
  "path" : "my-plugin.jar"
}

HTTP status code 200

Plugin response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
idtruestringId of the plugin.
manifesttrueobjectManifest of the plugin
nametruestringName of the plugin.
statustruestringStatus of the plugin

Example:

{
  "id" : "hello-world",
  "name" : "Hello World 1",
  "manifest" : {
    "id" : "hello-world",
    "name" : "Hello World 1",
    "description" : "A dummy plugin",
    "version" : "1.0",
    "author" : "Joe Doe",
    "inception" : "2018-10-12T14:15:06.024Z",
    "license" : "Apache License 2.0"
  }
}

delete

delete

Undeploys the plugin with the given uuid.

Undeploys the plugin with the given uuid.

URI Parameters

  • id: required (string)

    Id of the plugin.

    Example:

    hello-world

HTTP status code 200

Plugin response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
idtruestringId of the plugin.
manifesttrueobjectManifest of the plugin
nametruestringName of the plugin.
statustruestringStatus of the plugin

Example:

{
  "id" : "hello-world",
  "name" : "Hello World 1",
  "manifest" : {
    "id" : "hello-world",
    "name" : "Hello World 1",
    "description" : "A dummy plugin",
    "version" : "1.0",
    "author" : "Joe Doe",
    "inception" : "2018-10-12T14:15:06.024Z",
    "license" : "Apache License 2.0"
  }
}

get

get

Loads deployment information for the plugin with the given id.

Loads deployment information for the plugin with the given id.

URI Parameters

  • uuid: required (string)

    Uuid of the plugin.

    Example:

    hello-world

HTTP status code 200

Plugin response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
idtruestringId of the plugin.
manifesttrueobjectManifest of the plugin
nametruestringName of the plugin.
statustruestringStatus of the plugin

Example:

{
  "id" : "hello-world",
  "name" : "Hello World 1",
  "manifest" : {
    "id" : "hello-world",
    "name" : "Hello World 1",
    "description" : "A dummy plugin",
    "version" : "1.0",
    "author" : "Joe Doe",
    "inception" : "2018-10-12T14:15:06.024Z",
    "license" : "Apache License 2.0"
  }
}

post

post

Invoke the processing of remaining jobs.

Invoke the processing of remaining jobs.

HTTP status code 200

Response message.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Initiates shutdown of this instance.

Initiates shutdown of this instance.

HTTP status code 200

Shutdown initiated.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

Return the Gentics Mesh server status.

/health

Endpoints for Mesh health checks

get

get

Returns an empty response with status code 200 if Gentics Mesh is alive.

get

get

Returns an empty response with status code 200 if Gentics Mesh is ready. Responds with 503 otherwise.

get

get

Returns an empty response with status code 200 if Gentics Mesh is writable. Responds with 503 otherwise.

Provides search endpoints which can be used to invoke global searches

post

post

Drops all indices and recreates them. The index sync is not invoked automatically.

Drops all indices and recreates them. The index sync is not invoked automatically.

Query Parameters

  • index: (string)

    Index pattern to handle

    Example:

    node-.*

HTTP status code 200

Recreated all indices.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoke a search query for groups and return a paged list response.

Invoke a search query for groups and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for groups

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "25ba1622a1f7458fba1622a1f7658fea",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Admin Group",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "roles" : [ {
      "name" : "admin",
      "uuid" : "cc9999a4194d4f069999a4194d1f06d7"
    } ]
  }, {
    "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d",
    "name" : "Editor Group",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "roles" : [ ]
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for microschemas and return a paged list response.

Invoke a search query for microschemas and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for microschemas

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for nodes and return a paged list response.

Invoke a search query for nodes and return a paged list response.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for nodes

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "vehicles"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "vehicles"
    } ],
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag en",
      "filename" : "dummy-content.en.html",
      "teaser" : "Dummy teaser for en",
      "content" : "Content for language tag en"
    },
    "breadcrumb" : [ {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "Automobiles",
      "path" : "/automobiles"
    }, {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for projects and return a paged list response.

Invoke a search query for projects and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for projects

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Dummy project",
    "rootNode" : {
      "uuid" : "adaf48da8c124049af48da8c12a0493e"
    },
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "217f8c981ada4642bf8c981adaa642c3",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Dummy Project (Mobile)",
    "rootNode" : {
      "uuid" : "adaf48da8c124049af48da8c12a0493e"
    },
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for roles and return a paged list response.

Invoke a search query for roles and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for roles

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "ddcddceb33d648318ddceb33d618314f",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Reader role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ ]
  }, {
    "uuid" : "cc9999a4194d4f069999a4194d1f06d7",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Admin role",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "clients",
      "uuid" : "df81c23d9ff1450081c23d9ff195005e"
    } ]
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for schemas and return a paged list response.

Invoke a search query for schemas and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for schemas

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get

get

Returns the search index status.

post

post

Invokes the manual synchronisation of the search indices. This operation may take some time to complete and is performed asynchronously. When clustering is enabled it will be executed on any free instance.

Invokes the manual synchronisation of the search indices. This operation may take some time to complete and is performed asynchronously. When clustering is enabled it will be executed on any free instance.

Query Parameters

  • index: (string)

    Index pattern to handle

    Example:

    node-.*

HTTP status code 200

Invoked index synchronisation on all indices.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoke a search query for tagFamilies and return a paged list response.

Invoke a search query for tagFamilies and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for tagFamilies

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Colors",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for tags and return a paged list response.

Invoke a search query for tags and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for tags

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for users and return a paged list response.

Invoke a search query for users and return a paged list response.

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result for users

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Doe",
    "firstname" : "Joe",
    "username" : "jdoe",
    "emailAddress" : "j.doe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "589319933be24ec79319933be24ec7fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "lastname" : "Roe",
    "firstname" : "Jane",
    "username" : "jroe",
    "emailAddress" : "j.roe@nowhere.com",
    "nodeReference" : {
      "projectName" : "dummy",
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "schema" : {
        "name" : "vehicle",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      }
    },
    "enabled" : true,
    "groups" : [ {
      "name" : "editors",
      "uuid" : "e728c2fc5a0146a2a8c2fc5a0186a28d"
    }, {
      "name" : "webclient",
      "uuid" : "4267d8bf30824e36a7d8bf3082de36a3"
    }, {
      "name" : "editors",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    } ],
    "admin" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

/rawSearch

Provides search endpoints which can be used to invoke global searches which return the unmodified Elasticsearch response.

post

post

Invoke a search query for groups and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for groups and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for microschemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for microschemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for projects and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for projects and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for roles and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for roles and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for schemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for schemas and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for users and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for users and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

/utilities

Provides endpoints for various utility actions

post

post

Return the posted text and resolve and replace all found mesh links. A mesh link must be in the format {{mesh.link("UUID","languageTag")}}

Return the posted text and resolve and replace all found mesh links. A mesh link must be in the format {{mesh.link("UUID","languageTag")}}

Query Parameters

  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium

Body

Type: text/plain

Example:

Some text before {{mesh.link("adaf48da8c124049af48da8c12a0493e", "en")}} and after.

HTTP status code 200

Some text before /api/v2/dummy/webroot/flower.jpg and after

post

post

Validate the posted microschema and report errors.

Validate the posted microschema and report errors.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
descriptionfalsestringDescription of the microschema
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldsfalsearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.

Example:

{
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true
}

HTTP status code 200

The validation report

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
elasticsearchfalseobjectThe generated default elasticsearch index configuration which includes the used analyzers and mappings.
languageElasticsearchfalseobjectThe generated elasticsearch index configuration for each language.
messagetrueobjectDetailed validation message.
statustruestringStatus of the validation.

Example:

{
  "status" : "VALID",
  "message" : {
    "message" : "Schema validation was successful."
  },
  "elasticsearch" : {
    "settings" : {
      "analysis" : {
        "analyzer" : {
          "trigrams" : {
            "tokenizer" : "my_ngram_tokenizer",
            "filter" : [ "lowercase" ]
          }
        },
        "tokenizer" : {
          "my_ngram_tokenizer" : {
            "type" : "nGram",
            "min_gram" : "3",
            "max_gram" : "3"
          }
        }
      },
      "somebogus" : "value"
    },
    "mappings" : {
      "default" : {
        "properties" : {
          "uuid" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "created" : {
            "type" : "date",
            "index" : "not_analyzed"
          },
          "edited" : {
            "type" : "date",
            "index" : "not_analyzed"
          },
          "editor" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "creator" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "_roleUuids" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "project" : {
            "type" : "object",
            "properties" : {
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "tags" : {
            "type" : "nested",
            "properties" : {
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "tagFamilies" : {
            "type" : "object",
            "dynamic" : true
          },
          "language" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "schema" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              },
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "version" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "displayField" : {
            "type" : "object",
            "properties" : {
              "key" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "value" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              }
            }
          },
          "parentNode" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "fields" : {
            "properties" : { }
          }
        },
        "dynamic" : "strict",
        "dynamic_templates" : [ {
          "tagFamilyUuid" : {
            "path_match" : "tagFamilies.*.uuid",
            "match_mapping_type" : "*",
            "mapping" : {
              "type" : "string",
              "index" : "not_analyzed"
            }
          }
        }, {
          "tagFamilyTags" : {
            "path_match" : "tagFamilies.*.tags",
            "match_mapping_type" : "*",
            "mapping" : {
              "type" : "nested",
              "properties" : {
                "name" : {
                  "type" : "string",
                  "index" : "analyzed",
                  "analyzer" : "trigrams",
                  "fields" : {
                    "raw" : {
                      "type" : "string",
                      "index" : "not_analyzed"
                    }
                  }
                },
                "uuid" : {
                  "type" : "string",
                  "index" : "not_analyzed"
                }
              }
            }
          }
        } ]
      }
    }
  }
}

post

post

Validate the posted schema and report errors.

Validate the posted schema and report errors.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should create new versions.
containerfalsebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
descriptionfalsestringNew description of the schema.
displayFieldfalsestringName of the display field.
elasticsearchfalseobjectAdditional elasticsearch index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalseboolean'Exclude from indexing' schema flag.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
versionfalsestringVersion of the schema.

Example:

{
  "description" : "New description",
  "name" : "extended-content",
  "fields" : [ ],
  "microschema" : false
}

HTTP status code 200

The validation message

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
elasticsearchfalseobjectThe generated default elasticsearch index configuration which includes the used analyzers and mappings.
languageElasticsearchfalseobjectThe generated elasticsearch index configuration for each language.
messagetrueobjectDetailed validation message.
statustruestringStatus of the validation.

Example:

{
  "status" : "VALID",
  "message" : {
    "message" : "Schema validation was successful."
  },
  "elasticsearch" : {
    "settings" : {
      "analysis" : {
        "analyzer" : {
          "trigrams" : {
            "tokenizer" : "my_ngram_tokenizer",
            "filter" : [ "lowercase" ]
          }
        },
        "tokenizer" : {
          "my_ngram_tokenizer" : {
            "type" : "nGram",
            "min_gram" : "3",
            "max_gram" : "3"
          }
        }
      },
      "somebogus" : "value"
    },
    "mappings" : {
      "default" : {
        "properties" : {
          "uuid" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "created" : {
            "type" : "date",
            "index" : "not_analyzed"
          },
          "edited" : {
            "type" : "date",
            "index" : "not_analyzed"
          },
          "editor" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "creator" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "_roleUuids" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "project" : {
            "type" : "object",
            "properties" : {
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "tags" : {
            "type" : "nested",
            "properties" : {
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "tagFamilies" : {
            "type" : "object",
            "dynamic" : true
          },
          "language" : {
            "type" : "string",
            "index" : "not_analyzed"
          },
          "schema" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              },
              "name" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "version" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "displayField" : {
            "type" : "object",
            "properties" : {
              "key" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              },
              "value" : {
                "type" : "string",
                "index" : "analyzed",
                "analyzer" : "trigrams",
                "fields" : {
                  "raw" : {
                    "type" : "string",
                    "index" : "not_analyzed"
                  }
                }
              }
            }
          },
          "parentNode" : {
            "type" : "object",
            "properties" : {
              "uuid" : {
                "type" : "string",
                "index" : "not_analyzed"
              }
            }
          },
          "fields" : {
            "properties" : { }
          }
        },
        "dynamic" : "strict",
        "dynamic_templates" : [ {
          "tagFamilyUuid" : {
            "path_match" : "tagFamilies.*.uuid",
            "match_mapping_type" : "*",
            "mapping" : {
              "type" : "string",
              "index" : "not_analyzed"
            }
          }
        }, {
          "tagFamilyTags" : {
            "path_match" : "tagFamilies.*.tags",
            "match_mapping_type" : "*",
            "mapping" : {
              "type" : "nested",
              "properties" : {
                "name" : {
                  "type" : "string",
                  "index" : "analyzed",
                  "analyzer" : "trigrams",
                  "fields" : {
                    "raw" : {
                      "type" : "string",
                      "index" : "not_analyzed"
                    }
                  }
                },
                "uuid" : {
                  "type" : "string",
                  "index" : "not_analyzed"
                }
              }
            }
          }
        } ]
      }
    }
  }
}

/auth

Endpoint which contains login and logout methods.

get post

get

Login via basic or bearer authentication.

post

Login via this dedicated login endpoint.

Login via this dedicated login endpoint.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
apikeyfalsestringAPI key of the user to log in.
newPasswordfalsestringNew password that will be set after successful login.
passwordfalsestringPassword of the user which should be logged in.
usernamefalsestringUsername of the user which should be logged in.

Example:

{
  "username" : "admin",
  "password" : "finger"
}

HTTP status code 200

Generated login token.

Body

Type: text/plain

Example:

{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyVXVpZCI6IlVVSURPRlVTRVIxIiwiZXhwIjoxNDY5MTE3MjQ3LCJpYXQiOjE0NjkxMTM2NDd9.i1u4RMs4K7zBkGhmcpp1P79Wpz2UQYJkZKJTVdFp_iU="}

get

get

Logout and delete the currently active session.

get

get

Load your own user which is currently logged in.

/eventbus

This endpoint is a SockJS compliant websocket that creates a bridge to the mesh eventbus. It allows handling of various mesh specific events.

/

Provides endpoints that return information about the REST API.

get

get

Endpoint which returns version information

Endpoint which returns version information

HTTP status code 200

JSON which contains version information

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
databaseRevisionfalsestringDatabase structure revision hash.
databaseVendorfalsestringUsed database implementation vendor name.
databaseVersionfalsestringUsed database implementation version.
meshNodeNamefalsestringNode name of the Gentics Mesh instance.
meshVersionfalsestringGentics Mesh Version string.
searchVendorfalsestringUsed search implementation vendor name.
searchVersionfalsestringUsed search implementation version.
vertxVersionfalsestringUsed Vert.x version.

Example:

{
  "meshVersion" : "2.1.12-SNAPSHOT",
  "meshNodeName" : "Reminiscent Tirtouga",
  "databaseVendor" : "orientdb",
  "databaseVersion" : "2.2.16",
  "searchVendor" : "elasticsearch",
  "searchVersion" : "2.4.3",
  "vertxVersion" : "4.5.7"
}

get

get

Endpoint which provides a RAML document for all registed endpoints.

get

get

Return the current project info.

Return the current project info.

URI Parameters

  • project: required (string)

    Name of the project.

    Example:

    demo

HTTP status code 200

Project information.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
languagesfalsearrayProject's languages.
nametruestringThe name of the project.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
rootNodetrueobjectThe project root node. All futher nodes are children of this node.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "d3b1840b01464b54b1840b0146cb54f5",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "demo",
  "rootNode" : {
    "uuid" : "adaf48da8c124049af48da8c12a0493e"
  },
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

/{project}/nodes

Provides endpoints which allow the manipulation of nodes.

post get

post

Create a new node.

get

Read all nodes and return a paged list response.

Create a new node.

URI Parameters

  • project: required (string)

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
assignLanguagefalsebooleanAssign a requested language to the project, if none was so far. Default is 'true'.
fieldstrueobjectDynamic map with fields of the node content.
grantfalseobjectPermissions to be granted to roles on the created node.
languagetruestringISO 639-1 language tag of the node content.
parentNodetrueobjectReference to the parent node in which the node will be created. The uuid of this object must be set.
publishfalsebooleanWhether the publish the node after creation.
schematrueobjectReference to the schema of the node.
tagsfalsearrayList of tags that should be used to tag the node.

Example:

{
  "parentNode" : {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f"
  },
  "schema" : {
    "name" : "vehicle"
  },
  "language" : "en",
  "fields" : {
    "name" : "DeLorean DMC-12",
    "description" : "The DeLorean DMC-12 is a sports car manufactured by John DeLorean's DeLorean Motor Company for the American market from 1981–83."
  },
  "publish" : false,
  "assignLanguage" : true
}

HTTP status code 201

Created node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Read all nodes and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded list of nodes.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "vehicles"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "vehicles"
    } ],
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag en",
      "filename" : "dummy-content.en.html",
      "teaser" : "Dummy teaser for en",
      "content" : "Content for language tag en"
    },
    "breadcrumb" : [ {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "Automobiles",
      "path" : "/automobiles"
    }, {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Load the node with the given uuid.

post

Update or create the node with the given uuid. Mesh will automatically check for version conflicts if a version was specified in the request and return a 409 error if a conflict has been detected. Additional conflict checks for WebRoot path conflicts will also be performed. The node is created if no node with the specified uuid could be found.

delete

Delete the node with the given uuid.

Load the node with the given uuid.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • role: (string)

    The role query parameter take a UUID of a role and may be used to add permission information to the response via the rolePerm property which lists the permissions for the specified role on the element. This may be useful when you are logged in as admin but you want to retrieve the editor role permissions on a given node. Endpoint: /api/v2/:projectName/nodes?role=:roleUuid

    Example:

    24cf92691c7641158f92691c76c115ef
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

Loaded node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Update or create the node with the given uuid. Mesh will automatically check for version conflicts if a version was specified in the request and return a 409 error if a conflict has been detected. Additional conflict checks for WebRoot path conflicts will also be performed. The node is created if no node with the specified uuid could be found.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
assignLanguagefalsebooleanAssign a requested language to the project, if none was so far.
fieldsfalseobjectDynamic map with fields of the node content.
grantfalseobjectPermissions to be granted to roles on the updated node.
languagefalsestringISO 639-1 language tag of the node content.
manipulationfalseobjectImage manipulation changes request.
publishfalsebooleanWhether the publish the node after updating.
tagsfalsearrayList of tags that should be used to tag the node.
versionfalsestringVersion number which can be provided in order to handle and detect concurrent changes to the node content.

Example:

{
  "language" : "en",
  "fields" : {
    "filename" : "index-renamed.en.html",
    "relatedProduct-" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    }, {
      "uuid" : "4c83d010122c4a2783d010122c4a2782"
    }, {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    } ],
    "image" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "version" : "1.0",
  "publish" : false,
  "assignLanguage" : true
}

HTTP status code 200

Updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "vehicles"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "vehicles"
  } ],
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag en",
    "filename" : "dummy-content.en.html",
    "teaser" : "Dummy teaser for en",
    "content" : "Content for language tag en"
  },
  "breadcrumb" : [ {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "Automobiles",
    "path" : "/automobiles"
  }, {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : false,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

HTTP status code 409

A conflict has been detected.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Delete the node with the given uuid.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • recursive: (boolean)

    Specifiy whether deletion should also be applied recursively

    Example:

    true

HTTP status code 204

Deletion was successful.

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post get

post

Update the binaryfield with the given name.

get

Download the binary field with the given name. You can use image query parameters for crop and resize if the binary data represents an image.

Update the binaryfield with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the binary field

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: multipart/form-data

Form Parameters
  • binary: required (file)

    Single binary file part.

  • language: required (string)

    Language of the node content which contains the binary field which should be updated.

    Example:

    en
  • version: required (string)

    Version of the node which should be updated. This information is used to determine conflicting updates.

    Example:

    1.0

HTTP status code 200

The response contains the updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Download the binary field with the given name. You can use image query parameters for crop and resize if the binary data represents an image.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the binary field

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • fpz: (number)

    Set the focal point zoom factor. The value must be greater than one.

    Example:

    1.5
  • rect: (string)

    Set image crop area.

    Example:

    20,20,128,128
  • w: (number)

    Set image target width. The height will automatically be calculated if the width was omitted.

    Example:

    1280
  • h: (number)

    Set image target height. The width will automatically be calculated if the height was omitted.

    Example:

    720
  • resize: (string)

    Set the resize mode. Possible modes: force : The force mode will resize the image to the specified dimensions. This can lead to a distorted image when the aspect ratio of the source image does not match the destination aspect ratio smart : The smart mode will resize the image proportionally so that the resulting destination format matches the source format in at least one dimension. No distortion of the image will occur. prop : The prop mode will resize the image proportionally so that the resulting destination format fits inside the provided dimensions. No distortion of the image will occur.

    Example:

    smart
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1
  • fpy: (number)

    Set the focal point y factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.2
  • crop: (string)

    Set the crop mode. Possible modes: rect : The rect mode will work in combination with the rect parameter and crop the specified area. fp : The fp mode will utilize the specified or pre-selected focal point and crop the image according to the position of the focus point and the specified image size.

    Example:

    rect
  • fpx: (number)

    Set the focal point x factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.1

post

post

Set the check status for the binaryfield with the given name.

Set the check status for the binaryfield with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the field for which the check status is to be updated.

    Example:

    stringField
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: multipart/form-data

Form Parameters
  • reason: (string)

    The reason why the binary was denied.

    Example:

    Malware detected
  • status: required (string)

    The result of the binary check. One of ACCEPTED or DENIED.

    Example:

    DENIED

HTTP status code 204

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get delete post

get

Get the list of image manipulation variants of the binary, possessed by a field with the given name.

delete

Delete unused image manipulation variants of the binary, referenced by a field with the given name.

post

Add new image variants to the binary, referenced by a field with the given name.

Get the list of image manipulation variants of the binary, possessed by a field with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the image field.

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • original: (boolean)

    Specifies a need to retrieve original image along with its manipulation variants.

    Example:

    true
  • filesize: (boolean)

    Specifies a need to retrieve filesizes for the returned image manipulation variants.

    Example:

    true
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

A list of image variants have been returned.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
variantsfalsearrayList of image manipulation variants.

Example:

{
  "variants" : [ {
    "width" : 500,
    "height" : 100,
    "origin" : true,
    "auto" : false
  }, {
    "rect" : {
      "startX" : 10,
      "startY" : 10,
      "width" : 20,
      "height" : 20
    },
    "cropMode" : "RECT",
    "origin" : false,
    "auto" : false
  }, {
    "height" : 50,
    "origin" : false,
    "auto" : false
  } ]
}

Delete unused image manipulation variants of the binary, referenced by a field with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the image field.

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • original: (boolean)

    Specifies a need to retrieve original image along with its manipulation variants.

    Example:

    true
  • filesize: (boolean)

    Specifies a need to retrieve filesizes for the returned image manipulation variants.

    Example:

    true
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 204

Image variants have been deleted.

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Add new image variants to the binary, referenced by a field with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the image field.

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • original: (boolean)

    Specifies a need to retrieve original image along with its manipulation variants.

    Example:

    true
  • filesize: (boolean)

    Specifies a need to retrieve filesizes for the returned image manipulation variants.

    Example:

    true
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
deleteOtherfalsebooleanThis flag states that all the existing variants, except the mentioned in `variants` field, should be dropped.If no variants are provided along with the flag, all the image manipulation variants are to be dropped.
variantsfalsearrayThis field contains a set of image manipulation variants to be manipulated upon.

Example:

{
  "variants" : [ {
    "width" : "auto",
    "height" : "100",
    "resizeMode" : "SMART",
    "cacheKey" : "resizeSMARTrwautorh100"
  }, {
    "resizeMode" : "SMART",
    "focalPoint" : {
      "x" : 0.3,
      "y" : 0.3
    },
    "focalZoom" : 0.6,
    "focalPointZoom" : 0.6,
    "cacheKey" : "resizeSMARTfp0.3-0.3fpz0.6"
  } ],
  "deleteOther" : false
}

HTTP status code 200

An updated list of variants is returned

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
variantsfalsearrayList of image manipulation variants.

Example:

{
  "variants" : [ {
    "width" : 500,
    "height" : 100,
    "origin" : true,
    "auto" : false
  }, {
    "rect" : {
      "startX" : 10,
      "startY" : 10,
      "width" : 20,
      "height" : 20
    },
    "cropMode" : "RECT",
    "origin" : false,
    "auto" : false
  }, {
    "height" : 50,
    "origin" : false,
    "auto" : false
  } ]
}

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Transform the image with the given field name and overwrite the stored image with the transformation result.

Transform the image with the given field name and overwrite the stored image with the transformation result.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the field

    Example:

    image
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
cropModefalsestringCrop mode. To be used in conjunction with cropRect
cropRectfalseobjectCrop area.
focalPointfalseobjectOptional new focal point for the transformed image.
heightfalsestringNew height of the image.
languagetruestringISO 639-1 language tag of the node which provides the image which should be transformed.
resizeModefalsestringResize mode.
versiontruestringVersion number which must be provided in order to handle and detect concurrent changes to the node content.
widthfalsestringNew width of the image.

Example:

{
  "version" : "1.0",
  "language" : "en",
  "width" : "100",
  "height" : "200",
  "cropRect" : {
    "startX" : 50,
    "startY" : 20,
    "width" : 170,
    "height" : 150
  },
  "focalPoint" : {
    "x" : 0.3,
    "y" : 0.6
  }
}

HTTP status code 200

Transformation was executed and updated node was returned.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

Load all child nodes and return a paged list response.

Load all child nodes and return a paged list response.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium
  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of loaded node children.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "vehicles"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "vehicles"
    } ],
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag en",
      "filename" : "dummy-content.en.html",
      "teaser" : "Dummy teaser for en",
      "content" : "Content for language tag en"
    },
    "breadcrumb" : [ {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "Automobiles",
      "path" : "/automobiles"
    }, {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

delete

delete

Delete the language specific content of the node.

Delete the language specific content of the node.

URI Parameters

  • project: required (string)
  • language: required (string)

    Language tag of the content which should be deleted.

    Example:

    en
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 204

Language variation of the node has been deleted.

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get post delete

get

Return the publish status for the given language of the node.

post

Publish the language of the node. This will automatically assign a new major version to the node and update the draft version to the published version.

delete

Take the language of the node offline.

Return the publish status for the given language of the node.

URI Parameters

  • project: required (string)
  • language: required (string)

    Name of the language tag

    Example:

    en
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 200

Publish status of the specific language.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
publishDatefalsestringISO8601 formatted publish date string.
publishedtruebooleanFlag which indicates whether the content is published.
publisherfalseobjectReference to the publisher user of the node content.
versiontruestringVersion number.

Example:

{
  "published" : true,
  "version" : "3.0",
  "publisher" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "publishDate" : "2018-11-20T20:12:01.084Z"
}

HTTP status code 404

The node or the language could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Publish the language of the node. This will automatically assign a new major version to the node and update the draft version to the published version.

URI Parameters

  • project: required (string)
  • language: required (string)

    Name of the language tag

    Example:

    en
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 200

Updated publish status.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
publishDatefalsestringISO8601 formatted publish date string.
publishedtruebooleanFlag which indicates whether the content is published.
publisherfalseobjectReference to the publisher user of the node content.
versiontruestringVersion number.

Example:

{
  "published" : true,
  "version" : "3.0",
  "publisher" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "publishDate" : "2018-11-20T20:12:01.084Z"
}

HTTP status code 404

The node or the language could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Take the language of the node offline.

URI Parameters

  • project: required (string)
  • language: required (string)

    Name of the language tag

    Example:

    en
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 204

Node language was taken offline.

HTTP status code 404

The node or the language could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Move the node into the target node.

Move the node into the target node.

URI Parameters

  • project: required (string)
  • toUuid: required (string)

    Uuid of target the node.

    Example:

    2e1c9ac190fe49d69c9ac190fee9d6fe
  • nodeUuid: required (string)

    Uuid of the node which should be moved.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 204

Node was moved.

HTTP status code 404

The source or target node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

Returns a navigation object for the provided node.

Returns a navigation object for the provided node.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • maxDepth: (number - default: 10)

    Specifies the maximum depth for the requested navigation tree structure.

    Example:

    5
  • includeAll: (boolean)

    If set to true all nodes will be included in the response. By default only container nodes are included in a navigation response.

    Example:

    true

HTTP status code 200

Loaded navigation.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
childrenfalsearrayList of further child elements of the node.
nodefalseobjectDetailed node information.
uuidfalsestringUuid of the node within this navigation element.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get post delete

get

Return the published status of the node.

post

Publish all language specific contents of the node with the given uuid.

delete

Unpublish the given node.

Return the published status of the node.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 200

Publish status of the node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagesfalseobjectMap of publish status entries per language

Example:

{
  "availableLanguages" : {
    "de" : {
      "published" : false,
      "version" : "0.4"
    },
    "en" : {
      "published" : true,
      "version" : "3.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-11-20T20:12:01.084Z"
    },
    "fr" : {
      "published" : false,
      "version" : "5.2"
    }
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Publish all language specific contents of the node with the given uuid.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • recursive: (boolean)

    Specifiy whether the invoked action should be applied recursively.

    Example:

    true

HTTP status code 200

Publish status of the node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagesfalseobjectMap of publish status entries per language

Example:

{
  "availableLanguages" : {
    "de" : {
      "published" : false,
      "version" : "0.4"
    },
    "en" : {
      "published" : true,
      "version" : "3.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-11-20T20:12:01.084Z"
    },
    "fr" : {
      "published" : false,
      "version" : "5.2"
    }
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Unpublish the given node.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • recursive: (boolean)

    Specifiy whether the invoked action should be applied recursively.

    Example:

    true

HTTP status code 204

Node was unpublished.

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get post delete

get

Get the permissions on the node for all roles.

post

Grant permissions on the node to multiple roles.

delete

Revoke permissions on the node from multiple roles.

Get the permissions on the node for all roles.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "publish" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "readPublished" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the node to multiple roles.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "publish" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "readPublished" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "100936060e164ab0898c74c614659985"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "publish" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "readPublished" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the node from multiple roles.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "publish" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "readPublished" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "publish" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "readPublished" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

post

post

Create the s3 binaryfield with the given name.

Create the s3 binaryfield with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the field which should be created.

    Example:

    stringField
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: multipart/form-data

Form Parameters
  • binary: required (file)

    Single binary file part.

  • language: required (string)

    Language of the node content which contains the binary field which should be updated.

    Example:

    en
  • version: required (string)

    Version of the node which should be updated. This information is used to determine conflicting updates.

    Example:

    1.0

HTTP status code 200

The response contains the updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Set the check status for the binaryfield with the given name.

Set the check status for the binaryfield with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the field which should be created.

    Example:

    stringField
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: multipart/form-data

Form Parameters
  • reason: (string)

    The reason why the binary was denied.

    Example:

    Malware detected
  • status: required (string)

    The result of the binary check. One of ACCEPTED or DENIED.

    Example:

    DENIED

HTTP status code 204

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Parse metadata of s3 binaryfield with the given name.

Parse metadata of s3 binaryfield with the given name.

URI Parameters

  • project: required (string)
  • fieldName: required (string)

    Name of the field which should be created.

    Example:

    stringField
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: multipart/form-data

Form Parameters
  • binary: required (file)

    Single binary file part.

  • language: required (string)

    Language of the node content which contains the binary field which should be updated.

    Example:

    en
  • version: required (string)

    Version of the node which should be updated. This information is used to determine conflicting updates.

    Example:

    1.0

HTTP status code 200

The response contains the updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "adaf48da8c124049af48da8c12a0493e",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "edited" : "2018-11-20T20:12:01.084Z",
  "availableLanguages" : {
    "de" : {
      "published" : true,
      "version" : "1.0",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    },
    "en" : {
      "published" : false,
      "version" : "1.1",
      "publisher" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "publishDate" : "2018-10-12T14:15:06.024Z"
    }
  },
  "languagePaths" : {
    "de" : "/api/v2/yourProject/webroot/Bilder",
    "en" : "/api/v2/yourProject/webroot/Images"
  },
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247"
  } ],
  "childrenInfo" : {
    "folder" : {
      "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
      "count" : 5
    },
    "blogpost" : {
      "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
      "count" : 1
    }
  },
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag de-DE",
    "filename" : "dummy-content.de.html",
    "teaser" : "Dummy teaser for de-DE",
    "content" : "Content for language tag de-DE",
    "relatedProduct" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    }, {
      "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
    }, {
      "uuid" : "986fae0301fc4715afae0301fc27158f"
    } ],
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "binary" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "path" : "/api/v2/yourProject/webroot/Images",
  "breadcrumb" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "news",
    "path" : "/news"
  }, {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "2015",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node or the field could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get post

get

Return a list of all tags which tag the node.

post

Update the list of assigned tags

Return a list of all tags which tag the node.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

List of tags that were used to tag the node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Update the list of assigned tags

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
tagstruearrayList of tags which should be assigned to the node. Tags which are not included will be removed from the node.

Example:

{
  "tags" : [ {
    "name" : "green",
    "uuid" : "f36400b436d244c3a400b436d244c3f4",
    "tagFamily" : "colors"
  }, {
    "name" : "yellow",
    "uuid" : "f36400b436d244c3a400b436d244c3f4",
    "tagFamily" : "colors"
  } ]
}

HTTP status code 200

Updated tag list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

HTTP status code 404

The node could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post delete

post

Assign the given tag to the node.

delete

Remove the given tag from the node.

Assign the given tag to the node.

URI Parameters

  • project: required (string)
  • tagUuid: required (string)

    Uuid of the tag

    Example:

    2e1c9ac190fe49d69c9ac190fee9d6fe
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

HTTP status code 200

Updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "vehicles"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "vehicles"
  } ],
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag en",
    "filename" : "dummy-content.en.html",
    "teaser" : "Dummy teaser for en",
    "content" : "Content for language tag en"
  },
  "breadcrumb" : [ {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "Automobiles",
    "path" : "/automobiles"
  }, {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : false,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 404

The node or tag could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

Remove the given tag from the node.

URI Parameters

  • project: required (string)
  • tagUuid: required (string)

    Uuid of the tag

    Example:

    2e1c9ac190fe49d69c9ac190fee9d6fe
  • nodeUuid: required (string)

    Uuid of the node

    Example:

    adaf48da8c124049af48da8c12a0493e

HTTP status code 204

Removal was successful.

HTTP status code 404

The node or tag could not be found.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get

get

Returns a list of versions.

Returns a list of versions.

URI Parameters

  • project: required (string)
  • nodeUuid: required (string)

    Uuid of the node.

    Example:

    adaf48da8c124049af48da8c12a0493e

Query Parameters

  • lang: (string)

    ISO 639-1 language tag of the language which should be loaded. Fallback handling can be applied by specifying multiple languages in a comma-separated list. The first matching language will be returned. If omitted or the requested language is not available then the defaultLanguage as configured in mesh.yml will be returned.

    Example:

    en,de
  • resolveLinks: (string)

    The resolve links parameter can be set to either short, medium or full. Stored mesh links will automatically be resolved and replaced by the resolved webroot link. With the parameter set the path property as well as the languagesPath property (for available language variants) will be included in the response. Gentics Mesh links in any HTML-typed field will automatically be resolved and replaced by the resolved WebRoot path. No resolving occurs if no link has been specified.

    Example:

    medium

HTTP status code 200

Loaded version list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
versions.additionalProperties.items.branchRoottruebooleanIs the version used as a root version in another branch?
versions.additionalProperties.items.createdtruestringISO8601 formatted created date string.
versions.additionalProperties.items.creatortrueobjectUser reference of the creator of the element.
versions.additionalProperties.items.drafttruebooleanIs the content a draft version?
versions.additionalProperties.items.publishedtruebooleanIs the content published version?
versions.additionalProperties.items.versiontruestringVersion of the content.

Example:

{
  "versions" : {
    "de" : [ {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "1.0"
    }, {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "1.1"
    }, {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "2.0"
    } ],
    "en" : [ {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "1.0"
    }, {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "1.1"
    }, {
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-11-20T20:12:01.084Z",
      "version" : "2.0"
    } ]
  }
}

/{project}/tagFamilies

Provides endpoints which allow the manipulation of tag families and tags.

get post

get

Load multiple tag families and return a paged list response.

post

Create a new tag family.

Load multiple tag families and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded tag families.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Colors",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

Create a new tag family.

URI Parameters

  • project: required (string)

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringName of the tag family which will be created.

Example:

{
  "name" : "Colors"
}

HTTP status code 201

Created tag family.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
namefalsestringName of the tag family.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Colors",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

get post delete

get

Read the tag family with the given uuid.

post

Update the tag family with the given uuid. The tag family will be created if it can't be found for the given uuid.

delete

Delete the tag family.

Read the tag family with the given uuid.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d

HTTP status code 200

Loaded tag family.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
namefalsestringName of the tag family.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Colors",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the tag family with the given uuid. The tag family will be created if it can't be found for the given uuid.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the tag family

Example:

{
  "name" : "Nicer colors"
}

HTTP status code 200

Updated tag family.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
namefalsestringName of the tag family.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element

Example:

{
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Nicer colors",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Delete the tag family.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d

HTTP status code 204

Tag family was deleted.

get post delete

get

Get the permissions on the tag family for all roles.

post

Grant permissions on the tag family to multiple roles.

delete

Revoke permissions on the tag family from multiple roles.

Get the permissions on the tag family for all roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family

    Example:

    1898428398164d9a9842839816ed9a3d

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the tag family to multiple roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family

    Example:

    1898428398164d9a9842839816ed9a3d

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "8b0e83e923a04b5eaaff095e6aa3ada8"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the tag family from multiple roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family

    Example:

    1898428398164d9a9842839816ed9a3d

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

post get

post

Create a new tag within the tag family.

get

Load tags which were assigned to this tag family and return a paged list response.

Create a new tag within the tag family.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringName of the tag which will be created.

Example:

{
  "name" : "red"
}

HTTP status code 200

Created tag

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the tag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
tagFamilytrueobjectReference to the tag family to which the tag belongs.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "tagFamily" : {
    "name" : "colors",
    "uuid" : "1898428398164d9a9842839816ed9a3d"
  },
  "name" : "red",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Load tags which were assigned to this tag family and return a paged list response.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of tags.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Read the specified tag from the tag family.

post

Update the specified tag. The tag is created if no tag with the specified uuid could be found.

delete

Remove the tag from the tag family.

Read the specified tag from the tag family.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d
  • tagUuid: required (string)

    Uuid of the tag.

    Example:

    6e6f1d9f055447d2af1d9f055417d289

Query Parameters

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

HTTP status code 200

Loaded tag.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the tag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
tagFamilytrueobjectReference to the tag family to which the tag belongs.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "tagFamily" : {
    "name" : "colors",
    "uuid" : "1898428398164d9a9842839816ed9a3d"
  },
  "name" : "red",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the specified tag. The tag is created if no tag with the specified uuid could be found.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d
  • tagUuid: required (string)

    Uuid of the tag.

    Example:

    6e6f1d9f055447d2af1d9f055417d289

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
nametruestringNew name of the tag.

Example:

{
  "name" : "Red"
}

HTTP status code 200

Updated tag.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
nametruestringName of the tag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
tagFamilytrueobjectReference to the tag family to which the tag belongs.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "tagFamily" : {
    "name" : "colors",
    "uuid" : "1898428398164d9a9842839816ed9a3d"
  },
  "name" : "Red",
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Remove the tag from the tag family.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d
  • tagUuid: required (string)

    Uuid of the tag.

    Example:

    6e6f1d9f055447d2af1d9f055417d289

HTTP status code 204

Tag was removed from the tag family

get

get

Load all nodes that have been tagged with the tag and return a paged list response.

Load all nodes that have been tagged with the tag and return a paged list response.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)

    Uuid of the tag family.

    Example:

    1898428398164d9a9842839816ed9a3d
  • tagUuid: required (string)

    Uuid of the tag.

    Example:

    6e6f1d9f055447d2af1d9f055417d289

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of nodes which were tagged using the provided tag.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "vehicles"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "vehicles"
    } ],
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag en",
      "filename" : "dummy-content.en.html",
      "teaser" : "Dummy teaser for en",
      "content" : "Content for language tag en"
    },
    "breadcrumb" : [ {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "Automobiles",
      "path" : "/automobiles"
    }, {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Get the permissions on the tag for all roles.

post

Grant permissions on the tag to multiple roles.

delete

Revoke permissions on the tag from multiple roles.

Get the permissions on the tag for all roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)
  • tagUuid: required (string)

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the tag to multiple roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)
  • tagUuid: required (string)

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "b1177a850ce9443d8ffac81025233629"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the tag from multiple roles.

URI Parameters

  • project: required (string)
  • tagFamilyUuid: required (string)
  • tagUuid: required (string)

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

/{project}/navroot

Provides an endpoint which can be used to retrieve a navigation response

get

get

Return a navigation for the node which is located using the given path.

Return a navigation for the node which is located using the given path.

URI Parameters

  • project: required (string)
  • path: required (string)

    Webroot path to the node language variation.

    Example:

    someFolder/somePage.html

Query Parameters

  • maxDepth: (number - default: 10)

    Specifies the maximum depth for the requested navigation tree structure.

    Example:

    5
  • includeAll: (boolean)

    If set to true all nodes will be included in the response. By default only container nodes are included in a navigation response.

    Example:

    true

HTTP status code 200

Loaded navigation.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
childrenfalsearrayList of further child elements of the node.
nodefalseobjectDetailed node information.
uuidfalsestringUuid of the node within this navigation element.

Example:

{
  "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
  "node" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  },
  "children" : [ {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "node" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "creator" : {
        "firstName" : "Joe",
        "lastName" : "Doe",
        "uuid" : "589319933be24ec79319933be24ec7fe"
      },
      "created" : "2018-10-12T14:15:06.024Z",
      "edited" : "2018-11-20T20:12:01.084Z",
      "availableLanguages" : {
        "de" : {
          "published" : true,
          "version" : "1.0",
          "publisher" : {
            "firstName" : "Joe",
            "lastName" : "Doe",
            "uuid" : "589319933be24ec79319933be24ec7fe"
          },
          "publishDate" : "2018-10-12T14:15:06.024Z"
        },
        "en" : {
          "published" : false,
          "version" : "1.1",
          "publisher" : {
            "firstName" : "Joe",
            "lastName" : "Doe",
            "uuid" : "589319933be24ec79319933be24ec7fe"
          },
          "publishDate" : "2018-10-12T14:15:06.024Z"
        }
      },
      "languagePaths" : {
        "de" : "/api/v2/yourProject/webroot/Bilder",
        "en" : "/api/v2/yourProject/webroot/Images"
      },
      "parentNode" : {
        "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
        "displayName" : "parentNodeDisplayName"
      },
      "tags" : [ {
        "name" : "red",
        "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
        "tagFamily" : "colors"
      }, {
        "name" : "green",
        "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
        "tagFamily" : "colors"
      }, {
        "name" : "car",
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      }, {
        "name" : "ship",
        "uuid" : "86c0a2b6435d434280a2b6435da34247"
      } ],
      "childrenInfo" : {
        "folder" : {
          "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
          "count" : 5
        },
        "blogpost" : {
          "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
          "count" : 1
        }
      },
      "schema" : {
        "name" : "content",
        "uuid" : "e287e8a7497940ac87e8a7497940ac82",
        "version" : "1.0"
      },
      "fields" : {
        "name" : "Name for language tag de-DE",
        "filename" : "dummy-content.de.html",
        "teaser" : "Dummy teaser for de-DE",
        "content" : "Content for language tag de-DE",
        "relatedProduct" : {
          "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
        },
        "price" : 100.1,
        "enabled" : true,
        "branch" : "2018-10-12T14:15:06.024Z",
        "categories" : [ {
          "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
        }, {
          "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
        }, {
          "uuid" : "986fae0301fc4715afae0301fc27158f"
        } ],
        "names" : [ "Jack", "Joe", "Mary", "Tom" ],
        "categoryIds" : [ 1, 42, 133, 7 ],
        "binary" : {
          "fileName" : "flower.jpg",
          "width" : 800,
          "height" : 600,
          "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
          "fileSize" : 95365,
          "mimeType" : "image/jpeg",
          "dominantColor" : "#22a7f0",
          "focalPoint" : {
            "x" : 0.1,
            "y" : 0.2
          },
          "checkStatus" : "POSTPONED"
        },
        "location" : {
          "microschema" : {
            "name" : "geolocation"
          },
          "fields" : {
            "latitude" : 48.208330230278,
            "longitude" : 16.373063840833
          }
        },
        "locations" : [ {
          "microschema" : {
            "name" : "geolocation"
          },
          "fields" : {
            "latitude" : 48.208330230278,
            "longitude" : 16.373063840833
          }
        }, {
          "microschema" : {
            "name" : "geolocation"
          },
          "fields" : {
            "latitude" : 48.137222,
            "longitude" : 11.575556
          }
        } ]
      },
      "path" : "/api/v2/yourProject/webroot/Images",
      "breadcrumb" : [ {
        "uuid" : "adaf48da8c124049af48da8c12a0493e",
        "displayName" : "news",
        "path" : "/news"
      }, {
        "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
        "displayName" : "2015",
        "path" : "/automobiles/delorean-dmc-12"
      } ],
      "permissions" : {
        "create" : true,
        "read" : true,
        "update" : true,
        "delete" : true,
        "publish" : false,
        "readPublished" : false
      }
    }
  } ]
}

/{project}/webroot

Provides endpoints which allow loading nodes via a webroot path.

get post

get

Load the node or the node's binary data which is located using the provided path.

post

Update or create a node for the given path.

Load the node or the node's binary data which is located using the provided path.

URI Parameters

  • project: required (string)
  • path: required (string)

    Path to the node

    Example:

    /News/2015/Images/flower.jpg

Query Parameters

  • fpz: (number)

    Set the focal point zoom factor. The value must be greater than one.

    Example:

    1.5
  • rect: (string)

    Set image crop area.

    Example:

    20,20,128,128
  • w: (number)

    Set image target width. The height will automatically be calculated if the width was omitted.

    Example:

    1280
  • h: (number)

    Set image target height. The width will automatically be calculated if the height was omitted.

    Example:

    720
  • resize: (string)

    Set the resize mode. Possible modes: force : The force mode will resize the image to the specified dimensions. This can lead to a distorted image when the aspect ratio of the source image does not match the destination aspect ratio smart : The smart mode will resize the image proportionally so that the resulting destination format matches the source format in at least one dimension. No distortion of the image will occur. prop : The prop mode will resize the image proportionally so that the resulting destination format fits inside the provided dimensions. No distortion of the image will occur.

    Example:

    smart
  • fpy: (number)

    Set the focal point y factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.2
  • crop: (string)

    Set the crop mode. Possible modes: rect : The rect mode will work in combination with the rect parameter and crop the specified area. fp : The fp mode will utilize the specified or pre-selected focal point and crop the image according to the position of the focus point and the specified image size.

    Example:

    rect
  • fpx: (number)

    Set the focal point x factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.1

HTTP status code 200

JSON for a node or the binary data of the node for the given path.

Headers

  • Webroot-Response-Type: (string)

    Header value which identifies the type of the webroot response. The response can either be a node or binary response.

    Example:

    node

Update or create a node for the given path.

URI Parameters

  • project: required (string)
  • path: required (string)

    Path to the node

    Example:

    /News/2015/Images/flower.jpg

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
assignLanguagefalsebooleanAssign a requested language to the project, if none was so far.
fieldsfalseobjectDynamic map with fields of the node content.
grantfalseobjectPermissions to be granted to roles on the updated node.
languagefalsestringISO 639-1 language tag of the node content.
manipulationfalseobjectImage manipulation changes request.
publishfalsebooleanWhether the publish the node after updating.
tagsfalsearrayList of tags that should be used to tag the node.
versionfalsestringVersion number which can be provided in order to handle and detect concurrent changes to the node content.

Example:

{
  "language" : "en",
  "fields" : {
    "filename" : "index-renamed.en.html",
    "relatedProduct-" : {
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    },
    "price" : 100.1,
    "enabled" : true,
    "branch" : "2018-10-12T14:15:06.024Z",
    "categories" : [ {
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    }, {
      "uuid" : "4c83d010122c4a2783d010122c4a2782"
    }, {
      "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
    } ],
    "image" : {
      "fileName" : "flower.jpg",
      "width" : 800,
      "height" : 600,
      "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
      "fileSize" : 95365,
      "mimeType" : "image/jpeg",
      "dominantColor" : "#22a7f0",
      "focalPoint" : {
        "x" : 0.1,
        "y" : 0.2
      },
      "checkStatus" : "POSTPONED"
    },
    "names" : [ "Jack", "Joe", "Mary", "Tom" ],
    "categoryIds" : [ 1, 42, 133, 7 ],
    "location" : {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    },
    "locations" : [ {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.208330230278,
        "longitude" : 16.373063840833
      }
    }, {
      "microschema" : {
        "name" : "geolocation"
      },
      "fields" : {
        "latitude" : 48.137222,
        "longitude" : 11.575556
      }
    } ]
  },
  "version" : "1.0",
  "publish" : false,
  "assignLanguage" : true
}

HTTP status code 200

Updated node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "vehicles"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "vehicles"
  } ],
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag en",
    "filename" : "dummy-content.en.html",
    "teaser" : "Dummy teaser for en",
    "content" : "Content for language tag en"
  },
  "breadcrumb" : [ {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "Automobiles",
    "path" : "/automobiles"
  }, {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : false,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 201

Created node.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
availableLanguagestrueobjectMap of languages for which content is available and their publish status.
breadcrumbtruearrayList of nodes which construct the breadcrumb. Note that the start node will not be included in the list.
childrenInfofalseobjectObject which contains information about child elements.
containertruebooleanFlag which indicates whether the node is a container and can contain nested elements.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
displayFieldfalsestringDisplay field name of the node. May not be retured if the node schema has no display field.
displayNamefalsestringDisplay field value of the node. May not be retured if the node schema has no display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
fieldstrueobjectDynamic map with fields of the node language specific content.
languagefalsestringISO 639-1 language tag of the node content.
languagePathsfalseobjectMap of webroot paths per language. This property will only be populated if the resolveLinks query parameter has been set accordingly.
parentNodefalseobjectReference to the parent node. Note that the root node of the project has no parent node.
pathfalsestringWebroot path to the node content. Will only be provided if the resolveLinks query parameter has been set accordingly.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
projecttrueobjectReference to the project of the node.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
schematrueobjectReference to the schema of the node.
tagstruearrayList of tags that were used to tag the node.
uuidtruestringUuid of the element
versiontruestringVersion of the node content.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "parentNode" : {
    "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
    "displayName" : "parentNodeDisplayName"
  },
  "tags" : [ {
    "name" : "red",
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "tagFamily" : "colors"
  }, {
    "name" : "green",
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "tagFamily" : "colors"
  }, {
    "name" : "car",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "vehicles"
  }, {
    "name" : "ship",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "vehicles"
  } ],
  "schema" : {
    "name" : "content",
    "uuid" : "e287e8a7497940ac87e8a7497940ac82",
    "version" : "1.0"
  },
  "fields" : {
    "name" : "Name for language tag en",
    "filename" : "dummy-content.en.html",
    "teaser" : "Dummy teaser for en",
    "content" : "Content for language tag en"
  },
  "breadcrumb" : [ {
    "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
    "displayName" : "Automobiles",
    "path" : "/automobiles"
  }, {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "displayName" : "DeLorean DMC-12",
    "path" : "/automobiles/delorean-dmc-12"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : false,
    "delete" : false,
    "publish" : false,
    "readPublished" : false
  }
}

HTTP status code 409

A conflict has been detected.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

/{project}/webrootfield

Provides endpoint which allow viewing the requested field for the node loaded via a webroot path.

get post

get

Download the field with the given name from the given path. You can use image query parameters for crop and resize if the binary data represents an image.

post

Update the field variants with the given name from the given path.

Download the field with the given name from the given path. You can use image query parameters for crop and resize if the binary data represents an image.

URI Parameters

  • project: required (string)
  • path: required (string)

    Path to the node

    Example:

    /News/2015/Images/flower.jpg
  • fieldName: required (string)

    Name of the field which should be processed.

    Example:

    binaryField

Query Parameters

  • fpz: (number)

    Set the focal point zoom factor. The value must be greater than one.

    Example:

    1.5
  • rect: (string)

    Set image crop area.

    Example:

    20,20,128,128
  • w: (number)

    Set image target width. The height will automatically be calculated if the width was omitted.

    Example:

    1280
  • h: (number)

    Set image target height. The width will automatically be calculated if the height was omitted.

    Example:

    720
  • resize: (string)

    Set the resize mode. Possible modes: force : The force mode will resize the image to the specified dimensions. This can lead to a distorted image when the aspect ratio of the source image does not match the destination aspect ratio smart : The smart mode will resize the image proportionally so that the resulting destination format matches the source format in at least one dimension. No distortion of the image will occur. prop : The prop mode will resize the image proportionally so that the resulting destination format fits inside the provided dimensions. No distortion of the image will occur.

    Example:

    smart
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1
  • fpy: (number)

    Set the focal point y factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.2
  • crop: (string)

    Set the crop mode. Possible modes: rect : The rect mode will work in combination with the rect parameter and crop the specified area. fp : The fp mode will utilize the specified or pre-selected focal point and crop the image according to the position of the focus point and the specified image size.

    Example:

    rect
  • fpx: (number)

    Set the focal point x factor between 0 and 1 where 0.5 is the middle of the image. You can use this parameter in combination with the crop=fp parameter in order to crop and resize the image in relation to the given point.

    Example:

    0.1

HTTP status code 200

JSON for a node/micronode/list field value, or the binary data for the binary field, or the text data for any other field of the node for the given path.

Headers

  • Webroot-Response-Type: (string)

    Header value which identifies the type of the webrootfield response. The response can either be a JSON, text or binary response.

    Example:

    node

Update the field variants with the given name from the given path.

URI Parameters

  • project: required (string)
  • path: required (string)

    Path to the node

    Example:

    /News/2015/Images/flower.jpg
  • fieldName: required (string)

    Name of the field which should be processed.

    Example:

    binaryField

Query Parameters

  • original: (boolean)

    Specifies a need to retrieve original image along with its manipulation variants.

    Example:

    true
  • filesize: (boolean)

    Specifies a need to retrieve filesizes for the returned image manipulation variants.

    Example:

    true
  • branch: (string)

    Specifies the branch to be used for loading data. The latest project branch will be used if this parameter is omitted.

    Example:

    24cf92691c7641158f92691c76c115ef
  • version: (string - default: draft)

    Specifies the version to be loaded. Can either be published/draft or version number. e.g.: 0.1, 1.0, draft, published.

    Example:

    1.1

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
deleteOtherfalsebooleanThis flag states that all the existing variants, except the mentioned in `variants` field, should be dropped.If no variants are provided along with the flag, all the image manipulation variants are to be dropped.
variantsfalsearrayThis field contains a set of image manipulation variants to be manipulated upon.

Example:

{
  "variants" : [ {
    "width" : "auto",
    "height" : "100",
    "resizeMode" : "SMART",
    "cacheKey" : "resizeSMARTrwautorh100"
  }, {
    "resizeMode" : "SMART",
    "focalPoint" : {
      "x" : 0.3,
      "y" : 0.3
    },
    "focalZoom" : 0.6,
    "focalPointZoom" : 0.6,
    "cacheKey" : "resizeSMARTfp0.3-0.3fpz0.6"
  } ],
  "deleteOther" : false
}

HTTP status code 200

JSON for a variants of the binary field of the node for the given path.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
variantsfalsearrayList of image manipulation variants.

Example:

{
  "variants" : [ {
    "width" : 500,
    "height" : 100,
    "origin" : true,
    "auto" : false
  }, {
    "rect" : {
      "startX" : 10,
      "startY" : 10,
      "width" : 20,
      "height" : 20
    },
    "cropMode" : "RECT",
    "origin" : false,
    "auto" : false
  }, {
    "height" : 50,
    "origin" : false,
    "auto" : false
  } ]
}

/{project}/branches

Provides endpoints which allow the manipulation of branches.

post get

post

Create a new branch and automatically invoke a node migration.

get

Load multiple branches and return a paged list response.

Create a new branch and automatically invoke a node migration.

URI Parameters

  • project: required (string)

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
baseBranchfalseobjectOptional reference to the base branch. If not set, the new branch will be based on the current 'latest' branch.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latestfalsebooleanWhether the new branch will be set as 'latest' branch. Defaults to 'true'.
nametruestringName of the branch.
pathPrefixfalsestringOptional path prefix for webroot path and rendered links.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.

Example:

{
  "name" : "Winter 2016",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "latest" : true
}

HTTP status code 201

Created branch.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latesttruebooleanFlag which indicates whether this is the latest branch. Requests that do not specify a specific branch will be performed in the scope of the latest branch.
migratedtruebooleanFlag which indicates whether any active node migration for this branch is still running or whether all nodes have been migrated to this branch.
nametruestringName of the branch.
pathPrefixtruestringOptional path prefix for webroot path and rendered links.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.
tagstruearrayList of tags that were used to tag the branch.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "39f69bee0baa415eb69bee0baa115e82",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Winter 2016",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "pathPrefix" : "my/prefix",
  "migrated" : true,
  "latest" : false,
  "tags" : [ {
    "name" : "dev",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "branchTags"
  }, {
    "name" : "prod",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "branchTags"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "rolePerms" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Load multiple branches and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded branches.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "summer2016",
    "hostname" : "getmesh.io",
    "ssl" : true,
    "pathPrefix" : "my/prefix",
    "migrated" : true,
    "latest" : false,
    "tags" : [ {
      "name" : "dev",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "branchTags"
    }, {
      "name" : "prod",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "branchTags"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "rolePerms" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "autumn2016",
    "hostname" : "getmesh.io",
    "ssl" : true,
    "pathPrefix" : "my/prefix",
    "migrated" : true,
    "latest" : true,
    "tags" : [ {
      "name" : "dev",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "branchTags"
    }, {
      "name" : "prod",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "branchTags"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    },
    "rolePerms" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post

get

Load the branch with the given uuid.

post

Update the branch with the given uuid. The branch is created if no branch with the specified uuid could be found.

Load the branch with the given uuid.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Query Parameters

  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

HTTP status code 200

Loaded branch.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latesttruebooleanFlag which indicates whether this is the latest branch. Requests that do not specify a specific branch will be performed in the scope of the latest branch.
migratedtruebooleanFlag which indicates whether any active node migration for this branch is still running or whether all nodes have been migrated to this branch.
nametruestringName of the branch.
pathPrefixtruestringOptional path prefix for webroot path and rendered links.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.
tagstruearrayList of tags that were used to tag the branch.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "39f69bee0baa415eb69bee0baa115e82",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Summer Collection Branch",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "pathPrefix" : "my/prefix",
  "migrated" : true,
  "latest" : true,
  "tags" : [ {
    "name" : "dev",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "branchTags"
  }, {
    "name" : "prod",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "branchTags"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "rolePerms" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Update the branch with the given uuid. The branch is created if no branch with the specified uuid could be found.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
nametruestringName of the branch.
pathPrefixfalsestringOptional path prefix for webroot path and rendered links.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.

Example:

{
  "name" : "Winter Collection Branch",
  "hostname" : "getmesh.io",
  "ssl" : true
}

HTTP status code 200

Updated branch

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latesttruebooleanFlag which indicates whether this is the latest branch. Requests that do not specify a specific branch will be performed in the scope of the latest branch.
migratedtruebooleanFlag which indicates whether any active node migration for this branch is still running or whether all nodes have been migrated to this branch.
nametruestringName of the branch.
pathPrefixtruestringOptional path prefix for webroot path and rendered links.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.
tagstruearrayList of tags that were used to tag the branch.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "39f69bee0baa415eb69bee0baa115e82",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Winter Collection Branch",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "pathPrefix" : "my/prefix",
  "migrated" : true,
  "latest" : false,
  "tags" : [ {
    "name" : "dev",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "branchTags"
  }, {
    "name" : "prod",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "branchTags"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "rolePerms" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

post

post

Set the branch with the given uuid as 'latest' branch of the project.

Set the branch with the given uuid as 'latest' branch of the project.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

Latest branch

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latesttruebooleanFlag which indicates whether this is the latest branch. Requests that do not specify a specific branch will be performed in the scope of the latest branch.
migratedtruebooleanFlag which indicates whether any active node migration for this branch is still running or whether all nodes have been migrated to this branch.
nametruestringName of the branch.
pathPrefixtruestringOptional path prefix for webroot path and rendered links.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.
tagstruearrayList of tags that were used to tag the branch.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "39f69bee0baa415eb69bee0baa115e82",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Winter Collection Branch",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "pathPrefix" : "my/prefix",
  "migrated" : true,
  "latest" : true,
  "tags" : [ {
    "name" : "dev",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "branchTags"
  }, {
    "name" : "prod",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "branchTags"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "rolePerms" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

get post

get

Load microschemas that are assigned to the branch and return a paged list response.

post

Assign a microschema version to the branch.

Load microschemas that are assigned to the branch and return a paged list response.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

List of microschemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
microschemasfalsearrayList of microschema references.

Example:

{
  "microschemas" : [ {
    "name" : "vcard",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "2.0"
  }, {
    "name" : "geolocation",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0"
  } ]
}

Assign a microschema version to the branch.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
microschemasfalsearrayList of microschema references.

Example:

{
  "microschemas" : [ {
    "name" : "vcard",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "2.0"
  }, {
    "name" : "geolocation",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0"
  } ]
}

HTTP status code 200

Updated microschema list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
microschemasfalsearrayList of microschema references.

Example:

{
  "microschemas" : [ {
    "name" : "vcard",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "2.0"
  }, {
    "name" : "geolocation",
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0"
  } ]
}

post

post

Invoked the micronode migration for not yet migrated micronodes of microschemas that are assigned to the branch.

Invoked the micronode migration for not yet migrated micronodes of microschemas that are assigned to the branch.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

schema_migration_invoked

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

post

post

Invoked the node migration for not yet migrated nodes of schemas that are assigned to the branch.

Invoked the node migration for not yet migrated nodes of schemas that are assigned to the branch.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

schema_migration_invoked

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
internalMessagetruestringInternal developer friendly message
messagetruestringEnduser friendly translated message. Translation depends on the 'Accept-Language' header value
propertiesfalseobjectMap of i18n properties which were used to construct the provided message

Example:

{
  "message" : "I18n message"
}

get post delete

get

Get the permissions on the branch for all roles.

post

Grant permissions on the branch to multiple roles.

delete

Revoke permissions on the branch from multiple roles.

Get the permissions on the branch for all roles.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

Loaded permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Grant permissions on the branch to multiple roles.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
exclusivefalsebooleanFlag which indicates whether the permissions granted to only the given roles (will be revoked from all other roles).
ignoretruearrayRoles which are ignored when the exclusive flag is set.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "exclusive" : true,
  "ignore" : [ {
    "name" : "admin",
    "uuid" : "a156b18df4f643238504928f37c4b8d9"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

Revoke permissions on the branch from multiple roles.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

HTTP status code 200

Updated permissions.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createtruearrayRoles to which the create permission is granted.
deletetruearrayRoles to which the delete permission is granted.
publishfalsearrayRoles to which the publish permission is granted.
readtruearrayRoles to which the read permission is granted.
readPublishedfalsearrayRoles to which the read published permission is granted.
updatetruearrayRoles to which the update permission is granted.

Example:

{
  "create" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "read" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "update" : [ {
    "name" : "translator",
    "uuid" : "d84a6f054a3f4ed68a6f054a3f1ed635"
  }, {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ],
  "delete" : [ {
    "name" : "editor",
    "uuid" : "01ed2f8647421b2b85891e5204d53f1b"
  } ]
}

get post

get

Load schemas that are assigned to the branch and return a paged list response.

post

Assign a schema version to the branch.

Load schemas that are assigned to the branch and return a paged list response.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

HTTP status code 200

Loaded schema list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
schemasfalsearrayList of schema references.

Example:

{
  "schemas" : [ {
    "name" : "content",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "folder",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "binary-data",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  } ]
}

Assign a schema version to the branch.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
schemasfalsearrayList of schema references.

Example:

{
  "schemas" : [ {
    "name" : "content",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "folder",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "binary-data",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  } ]
}

HTTP status code 200

Updated schema list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
schemasfalsearrayList of schema references.

Example:

{
  "schemas" : [ {
    "name" : "content",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "folder",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  }, {
    "name" : "binary-data",
    "uuid" : "39f69bee0baa415eb69bee0baa115e82",
    "version" : "1.0"
  } ]
}

get post

get

Return a list of all tags which tag the branch.

post

Update the list of assigned tags

Return a list of all tags which tag the branch.

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch.

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

List of tags that were used to tag the branch.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

Update the list of assigned tags

URI Parameters

  • project: required (string)
  • branchUuid: required (string)

    Uuid of the branch.

    Example:

    39f69bee0baa415eb69bee0baa115e82

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
tagstruearrayList of tags which should be assigned to the node. Tags which are not included will be removed from the node.

Example:

{
  "tags" : [ {
    "name" : "green",
    "uuid" : "f36400b436d244c3a400b436d244c3f4",
    "tagFamily" : "colors"
  }, {
    "name" : "yellow",
    "uuid" : "f36400b436d244c3a400b436d244c3f4",
    "tagFamily" : "colors"
  } ]
}

HTTP status code 200

Updated tag list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post delete

post

Assign the given tag to the branch.

delete

Remove the given tag from the branch.

Assign the given tag to the branch.

URI Parameters

  • project: required (string)
  • tagUuid: required (string)

    Uuid of the tag

    Example:

    6e6f1d9f055447d2af1d9f055417d289
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 200

Updated branch.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
hostnamefalsestringThe hostname of the branch which will be used to generate links across multiple projects.
latesttruebooleanFlag which indicates whether this is the latest branch. Requests that do not specify a specific branch will be performed in the scope of the latest branch.
migratedtruebooleanFlag which indicates whether any active node migration for this branch is still running or whether all nodes have been migrated to this branch.
nametruestringName of the branch.
pathPrefixtruestringOptional path prefix for webroot path and rendered links.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
sslfalsebooleanSSL flag of the branch which will be used to generate links across multiple projects.
tagstruearrayList of tags that were used to tag the branch.
uuidtruestringUuid of the element

Example:

{
  "uuid" : "39f69bee0baa415eb69bee0baa115e82",
  "creator" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "created" : "2018-10-12T14:15:06.024Z",
  "editor" : {
    "firstName" : "Joe",
    "lastName" : "Doe",
    "uuid" : "589319933be24ec79319933be24ec7fe"
  },
  "edited" : "2018-11-20T20:12:01.084Z",
  "name" : "Summer Collection Branch",
  "hostname" : "getmesh.io",
  "ssl" : true,
  "pathPrefix" : "my/prefix",
  "migrated" : true,
  "latest" : false,
  "tags" : [ {
    "name" : "dev",
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "tagFamily" : "branchTags"
  }, {
    "name" : "prod",
    "uuid" : "86c0a2b6435d434280a2b6435da34247",
    "tagFamily" : "branchTags"
  } ],
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  },
  "rolePerms" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Remove the given tag from the branch.

URI Parameters

  • project: required (string)
  • tagUuid: required (string)

    Uuid of the tag

    Example:

    6e6f1d9f055447d2af1d9f055417d289
  • branchUuid: required (string)

    Uuid of the branch

    Example:

    39f69bee0baa415eb69bee0baa115e82

HTTP status code 204

Removal was successful.

/{project}/graphql

GraphQL endpoint

post

post

Endpoint which accepts GraphQL queries.

Endpoint which accepts GraphQL queries.

URI Parameters

  • project: required (string)

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
operationNamefalsestringGraphQL operation name.
querytruestringThe actual GraphQL query.
variablesfalseobjectJSON object which contains the variables.

Example:

{
  "query" : "{ me { username } }"
}

HTTP status code 200

Basic GraphQL response.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
datatrueobjectNested JSON object which contains the query result data.
errorsfalsearrayArray of errors which were encoutered when handling the query.

Example:

{
  "data" : {
    "me" : {
      "username" : "anonymous"
    }
  }
}

/{project}/search

Provides endpoints which allow project wide search.

post

post

Invoke a search query for nodes and return a paged list response.

Invoke a search query for nodes and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • etag: (boolean - default: true)

    Parameter which can be used to disable the etag parameter generation and thus increase performance when etags are not needed.

  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • fields: (string)

    Limit the output to certain fields. This is useful in order to reduce the response JSON overhead.

  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "adaf48da8c124049af48da8c12a0493e",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "edited" : "2018-11-20T20:12:01.084Z",
    "availableLanguages" : {
      "de" : {
        "published" : true,
        "version" : "1.0",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      },
      "en" : {
        "published" : false,
        "version" : "1.1",
        "publisher" : {
          "firstName" : "Joe",
          "lastName" : "Doe",
          "uuid" : "589319933be24ec79319933be24ec7fe"
        },
        "publishDate" : "2018-10-12T14:15:06.024Z"
      }
    },
    "languagePaths" : {
      "de" : "/api/v2/yourProject/webroot/Bilder",
      "en" : "/api/v2/yourProject/webroot/Images"
    },
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247"
    } ],
    "childrenInfo" : {
      "folder" : {
        "schemaUuid" : "4c83d010122c4a2783d010122c4a2782",
        "count" : 5
      },
      "blogpost" : {
        "schemaUuid" : "86c0a2b6435d434280a2b6435da34247",
        "count" : 1
      }
    },
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag de-DE",
      "filename" : "dummy-content.de.html",
      "teaser" : "Dummy teaser for de-DE",
      "content" : "Content for language tag de-DE",
      "relatedProduct" : {
        "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c"
      },
      "price" : 100.1,
      "enabled" : true,
      "branch" : "2018-10-12T14:15:06.024Z",
      "categories" : [ {
        "uuid" : "cf26ed6198204bf0a6ed6198207bf046"
      }, {
        "uuid" : "dff59dcc9f8e4061b59dcc9f8e80615b"
      }, {
        "uuid" : "986fae0301fc4715afae0301fc27158f"
      } ],
      "names" : [ "Jack", "Joe", "Mary", "Tom" ],
      "categoryIds" : [ 1, 42, 133, 7 ],
      "binary" : {
        "fileName" : "flower.jpg",
        "width" : 800,
        "height" : 600,
        "sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
        "fileSize" : 95365,
        "mimeType" : "image/jpeg",
        "dominantColor" : "#22a7f0",
        "focalPoint" : {
          "x" : 0.1,
          "y" : 0.2
        },
        "checkStatus" : "POSTPONED"
      },
      "location" : {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      },
      "locations" : [ {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.208330230278,
          "longitude" : 16.373063840833
        }
      }, {
        "microschema" : {
          "name" : "geolocation"
        },
        "fields" : {
          "latitude" : 48.137222,
          "longitude" : 11.575556
        }
      } ]
    },
    "path" : "/api/v2/yourProject/webroot/Images",
    "breadcrumb" : [ {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "news",
      "path" : "/news"
    }, {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "2015",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "parentNode" : {
      "uuid" : "688f7beae8d240bf8f7beae8d2a0bf2e",
      "displayName" : "parentNodeDisplayName"
    },
    "tags" : [ {
      "name" : "red",
      "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
      "tagFamily" : "colors"
    }, {
      "name" : "green",
      "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
      "tagFamily" : "colors"
    }, {
      "name" : "car",
      "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
      "tagFamily" : "vehicles"
    }, {
      "name" : "ship",
      "uuid" : "86c0a2b6435d434280a2b6435da34247",
      "tagFamily" : "vehicles"
    } ],
    "schema" : {
      "name" : "content",
      "uuid" : "e287e8a7497940ac87e8a7497940ac82",
      "version" : "1.0"
    },
    "fields" : {
      "name" : "Name for language tag en",
      "filename" : "dummy-content.en.html",
      "teaser" : "Dummy teaser for en",
      "content" : "Content for language tag en"
    },
    "breadcrumb" : [ {
      "uuid" : "ca6c7df3f45b48d4ac7df3f45ba8d42f",
      "displayName" : "Automobiles",
      "path" : "/automobiles"
    }, {
      "uuid" : "adaf48da8c124049af48da8c12a0493e",
      "displayName" : "DeLorean DMC-12",
      "path" : "/automobiles/delorean-dmc-12"
    } ],
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for tagFamilies and return a paged list response.

Invoke a search query for tagFamilies and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "name" : "Colors",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post

post

Invoke a search query for tags and return a paged list response.

Invoke a search query for tags and return a paged list response.

URI Parameters

  • project: required (string)

Query Parameters

  • sortBy: (string)

    Field name to sort the result by.

    Example:

    name
  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true
  • page: (number - default: 1)

    Number of page to be loaded.

    Example:

    42
  • perPage: (number)

    Number of elements per page.

    Example:

    42
  • order: (string - default: UNSORTED)

    Field order (ASC/DESC/UNSORTED) to sort the result by.

    Example:

    ASCENDING

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Paged search result list.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "8931caed445d4d1cb1caed445d0d1c8c",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "green",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2e1c9ac190fe49d69c9ac190fee9d6fe",
    "creator" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "created" : "2018-10-12T14:15:06.024Z",
    "editor" : {
      "firstName" : "Joe",
      "lastName" : "Doe",
      "uuid" : "589319933be24ec79319933be24ec7fe"
    },
    "edited" : "2018-11-20T20:12:01.084Z",
    "tagFamily" : {
      "name" : "colors",
      "uuid" : "1898428398164d9a9842839816ed9a3d"
    },
    "name" : "Name for language tag en",
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : false,
      "delete" : false,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

/{project}/rawSearch

Provides endpoints which allow project wide search which return the unmodified Elasticsearch response.

post

post

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for nodes and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

URI Parameters

  • project: required (string)

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for tagFamilies and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

URI Parameters

  • project: required (string)

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

post

post

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

Invoke a search query for tags and return the unmodified Elasticsearch response. Note that the query will be executed using the multi search API of Elasticsearch.

URI Parameters

  • project: required (string)

Query Parameters

  • wait: (boolean)

    Specify whether search should wait for the search to be idle before responding.

    Example:

    true

Body

Type: application/json

Example:

{"query":{"query_string":{"query":"some name"}}}

HTTP status code 200

Raw search response.

Body

Type: text/plain

Example:

{}

/{project}/schemas

Provides endpoints which can be used to assign schemas to projects.

get

get

Read multiple schemas and return a paged list response.

Read multiple schemas and return a paged list response.

URI Parameters

  • project: required (string)

HTTP status code 200

Loaded list of schemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
    "displayField" : "name",
    "segmentField" : "name",
    "container" : false,
    "description" : "Example schema description",
    "name" : "ExampleSchema",
    "fields" : [ {
      "name" : "name",
      "label" : "Name",
      "required" : false,
      "noIndex" : false,
      "type" : "string"
    }, {
      "name" : "number",
      "label" : "Number",
      "required" : false,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "html",
      "label" : "Teaser",
      "required" : false,
      "noIndex" : false,
      "type" : "html"
    }, {
      "name" : "list",
      "label" : "List of nodes",
      "required" : false,
      "noIndex" : false,
      "listType" : "node",
      "type" : "list",
      "allow" : [ "content", "video" ]
    }, {
      "name" : "node",
      "required" : false,
      "noIndex" : false,
      "type" : "node",
      "allow" : [ "content", "video", "image" ]
    }, {
      "name" : "location",
      "label" : "Location",
      "required" : false,
      "noIndex" : false,
      "type" : "micronode",
      "allow" : [ "geolocation" ]
    }, {
      "name" : "locationlist",
      "label" : "List of Locations",
      "required" : false,
      "noIndex" : false,
      "listType" : "micronode",
      "type" : "list",
      "allow" : [ "geolocation" ]
    } ],
    "microschema" : false,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

get post delete

get

Load the schema with the given uuid.

post

Assign the schema to the project. This will automatically assign the latest schema version to all branches of the project.

delete

Remove the schema with the given uuid from the project. This will automatically remove all schema versions of the given schema from all branches of the project.

Load the schema with the given uuid.

URI Parameters

  • project: required (string)
  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

HTTP status code 200

Loaded schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Assign the schema to the project. This will automatically assign the latest schema version to all branches of the project.

URI Parameters

  • project: required (string)
  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

HTTP status code 200

Assigned schema.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
autoPurgefalsebooleanAuto purge flag of the schema. Controls whether contents of this schema should be automatically purged on update.
containertruebooleanFlag which indicates whether nodes which use this schema store additional child nodes.
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the schema.
displayFieldtruestringName of the display field.
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of schema fields
nametruestringName of the schema.
noIndexfalsebooleanFlag which indicates whether nodes which use this schema should be excluded from the indexing.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
segmentFieldfalsestringName of the segment field. This field is used to construct the webroot path to the node.
urlFieldsfalsearrayNames of the fields which provide a compete url to the node. This property can be used to define custom urls for certain nodes. The webroot API will try to locate the node via it's segment field and via the specified url fields.
uuidtruestringUuid of the element
versiontruestringVersion of the schema.

Example:

{
  "uuid" : "c5ac82fa1a9c43b6ac82fa1a9ca3b61c",
  "displayField" : "name",
  "segmentField" : "name",
  "container" : false,
  "description" : "Example schema description",
  "name" : "ExampleSchema",
  "fields" : [ {
    "name" : "name",
    "label" : "Name",
    "required" : false,
    "noIndex" : false,
    "type" : "string"
  }, {
    "name" : "number",
    "label" : "Number",
    "required" : false,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "html",
    "label" : "Teaser",
    "required" : false,
    "noIndex" : false,
    "type" : "html"
  }, {
    "name" : "list",
    "label" : "List of nodes",
    "required" : false,
    "noIndex" : false,
    "listType" : "node",
    "type" : "list",
    "allow" : [ "content", "video" ]
  }, {
    "name" : "node",
    "required" : false,
    "noIndex" : false,
    "type" : "node",
    "allow" : [ "content", "video", "image" ]
  }, {
    "name" : "location",
    "label" : "Location",
    "required" : false,
    "noIndex" : false,
    "type" : "micronode",
    "allow" : [ "geolocation" ]
  }, {
    "name" : "locationlist",
    "label" : "List of Locations",
    "required" : false,
    "noIndex" : false,
    "listType" : "micronode",
    "type" : "list",
    "allow" : [ "geolocation" ]
  } ],
  "microschema" : false,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Remove the schema with the given uuid from the project. This will automatically remove all schema versions of the given schema from all branches of the project.

URI Parameters

  • project: required (string)
  • schemaUuid: required (string)

    Uuid of the schema.

    Example:

    2aa83a2b3cba40a1a83a2b3cba90a1de

HTTP status code 204

Schema was successfully removed.

/{project}/microschemas

Contains endpoints which allow microschemas to be assigned to projects.

get

get

Read all microschemas which are assigned to the project.

Read all microschemas which are assigned to the project.

URI Parameters

  • project: required (string)

HTTP status code 200

List of assigned microschemas.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
_metainfotrueobjectPaging information of the list result.
datatruearrayArray which contains the found elements.

Example:

{
  "data" : [ {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  }, {
    "uuid" : "2715307deafc4ecc95307deafccecc10",
    "version" : "1.0",
    "description" : "Microschema for Geolocations",
    "name" : "geolocation",
    "fields" : [ {
      "name" : "longitude",
      "label" : "Longitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    }, {
      "name" : "latitude",
      "label" : "Latitude",
      "required" : true,
      "noIndex" : false,
      "type" : "number"
    } ],
    "microschema" : true,
    "permissions" : {
      "create" : true,
      "read" : true,
      "update" : true,
      "delete" : true,
      "publish" : false,
      "readPublished" : false
    }
  } ],
  "_metainfo" : {
    "currentPage" : 1,
    "perPage" : 2,
    "pageCount" : 10,
    "totalCount" : 20
  }
}

post delete

post

Add the microschema to the project.

delete

Remove the microschema from the project.

Add the microschema to the project.

URI Parameters

  • project: required (string)
  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

HTTP status code 200

Microschema was added to the project.

Body

Type: application/json

Schema:

PropertyMandatoryTypeDescription
createdtruestringISO8601 formatted created date string.
creatortrueobjectUser reference of the creator of the element.
descriptionfalsestringDescription of the microschema
editedtruestringISO8601 formatted edited date string.
editorfalseobjectUser reference of the editor of the element.
elasticsearchfalseobjectAdditional search index configuration. This can be used to setup custom analyzers and filters.
fieldstruearrayList of microschema fields
nametruestringName of the microschema
noIndexfalseboolean'Exclude from indexing' flag.
permissions.createtruebooleanFlag which indicates whether the create permission is granted.
permissions.deletetruebooleanFlag which indicates whether the delete permission is granted.
permissions.publishfalsebooleanFlag which indicates whether the publish permission is granted.
permissions.readtruebooleanFlag which indicates whether the read permission is granted.
permissions.readPublishedfalsebooleanFlag which indicates whether the read published permission is granted.
permissions.updatetruebooleanFlag which indicates whether the update permission is granted.
rolePermsfalseobjectPermission information for provided role. This property will only be populated if a role query parameter has been specified.
uuidtruestringUuid of the element
versiontruestringVersion of the microschema

Example:

{
  "uuid" : "2715307deafc4ecc95307deafccecc10",
  "version" : "1.0",
  "description" : "Microschema for Geolocations",
  "name" : "geolocation",
  "fields" : [ {
    "name" : "longitude",
    "label" : "Longitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  }, {
    "name" : "latitude",
    "label" : "Latitude",
    "required" : true,
    "noIndex" : false,
    "type" : "number"
  } ],
  "microschema" : true,
  "permissions" : {
    "create" : true,
    "read" : true,
    "update" : true,
    "delete" : true,
    "publish" : false,
    "readPublished" : false
  }
}

Remove the microschema from the project.

URI Parameters

  • project: required (string)
  • microschemaUuid: required (string)

    Uuid of the microschema.

    Example:

    2715307deafc4ecc95307deafccecc10

HTTP status code 204

Microschema was removed from project.