/users

Provides endpoints which allow the manipulation of users.

post

Create a new user.

get

Load multiple users and return a paged list response.

post

Update the user with the given uuid.

get

Read the user with the given uuid

delete

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

get

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

post

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

post

Return API token which can be used to authenticate the user. Store the key somewhere save since you won't be able to retrieve it later on.

delete

Invalidate the issued API token.

/roles

Provides endpoints which allow the manipulation of roles.

post

Create a new role.

get

Load multiple roles and return a paged list response

get

Load the role with the given uuid.

post

Update the role with the given uuid.

delete

Delete the role with the given uuid

post

Set the permissions between role and the targeted element.

get

Load the permissions between given role and the targeted element.

/groups

Provides endpoints which allow the manipulation of groups.

post

Create a new group.

get

Read multiple groups and return a paged list response.

get

Read the group with the given uuid.

post

Update the group with the given uuid.

delete

Delete the given group.

get

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

post

Add the specified role to the group.

delete

Remove the given role from the group.

get

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

post

Add the given user to the group

/projects

Provides endpoints which allow the manipulation of projects.

post

Create a new project.

get

Load multiple projects and return a paged response.

get

Load the project with the given uuid.

post

Update the project with the given uuid.

delete

Delete the project and all attached nodes.

/schemas

Provides endpoints which allow the manipulation of schemas.

get

Read multiple schemas and return a paged list response.

post

Create a new schema.

get

Load the schema with the given uuid.

post

Update the schema.

delete

Delete the schema with the given uuid.

post

Apply the posted changes to the schema.

post

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

/microschemas

Endpoint which provides methods to manipulate microschemas.

post

Create a new microschema.

get

Read multiple microschemas and return a paged list response.

get

Read the microschema with the given uuid.

post

Update the microschema with the given uuid.

delete

Delete the microschema with the given uuid.

post

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

post

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

/admin

Collection of administrative endpoints which usually require admin permission

post

Invoke a graph database backup and dump the data to the configured backup location. Note that this operation will block all current operation.

post

Invoke a orientdb graph database export.

post

Invoke a orientdb graph database import. The latest import file from the import directory will be used for this operation.

post

Invoke a graph database restore. The latest dump from the backup directory will be inserted. Please note that this operation will block all current operation and effecivly destroy all previously stored data.

get

Return the mesh system status.

get

Return the current schema or node migration status.

Provides search endpoints which can be used to invoke global searches

get

Create search index mappings.

post

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

post

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

post

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

post

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

get

Invokes a full reindex of the search indices. This operation may take some time to complete.

post

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

post

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

get

Returns the search index status.

post

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

post

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

post

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

/utilities

Provides endpoints for various utility actions

post

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

/auth

Endpoint which contains login and logout methods.

get

Login via basic authentication.

post

Login via this dedicated login endpoint.

get

Logout and delete the currently active session.

get

Load your own user which is currently logged in.

/eventbus

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

/

Provides endpoints that return information about the REST API.

get

Endpoint which returns version information

get

Endpoint which provides a RAML document for all registed endpoints.

get

Return the current project info.

/{project}/nodes

Provides endpoints which allow the manipulation of nodes.

post

Create a new node.

get

Read all nodes and return a paged list response.

get

Load the node with the given uuid.

post

Update the node with the given uuid. It is mandatory to specify the version within the update request. Mesh will automatically check for version conflicts and return a 409 error if a conflict has been detected. Additional conflict checks for WebRoot path conflicts will also be performed.

delete

Delete the node with the given uuid.

post

Update the binaryfield with the given name.

get

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

post

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

get

Load all child nodes and return a paged list response.

delete

Delete the language specific content of the node.

get

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

post

Move the node into the target node.

get

Returns a navigation object for the provided node.

get

Return the published status of the node.

post

Publish the node with the given uuid.

delete

Unpublish the given node.

get

Return a list of all tags which tag the node.

post

Update the list of assigned tags

post

Assign the given tag to the node.

delete

Remove the given tag from the node.

/{project}/tagFamilies

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

get

Load multiple tag families and return a paged list response.

post

Create a new tag family.

get

Read the tag family with the given uuid.

post

Update the tag family with the given uuid.

delete

Delete the tag family.

get

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

get

Read the specified tag from the tag family.

post

Update the specified tag

delete

Remove the tag from the tag family.

get

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

/{project}/navroot

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

get

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

/{project}/webroot

Provides endpoints which allow loading nodes via a webroot path.

get

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

/{project}/releases

Provides endpoints which allow the manipulation of releases.

post

Create a new release and automatically invoke a node migration.

get

Load multiple releases and return a paged list response.

get

Load the release with the given uuid.

post

Update the release with the given uuid.

get

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

post

Assign a microschema version to the release.

get

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

get

Invoked the node migration for not yet migrated nodes of schemas that are assigned to the release.

get

Load schemas that are assigned to the release and return a paged list response.

post

Assign a schema version to the release.

/{project}/graphql

GraphQL endpoint

post

Endpoint which accepts GraphQL queries.

Provides endpoints which allow project wide search.

post

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

post

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

post

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

/{project}/schemas

Provides endpoints which can be used to assign schemas to projects.

get

Read multiple schemas and return a paged list response.

get

Load the schema with the given uuid.

post

Assign the schema to the project. This will automatically assign the latest schema version to all releases of the project.

delete

Remove the schema with the given uuid from the project. This will automatically remove all schema versions of the given schema from all releases of the project.

/{project}/microschemas

Contains endpoints which allow microschemas to be assigned to projects.

get

Read all microschemas which are assigned to the project.

post

Add the microschema to the project.

delete

Remove the microschema from the project.