Users
The users rest endpoint is used for CRUD operations on user objects.
Retrieves a list of users.
Create a new user. Please note that users create requests may also contain a node reference which is useful when storing additional data next to the user is required.
get /users
Retrieves a list of users.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}, {
"uuid" : "c063610e515f407da3610e515fa07d33",
"creator" : {
"name" : "jdoe42",
"uuid" : "82d08b65b6de4f6b908b65b6de7f6b00"
},
"created" : 1459933012312,
"editor" : {
"name" : "jdoe42",
"uuid" : "ce0ad480261b469c8ad480261b369cff"
},
"edited" : 1459933012312,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Roe",
"firstname" : "Jane",
"username" : "jroe",
"emailAddress" : "j.roe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "0ffbfdb5e4004c02bbfdb5e400fc0256"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "9354683b42fe45d494683b42fe05d436"
}, {
"name" : "super-editors",
"uuid" : "796fd68cbb0040b6afd68cbb0000b606"
}, {
"name" : "editors",
"uuid" : "ccde2b4d672e43059e2b4d672e43057b"
} ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /users
Create a new user. Please note that users create requests may also contain a node reference which is useful when storing additional data next to the user is required.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"password" : "iesiech0eewinioghaRa",
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "0ffbfdb5e4004c02bbfdb5e400fc0256"
},
"groupUuid" : "a496712f9d13490096712f9d13190071"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}
Retrieves a single user with the given uuid.
Updates the user with the given uuid.
Deletes the user with the given uuid.
get /users/{uuid}
Retrieves a single user with the given uuid.
URI Parameters
- uuid: required (string)
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}
put /users/{uuid}
Updates the user with the given uuid.
URI Parameters
- uuid: required (string)
Body
Type: application/json
Example:
{
"password" : "iesiech0eewinioghaRa",
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "0ffbfdb5e4004c02bbfdb5e400fc0256"
}
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}
Return the user permissions to the given element.
get /users/{uuid}/{uuid}/permissions/{pathToElement}
Return the user permissions to the given element.
URI Parameters
- uuid: required (string)
- uuid: required (string)
Uuid of the user that should be used to read the permissions.
- pathToElement: required (string)
Path to the element.
Example:
/:userUuid/permissions/projects/:projectUuid/schemas/:schemaUuid /:userUuid/permissions/projects/:projectUuid/schemas /:userUuid/permissions/projects/:projectUuid/nodes /:userUuid/permissions/projects/:projectUuid
HTTP status code 200
Body
Type: application/json
Example:
{
"permissions" : [ "read", "create", "update", "delete" ]
}
Roles
Retrieves a list of roles.
Create a new role.
get /roles
Retrieves a list of roles.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "15f305639cdf40f8b305639cdf50f8c5",
"creator" : {
"name" : "jdoe42",
"uuid" : "00d4015b87114c0194015b8711ec01a1"
},
"created" : 1459933012334,
"editor" : {
"name" : "jdoe42",
"uuid" : "ef2d9f341f0848c1ad9f341f0818c162"
},
"edited" : 1459933012334,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin role",
"groups" : [ {
"name" : "editors",
"uuid" : "3f5314b3810947399314b381091739ee"
}, {
"name" : "guests",
"uuid" : "069b735193b74f529b735193b7ef5242"
} ]
}, {
"uuid" : "b5775ea0a40e462ab75ea0a40e562acd",
"creator" : {
"name" : "jdoe42",
"uuid" : "f3e5c530a9c54260a5c530a9c5726098"
},
"created" : 1459933012339,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ffa098221b74a3dba098221b7ca3d67"
},
"edited" : 1459933012339,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Reader role",
"groups" : [ ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /roles
Create a new role.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"name" : "super editors"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "15f305639cdf40f8b305639cdf50f8c5",
"creator" : {
"name" : "jdoe42",
"uuid" : "00d4015b87114c0194015b8711ec01a1"
},
"created" : 1459933012334,
"editor" : {
"name" : "jdoe42",
"uuid" : "ef2d9f341f0848c1ad9f341f0818c162"
},
"edited" : 1459933012334,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin role",
"groups" : [ {
"name" : "editors",
"uuid" : "3f5314b3810947399314b381091739ee"
}, {
"name" : "guests",
"uuid" : "069b735193b74f529b735193b7ef5242"
} ]
}
Retrieves a single role with the given uuid.
Updates a single role with the given uuid.
Deletes a single role with the given uuid.
get /roles/{uuid}
Retrieves a single role with the given uuid.
URI Parameters
- uuid: required (string)
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "15f305639cdf40f8b305639cdf50f8c5",
"creator" : {
"name" : "jdoe42",
"uuid" : "00d4015b87114c0194015b8711ec01a1"
},
"created" : 1459933012334,
"editor" : {
"name" : "jdoe42",
"uuid" : "ef2d9f341f0848c1ad9f341f0818c162"
},
"edited" : 1459933012334,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin role",
"groups" : [ {
"name" : "editors",
"uuid" : "3f5314b3810947399314b381091739ee"
}, {
"name" : "guests",
"uuid" : "069b735193b74f529b735193b7ef5242"
} ]
}
put /roles/{uuid}
Updates a single role with the given uuid.
URI Parameters
- uuid: required (string)
Body
Type: application/json
Example:
{
"name" : "New name"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "15f305639cdf40f8b305639cdf50f8c5",
"creator" : {
"name" : "jdoe42",
"uuid" : "00d4015b87114c0194015b8711ec01a1"
},
"created" : 1459933012334,
"editor" : {
"name" : "jdoe42",
"uuid" : "ef2d9f341f0848c1ad9f341f0818c162"
},
"edited" : 1459933012334,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin role",
"groups" : [ {
"name" : "editors",
"uuid" : "3f5314b3810947399314b381091739ee"
}, {
"name" : "guests",
"uuid" : "069b735193b74f529b735193b7ef5242"
} ]
}
Return the role permission to the given element.
Update the role permission to the given element and update the permission to the given element. This is useful when it is required to grant certain permissions on a given path segment / object.
get /roles/{uuid}/permissions/{pathToElement}
Return the role permission to the given element.
URI Parameters
- uuid: required (string)
Uuid of the role that should be used to update the permissions.
- pathToElement: required (string)
Path to the element.
Example:
/:roleUuid/permissions/projects/:projectUuid/schemas/:schemaUuid /:roleUuid/permissions/projects/:projectUuid/schemas /:roleUuid/permissions/projects/:projectUuid/nodes /:roleUuid/permissions/projects/:projectUuid /:roleUuid/permissions/projects
HTTP status code 200
Body
Type: application/json
Example:
{
"permissions" : [ "read", "create", "update", "delete" ]
}
put /roles/{uuid}/permissions/{pathToElement}
Update the role permission to the given element and update the permission to the given element. This is useful when it is required to grant certain permissions on a given path segment / object.
URI Parameters
- uuid: required (string)
Uuid of the role that should be used to update the permissions.
- pathToElement: required (string)
Path to the element.
Example:
/:roleUuid/permissions/projects/:projectUuid/schemas/:schemaUuid /:roleUuid/permissions/projects/:projectUuid/schemas /:roleUuid/permissions/projects/:projectUuid/nodes /:roleUuid/permissions/projects/:projectUuid /:roleUuid/permissions/projects
Body
Type: application/json
Example:
{
"permissions" : [ "read", "create", "update", "delete" ],
"recursive" : false
}
Groups
Retrieves a list of groups.
Create a new group.
get /groups
Retrieves a list of groups.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}, {
"uuid" : "eb5d226daf0d496f9d226daf0d696f75",
"created" : 0,
"edited" : 0,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Editor Group",
"roles" : [ ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /groups
Create a new group.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- orderBy: (string)
Set the attribute by which the results should be ordered.
Body
Type: application/json
Example:
{
"name" : "new group"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}
Retrieves a single group with the given uuid.
Updates a single group with the given uuid.
Deletes a single group with the given uuid.
get /groups/{uuid}
Retrieves a single group with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}
put /groups/{uuid}
Updates a single group with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- orderBy: (string)
Set the attribute by which the results should be ordered.
Body
Type: application/json
Example:
{ }
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}
delete /groups/{uuid}
Deletes a single group with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- orderBy: (string)
Set the attribute by which the results should be ordered.
List all the roles for the given group.
get /groups/{uuid}/roles
List all the roles for the given group.
URI Parameters
- uuid: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}, {
"uuid" : "eb5d226daf0d496f9d226daf0d696f75",
"created" : 0,
"edited" : 0,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Editor Group",
"roles" : [ ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Add the given role to the the group.
Remove the given role from the group.
put /groups/{uuid}/roles/{uuid}
Add the given role to the the group.
URI Parameters
- uuid: required (string)
- uuid: required (string)
Add the user with the given uuid to the group.
Remove the user with the given uuid from the group.
Projects
Retrieves a list of projects.
Create a new project.
get /projects
Retrieves a list of projects.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- orderBy: (string)
Set the attribute by which the results should be ordered.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "78e09798d5754d9fa09798d575cd9fe9",
"creator" : {
"name" : "jdoe42",
"uuid" : "f392be681e3c441b92be681e3c441bdb"
},
"created" : 1459933012477,
"editor" : {
"name" : "jdoe42",
"uuid" : "4750f4e4be8041ff90f4e4be8051ff10"
},
"edited" : 1459933012477,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project",
"rootNodeUuid" : "5c627814aa2f4d16a27814aa2fcd16fe"
}, {
"uuid" : "5c7c9de052ae4e05bc9de052aebe053d",
"creator" : {
"name" : "jdoe42",
"uuid" : "e9ad2064b87b46bead2064b87bf6be6e"
},
"created" : 1459933012478,
"editor" : {
"name" : "jdoe42",
"uuid" : "78cdd6e74f2340338dd6e74f23a033af"
},
"edited" : 1459933012478,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project (Mobile)",
"rootNodeUuid" : "bc5977d1f72e4fa29977d1f72e9fa24b"
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
HTTP status code 400
Bad Request
HTTP status code 500
Internal Server Error
post /projects
Create a new project.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"name" : "New project"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "78e09798d5754d9fa09798d575cd9fe9",
"creator" : {
"name" : "jdoe42",
"uuid" : "f392be681e3c441b92be681e3c441bdb"
},
"created" : 1459933012477,
"editor" : {
"name" : "jdoe42",
"uuid" : "4750f4e4be8041ff90f4e4be8051ff10"
},
"edited" : 1459933012477,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project",
"rootNodeUuid" : "5c627814aa2f4d16a27814aa2fcd16fe"
}
Retrieves the project with the given uuid.
Update the project with the given uuid.
Deletes the project with the given uuid.
get /projects/{uuid}
Retrieves the project with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
Body
Type: application/json
Example:
{
"uuid" : "78e09798d5754d9fa09798d575cd9fe9",
"creator" : {
"name" : "jdoe42",
"uuid" : "f392be681e3c441b92be681e3c441bdb"
},
"created" : 1459933012477,
"editor" : {
"name" : "jdoe42",
"uuid" : "4750f4e4be8041ff90f4e4be8051ff10"
},
"edited" : 1459933012477,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project",
"rootNodeUuid" : "5c627814aa2f4d16a27814aa2fcd16fe"
}
put /projects/{uuid}
Update the project with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"name" : "Renamed project"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "78e09798d5754d9fa09798d575cd9fe9",
"creator" : {
"name" : "jdoe42",
"uuid" : "f392be681e3c441b92be681e3c441bdb"
},
"created" : 1459933012477,
"editor" : {
"name" : "jdoe42",
"uuid" : "4750f4e4be8041ff90f4e4be8051ff10"
},
"edited" : 1459933012477,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project",
"rootNodeUuid" : "5c627814aa2f4d16a27814aa2fcd16fe"
}
delete /projects/{uuid}
Deletes the project with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Schemas
Retrieves a list of object schemas.
Create the schema.
get /schemas
Retrieves a list of object schemas.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "d187e97352df415587e97352dfa155b8",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"name" : "Example Schema",
"fields" : [ {
"name" : "name",
"label" : "Name",
"required" : false,
"type" : "string"
}, {
"name" : "number",
"label" : "Number",
"required" : false,
"type" : "number"
}, {
"name" : "html",
"label" : "Teaser",
"required" : false,
"type" : "html"
}, {
"name" : "list",
"label" : "List of nodes",
"required" : false,
"listType" : "node",
"type" : "list",
"allow" : [ "content", "video" ]
}, {
"name" : "node",
"required" : false,
"type" : "node",
"allow" : [ "content", "video", "image" ]
}, {
"name" : "location",
"label" : "Location",
"required" : false,
"type" : "micronode",
"allow" : [ "geolocation" ]
}, {
"name" : "locationlist",
"label" : "List of Locations",
"required" : false,
"listType" : "micronode",
"type" : "list",
"allow" : [ "geolocation" ]
} ],
"displayField" : "name",
"segmentField" : "name",
"container" : false
}, {
"uuid" : "20354a38b6434abbb54a38b643dabb26",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"name" : "Example Schema",
"fields" : [ {
"name" : "name",
"label" : "Name",
"required" : false,
"type" : "string"
}, {
"name" : "number",
"label" : "Number",
"required" : false,
"type" : "number"
}, {
"name" : "html",
"label" : "Teaser",
"required" : false,
"type" : "html"
}, {
"name" : "list",
"label" : "List of nodes",
"required" : false,
"listType" : "node",
"type" : "list",
"allow" : [ "content", "video" ]
}, {
"name" : "node",
"required" : false,
"type" : "node",
"allow" : [ "content", "video", "image" ]
}, {
"name" : "location",
"label" : "Location",
"required" : false,
"type" : "micronode",
"allow" : [ "geolocation" ]
}, {
"name" : "locationlist",
"label" : "List of Locations",
"required" : false,
"listType" : "micronode",
"type" : "list",
"allow" : [ "geolocation" ]
} ],
"displayField" : "name",
"segmentField" : "name",
"container" : false
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
HTTP status code 400
Bad Request
HTTP status code 500
Internal Server Error
post /schemas
Create the schema.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"permissions" : [ ],
"version" : 0,
"description" : "New description",
"name" : "extended-content",
"fields" : [ ],
"container" : false
}
HTTP status code 200
Body
Type: application/json
Example:
{
"permissions" : [ ],
"version" : 0,
"description" : "New description",
"name" : "extended-content",
"fields" : [ ],
"container" : false
}
Retrieves the schema with the given uuid.
Invoke a schema migration.
Deletes the schema with the given uuid.
get /schemas/{uuid}
Retrieves the schema with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"permissions" : [ ],
"version" : 0,
"description" : "New description",
"name" : "extended-content",
"fields" : [ ],
"container" : false
}
put /schemas/{uuid}
Invoke a schema migration.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"permissions" : [ ],
"version" : 0,
"description" : "New description",
"name" : "extended-content",
"fields" : [ ],
"container" : false
}
delete /schemas/{uuid}
Deletes the schema with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Add the schema to the project.
Remove the schema from the project.
Create a diff of the latest and posted schema.
post /schemas/{uuid}/diff
Create a diff of the latest and posted schema.
URI Parameters
- uuid: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"changes" : [ {
"operation" : "ADDFIELD",
"properties" : {
"field" : "listFieldToBeAddedField",
"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" : { }
} ]
}
Invoke a schema migration.
post /schemas/{uuid}/changes
Microschemas
Retrieves a list of microschemas.
Create the microschema.
get /microschemas
Retrieves a list of microschemas.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "bfe8a5e561aa4562a8a5e561aa856283",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}, {
"uuid" : "ff614037f7ba4caaa14037f7ba8caaba",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
HTTP status code 400
Bad Request
HTTP status code 500
Internal Server Error
post /microschemas
Create the microschema.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"uuid" : "346323b65884454aa323b65884b54a53",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "346323b65884454aa323b65884b54a53",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}
Retrieves the microschema with the given uuid.
Invoke a microschema migration.
Deletes the microschema with the given uuid.
get /microschemas/{uuid}
Retrieves the microschema with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "346323b65884454aa323b65884b54a53",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}
put /microschemas/{uuid}
Invoke a microschema migration.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Body
Type: application/json
Example:
{
"uuid" : "346323b65884454aa323b65884b54a53",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}
delete /microschemas/{uuid}
Deletes the microschema with the given uuid.
URI Parameters
- uuid: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Create a diff of the latest and posted microschema.
post /microschemas/{uuid}/diff
Create a diff of the latest and posted microschema.
URI Parameters
- uuid: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"changes" : [ {
"operation" : "ADDFIELD",
"properties" : {
"field" : "listFieldToBeAddedField",
"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" : { }
} ]
}
Invoke a microschema migration.
post /microschemas/{uuid}/changes
WebRoot
Retrieves the node with the given path. Please note that it is also possible to query binary data instead of the node JSON metadata. Binary data will be returned if the targeted node provides a path segment using a binary field.
get /{projectName}/webroot/{path}
Retrieves the node with the given path. Please note that it is also possible to query binary data instead of the node JSON metadata. Binary data will be returned if the targeted node provides a path segment using a binary field.
URI Parameters
- projectName: required (string)
- path: required (string)
Path to a node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- width: (string)
Set image target width. The height is automatically calculated when the width is omitted.
- height: (string)
Set image target height. The width is automatically calculated when the height is omitted.
- cropx: (string)
Set image crop area x coordinate.
- cropy: (string)
Set image crop area y coordinate.
- cropw: (string)
Set image crop area width.
- croph: (string)
Set image crop area height.
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "c0a3fe69a7954213a3fe69a795d21302",
"creator" : {
"name" : "jdoe42",
"uuid" : "36f3e26a00514737b3e26a00510737a3"
},
"created" : 1459933012344,
"edited" : 1459933012344,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "78b7d92f1f4d4451b7d92f1f4d5451af",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "3385b673f3364d0085b673f3366d00e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "bac32a9b09aa43bb832a9b09aa73bbac",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "c064f85ba1e3407fa4f85ba1e3507fb4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "5599bb12078b438599bb12078b938532"
}, {
"uuid" : "e52af3ce205e46e0aaf3ce205e56e0f1"
}, {
"uuid" : "84872be053c1436d872be053c1f36d55"
} ],
"locations-micronodeListField" : [ {
"uuid" : "dd98a459f38e454e98a459f38e354ec1",
"microschema" : {
"name" : "geolocation",
"uuid" : "484897e887a343558897e887a333550c"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "2c17e9a5160b4d9397e9a5160b8d9321",
"microschema" : {
"name" : "geolocation",
"uuid" : "6e0f859f8ea444fe8f859f8ea424fe1c"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "0274ae5f147f4e9db4ae5f147f7e9dc2",
"microschema" : {
"name" : "geolocation",
"uuid" : "48d593d728bc454c9593d728bc454c48"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "c11b75bc4ed940709b75bc4ed9c07030"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
NavRoot
Load a nested navigation response using the given node as the root element of the navigation. Note that it is only possible to target container nodes.
get /{projectName}/navroot/{path}
Load a nested navigation response using the given node as the root element of the navigation. Note that it is only possible to target container nodes.
URI Parameters
- projectName: required (string)
- path: required (string)
Path to the navigation root node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- resolveLinks: (one of off, short, medium, full - default: off)
Set whether links shall be resolved. "off" means no link resolving. "full" will contain the webroot prefix and project name, "medium" will contain the project name and "short" neither webroot prefix nor project name.
- maxDepth: (number - default: 10)
Maximum depth for the navigation tree structure.
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"root" : {
"uuid" : "535b5921c6cf45a69b5921c6cf95a6d3",
"node" : {
"uuid" : "535b5921c6cf45a69b5921c6cf95a6d3",
"creator" : {
"name" : "jdoe42",
"uuid" : "219b6939f025409e9b6939f025009e10"
},
"created" : 1459933012374,
"edited" : 1459933012374,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "9da1bc870ea94e94a1bc870ea90e9457",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "84848cf4e98546e6848cf4e985c6e6bb",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "17ec6acf8ed34e8bac6acf8ed31e8ba5",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "15e57d22c8754cf5a57d22c8757cf51f",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "d623d71e41a04a14a3d71e41a07a1460"
}, {
"uuid" : "40d4af75221c4d8b94af75221c2d8be9"
}, {
"uuid" : "c151cf7a970f44dc91cf7a970fd4dca5"
} ],
"locations-micronodeListField" : [ {
"uuid" : "b6c6f98e2e9a4e1986f98e2e9abe19ea",
"microschema" : {
"name" : "geolocation",
"uuid" : "bc8e45768a4548df8e45768a4518dfee"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "78ef807958fd4235af807958fd7235d8",
"microschema" : {
"name" : "geolocation",
"uuid" : "bbe7d9f628a14c2aa7d9f628a1cc2a71"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "7f597c887f2c48f7997c887f2c98f787",
"microschema" : {
"name" : "geolocation",
"uuid" : "424890166eab4cb48890166eab5cb498"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "d89e376678cc48289e376678cc58287a"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
},
"children" : [ {
"uuid" : "8eacb8eb1d8645dcacb8eb1d8635dcd5",
"node" : {
"uuid" : "8eacb8eb1d8645dcacb8eb1d8635dcd5",
"creator" : {
"name" : "jdoe42",
"uuid" : "1979f9f51df448c2b9f9f51df418c2e5"
},
"created" : 1459933012374,
"edited" : 1459933012374,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "e1e0d401eb1b49a7a0d401eb1ba9a786",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "e8b3a5e9ae7440f3b3a5e9ae7410f3e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "5cccbf12eb32431c8cbf12eb32531c57",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "3d68c5ecdb2c44d9a8c5ecdb2c94d981",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "d9286d7363d24137a86d7363d2113760"
}, {
"uuid" : "7362d8fcff834f65a2d8fcff838f6579"
}, {
"uuid" : "c919ad831951431e99ad831951d31ed3"
} ],
"locations-micronodeListField" : [ {
"uuid" : "f653c04191a049f693c04191a0b9f61f",
"microschema" : {
"name" : "geolocation",
"uuid" : "b2605b21c8ea4c1aa05b21c8ea1c1ac5"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "614c1fef9b3e400b8c1fef9b3e200bc5",
"microschema" : {
"name" : "geolocation",
"uuid" : "60e11ef9294c4bf5a11ef9294ccbf581"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "e88de60f277442068de60f2774c206c0",
"microschema" : {
"name" : "geolocation",
"uuid" : "d8445f88732c42b3845f88732cb2b3cb"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "8c4881fc14fb48608881fc14fb28600f"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
} ]
}
}
Nodes
Load all nodes.
Create a new node.
get /{projectName}/nodes/
Load all nodes.
URI Parameters
- projectName: required (string)
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- expandAll: (boolean)
Expand all fields which can be expanded.
- expand: (string)
Expand the fields with the given name. It is possible to specify multiple field names by separating with a ',' character.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "d42f1d35b941441daf1d35b941c41d20",
"creator" : {
"name" : "jdoe42",
"uuid" : "72179a8c6a1245a5979a8c6a1265a57d"
},
"created" : 1459933012369,
"edited" : 1459933012369,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "2ab91dc762e04948b91dc762e0594865",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "0a6d89843db945a1ad89843db965a1c1",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "79fdc8167aaa4e5dbdc8167aaa7e5d22",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "cbc67e2d49f8491c867e2d49f8691ce4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "18de641645e34ad89e641645e38ad807"
}, {
"uuid" : "bea063aa505446bfa063aa505456bf82"
}, {
"uuid" : "622d68693c004d29ad68693c003d292d"
} ],
"locations-micronodeListField" : [ {
"uuid" : "5dad89d8575e4e66ad89d8575ebe66e9",
"microschema" : {
"name" : "geolocation",
"uuid" : "837ea470d65d466cbea470d65d866c99"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "620353734b994be68353734b998be601",
"microschema" : {
"name" : "geolocation",
"uuid" : "e62d76c4bb454e31ad76c4bb452e31f1"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "537409fb8c2f40ccb409fb8c2f90ccea",
"microschema" : {
"name" : "geolocation",
"uuid" : "0813be965fc4445593be965fc48455e4"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "fb619fb9f21b4d84a19fb9f21bfd843e"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}, {
"uuid" : "8b6f7c174b0e4f9eaf7c174b0e2f9e6b",
"creator" : {
"name" : "jdoe42",
"uuid" : "718246d5e0ba42328246d5e0ba92329a"
},
"created" : 1459933012370,
"editor" : {
"name" : "jdoe42",
"uuid" : "735742b5632a46a19742b5632af6a1ef"
},
"edited" : 1459933012370,
"permissions" : [ "READ", "CREATE" ],
"parentNode" : {
"uuid" : "97120aeeca1248d2920aeeca1258d28e",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : { },
"schema" : {
"name" : "content",
"uuid" : "95ea3cf54d0642a2aa3cf54d0612a2cc",
"version" : 1
},
"published" : false,
"fields" : {
"filename" : "dummy-content.en.html",
"name" : "Name for language tag en",
"content" : "Content for language tag en",
"teaser" : "Dummy teaser for en"
},
"breadcrumb" : [ ],
"container" : false
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /{projectName}/nodes/
Create a new node.
URI Parameters
- projectName: required (string)
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- expandAll: (boolean)
Expand all fields which can be expanded.
- expand: (string)
Expand the fields with the given name. It is possible to specify multiple field names by separating with a ',' character.
Body
Type: application/json
Example:
{
"schema" : {
"name" : "content",
"uuid" : "c703436a881f47df83436a881f67df04",
"version" : 1
},
"published" : true,
"language" : "en",
"fields" : {
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "d90381382d6748168381382d67181688"
}, {
"uuid" : "e98988d2fa554de08988d2fa558de03b"
}, {
"uuid" : "97a5f09804ac44e7a5f09804ace4e754"
} ],
"locations-micronodeListField" : [ {
"microschema" : {
"name" : "geolocation",
"uuid" : "3cfdc9f41a914cecbdc9f41a914cecd1"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"microschema" : {
"name" : "geolocation",
"uuid" : "97a98d8f9d4b459fa98d8f9d4ba59ffe"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"title" : "English title",
"content" : "English content",
"filename" : "index.en.html",
"location-micronodeField" : {
"microschema" : {
"name" : "geolocation",
"uuid" : "4f1c7ab87e7d468a9c7ab87e7d368a53"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "9476360798fd43f5b6360798fd03f57c"
},
"name" : "English name",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"teaser" : "English teaser"
},
"parentNodeUuid" : "9544eaf210e8430884eaf210e87308b3"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "c0a3fe69a7954213a3fe69a795d21302",
"creator" : {
"name" : "jdoe42",
"uuid" : "36f3e26a00514737b3e26a00510737a3"
},
"created" : 1459933012344,
"edited" : 1459933012344,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "78b7d92f1f4d4451b7d92f1f4d5451af",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "3385b673f3364d0085b673f3366d00e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "bac32a9b09aa43bb832a9b09aa73bbac",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "c064f85ba1e3407fa4f85ba1e3507fb4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "5599bb12078b438599bb12078b938532"
}, {
"uuid" : "e52af3ce205e46e0aaf3ce205e56e0f1"
}, {
"uuid" : "84872be053c1436d872be053c1f36d55"
} ],
"locations-micronodeListField" : [ {
"uuid" : "dd98a459f38e454e98a459f38e354ec1",
"microschema" : {
"name" : "geolocation",
"uuid" : "484897e887a343558897e887a333550c"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "2c17e9a5160b4d9397e9a5160b8d9321",
"microschema" : {
"name" : "geolocation",
"uuid" : "6e0f859f8ea444fe8f859f8ea424fe1c"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "0274ae5f147f4e9db4ae5f147f7e9dc2",
"microschema" : {
"name" : "geolocation",
"uuid" : "48d593d728bc454c9593d728bc454c48"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "c11b75bc4ed940709b75bc4ed9c07030"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
Retrieves the node with the given uuid.
Updates the node with the given uuid.
Deletes the node with the given uuid.
get /{projectName}/nodes/{uuid}
Retrieves the node with the given uuid.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- lang: (string)
Filter the languages in the form of a list containing IETF language tags which are separated by comma.
Example:
?lang=de,en
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- expandAll: (boolean)
Expand all fields which can be expanded.
- expand: (string)
Expand the fields with the given name. It is possible to specify multiple field names by separating with a ',' character.
- resolveLinks: (one of off, short, medium, full - default: off)
Set whether links shall be resolved. "off" means no link resolving. "full" will contain the webroot prefix and project name, "medium" will contain the project name and "short" neither webroot prefix nor project name.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "c0a3fe69a7954213a3fe69a795d21302",
"creator" : {
"name" : "jdoe42",
"uuid" : "36f3e26a00514737b3e26a00510737a3"
},
"created" : 1459933012344,
"edited" : 1459933012344,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "78b7d92f1f4d4451b7d92f1f4d5451af",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "3385b673f3364d0085b673f3366d00e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "bac32a9b09aa43bb832a9b09aa73bbac",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "c064f85ba1e3407fa4f85ba1e3507fb4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "5599bb12078b438599bb12078b938532"
}, {
"uuid" : "e52af3ce205e46e0aaf3ce205e56e0f1"
}, {
"uuid" : "84872be053c1436d872be053c1f36d55"
} ],
"locations-micronodeListField" : [ {
"uuid" : "dd98a459f38e454e98a459f38e354ec1",
"microschema" : {
"name" : "geolocation",
"uuid" : "484897e887a343558897e887a333550c"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "2c17e9a5160b4d9397e9a5160b8d9321",
"microschema" : {
"name" : "geolocation",
"uuid" : "6e0f859f8ea444fe8f859f8ea424fe1c"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "0274ae5f147f4e9db4ae5f147f7e9dc2",
"microschema" : {
"name" : "geolocation",
"uuid" : "48d593d728bc454c9593d728bc454c48"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "c11b75bc4ed940709b75bc4ed9c07030"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
put /{projectName}/nodes/{uuid}
Updates the node with the given uuid.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- expandAll: (boolean)
Expand all fields which can be expanded.
- expand: (string)
Expand the fields with the given name. It is possible to specify multiple field names by separating with a ',' character.
- resolveLinks: (one of off, short, medium, full - default: off)
Set whether links shall be resolved. "off" means no link resolving. "full" will contain the webroot prefix and project name, "medium" will contain the project name and "short" neither webroot prefix nor project name.
Body
Type: application/json
Example:
{
"schema" : {
"name" : "content",
"uuid" : "bab6b8901fe14bb5b6b8901fe16bb53a",
"version" : 1
},
"published" : true,
"language" : "en",
"fields" : {
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"filename" : "index-renamed.en.html",
"categories-nodeListField" : [ {
"uuid" : "6c95063c91a4411c95063c91a4a11cb1"
}, {
"uuid" : "099d5b609dc741589d5b609dc73158c3"
}, {
"uuid" : "4fd97b16dea34b1a997b16dea3bb1a95"
} ],
"location-micronodeField" : {
"uuid" : "99c40df85abf443d840df85abf343d31",
"microschema" : {
"name" : "geolocation",
"uuid" : "a7d30301259b4c3b930301259b1c3bb4"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"locations-micronodeListField" : [ {
"uuid" : "e6c2eb00e770402282eb00e7707022d2",
"microschema" : {
"name" : "geolocation",
"uuid" : "679e2921f53640cb9e2921f53630cb49"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "fc1ac5ecc7b349089ac5ecc7b38908b1",
"microschema" : {
"name" : "geolocation",
"uuid" : "6757c93c812a409597c93c812a909567"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"relatedProduct-nodeField" : {
"uuid" : "7487cc22301f48e987cc22301f78e984"
},
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ]
}
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "c0a3fe69a7954213a3fe69a795d21302",
"creator" : {
"name" : "jdoe42",
"uuid" : "36f3e26a00514737b3e26a00510737a3"
},
"created" : 1459933012344,
"edited" : 1459933012344,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "78b7d92f1f4d4451b7d92f1f4d5451af",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "3385b673f3364d0085b673f3366d00e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "bac32a9b09aa43bb832a9b09aa73bbac",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "c064f85ba1e3407fa4f85ba1e3507fb4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "5599bb12078b438599bb12078b938532"
}, {
"uuid" : "e52af3ce205e46e0aaf3ce205e56e0f1"
}, {
"uuid" : "84872be053c1436d872be053c1f36d55"
} ],
"locations-micronodeListField" : [ {
"uuid" : "dd98a459f38e454e98a459f38e354ec1",
"microschema" : {
"name" : "geolocation",
"uuid" : "484897e887a343558897e887a333550c"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "2c17e9a5160b4d9397e9a5160b8d9321",
"microschema" : {
"name" : "geolocation",
"uuid" : "6e0f859f8ea444fe8f859f8ea424fe1c"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "0274ae5f147f4e9db4ae5f147f7e9dc2",
"microschema" : {
"name" : "geolocation",
"uuid" : "48d593d728bc454c9593d728bc454c48"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "c11b75bc4ed940709b75bc4ed9c07030"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
HTTP status code 423
delete /{projectName}/nodes/{uuid}
Deletes the node with the given uuid.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- resolveLinks: (one of off, short, medium, full - default: off)
Set whether links shall be resolved. "off" means no link resolving. "full" will contain the webroot prefix and project name, "medium" will contain the project name and "short" neither webroot prefix nor project name.
Load the tags that tag the node.
get /{projectName}/nodes/{uuid}/tags
Load the tags that tag the node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Query Parameters
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}, {
"uuid" : "5ff99cd33c754d9ab99cd33c75cd9aa3",
"creator" : {
"name" : "jdoe42",
"uuid" : "55f0d434e34c4415b0d434e34c8415ac"
},
"created" : 1459933012382,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ecc20274b214fc78c20274b212fc785"
},
"edited" : 1459933012382,
"permissions" : [ "READ", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "Name for language tag en"
}
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Add the tag to the node.
Remove the tag from the node.
put /{projectName}/nodes/{uuid}/tags/{tagUuuid}
Add the tag to the node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- tagUuuid: required (string)
delete /{projectName}/nodes/{uuid}/tags/{tagUuuid}
Remove the tag from the node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- tagUuuid: required (string)
Deletes the language from the given node.
delete /{projectName}/nodes/{uuid}/languages/{languageTag}
Load the binary property value.
Update the binary property value.
Upload the binary property value.
get /{projectName}/nodes/{uuid}/languages/{languageTag}/fields/{fieldname}
Load the binary property value.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- languageTag: required (string)
- fieldname: required (string)
Query Parameters
- width: (string)
Set image target width. The height is automatically calculated when the width is omitted.
- height: (string)
Set image target height. The width is automatically calculated when the height is omitted.
- cropx: (string)
Set image crop area x coordinate.
- cropy: (string)
Set image crop area y coordinate.
- cropw: (string)
Set image crop area width.
- croph: (string)
Set image crop area height.
put /{projectName}/nodes/{uuid}/languages/{languageTag}/fields/{fieldname}
Update the binary property value.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- languageTag: required (string)
- fieldname: required (string)
post /{projectName}/nodes/{uuid}/languages/{languageTag}/fields/{fieldname}
Upload the binary property value.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- languageTag: required (string)
- fieldname: required (string)
Transform the binary property value (for binary fields)
post /{projectName}/nodes/{uuid}/languages/{languageTag}/fields/{fieldname}/transform
Transform the binary property value (for binary fields)
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- languageTag: required (string)
- fieldname: required (string)
Body
Type: application/json
Example:
{
"width" : 100,
"height" : 200,
"cropx" : 50,
"cropy" : 20,
"croph" : 150,
"cropw" : 170
}
Load child nodes for the given node.
get /{projectName}/nodes/{uuid}/children
Load child nodes for the given node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- expandAll: (boolean)
Expand all fields which can be expanded.
- expand: (string)
Expand the fields with the given name. It is possible to specify multiple field names by separating with a ',' character.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
Return a nested navigation tree structure for the given node.
get /{projectName}/nodes/{uuid}/navigation
Return a nested navigation tree structure for the given node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- maxDepth: (number - default: 10)
Maximum depth for the navigation tree structure.
HTTP status code 200
Body
Type: application/json
Example:
{
"root" : {
"uuid" : "535b5921c6cf45a69b5921c6cf95a6d3",
"node" : {
"uuid" : "535b5921c6cf45a69b5921c6cf95a6d3",
"creator" : {
"name" : "jdoe42",
"uuid" : "219b6939f025409e9b6939f025009e10"
},
"created" : 1459933012374,
"edited" : 1459933012374,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "9da1bc870ea94e94a1bc870ea90e9457",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "84848cf4e98546e6848cf4e985c6e6bb",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "17ec6acf8ed34e8bac6acf8ed31e8ba5",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "15e57d22c8754cf5a57d22c8757cf51f",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "d623d71e41a04a14a3d71e41a07a1460"
}, {
"uuid" : "40d4af75221c4d8b94af75221c2d8be9"
}, {
"uuid" : "c151cf7a970f44dc91cf7a970fd4dca5"
} ],
"locations-micronodeListField" : [ {
"uuid" : "b6c6f98e2e9a4e1986f98e2e9abe19ea",
"microschema" : {
"name" : "geolocation",
"uuid" : "bc8e45768a4548df8e45768a4518dfee"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "78ef807958fd4235af807958fd7235d8",
"microschema" : {
"name" : "geolocation",
"uuid" : "bbe7d9f628a14c2aa7d9f628a1cc2a71"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "7f597c887f2c48f7997c887f2c98f787",
"microschema" : {
"name" : "geolocation",
"uuid" : "424890166eab4cb48890166eab5cb498"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "d89e376678cc48289e376678cc58287a"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
},
"children" : [ {
"uuid" : "8eacb8eb1d8645dcacb8eb1d8635dcd5",
"node" : {
"uuid" : "8eacb8eb1d8645dcacb8eb1d8635dcd5",
"creator" : {
"name" : "jdoe42",
"uuid" : "1979f9f51df448c2b9f9f51df418c2e5"
},
"created" : 1459933012374,
"edited" : 1459933012374,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "e1e0d401eb1b49a7a0d401eb1ba9a786",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "e8b3a5e9ae7440f3b3a5e9ae7410f3e9",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "5cccbf12eb32431c8cbf12eb32531c57",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "3d68c5ecdb2c44d9a8c5ecdb2c94d981",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "d9286d7363d24137a86d7363d2113760"
}, {
"uuid" : "7362d8fcff834f65a2d8fcff838f6579"
}, {
"uuid" : "c919ad831951431e99ad831951d31ed3"
} ],
"locations-micronodeListField" : [ {
"uuid" : "f653c04191a049f693c04191a0b9f61f",
"microschema" : {
"name" : "geolocation",
"uuid" : "b2605b21c8ea4c1aa05b21c8ea1c1ac5"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "614c1fef9b3e400b8c1fef9b3e200bc5",
"microschema" : {
"name" : "geolocation",
"uuid" : "60e11ef9294c4bf5a11ef9294ccbf581"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "e88de60f277442068de60f2774c206c0",
"microschema" : {
"name" : "geolocation",
"uuid" : "d8445f88732c42b3845f88732cb2b3cb"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "8c4881fc14fb48608881fc14fb28600f"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}
} ]
}
}
Move the node to the given node.
put /{projectName}/nodes/{uuid}/moveTo/{targetNodeUuid}
Move the node to the given node.
URI Parameters
- projectName: required (string)
- uuid: required (string)
Uuid of a single node.
- targetNodeUuid: required (string)
Uuid of a the target node. This node will become the new parent of the source node.
TagFamilies
Load all tag families of the project.
Create a new tag family.
get /{projectName}/tagFamilies/
Load all tag families of the project.
URI Parameters
- projectName: required (string)
Name of the project.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"creator" : {
"name" : "jdoe42",
"uuid" : "84ba2f11eb3847baba2f11eb38f7bac6"
},
"created" : 1459933012385,
"editor" : {
"name" : "jdoe42",
"uuid" : "cb0b575151be492d8b575151bef92dd0"
},
"edited" : 1459933012385,
"permissions" : [ "READ", "CREATE", "UPDATE" ],
"name" : "Colors"
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /{projectName}/tagFamilies/
Create a new tag family.
URI Parameters
- projectName: required (string)
Name of the project.
Body
Type: application/json
Example:
{
"name" : "Colors"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"creator" : {
"name" : "jdoe42",
"uuid" : "84ba2f11eb3847baba2f11eb38f7bac6"
},
"created" : 1459933012385,
"editor" : {
"name" : "jdoe42",
"uuid" : "cb0b575151be492d8b575151bef92dd0"
},
"edited" : 1459933012385,
"permissions" : [ "READ", "CREATE", "UPDATE" ],
"name" : "Colors"
}
Load the tag family with the given uuid.
Update the tag family with the given path.
Delete the tag family with the given path.
get /{projectName}/tagFamilies/{uuid}
Load the tag family with the given uuid.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag family.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}
put /{projectName}/tagFamilies/{uuid}
Update the tag family with the given path.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag family.
Body
Type: application/json
Example:
{
"name" : "Nicer colors"
}
HTTP status code 200
Body
Type: application/json
Example:
{
"creator" : {
"name" : "jdoe42",
"uuid" : "84ba2f11eb3847baba2f11eb38f7bac6"
},
"created" : 1459933012385,
"editor" : {
"name" : "jdoe42",
"uuid" : "cb0b575151be492d8b575151bef92dd0"
},
"edited" : 1459933012385,
"permissions" : [ "READ", "CREATE", "UPDATE" ],
"name" : "Colors"
}
delete /{projectName}/tagFamilies/{uuid}
Load all tags which were assigned to this tag family.
get /{projectName}/tagFamilies/{uuid}/tags
Load all tags which were assigned to this tag family.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag family.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}, {
"uuid" : "5ff99cd33c754d9ab99cd33c75cd9aa3",
"creator" : {
"name" : "jdoe42",
"uuid" : "55f0d434e34c4415b0d434e34c8415ac"
},
"created" : 1459933012382,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ecc20274b214fc78c20274b212fc785"
},
"edited" : 1459933012382,
"permissions" : [ "READ", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "Name for language tag en"
}
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Tags
Load all tags of the project.
Create a new tag.
get /{projectName}/tags/
Load all tags of the project.
URI Parameters
- projectName: required (string)
Name of the project.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
- orderBy: (string)
Set the attribute by which the results should be ordered.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}, {
"uuid" : "5ff99cd33c754d9ab99cd33c75cd9aa3",
"creator" : {
"name" : "jdoe42",
"uuid" : "55f0d434e34c4415b0d434e34c8415ac"
},
"created" : 1459933012382,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ecc20274b214fc78c20274b212fc785"
},
"edited" : 1459933012382,
"permissions" : [ "READ", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "Name for language tag en"
}
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
post /{projectName}/tags/
Create a new tag.
URI Parameters
- projectName: required (string)
Name of the project.
Body
Type: application/json
Example:
{
"fields" : { }
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}
Load the tag with the given uuid.
Update the tag with the given path.
Delete the tag with the given path.
get /{projectName}/tags/{uuid}
Load the tag with the given uuid.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- orderBy: (string)
Set the attribute by which the results should be ordered.
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}
put /{projectName}/tags/{uuid}
Update the tag with the given path.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
Body
Type: application/json
Example:
{
"fields" : { }
}
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}
delete /{projectName}/tags/{uuid}
Delete the tag with the given path.
URI Parameters
- projectName: required (string)
Name of the project.
- uuid: required (string)
The uuid of a single tag.
Query Parameters
- role: (string)
Set the role uuid which will be used to populate the rolePerms field within the response.
Search
Query for nodes. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/nodes
Query for nodes. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
Query Parameters
- lang: (string)
Filter the languages in the form of a list containing IETF language tags which are separated by comma.
Example:
?lang=de,en
- page: (number)
The page to be displayed. Please note that page numbering is 1-based and that omitting the page parameter will return the first page 1.
- perPage: (number)
The page size. A page size of 25 will be used when this parameter is omitted.
Body
Type: application/json
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "d42f1d35b941441daf1d35b941c41d20",
"creator" : {
"name" : "jdoe42",
"uuid" : "72179a8c6a1245a5979a8c6a1265a57d"
},
"created" : 1459933012369,
"edited" : 1459933012369,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"availableLanguages" : [ "en", "de" ],
"languagePaths" : {
"de" : "/api/v1/yourProject/webroot/Bilder",
"en" : "/api/v1/yourProject/webroot/Images"
},
"parentNode" : {
"uuid" : "2ab91dc762e04948b91dc762e0594865",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : {
"folder" : {
"schemaUuid" : "0a6d89843db945a1ad89843db965a1c1",
"count" : 5
},
"blogpost" : {
"schemaUuid" : "79fdc8167aaa4e5dbdc8167aaa7e5d22",
"count" : 1
}
},
"schema" : {
"name" : "content",
"uuid" : "cbc67e2d49f8491c867e2d49f8691ce4",
"version" : 1
},
"published" : true,
"fields" : {
"content-htmlField" : "Content for language tag de-DE",
"names-stringListField" : [ "Jack", "Joe", "Mary", "Tom" ],
"categories-nodeListField" : [ {
"uuid" : "18de641645e34ad89e641645e38ad807"
}, {
"uuid" : "bea063aa505446bfa063aa505456bf82"
}, {
"uuid" : "622d68693c004d29ad68693c003d292d"
} ],
"locations-micronodeListField" : [ {
"uuid" : "5dad89d8575e4e66ad89d8575ebe66e9",
"microschema" : {
"name" : "geolocation",
"uuid" : "837ea470d65d466cbea470d65d866c99"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
}, {
"uuid" : "620353734b994be68353734b998be601",
"microschema" : {
"name" : "geolocation",
"uuid" : "e62d76c4bb454e31ad76c4bb452e31f1"
},
"fields" : {
"latitude" : 48.137222,
"longitude" : 11.575556
},
"type" : "micronode"
} ],
"enabled-booleanField" : true,
"price-numberField" : 100.1,
"filename-stringField" : "dummy-content.de.html",
"teaser-stringField" : "Dummy teaser for de-DE",
"location-micronodeField" : {
"uuid" : "537409fb8c2f40ccb409fb8c2f90ccea",
"microschema" : {
"name" : "geolocation",
"uuid" : "0813be965fc4445593be965fc48455e4"
},
"fields" : {
"latitude" : 48.208330230278,
"longitude" : 16.373063840833
},
"type" : "micronode"
},
"relatedProduct-nodeField" : {
"uuid" : "fb619fb9f21b4d84a19fb9f21bfd843e"
},
"name-stringField" : "Name for language tag de-DE",
"release-dateField" : 1459933012,
"categoryIds-numberListField" : [ 1, 42, 133, 7 ],
"binary-binaryField" : {
"fileName" : "flower.jpg",
"width" : 800,
"height" : 600,
"sha512sum" : "ec582eb760034dd91d5fd33656c0b56f082b7365d32e2a139dd9c87ebc192bff3525f32ff4c4137463a31cad020ac19e6e356508db2b90e32d737b6d725e14c1",
"fileSize" : 95365,
"mimeType" : "image/jpeg",
"dpi" : 200,
"type" : "binary"
}
},
"path" : "/api/v1/yourProject/webroot/Images",
"breadcrumb" : [ ],
"container" : false
}, {
"uuid" : "8b6f7c174b0e4f9eaf7c174b0e2f9e6b",
"creator" : {
"name" : "jdoe42",
"uuid" : "718246d5e0ba42328246d5e0ba92329a"
},
"created" : 1459933012370,
"editor" : {
"name" : "jdoe42",
"uuid" : "735742b5632a46a19742b5632af6a1ef"
},
"edited" : 1459933012370,
"permissions" : [ "READ", "CREATE" ],
"parentNode" : {
"uuid" : "97120aeeca1248d2920aeeca1258d28e",
"displayName" : "parentNodeDisplayName"
},
"tags" : { },
"childrenInfo" : { },
"schema" : {
"name" : "content",
"uuid" : "95ea3cf54d0642a2aa3cf54d0612a2cc",
"version" : 1
},
"published" : false,
"fields" : {
"filename" : "dummy-content.en.html",
"name" : "Name for language tag en",
"content" : "Content for language tag en",
"teaser" : "Dummy teaser for en"
},
"breadcrumb" : [ ],
"container" : false
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for tags. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/tags
Query for tags. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "60b4b034f5ba40f1b4b034f5ba70f1d5",
"creator" : {
"name" : "jdoe42",
"uuid" : "ffd7db86ae30423597db86ae3072350b"
},
"created" : 1459933012380,
"editor" : {
"name" : "jdoe42",
"uuid" : "2902effd9b3d404282effd9b3d404291"
},
"edited" : 1459933012380,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "tagName"
}
}, {
"uuid" : "5ff99cd33c754d9ab99cd33c75cd9aa3",
"creator" : {
"name" : "jdoe42",
"uuid" : "55f0d434e34c4415b0d434e34c8415ac"
},
"created" : 1459933012382,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ecc20274b214fc78c20274b212fc785"
},
"edited" : 1459933012382,
"permissions" : [ "READ", "CREATE" ],
"tagFamily" : {
"name" : "colors",
"uuid" : "814b1cadfb144ec18b1cadfb14fec147"
},
"fields" : {
"name" : "Name for language tag en"
}
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for users. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/users
Query for users. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}, {
"uuid" : "c063610e515f407da3610e515fa07d33",
"creator" : {
"name" : "jdoe42",
"uuid" : "82d08b65b6de4f6b908b65b6de7f6b00"
},
"created" : 1459933012312,
"editor" : {
"name" : "jdoe42",
"uuid" : "ce0ad480261b469c8ad480261b369cff"
},
"edited" : 1459933012312,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Roe",
"firstname" : "Jane",
"username" : "jroe",
"emailAddress" : "j.roe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "0ffbfdb5e4004c02bbfdb5e400fc0256"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "9354683b42fe45d494683b42fe05d436"
}, {
"name" : "super-editors",
"uuid" : "796fd68cbb0040b6afd68cbb0000b606"
}, {
"name" : "editors",
"uuid" : "ccde2b4d672e43059e2b4d672e43057b"
} ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for groups. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/groups
Query for groups. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "208206f3ec08426b8206f3ec08226b76",
"creator" : {
"name" : "jdoe42",
"uuid" : "dabcf15592fe417cbcf15592fe817ccd"
},
"created" : 1459933012327,
"editor" : {
"name" : "jdoe42",
"uuid" : "ba7e8b0b0aa74b13be8b0b0aa7fb13a5"
},
"edited" : 1459933012327,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin Group",
"roles" : [ {
"name" : "admin",
"uuid" : "bfe33f857bd048c5a33f857bd0e8c53b"
} ]
}, {
"uuid" : "eb5d226daf0d496f9d226daf0d696f75",
"created" : 0,
"edited" : 0,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Editor Group",
"roles" : [ ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for roles. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/roles
Query for roles. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "15f305639cdf40f8b305639cdf50f8c5",
"creator" : {
"name" : "jdoe42",
"uuid" : "00d4015b87114c0194015b8711ec01a1"
},
"created" : 1459933012334,
"editor" : {
"name" : "jdoe42",
"uuid" : "ef2d9f341f0848c1ad9f341f0818c162"
},
"edited" : 1459933012334,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Admin role",
"groups" : [ {
"name" : "editors",
"uuid" : "3f5314b3810947399314b381091739ee"
}, {
"name" : "guests",
"uuid" : "069b735193b74f529b735193b7ef5242"
} ]
}, {
"uuid" : "b5775ea0a40e462ab75ea0a40e562acd",
"creator" : {
"name" : "jdoe42",
"uuid" : "f3e5c530a9c54260a5c530a9c5726098"
},
"created" : 1459933012339,
"editor" : {
"name" : "jdoe42",
"uuid" : "1ffa098221b74a3dba098221b7ca3d67"
},
"edited" : 1459933012339,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Reader role",
"groups" : [ ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for projects. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/projects
Query for projects. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "78e09798d5754d9fa09798d575cd9fe9",
"creator" : {
"name" : "jdoe42",
"uuid" : "f392be681e3c441b92be681e3c441bdb"
},
"created" : 1459933012477,
"editor" : {
"name" : "jdoe42",
"uuid" : "4750f4e4be8041ff90f4e4be8051ff10"
},
"edited" : 1459933012477,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project",
"rootNodeUuid" : "5c627814aa2f4d16a27814aa2fcd16fe"
}, {
"uuid" : "5c7c9de052ae4e05bc9de052aebe053d",
"creator" : {
"name" : "jdoe42",
"uuid" : "e9ad2064b87b46bead2064b87bf6be6e"
},
"created" : 1459933012478,
"editor" : {
"name" : "jdoe42",
"uuid" : "78cdd6e74f2340338dd6e74f23a033af"
},
"edited" : 1459933012478,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"name" : "Dummy Project (Mobile)",
"rootNodeUuid" : "bc5977d1f72e4fa29977d1f72e9fa24b"
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for tagFamilies. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/tagFamilies
Query for tagFamilies. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"creator" : {
"name" : "jdoe42",
"uuid" : "84ba2f11eb3847baba2f11eb38f7bac6"
},
"created" : 1459933012385,
"editor" : {
"name" : "jdoe42",
"uuid" : "cb0b575151be492d8b575151bef92dd0"
},
"edited" : 1459933012385,
"permissions" : [ "READ", "CREATE", "UPDATE" ],
"name" : "Colors"
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for schemas. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/schemas
Query for schemas. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "d187e97352df415587e97352dfa155b8",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"name" : "Example Schema",
"fields" : [ {
"name" : "name",
"label" : "Name",
"required" : false,
"type" : "string"
}, {
"name" : "number",
"label" : "Number",
"required" : false,
"type" : "number"
}, {
"name" : "html",
"label" : "Teaser",
"required" : false,
"type" : "html"
}, {
"name" : "list",
"label" : "List of nodes",
"required" : false,
"listType" : "node",
"type" : "list",
"allow" : [ "content", "video" ]
}, {
"name" : "node",
"required" : false,
"type" : "node",
"allow" : [ "content", "video", "image" ]
}, {
"name" : "location",
"label" : "Location",
"required" : false,
"type" : "micronode",
"allow" : [ "geolocation" ]
}, {
"name" : "locationlist",
"label" : "List of Locations",
"required" : false,
"listType" : "micronode",
"type" : "list",
"allow" : [ "geolocation" ]
} ],
"displayField" : "name",
"segmentField" : "name",
"container" : false
}, {
"uuid" : "20354a38b6434abbb54a38b643dabb26",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"name" : "Example Schema",
"fields" : [ {
"name" : "name",
"label" : "Name",
"required" : false,
"type" : "string"
}, {
"name" : "number",
"label" : "Number",
"required" : false,
"type" : "number"
}, {
"name" : "html",
"label" : "Teaser",
"required" : false,
"type" : "html"
}, {
"name" : "list",
"label" : "List of nodes",
"required" : false,
"listType" : "node",
"type" : "list",
"allow" : [ "content", "video" ]
}, {
"name" : "node",
"required" : false,
"type" : "node",
"allow" : [ "content", "video", "image" ]
}, {
"name" : "location",
"label" : "Location",
"required" : false,
"type" : "micronode",
"allow" : [ "geolocation" ]
}, {
"name" : "locationlist",
"label" : "List of Locations",
"required" : false,
"listType" : "micronode",
"type" : "list",
"allow" : [ "geolocation" ]
} ],
"displayField" : "name",
"segmentField" : "name",
"container" : false
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Query for microschemas. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
post /search/microschemas
Query for microschemas. Accepts an elastic search json query. Please note that the from and size parameters can't be used because they conflict with the mesh paging parameters.
Headers
- Accept-Language: (string)
The response messages are localized according to the set header value. English and german translations can be provided. Unsupported languages will fallback to english.
HTTP status code 200
Body
Type: application/json
Example:
{
"data" : [ {
"uuid" : "bfe8a5e561aa4562a8a5e561aa856283",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
}, {
"uuid" : "ff614037f7ba4caaa14037f7ba8caaba",
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"version" : 0,
"description" : "Microschema for Geolocations",
"name" : "geolocation",
"fields" : [ {
"name" : "longitude",
"label" : "Longitude",
"required" : true,
"type" : "number"
}, {
"name" : "latitude",
"label" : "Latitude",
"required" : true,
"type" : "number"
} ]
} ],
"_metainfo" : {
"currentPage" : 1,
"perPage" : 2,
"pageCount" : 10,
"totalCount" : 20
}
}
Load the search status information.
Authentication
Return the user response for the current user.
get /auth/me
Return the user response for the current user.
HTTP status code 200
Body
Type: application/json
Example:
{
"uuid" : "1b138b1d06574ea2938b1d06575ea297",
"creator" : {
"name" : "jdoe42",
"uuid" : "89e1f1e69e25403ea1f1e69e25303ead"
},
"created" : 1459933012250,
"editor" : {
"name" : "jdoe42",
"uuid" : "95b16d9453ef4b70b16d9453ef6b70db"
},
"edited" : 1459933012251,
"permissions" : [ "READ", "UPDATE", "DELETE", "CREATE" ],
"lastname" : "Doe",
"firstname" : "Joe",
"username" : "jdoe42",
"emailAddress" : "j.doe@nowhere.com",
"nodeReference" : {
"projectName" : "dummy",
"uuid" : "d468f89b726547daa8f89b7265f7da81"
},
"enabled" : true,
"groups" : [ {
"name" : "editors",
"uuid" : "bbcbba23414346558bba234143f655bd"
} ]
}
Login the user using the provided credentials.
post /auth/login
Login the user using the provided credentials.
Body
Type: application/json
Example:
{
"username" : "admin",
"password" : "finger"
}
Logout the user.
Eventbus Bridge
This endpoint is a SockJS compliant websocket that creates a bridge to the mesh eventbus. It allows handling of various mesh specific events.
Direct access to a websocket. This way the SockJS specific fallback is not used.
Administration
Fetch the current migration status.
Utilities
Resolve links in posted content. The content may be plain text, but also JSON.
post /utilities/linkResolver
Resolve links in posted content. The content may be plain text, but also JSON.
Query Parameters
- resolveLinks: (one of off, short, medium, full - default: off)
Set whether links shall be resolved. "off" means no link resolving. "full" will contain the webroot prefix and project name, "medium" will contain the project name and "short" neither webroot prefix nor project name.
- project: (string - default: project)
Project for which the link resolving is done. This is important for invalid links.
Body
Type: text/plain
Example:
Go to <a href="{{mesh.link('70bb205d44064671bb205d4406f671b3')}}">News</a>
HTTP status code 200
Body
Type: text/plain
Example:
Go to <a href="/myproject/news/2016/news.html">News</a>