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/

Obtain OAuth 2.0 access token

Exchange authorization credentials for an access token using the OAuth 2.0 protocol. Supports authorization code and refresh token grant types.

Status Codes:

• 200 OK – Successful token response

• 400 Bad Request – Token request failure

POST /auth/one-time-code/

Generate one-time authorization code

Generates a short-lived one-time code that can be used instead of standard authorization headers for WebSocket connections or download requests.

Status Codes:

• 200 OK – One-time code generated successfully

• default – Operation failure response.

Request Headers:

• Authorization – Standard bearer token for authentication (Required)

POST /auth/flow/password/

Initiate password authentication flow

Begins the authentication process using email and password credentials. May return intermediate authentication stages if multi-factor authentication is required.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/email-code/

Submit email verification code

Continues the authentication flow by submitting a time-based one-time password (TOTP) received via email. Requires an active authentication flow ID.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/api-key/

Initiate API key authentication flow

Begins authentication using an API key credential. Returns the next stage in the authentication flow.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/on-behalf/

Initiate on-behalf authentication (Admin only)

Allows administrators to begin an authentication flow on behalf of another user. Requires administrator privileges.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

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

Prepare OAuth 2.0 authentication URL

Generates a redirect URL to initiate OAuth 2.0 authentication with the specified provider.

Parameters:

• authenticationProvider (string) – Type of OAuth2 provider.

Status Codes:

• 200 OK – OAuth 2.0 redirect information

• default – Operation failure response.

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

Complete OAuth 2.0 authentication

Finalizes the OAuth 2.0 authentication flow after user redirection from the provider. Processes the authorization code or error response from the OAuth provider.

Parameters:

• authenticationProvider (string) – Type of OAuth2 provider.

Query Parameters:

• code (string) – Authorization code from OAuth provider

• state (string) – OAuth state parameter for CSRF protection (Required)

• error (string) – OAuth error code if authentication failed

• error_description (string) – Description of OAuth error

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /token/

Obtain OAuth 2.0 access token

Exchange authorization credentials for an access token using the OAuth 2.0 protocol. Supports authorization code and refresh token grant types.

Status Codes:

• 200 OK – Successful token response

• 400 Bad Request – Token request failure

POST /auth/one-time-code/

Generate one-time authorization code

Generates a short-lived one-time code that can be used instead of standard authorization headers for WebSocket connections or download requests.

Status Codes:

• 200 OK – One-time code generated successfully

• default – Operation failure response.

Request Headers:

• Authorization – Standard bearer token for authentication (Required)

POST /auth/flow/password/

Initiate password authentication flow

Begins the authentication process using email and password credentials. May return intermediate authentication stages if multi-factor authentication is required.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/email-code/

Submit email verification code

Continues the authentication flow by submitting a time-based one-time password (TOTP) received via email. Requires an active authentication flow ID.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/api-key/

Initiate API key authentication flow

Begins authentication using an API key credential. Returns the next stage in the authentication flow.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

POST /auth/flow/on-behalf/

Initiate on-behalf authentication (Admin only)

Allows administrators to begin an authentication flow on behalf of another user. Requires administrator privileges.

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

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

Prepare OAuth 2.0 authentication URL

Generates a redirect URL to initiate OAuth 2.0 authentication with the specified provider.

Parameters:

• authenticationProvider (string) – Type of OAuth2 provider.

Status Codes:

• 200 OK – OAuth 2.0 redirect information

• default – Operation failure response.

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

Complete OAuth 2.0 authentication

Finalizes the OAuth 2.0 authentication flow after user redirection from the provider. Processes the authorization code or error response from the OAuth provider.

Parameters:

• authenticationProvider (string) – Type of OAuth2 provider.

Query Parameters:

• code (string) – Authorization code from OAuth provider

• state (string) – OAuth state parameter for CSRF protection (Required)

• error (string) – OAuth error code if authentication failed

• error_description (string) – Description of OAuth error

Status Codes:

• 200 OK – Authentication flow stage response

• default – Operation failure response.

DataSource

PUT /datasource/{dataSourceId}/transaction/

Initiate a new data source transaction

Establishes a new transaction context with the specified data source. This operation: - Waits for data source availability (up to the specified start timeout) - Creates a transaction with the given unique identifier - Returns immediately if successful The transaction ID can be used in subsequent operations until committed or rolled back.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 204 No Content – Transaction successfully initialized and ready for operations

• default – Operation failure response.

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

Commit an active transaction

Permanently applies all changes made within the transaction scope. After successful commit, the transaction cannot be used for further operations.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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

Status Codes:

• 204 No Content – Transaction successfully committed and resources released

• default – Operation failure response.

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

Roll back an active transaction

Abandons all changes made within the transaction scope and releases resources. Can be called on already-failed transactions for cleanup.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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

Status Codes:

• 204 No Content – Transaction successfully aborted or was already in a failed state. All temporary changes have been discarded.

• default – Operation failure response.

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

Retrieve a document by ID or unique property

Fetches a single document using either its unique identifier or a specified unique property value. Returns null if no matching document is found.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• uniqueSchemaPropertyNameOrId (string) – The name of the unique property to search by (e.g., ‘Id’, ‘Name’). Can also be ‘Id’ to search by document identifier. (Required)

• uniqueSchemaPropertyValue (string) – The value of the specified unique property to match (Required)

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

Status Codes:

• 200 OK – Document found (or null if not found)

• default – Operation failure response.

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

Create a new document

Inserts a new document into the specified collection. The document will be validated according to the schema’s rules.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Successfully created document

• default – Operation failure response.

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

Update an existing document

Modifies an existing document in the collection. The entire document or only diff document could be provided with updated values.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Successfully updated document

• default – Operation failure response.

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

Delete a document by ID

Removes a document from the collection using its unique identifier. Returns the deleted document if found, otherwise returns null.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• id (string) – The unique identifier of the document to delete (Required)

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

Status Codes:

• 200 OK – Document deletion result (deleted document or null)

• default – Operation failure response.

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

Query documents with filtering and pagination

Retrieves a list of documents matching specified criteria. Supports filtering, sorting, pagination, and full-text search.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – List of matching documents

• default – Operation failure response.

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

Perform bulk document operations

Creates, updates, or deletes multiple documents in a single operation. Supports different import modes and optional dry-run validation.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

• importMode (string) – Determines how documents should be processed. (Required)

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

Status Codes:

• 200 OK – Bulk operation results

• default – Operation failure response.

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

Search across all collections

Performs a full-text search across all documents in all collections. Results are streamed as they become available using Server-Sent Events (SSE). Empty results are omitted from the stream.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• query (string) – Search term to match across all document fields. Supports partial matches and full-text search. (Required)

• limit (integer) – Maximum number of documents to return. If not specified, returns all matching documents.

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

Status Codes:

• 200 OK – Stream of search results as Server-Sent Events. Each event contains a ListResult object with matching documents.

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

Batch retrieve documents by unique identifiers

Efficiently fetches multiple documents in a single request by their unique properties. Maximum 20 documents per request. Results are returned in the same order as requested.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Array of document lookup results in the same order as requested. Each element is either the found document or null if not found.

• default – Operation failure response.

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

Convert game data to raw JSON format

Converts game data documents from various formats (XLSX, XLIF, MsgPack, BSON) directly to raw JSON output without any response wrapper.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Successfully converted raw JSON document

• default – Conversion error response

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

Export multiple collections in raw format

Exports documents from specified collections directly in downloadable formats (JSON, MsgPack, BSON, XLSX, XLIF) without any response wrapper. Supports filtering by schemas, properties and languages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Raw exported documents in requested format

• default – Export operation failure

GET /datasource/{dataSourceId}/raw/

Create raw data source backup

Generates a complete backup of the data source in raw format (JSON, MsgPack, BSON) without any response wrapper. The backup can be downloaded directly.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Raw backup data in requested format

• default – Backup operation failure

GET /datasource/{dataSourceId}/collections/

Export documents from multiple collections

Exports documents from specified collections in various formats (JSON, MsgPack, BSON, XLSX, XLIF). Supports filtering by schemas, properties, and languages. The export can be customized using different modes.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Successfully exported documents

• default – Operation failure response.

PUT /datasource/{dataSourceId}/collections/

Import documents into multiple collections

Bulk import documents into specified collections. Supports various data formats (JSON, MsgPack, BSON, XLSX, XLIF) and different import modes (create, update, upsert). Includes validation and dry-run capabilities.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Detailed import operation report

• default – Operation failure response.

GET /datasource/{dataSourceId}/

Create complete data source backup

Generates a comprehensive backup of the entire data source including all collections and documents. The backup can be exported in multiple formats (JSON, MsgPack, BSON).

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Successful backup result

• default – Operation failure response.

PUT /datasource/{dataSourceId}/

Restore data source from backup

Restores the entire data source from a previously created backup. Supports restoration from various formats (JSON, MsgPack, BSON).

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Restoration operation result

• default – Operation failure response.

POST /datasource/{dataSourceId}/validity/

Validate data source configuration

Performs comprehensive validation of the data source against specified requirements. Checks schema definitions, data integrity, and translation fullness.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Validation results including any issues found

• default – Operation failure response.

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

Check data source loading status

Retrieves the current loading progress and operational state of the data source. Useful for monitoring initialization or migration processes.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Current loading state with progress message and percentage

• default – Operation failure response.

GET /datasource/{dataSourceId}/stats/

Get data source issues statistics

Returns issue metrics about the data source including document counts and issues count.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Detailed statistical overview of the data source

• default – Operation failure response.

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

Generate data source SDK

Creates a source code SDK for the data source in the specified programming language. Supports various code generation options and optimizations. Returns a ZIP archive.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – ZIP archive containing generated source code

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

Download source code templates

Retrieves T4 templates used for source code generation. These templates can be customized for specialized SDK generation.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – ZIP archive containing template files

PUT /datasource/{dataSourceId}/transaction/

Initiate a new data source transaction

Establishes a new transaction context with the specified data source. This operation: - Waits for data source availability (up to the specified start timeout) - Creates a transaction with the given unique identifier - Returns immediately if successful The transaction ID can be used in subsequent operations until committed or rolled back.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 204 No Content – Transaction successfully initialized and ready for operations

• default – Operation failure response.

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

Commit an active transaction

Permanently applies all changes made within the transaction scope. After successful commit, the transaction cannot be used for further operations.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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

Status Codes:

• 204 No Content – Transaction successfully committed and resources released

• default – Operation failure response.

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

Roll back an active transaction

Abandons all changes made within the transaction scope and releases resources. Can be called on already-failed transactions for cleanup.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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

Status Codes:

• 204 No Content – Transaction successfully aborted or was already in a failed state. All temporary changes have been discarded.

• default – Operation failure response.

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

Retrieve a document by ID or unique property

Fetches a single document using either its unique identifier or a specified unique property value. Returns null if no matching document is found.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• uniqueSchemaPropertyNameOrId (string) – The name of the unique property to search by (e.g., ‘Id’, ‘Name’). Can also be ‘Id’ to search by document identifier. (Required)

• uniqueSchemaPropertyValue (string) – The value of the specified unique property to match (Required)

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

Status Codes:

• 200 OK – Document found (or null if not found)

• default – Operation failure response.

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

Create a new document

Inserts a new document into the specified collection. The document will be validated according to the schema’s rules.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Successfully created document

• default – Operation failure response.

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

Update an existing document

Modifies an existing document in the collection. The entire document or only diff document could be provided with updated values.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Successfully updated document

• default – Operation failure response.

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

Delete a document by ID

Removes a document from the collection using its unique identifier. Returns the deleted document if found, otherwise returns null.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• id (string) – The unique identifier of the document to delete (Required)

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

Status Codes:

• 200 OK – Document deletion result (deleted document or null)

• default – Operation failure response.

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

Query documents with filtering and pagination

Retrieves a list of documents matching specified criteria. Supports filtering, sorting, pagination, and full-text search.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – List of matching documents

• default – Operation failure response.

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

Perform bulk document operations

Creates, updates, or deletes multiple documents in a single operation. Supports different import modes and optional dry-run validation.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

• importMode (string) – Determines how documents should be processed. (Required)

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

Status Codes:

• 200 OK – Bulk operation results

• default – Operation failure response.

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

Search across all collections

Performs a full-text search across all documents in all collections. Results are streamed as they become available using Server-Sent Events (SSE). Empty results are omitted from the stream.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• query (string) – Search term to match across all document fields. Supports partial matches and full-text search. (Required)

• limit (integer) – Maximum number of documents to return. If not specified, returns all matching documents.

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

Status Codes:

• 200 OK – Stream of search results as Server-Sent Events. Each event contains a ListResult object with matching documents.

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

Batch retrieve documents by unique identifiers

Efficiently fetches multiple documents in a single request by their unique properties. Maximum 20 documents per request. Results are returned in the same order as requested.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Array of document lookup results in the same order as requested. Each element is either the found document or null if not found.

• default – Operation failure response.

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

Convert game data to raw JSON format

Converts game data documents from various formats (XLSX, XLIF, MsgPack, BSON) directly to raw JSON output without any response wrapper.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Successfully converted raw JSON document

• default – Conversion error response

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

Export multiple collections in raw format

Exports documents from specified collections directly in downloadable formats (JSON, MsgPack, BSON, XLSX, XLIF) without any response wrapper. Supports filtering by schemas, properties and languages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Raw exported documents in requested format

• default – Export operation failure

GET /datasource/{dataSourceId}/raw/

Create raw data source backup

Generates a complete backup of the data source in raw format (JSON, MsgPack, BSON) without any response wrapper. The backup can be downloaded directly.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Raw backup data in requested format

• default – Backup operation failure

GET /datasource/{dataSourceId}/collections/

Export documents from multiple collections

Exports documents from specified collections in various formats (JSON, MsgPack, BSON, XLSX, XLIF). Supports filtering by schemas, properties, and languages. The export can be customized using different modes.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Successfully exported documents

• default – Operation failure response.

PUT /datasource/{dataSourceId}/collections/

Import documents into multiple collections

Bulk import documents into specified collections. Supports various data formats (JSON, MsgPack, BSON, XLSX, XLIF) and different import modes (create, update, upsert). Includes validation and dry-run capabilities.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Detailed import operation report

• default – Operation failure response.

GET /datasource/{dataSourceId}/

Create complete data source backup

Generates a comprehensive backup of the entire data source including all collections and documents. The backup can be exported in multiple formats (JSON, MsgPack, BSON).

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Successful backup result

• default – Operation failure response.

PUT /datasource/{dataSourceId}/

Restore data source from backup

Restores the entire data source from a previously created backup. Supports restoration from various formats (JSON, MsgPack, BSON).

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Restoration operation result

• default – Operation failure response.

POST /datasource/{dataSourceId}/validity/

Validate data source configuration

Performs comprehensive validation of the data source against specified requirements. Checks schema definitions, data integrity, and translation fullness.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

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

Status Codes:

• 200 OK – Validation results including any issues found

• default – Operation failure response.

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

Check data source loading status

Retrieves the current loading progress and operational state of the data source. Useful for monitoring initialization or migration processes.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Current loading state with progress message and percentage

• default – Operation failure response.

GET /datasource/{dataSourceId}/stats/

Get data source issues statistics

Returns issue metrics about the data source including document counts and issues count.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Detailed statistical overview of the data source

• default – Operation failure response.

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

Generate data source SDK

Creates a source code SDK for the data source in the specified programming language. Supports various code generation options and optimizations. Returns a ZIP archive.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – ZIP archive containing generated source code

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

Download source code templates

Retrieves T4 templates used for source code generation. These templates can be customized for specialized SDK generation.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – ZIP archive containing template files

DataSourceCapabilities

GET /datasource/{dataSourceId}/capabilities/

Retrieve data source capabilities

Returns the supported features and limitations of the data source, including supported query operations, indexing capabilities, and schema features.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Complete capability profile of the data source

• default – Operation failure response.

GET /datasource/{dataSourceId}/capabilities/

Retrieve data source capabilities

Returns the supported features and limitations of the data source, including supported query operations, indexing capabilities, and schema features.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Complete capability profile of the data source

• default – Operation failure response.

UserPresence

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

Get active users in data source

Retrieves a list of users currently active in the specified data source, including their presence status and user identifiers.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Array of user presence records

• default – Operation failure response.

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

Get active users in data source

Retrieves a list of users currently active in the specified data source, including their presence status and user identifiers.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Array of user presence records

• default – Operation failure response.

Processes

GET /datasource/{dataSourceId}/process/

List all processes

Retrieves a paginated list of both running and completed processes with their current states.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Paginated list of processes with their states

• default – Operation failure response.

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

Get process details

Retrieves the complete state information for a specific process.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Detailed state of the requested process

• default – Operation failure response.

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

Terminate a running process

Gracefully stops a currently running process with the specified reason.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• stopReason (string) – Reason for process termination (e.g., ‘user_request’, ‘maintenance’) (Required)

Status Codes:

• 200 OK – Final state of the stopped process

• default – Operation failure response.

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

Get raw process results

Retrieves the direct output of a completed process without standard response formatting.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Raw process output in its native format

GET /datasource/{dataSourceId}/process/

List all processes

Retrieves a paginated list of both running and completed processes with their current states.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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 – Paginated list of processes with their states

• default – Operation failure response.

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

Get process details

Retrieves the complete state information for a specific process.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – Detailed state of the requested process

• default – Operation failure response.

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

Terminate a running process

Gracefully stops a currently running process with the specified reason.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• stopReason (string) – Reason for process termination (e.g., ‘user_request’, ‘maintenance’) (Required)

Status Codes:

• 200 OK – Final state of the stopped process

• default – Operation failure response.

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

Get raw process results

Retrieves the direct output of a completed process without standard response formatting.

Parameters:

• processId (integer) – Id of process.

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

Status Codes:

• 200 OK – Raw process output in its native format

Formulas

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

List available formula types

Retrieves a paginated list of formula types/classes that can be used in game data formulas. Supports filtering by type name and pagination.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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) – Search term for filtering types. Can be: - Exact type name (e.g., “DateTime”) - Type alias (e.g. int, long) - Partial name (e.g., “Date”) - Capital letters (e.g., “DT” for “DateTime”)

Status Codes:

• 200 OK – Paginated list of matching formula types

• default – Operation failure response.

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

List available formula types

Retrieves a paginated list of formula types/classes that can be used in game data formulas. Supports filtering by type name and pagination.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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) – Search term for filtering types. Can be: - Exact type name (e.g., “DateTime”) - Type alias (e.g. int, long) - Partial name (e.g., “Date”) - Capital letters (e.g., “DT” for “DateTime”)

Status Codes:

• 200 OK – Paginated list of matching formula types

• default – Operation failure response.

Assets

GET /datasource/{dataSourceId}/assets/

List available assets

Retrieves a paginated list of assets available in the project that can be referenced from game data. Supports filtering by asset type and name, with pagination.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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) – Search term to filter asset names (empty returns all)

• types (array) – Filter by specific asset types (empty returns all)

Status Codes:

• 200 OK – Paginated list of matching assets

• default – Operation failure response.

GET /datasource/{dataSourceId}/assets/thumbnail/{path}

Get asset thumbnail

Retrieves a thumbnail image (PNG format) for the specified asset. The asset can be identified by various methods including path, unique ID, or numeric ID.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• path (string) – Captured rest of the path.

Query Parameters:

• size (integer) – Preferred thumbnail dimensions (width x height in pixels)

Status Codes:

• 200 OK – PNG thumbnail image of the requested asset

GET /datasource/{dataSourceId}/assets/

List available assets

Retrieves a paginated list of assets available in the project that can be referenced from game data. Supports filtering by asset type and name, with pagination.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

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) – Search term to filter asset names (empty returns all)

• types (array) – Filter by specific asset types (empty returns all)

Status Codes:

• 200 OK – Paginated list of matching assets

• default – Operation failure response.

GET /datasource/{dataSourceId}/assets/thumbnail/{path}

Get asset thumbnail

Retrieves a thumbnail image (PNG format) for the specified asset. The asset can be identified by various methods including path, unique ID, or numeric ID.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• path (string) – Captured rest of the path.

Query Parameters:

• size (integer) – Preferred thumbnail dimensions (width x height in pixels)

Status Codes:

• 200 OK – PNG thumbnail image of the requested asset

AiCompletion

POST /datasource/{dataSourceId}/completion/schema/

Generate schema design suggestions using AI

Uses AI to propose a game data schema structure based on provided context and requirements.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – AI-generated schema suggestions in natural language

• default – Operation failure response.

POST /datasource/{dataSourceId}/completion/schema/icon/

Generate icon suggestions for a schema

Uses AI to recommend appropriate icons for a given schema based on its name and description.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• iconSet (string) – Preferred icon set to use (e.g., ‘material’, ‘fugue’) (Required)

• schemaName (string) – Name of the schema needing an icon (Required)

• schemaDescription (string) – Optional description to help icon selection

Status Codes:

• 200 OK – AI-generated icon suggestions

• default – Operation failure response.

POST /datasource/{dataSourceId}/completion/thread/{threadId}/

Continue an AI conversation thread

Sends a new message to an existing AI chat thread and gets the AI’s response.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• threadId (string) – Id of AI chat thread.

Status Codes:

• 200 OK – AI’s response in the conversation

• default – Operation failure response.

DELETE /datasource/{dataSourceId}/completion/thread/{threadId}/

Delete an AI conversation thread

Permanently removes the specified chat thread and all its messages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• threadId (string) – Id of AI chat thread.

Status Codes:

• 204 No Content – Thread was successfully deleted

• default – Operation failure response.

POST /datasource/{dataSourceId}/completion/schema/

Generate schema design suggestions using AI

Uses AI to propose a game data schema structure based on provided context and requirements.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 200 OK – AI-generated schema suggestions in natural language

• default – Operation failure response.

POST /datasource/{dataSourceId}/completion/schema/icon/

Generate icon suggestions for a schema

Uses AI to recommend appropriate icons for a given schema based on its name and description.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• iconSet (string) – Preferred icon set to use (e.g., ‘material’, ‘fugue’) (Required)

• schemaName (string) – Name of the schema needing an icon (Required)

• schemaDescription (string) – Optional description to help icon selection

Status Codes:

• 200 OK – AI-generated icon suggestions

• default – Operation failure response.

POST /datasource/{dataSourceId}/completion/thread/{threadId}/

Continue an AI conversation thread

Sends a new message to an existing AI chat thread and gets the AI’s response.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• threadId (string) – Id of AI chat thread.

Status Codes:

• 200 OK – AI’s response in the conversation

• default – Operation failure response.

DELETE /datasource/{dataSourceId}/completion/thread/{threadId}/

Delete an AI conversation thread

Permanently removes the specified chat thread and all its messages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• threadId (string) – Id of AI chat thread.

Status Codes:

• 204 No Content – Thread was successfully deleted

• default – Operation failure response.

MachineTranslation

POST /datasource/{dataSourceId}/translation/

Initiate bulk translation

Starts asynchronous translation of game data across multiple schemas and languages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• 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.

• translationMode (string) – Translation mode. (Required)

Status Codes:

• 202 Accepted – Translation job was successfully queued

• default – Operation failure response.

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

Translate a single document

Synchronously translates a specific document between the specified languages.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

• translationMode (string) – Translation mode. (Required)

Status Codes:

• 200 OK – The translated document

• default – Operation failure response.

POST /datasource/{dataSourceId}/translation/

Initiate bulk translation

Starts asynchronous translation of game data across multiple schemas and languages.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

• 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.

• translationMode (string) – Translation mode. (Required)

Status Codes:

• 202 Accepted – Translation job was successfully queued

• default – Operation failure response.

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

Translate a single document

Synchronously translates a specific document between the specified languages.

Parameters:

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

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Query Parameters:

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

• translationMode (string) – Translation mode. (Required)

Status Codes:

• 200 OK – The translated document

• default – Operation failure response.

UiExtensions

GET /datasource/{dataSourceId}/extensions/content/{packageNameAndPath}

Get a specific file from an NPM package

Retrieves a file from the specified NPM package. The response content type is automatically determined by the file extension.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• packageNameAndPath (string) – The NPM package name and relative path to the file within the package. Format: package-name/path/to/file

Status Codes:

• 200 OK – The requested file content

GET /datasource/{dataSourceId}/extensions/status/{packageName}

Get or initiate package loading status

Retrieves the loading status of an NPM package. If the package isn’t currently loading, this request will initiate the loading process. Returns a stream of status updates.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• packageName (string) – The name of the NPM package to check or load

Status Codes:

• 200 OK – Server-Sent Events stream of package loading status updates

POST /datasource/{dataSourceId}/extensions/updates

Check for UI extension package updates

Verifies if newer versions are available for installed NPM packages used in UI extensions. Behavior notes: - Automatically reloads any stale/outdated packages - Skips packages that are currently in the process of loading - Returns immediately after initiating the check (operation is asynchronous)

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 202 Accepted – Update check initiated successfully. Note: This only indicates the request was accepted, not that updates were found.

• default – Operation failure response.

GET /datasource/{dataSourceId}/extensions/content/{packageNameAndPath}

Get a specific file from an NPM package

Retrieves a file from the specified NPM package. The response content type is automatically determined by the file extension.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• packageNameAndPath (string) – The NPM package name and relative path to the file within the package. Format: package-name/path/to/file

Status Codes:

• 200 OK – The requested file content

GET /datasource/{dataSourceId}/extensions/status/{packageName}

Get or initiate package loading status

Retrieves the loading status of an NPM package. If the package isn’t currently loading, this request will initiate the loading process. Returns a stream of status updates.

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

• packageName (string) – The name of the NPM package to check or load

Status Codes:

• 200 OK – Server-Sent Events stream of package loading status updates

POST /datasource/{dataSourceId}/extensions/updates

Check for UI extension package updates

Verifies if newer versions are available for installed NPM packages used in UI extensions. Behavior notes: - Automatically reloads any stale/outdated packages - Skips packages that are currently in the process of loading - Returns immediately after initiating the check (operation is asynchronous)

Parameters:

• dataSourceId (string) – Id of data source. Usually it is a branchId from one of branches from Project.

Status Codes:

• 202 Accepted – Update check initiated successfully. Note: This only indicates the request was accepted, not that updates were found.

• default – Operation failure response.

Preferences

GET /project/{projectId}/preferences/

Get project team-shared preferences.

Parameters:

• projectId (string) – Id of project. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

Status Codes:

• 204 No Content – Patch has been applied.

• 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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

Status Codes:

• 204 No Content – Patch has been applied.

• 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. Project are located within workspace.

Status Codes:

• 200 OK – Found Project.

• default – Operation failure response.

POST /project/{projectId}/

Update project with new parameters.

Parameters:

• projectId (string) – Id of project. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

Status Codes:

• 204 No Content – Branch has been updated.

• default – Operation failure response.

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

Update branch in project.

Parameters:

• branchName (string) – Name of branch. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

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. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

Status Codes:

• 200 OK – Found Project.

• default – Operation failure response.

POST /project/{projectId}/

Update project with new parameters.

Parameters:

• projectId (string) – Id of project. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

Status Codes:

• 204 No Content – Branch has been updated.

• default – Operation failure response.

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

Update branch in project.

Parameters:

• branchName (string) – Name of branch. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

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. Branches are located inside Project.

• projectId (string) – Id of project. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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. Project are located within workspace.

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.

Search

POST /search/

Search for users, projects, workspaces by specified keyword.

Status Codes:

• 200 OK – Search result with found search items.

• default – Operation failure response.

POST /search/

Search for users, projects, workspaces by specified keyword.

Status Codes:

• 200 OK – Search result with found search items.

• 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:

• 200 OK – Found resource.

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:

• 200 OK – Found resource.

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:

• 101 Switching Protocols – WebSocket upgrade were sucessful.

GET /notification/

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

Status Codes:

• 101 Switching Protocols – WebSocket upgrade were sucessful.

Troubleshooting

PUT /app/log/

Submit client-side log message to server

Records a client-generated log message on the server. Primarily used for debugging purposes in standalone-hosted environments where direct client logging is not available. The server may store or process these logs for troubleshooting and monitoring.

Status Codes:

• 204 No Content – Log message was successfully received (though may not necessarily be persisted, depending on server configuration)

• default – Operation failure response.