REST API

The web version of the Charon provides a experimental REST API feature.

Testing REST API

You can utilize the Swagger UI to perform test requests. In the Swagger UI, click on the Authorize button and paste your API Key for authentication.

Working with REST API

To make requests, you will need an API Key obtained from your profile page. Add the Authorization: Basic <api-key> header to all of your HTTP requests. Also is recommeded to provide correct User-Agent header.

Authentication

POST /token

Authenticate with oAuth protocol.

Status Codes:
POST /auth/one-time-code/

Request one-time code for current authentication credential. It could be used as ‘x-authorization’ query parameter instead of ‘Authorization’ header for WebSockets and download requests.

Status Codes:

  • 200 OK – One-time code. It has short expiration time.

  • default – Operation failure response.

Request Headers:

  • Authorization – Authorization header. (Required)

POST /auth/flow/password/

Begin authentication flow with password request.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/email-code/

Continue authentication flow with TOTP code from email.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/api-key/

Start authentication flow with API Key.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/on-behalf/

Start authentication flow on behalf of another user.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/oauth2/{authenticationProvider}/prepare/

Prepare OAuth2 sign-in URL.

Parameters:

  • authenticationProvider (string) – Type of OAuth2 provider.

Status Codes:

  • 200 OK – Sign-in URL location.

  • default – Operation failure response.

POST /auth/flow/oauth2/{authenticationProvider}/complete/

Complete OAuth2 authentication.

Parameters:

  • authenticationProvider (string) – Type of OAuth2 provider.

Query Parameters:

  • code (string) – The authorization code received from the authorization server.

  • state (string) – An opaque value used by the client to maintain state between the request and callback. (Required)

  • error (string) – A single error code.

  • error_description (string) – Human-readable text providing additional information.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /token

Authenticate with oAuth protocol.

Status Codes:
POST /auth/one-time-code/

Request one-time code for current authentication credential. It could be used as ‘x-authorization’ query parameter instead of ‘Authorization’ header for WebSockets and download requests.

Status Codes:

  • 200 OK – One-time code. It has short expiration time.

  • default – Operation failure response.

Request Headers:

  • Authorization – Authorization header. (Required)

POST /auth/flow/password/

Begin authentication flow with password request.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/email-code/

Continue authentication flow with TOTP code from email.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/api-key/

Start authentication flow with API Key.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/on-behalf/

Start authentication flow on behalf of another user.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

POST /auth/flow/oauth2/{authenticationProvider}/prepare/

Prepare OAuth2 sign-in URL.

Parameters:

  • authenticationProvider (string) – Type of OAuth2 provider.

Status Codes:

  • 200 OK – Sign-in URL location.

  • default – Operation failure response.

POST /auth/flow/oauth2/{authenticationProvider}/complete/

Complete OAuth2 authentication.

Parameters:

  • authenticationProvider (string) – Type of OAuth2 provider.

Query Parameters:

  • code (string) – The authorization code received from the authorization server.

  • state (string) – An opaque value used by the client to maintain state between the request and callback. (Required)

  • error (string) – A single error code.

  • error_description (string) – Human-readable text providing additional information.

Status Codes:

  • 200 OK – Authentication flow stage.

  • default – Operation failure response.

DataSource

PUT /datasource/{dataSourceId}/transaction/

Wait for data source availability and begin new transaction. Identifier specified in request later could be used with other request in `transaction` parameter.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 204 No Content – The transaction has started.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/transaction/{transactionId}/

Commit pending transaction.

Parameters:

  • dataSourceId (string) – Id of data source.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 204 No Content – The transaction has been successfully completed.

  • default – Operation failure response.

DELETE /datasource/{dataSourceId}/transaction/{transactionId}/

Reject pending transaction.

Parameters:

  • dataSourceId (string) – Id of data source.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 204 No Content – The transaction has either been aborted or has already failed.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Find document by it’s id or unique property value.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • uniqueSchemaPropertyNameOrId (string) – Document unique property’s name. For example ‘Id’. (Required)

  • uniqueSchemaPropertyValue (string) – Document’s unique property value. For example it’s ‘Id’ property. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found document or null.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Create document.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Created document.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Update document.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Updated document.

  • default – Operation failure response.

DELETE /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Delete document by it’s id.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • id (string) – Document’s id. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Deleted document or null.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/collection/{schemaNameOrId}/documents/

List documents.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found documents.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collection/{schemaNameOrId}/documents/

Bulk change documents.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • dryRun (boolean) – Perform dry run of operation and don’t persist changes’. (Required)

  • importMode (string) – Import mode. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Created document.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/documents/query/

Query documents from all collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • query (string) – Keyword to lookup in documents. (Required)

  • limit (integer) – Maximum number of documents to return.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found document stream where each event is instance of ‘ListResult’. Empty results are ommited.

POST /datasource/{dataSourceId}/documents/query/

Pick multiple documents by their unique properties e.g. batched find request. Max documents per request is - 20.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Pick results in same order as requested.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/converter/raw/

Convert specified game data documents from request body to JSON format and return it without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Converted game data document.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collections/raw/

Export documents from multiple collections into downloadable format without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

  • exportMode (string) – Export mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • properties (array) – List of properties on schemas to export. Id property is always exported. Empty list mean all properties.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/raw/

Backup data source into downloadable format without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/loading-progress/

Get data source’s loading progress.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source’s capabilities and loading progress.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/stats/

Get data source’s statistics.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Data source’s statistics.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collections/

Export documents from multiple collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • exportMode (string) – Export mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • properties (array) – List of properties on schemas to export. Id property is always exported. Empty list mean all properties.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collections/

Import documents into multiple collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • importMode (string) – Import mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • validationOptions (array) – Data source validation options. (Required)

  • dryRun (boolean) – Perform dry run of operation and don’t persist changes’. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Import report.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/

Backup data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Backed up data source.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/

Restore data source from specified documents.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source restoration result.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/validity/

Validadate data source with specified requirements/parameters.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

  • validationOptions (array) – Data source validation options. (Required)

Status Codes:

  • 200 OK – Data source’s configuration.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/source-code/

Generate source code for data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Source code packed into .zip archive.

GET /datasource/{dataSourceId}/source-code/templates/

Get T4 templates for generating source code.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Source code generation templates packed into .zip archive.

PUT /datasource/{dataSourceId}/transaction/

Wait for data source availability and begin new transaction. Identifier specified in request later could be used with other request in `transaction` parameter.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 204 No Content – The transaction has started.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/transaction/{transactionId}/

Commit pending transaction.

Parameters:

  • dataSourceId (string) – Id of data source.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 204 No Content – The transaction has been successfully completed.

  • default – Operation failure response.

DELETE /datasource/{dataSourceId}/transaction/{transactionId}/

Reject pending transaction.

Parameters:

  • dataSourceId (string) – Id of data source.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 204 No Content – The transaction has either been aborted or has already failed.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Find document by it’s id or unique property value.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • uniqueSchemaPropertyNameOrId (string) – Document unique property’s name. For example ‘Id’. (Required)

  • uniqueSchemaPropertyValue (string) – Document’s unique property value. For example it’s ‘Id’ property. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found document or null.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Create document.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Created document.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Update document.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Updated document.

  • default – Operation failure response.

DELETE /datasource/{dataSourceId}/collection/{schemaNameOrId}/

Delete document by it’s id.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • id (string) – Document’s id. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Deleted document or null.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/collection/{schemaNameOrId}/documents/

List documents.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found documents.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collection/{schemaNameOrId}/documents/

Bulk change documents.

Parameters:

  • schemaNameOrId (string) – Id or name of schema.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • validationOptions (array) – Data source validation options. (Required)

  • dryRun (boolean) – Perform dry run of operation and don’t persist changes’. (Required)

  • importMode (string) – Import mode. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Created document.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/documents/query/

Query documents from all collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • query (string) – Keyword to lookup in documents. (Required)

  • limit (integer) – Maximum number of documents to return.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Found document stream where each event is instance of ‘ListResult’. Empty results are ommited.

POST /datasource/{dataSourceId}/documents/query/

Pick multiple documents by their unique properties e.g. batched find request. Max documents per request is - 20.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Pick results in same order as requested.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/converter/raw/

Convert specified game data documents from request body to JSON format and return it without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Converted game data document.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collections/raw/

Export documents from multiple collections into downloadable format without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

  • exportMode (string) – Export mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • properties (array) – List of properties on schemas to export. Id property is always exported. Empty list mean all properties.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/raw/

Backup data source into downloadable format without response wrapper.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/loading-progress/

Get data source’s loading progress.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source’s capabilities and loading progress.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/stats/

Get data source’s statistics.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Data source’s statistics.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/collections/

Export documents from multiple collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • exportMode (string) – Export mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • properties (array) – List of properties on schemas to export. Id property is always exported. Empty list mean all properties.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Exported documents.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/collections/

Import documents into multiple collections.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • importMode (string) – Import mode. (Required)

  • schemas (array) – List of schemas to export/import. Empty list mean all schemas.

  • languages (array) – List of languages on schemas to export. Empty list mean all languages.

  • validationOptions (array) – Data source validation options. (Required)

  • dryRun (boolean) – Perform dry run of operation and don’t persist changes’. (Required)

  • transactionId (string) – Id or name of transaction.

Status Codes:

  • 200 OK – Import report.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/

Backup data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Backed up data source.

  • default – Operation failure response.

PUT /datasource/{dataSourceId}/

Restore data source from specified documents.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source restoration result.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/validity/

Validadate data source with specified requirements/parameters.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • transactionId (string) – Id or name of transaction.

  • validationOptions (array) – Data source validation options. (Required)

Status Codes:

  • 200 OK – Data source’s configuration.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/source-code/

Generate source code for data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Source code packed into .zip archive.

GET /datasource/{dataSourceId}/source-code/templates/

Get T4 templates for generating source code.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Source code generation templates packed into .zip archive.

DataSourceCapabilities

GET /datasource/{dataSourceId}/capabilities/

Get data source’s capabilities.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source’s capabilities.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/capabilities/

Get data source’s capabilities.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Data source’s capabilities.

  • default – Operation failure response.

UserPresence

GET /datasource/{dataSourceId}/present-users/

Get list of users present in specificated data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – List of user presence in data source.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/present-users/

Get list of users present in specificated data source.

Parameters:

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – List of user presence in data source.

  • default – Operation failure response.

Processes

GET /datasource/{dataSourceId}/process/

List processes.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

Status Codes:

  • 200 OK – Process state.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/process/{processId}/

Get process’s state.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Process state.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/process/{processId}/

Stop process.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • stopReason (string) – Reason why process has been stopped. (Required)

Status Codes:

  • 200 OK – Stopped process state.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/process/{processId}/result/raw/

Get process’s execution result without response wrapper.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Process result.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/process/

List processes.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

Status Codes:

  • 200 OK – Process state.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/process/{processId}/

Get process’s state.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Process state.

  • default – Operation failure response.

POST /datasource/{dataSourceId}/process/{processId}/

Stop process.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • stopReason (string) – Reason why process has been stopped. (Required)

Status Codes:

  • 200 OK – Stopped process state.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/process/{processId}/result/raw/

Get process’s execution result without response wrapper.

Parameters:

  • processId (integer) – Id of process.

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • download (boolean) – Set “Content-Disposition” header in order to make the browser download the result.

Status Codes:

  • 200 OK – Process result.

  • default – Operation failure response.

Formulas

GET /datasource/{dataSourceId}/formula/type/

List formula types.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in type name.

Status Codes:

  • 200 OK – List of types.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/formula/type/{typeName}/

Get formula type by name.

Parameters:

  • typeName (string) – Type name to find.

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Type description.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/formula/type/

List formula types.

Parameters:

  • dataSourceId (string) – Id of data source.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in type name.

Status Codes:

  • 200 OK – List of types.

  • default – Operation failure response.

GET /datasource/{dataSourceId}/formula/type/{typeName}/

Get formula type by name.

Parameters:

  • typeName (string) – Type name to find.

  • dataSourceId (string) – Id of data source.

Status Codes:

  • 200 OK – Type description.

  • default – Operation failure response.

Preferences

GET /project/{projectId}/preferences/

Get project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /project/{projectId}/preferences/

Save project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /project/{projectId}/preferences/

Patch project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /project/{projectId}/preferences/user/

Get project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /project/{projectId}/preferences/user/

Save project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /project/{projectId}/preferences/user/

Patch project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /workspace/{workspaceId}/preferences/

Get workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/preferences/

Save workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /workspace/{workspaceId}/preferences/

Patch workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /workspace/{workspaceId}/preferences/user/

Get user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/preferences/user/

Save user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /workspace/{workspaceId}/preferences/user/

Patch user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

DELETE /preferences/user/

Reset all user’s preferences.

Status Codes:

  • 204 No Content – Preferences has been reset.

  • default – Operation failure response.

GET /preferences/

Get default preferences.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /preferences/

Save default preferences.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /preferences/

Patch default preferences.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /project/{projectId}/preferences/

Get project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /project/{projectId}/preferences/

Save project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /project/{projectId}/preferences/

Patch project team-shared preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /project/{projectId}/preferences/user/

Get project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /project/{projectId}/preferences/user/

Save project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /project/{projectId}/preferences/user/

Patch project user’s preferences.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /workspace/{workspaceId}/preferences/

Get workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/preferences/

Save workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /workspace/{workspaceId}/preferences/

Patch workspace team-shared preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

GET /workspace/{workspaceId}/preferences/user/

Get user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/preferences/user/

Save user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /workspace/{workspaceId}/preferences/user/

Patch user’s workspace preferences.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

DELETE /preferences/user/

Reset all user’s preferences.

Status Codes:

  • 204 No Content – Preferences has been reset.

  • default – Operation failure response.

GET /preferences/

Get default preferences.

Status Codes:

  • 200 OK – Preferences object.

  • default – Operation failure response.

PUT /preferences/

Save default preferences.

Status Codes:

  • 204 No Content – Preferences has been saved.

  • default – Operation failure response.

PATCH /preferences/

Patch default preferences.

Status Codes:

  • 204 No Content – Patch has been applyed.

  • default – Operation failure response.

User

GET /user/

Get all available users.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in user name or email.

Status Codes:

  • 200 OK – List of users.

  • default – Operation failure response.

PUT /user/

Create user with specified parameters.

Status Codes:

  • 201 Created – User has been created.

  • default – Operation failure response.

POST /user/public/

Get public profiles of users by their ids.

Status Codes:

  • 200 OK – List of user public profiles.

  • default – Operation failure response.

GET /user/me/

Get current user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

PUT /user/password-reset/

Request password reset.

Status Codes:

  • 204 No Content – Password reset request has been accepted.

  • default – Operation failure response.

POST /user/password-reset/

Change user password by using code from email.

Status Codes:

  • 204 No Content – Password has been reset.

  • default – Operation failure response.

GET /user/{userId}/

Get user by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

POST /user/{userId}/

Update user with new parameters.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Updated workspace.

  • default – Operation failure response.

DELETE /user/{userId}/

Strip personal information from user, quit all groups and block any access to this user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – User has been soft-deleted.

  • default – Operation failure response.

GET /user/{userId}/public/

Get user public profile by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

POST /user/{userId}/login/password/

Change user password by using temporary code or old password.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – Password has been changed.

  • default – Operation failure response.

POST /user/{userId}/mfa/email-code/

Configure email-code multi-factor authentication.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – Multi-factor authentication has been configured.

  • default – Operation failure response.

DELETE /user/{userId}/login/tokens/

Revoke all issues tokens for specified user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – All tokens have been revokes. It is required to re-authenticate after this call.

  • default – Operation failure response.

POST /user/{userId}/login/api-key/

Add API key login to user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – List of workspaces.

  • default – Operation failure response.

DELETE /user/{userId}/login/api-key/

Delete API key login from user.

Parameters:

  • userId (string) – Id of user.

Query Parameters:

  • id (string) – Id of UserLogin with API key. (Required)

Status Codes:

  • 204 No Content – API key has been deleted and no longer valid.

  • default – Operation failure response.

POST /user/{userId}/invitations/{invitationId}/

Accept invitation.

Parameters:

  • userId (string) – Id of user.

  • invitationId (string) – Id of invitation.

Status Codes:

  • 204 No Content – Invitation has been accepted.

  • default – Operation failure response.

DELETE /user/{userId}/invitations/{invitationId}/

Decline invitation.

Parameters:

  • userId (string) – Id of user.

  • invitationId (string) – Id of invitation.

Status Codes:

  • 204 No Content – Invitation has been dismissed.

  • default – Operation failure response.

GET /user/

Get all available users.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in user name or email.

Status Codes:

  • 200 OK – List of users.

  • default – Operation failure response.

PUT /user/

Create user with specified parameters.

Status Codes:

  • 201 Created – User has been created.

  • default – Operation failure response.

POST /user/public/

Get public profiles of users by their ids.

Status Codes:

  • 200 OK – List of user public profiles.

  • default – Operation failure response.

GET /user/me/

Get current user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

PUT /user/password-reset/

Request password reset.

Status Codes:

  • 204 No Content – Password reset request has been accepted.

  • default – Operation failure response.

POST /user/password-reset/

Change user password by using code from email.

Status Codes:

  • 204 No Content – Password has been reset.

  • default – Operation failure response.

GET /user/{userId}/

Get user by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

POST /user/{userId}/

Update user with new parameters.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Updated workspace.

  • default – Operation failure response.

DELETE /user/{userId}/

Strip personal information from user, quit all groups and block any access to this user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – User has been soft-deleted.

  • default – Operation failure response.

GET /user/{userId}/public/

Get user public profile by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found user.

  • default – Operation failure response.

POST /user/{userId}/login/password/

Change user password by using temporary code or old password.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – Password has been changed.

  • default – Operation failure response.

POST /user/{userId}/mfa/email-code/

Configure email-code multi-factor authentication.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – Multi-factor authentication has been configured.

  • default – Operation failure response.

DELETE /user/{userId}/login/tokens/

Revoke all issues tokens for specified user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – All tokens have been revokes. It is required to re-authenticate after this call.

  • default – Operation failure response.

POST /user/{userId}/login/api-key/

Add API key login to user.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – List of workspaces.

  • default – Operation failure response.

DELETE /user/{userId}/login/api-key/

Delete API key login from user.

Parameters:

  • userId (string) – Id of user.

Query Parameters:

  • id (string) – Id of UserLogin with API key. (Required)

Status Codes:

  • 204 No Content – API key has been deleted and no longer valid.

  • default – Operation failure response.

POST /user/{userId}/invitations/{invitationId}/

Accept invitation.

Parameters:

  • userId (string) – Id of user.

  • invitationId (string) – Id of invitation.

Status Codes:

  • 204 No Content – Invitation has been accepted.

  • default – Operation failure response.

DELETE /user/{userId}/invitations/{invitationId}/

Decline invitation.

Parameters:

  • userId (string) – Id of user.

  • invitationId (string) – Id of invitation.

Status Codes:

  • 204 No Content – Invitation has been dismissed.

  • default – Operation failure response.

Workspace

GET /workspace/

Get all available workspaces.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in workspace name.

Status Codes:

  • 200 OK – List of workspaces.

  • default – Operation failure response.

GET /workspace/my/

Get current user’s workspaces.

Status Codes:

  • 200 OK – List of known workspaces.

  • default – Operation failure response.

GET /workspace/{workspaceId}/

Get workspace by id.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Found Workspace.

  • default – Operation failure response.

POST /workspace/{workspaceId}/

Update workspace with new parameters.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Updated workspace.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/administrators/

Promote member to workspace administrators.

Parameters:

  • workspaceId (string) – Id of workspace.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Member has been promoted to administrator.

  • default – Operation failure response.

DELETE /workspace/{workspaceId}/administrators/

Demote member from workspace administrators.

Parameters:

  • workspaceId (string) – Id of workspace.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Member has been demoted from administrator.

  • default – Operation failure response.

GET /workspace/{workspaceId}/members/

Get workspace members.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Workspace members.

  • default – Operation failure response.

GET /workspace/

Get all available workspaces.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in workspace name.

Status Codes:

  • 200 OK – List of workspaces.

  • default – Operation failure response.

GET /workspace/my/

Get current user’s workspaces.

Status Codes:

  • 200 OK – List of known workspaces.

  • default – Operation failure response.

GET /workspace/{workspaceId}/

Get workspace by id.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Found Workspace.

  • default – Operation failure response.

POST /workspace/{workspaceId}/

Update workspace with new parameters.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Updated workspace.

  • default – Operation failure response.

PUT /workspace/{workspaceId}/administrators/

Promote member to workspace administrators.

Parameters:

  • workspaceId (string) – Id of workspace.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Member has been promoted to administrator.

  • default – Operation failure response.

DELETE /workspace/{workspaceId}/administrators/

Demote member from workspace administrators.

Parameters:

  • workspaceId (string) – Id of workspace.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Member has been demoted from administrator.

  • default – Operation failure response.

GET /workspace/{workspaceId}/members/

Get workspace members.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Workspace members.

  • default – Operation failure response.

WorkspaceQuota

POST /workspace/{workspaceId}/quota-usage/

Get workspace quota usage.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Found Workspace.

  • default – Operation failure response.

POST /workspace/{workspaceId}/quota-usage/

Get workspace quota usage.

Parameters:

  • workspaceId (string) – Id of workspace.

Status Codes:

  • 200 OK – Found Workspace.

  • default – Operation failure response.

Project

GET /project/

Get all available projects.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in project name.

Status Codes:

  • 200 OK – List of projects.

  • default – Operation failure response.

PUT /project/

Create new project.

Status Codes:

  • 200 OK – Created project.

  • default – Operation failure response.

GET /project/my/

Get current user’s projects.

Status Codes:

  • 200 OK – List of projects.

  • default – Operation failure response.

GET /project/{projectId}/

Get project by id.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Found Project.

  • default – Operation failure response.

POST /project/{projectId}/

Update project with new parameters.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Updated project.

  • default – Operation failure response.

DELETE /project/{projectId}/

Delete project and all related data.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project has been deleted.

  • default – Operation failure response.

PUT /project/{projectId}/branch/

Create branch in project.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been created.

  • default – Operation failure response.

PUT /project/{projectId}/branch/{branchName}/

Push branch content into another branch in this project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been updated.

  • default – Operation failure response.

POST /project/{projectId}/branch/{branchName}/

Updade branch in project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been updated.

  • default – Operation failure response.

DELETE /project/{projectId}/branch/{branchName}/

Delete branch in project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been deleted.

  • default – Operation failure response.

POST /project/{projectId}/workspace/

Transfer project form one workspace to another.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project has been transfered.

  • default – Operation failure response.

PUT /project/{projectId}/members/

Invite another user into project.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Invite has been sent.

  • default – Operation failure response.

DELETE /project/{projectId}/members/

Expel another user from project.

Parameters:

  • projectId (string) – Id of project.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Invite has been sent.

  • default – Operation failure response.

POST /project/{projectId}/permissions/

Update project permissions.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project permissions has been updated.

  • default – Operation failure response.

GET /project/

Get all available projects.

Query Parameters:

  • skip (integer) – Number of elements to skip during paging. Aka offset or start.

  • take (integer) – Number of elements to take during paging. Aka limit or count.

  • query (string) – Any value to search in project name.

Status Codes:

  • 200 OK – List of projects.

  • default – Operation failure response.

PUT /project/

Create new project.

Status Codes:

  • 200 OK – Created project.

  • default – Operation failure response.

GET /project/my/

Get current user’s projects.

Status Codes:

  • 200 OK – List of projects.

  • default – Operation failure response.

GET /project/{projectId}/

Get project by id.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Found Project.

  • default – Operation failure response.

POST /project/{projectId}/

Update project with new parameters.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 200 OK – Updated project.

  • default – Operation failure response.

DELETE /project/{projectId}/

Delete project and all related data.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project has been deleted.

  • default – Operation failure response.

PUT /project/{projectId}/branch/

Create branch in project.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been created.

  • default – Operation failure response.

PUT /project/{projectId}/branch/{branchName}/

Push branch content into another branch in this project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been updated.

  • default – Operation failure response.

POST /project/{projectId}/branch/{branchName}/

Updade branch in project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been updated.

  • default – Operation failure response.

DELETE /project/{projectId}/branch/{branchName}/

Delete branch in project.

Parameters:

  • branchName (string) – Name of branch.

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Branch has been deleted.

  • default – Operation failure response.

POST /project/{projectId}/workspace/

Transfer project form one workspace to another.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project has been transfered.

  • default – Operation failure response.

PUT /project/{projectId}/members/

Invite another user into project.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Invite has been sent.

  • default – Operation failure response.

DELETE /project/{projectId}/members/

Expel another user from project.

Parameters:

  • projectId (string) – Id of project.

Query Parameters:

  • memberUserId (string) – Member user id. (Required)

Status Codes:

  • 204 No Content – Invite has been sent.

  • default – Operation failure response.

POST /project/{projectId}/permissions/

Update project permissions.

Parameters:

  • projectId (string) – Id of project.

Status Codes:

  • 204 No Content – Project permissions has been updated.

  • default – Operation failure response.

Membership

GET /membership/packages/

Get all membership packages.

Status Codes:

  • 200 OK – List of all membership packages.

  • default – Operation failure response.

GET /membership/packages/

Get all membership packages.

Status Codes:

  • 200 OK – List of all membership packages.

  • default – Operation failure response.

Billing

GET /billing/{userId}/account/

Get billing account by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found billing account.

  • default – Operation failure response.

POST /billing/{userId}/account/

Update billing information

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Updated billing account.

  • default – Operation failure response.

POST /billing/{userId}/contact-request/

Request contact from sales representative.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – An contact request has been made.

  • default – Operation failure response.

GET /billing/{userId}/payment/status/

Get status of payment for subscription for workspace.

Parameters:

  • userId (string) – Id of user.

Query Parameters:

  • sessionOrInvoiceId (string) – Payment session Id or invoice Id. (Required)

Status Codes:

  • 200 OK – Status of payment session or invoice.

  • default – Operation failure response.

POST /billing/{userId}/payment/status/

Start subscription session for workspace.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Payment action response.

  • default – Operation failure response.

POST /billing/{userId}/payment/

Make payment for selected invoice.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Payment action response.

  • default – Operation failure response.

POST /billing/{userId}/payment/upcoming/

Get prorated upcoming payment information.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Upcoming payment information

  • default – Operation failure response.

POST /billing/{userId}/customer-portal/

Get url of customer portal for user if available.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Portal url or none.

  • default – Operation failure response.

POST /billing/notification/

Accept notification from payment gate.

Status Codes:

  • 204 No Content – Notification has been accepted.

  • default – Operation failure response.

GET /billing/{userId}/account/

Get billing account by id.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Found billing account.

  • default – Operation failure response.

POST /billing/{userId}/account/

Update billing information

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Updated billing account.

  • default – Operation failure response.

POST /billing/{userId}/contact-request/

Request contact from sales representative.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 204 No Content – An contact request has been made.

  • default – Operation failure response.

GET /billing/{userId}/payment/status/

Get status of payment for subscription for workspace.

Parameters:

  • userId (string) – Id of user.

Query Parameters:

  • sessionOrInvoiceId (string) – Payment session Id or invoice Id. (Required)

Status Codes:

  • 200 OK – Status of payment session or invoice.

  • default – Operation failure response.

POST /billing/{userId}/payment/status/

Start subscription session for workspace.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Payment action response.

  • default – Operation failure response.

POST /billing/{userId}/payment/

Make payment for selected invoice.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Payment action response.

  • default – Operation failure response.

POST /billing/{userId}/payment/upcoming/

Get prorated upcoming payment information.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Upcoming payment information

  • default – Operation failure response.

POST /billing/{userId}/customer-portal/

Get url of customer portal for user if available.

Parameters:

  • userId (string) – Id of user.

Status Codes:

  • 200 OK – Portal url or none.

  • default – Operation failure response.

ResourceStorage

PUT /resourceStorage/

Create resource.

Query Parameters:

  • name (string) – Filename or name of resource. (Required)

  • purpose (string) – Use purpose of resource. (Required)

  • mediaType (string) – Media type of resource.

Status Codes:

  • 200 OK – Created resource id.

  • default – Operation failure response.

GET /resourceStorage/{resourceId}/

Get resource metadata by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:

  • 200 OK – Found resource.

  • default – Operation failure response.

DELETE /resourceStorage/{resourceId}/

Delete resource by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:

  • 204 No Content – Resource has been deleted.

  • default – Operation failure response.

GET /resourceStorage/{resourceId}/data/

Get resource binary data by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:
PUT /resourceStorage/

Create resource.

Query Parameters:

  • name (string) – Filename or name of resource. (Required)

  • purpose (string) – Use purpose of resource. (Required)

  • mediaType (string) – Media type of resource.

Status Codes:

  • 200 OK – Created resource id.

  • default – Operation failure response.

GET /resourceStorage/{resourceId}/

Get resource metadata by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:

  • 200 OK – Found resource.

  • default – Operation failure response.

DELETE /resourceStorage/{resourceId}/

Delete resource by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:

  • 204 No Content – Resource has been deleted.

  • default – Operation failure response.

GET /resourceStorage/{resourceId}/data/

Get resource binary data by id.

Parameters:

  • resourceId (string) – Id of resource.

Status Codes:

Context

GET /context/

Get page context.

Query Parameters:

  • projectName (string) – Project name of current page.

  • branchName (string) – Branch name of current page.

Status Codes:

  • 200 OK – Page’s context related properties.

  • default – Operation failure response.

GET /context/

Get page context.

Query Parameters:

  • projectName (string) – Project name of current page.

  • branchName (string) – Branch name of current page.

Status Codes:

  • 200 OK – Page’s context related properties.

  • default – Operation failure response.

Notifications

GET /notification/

Subscribe on notifications from server. This is WebSocket endpoint, any non ‘Upgrade’ requests will fail.

Status Codes:
GET /notification/

Subscribe on notifications from server. This is WebSocket endpoint, any non ‘Upgrade’ requests will fail.

Status Codes:

Troubleshooting

PUT /app/log/

Log specified message on server. Used internally while standalone-hosted.

Status Codes:

  • 204 No Content – URL has been opened (or ignored).

  • default – Operation failure response.