API description #

This page contains descriptions of all APIs available inMetaCroc. Technical information is available in swagger.

In all URLs, it is necessary to replace [tenant] by your tenant name.

Get Object Types #

GET /api/object-type

This API returns a list of Object Types from Settings.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/getObjectTypes

Get a list of all elements #

GET /api/system/{name}/tree

API returns a list of all elements from a selected system. System name is a parameter in URL. A part of response is element id necessary for other APIs.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/getTree

Get a single element metadata #

GET /api/structure/{id}

API returns a string with information about the selected element. Id of the element is a part of URL.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/getStructure

Get a table data #

GET /api/table/{tableId}

API returns a string with information about the selected table. Id of the element is a part of URL, response contains JSON with the table data.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/getTable

Generation of output scripts #

Generic scripts generation #

Start task POST /api/structure/export

Asynchronous API that performs a batch scripts generation. The response contains identification of asynchronous task.

swagger: `https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/structureMassExportAsync

Get task status GET /api/structure/export/{taskId}

This API returns status of the asynchronous task.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/structureMassExportAsyncStatus`

Get task result GET /api/structure/export/{taskId}/result

When asynchronous task is finished, this API returns result file.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/structureMassExportAsyncResult

This API will be available together with the new version. See release notes.

A single element script generation #

POST /api/structure/{id}/export/{objectTypeId}

A single element script generation API. Both parameters are a part of URL.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/externalExportStructure

Deployment confirmation #

POST /api/structure/{id}/deploy/{deploymentId}

Confirmation of element deployment.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/deployStructure

POST /api/structure/deployed

Confirmation of element deployment by info file generated during Push to Git action.

swagger: https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/confirmStructureDeployment

Update table #

PUT /api/table/{tableId}

Update table metadata.

swagger: `https://[tenant].metacroc.com/api/mdd-backend/swagger-ui/index.html#/API/tableUpdate'

This API replaces the table metadata by input JSON content. If you want to update a single attribute only, first read table data and then prepare full data set with all (even unchanged) attributes.

More information how to work with API, tokens, etc. is available in API how-to.