latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

entities-version-control-controller

Get version create request status (getVersionCreateRequestStatus)

Returns the status of previously made version create request.

This status contains following properties:

  • done - whether request processing is finished;
  • version - created version info: timestamp, version id (commit hash), commit name and commit author;
  • added - count of items that were created in the remote repo;
  • modified - modified items count;
  • removed - removed items count;
  • error - error message, if an error occurred while handling the request.

An example of successful status:

{
  "done": true,
  "added": 10,
  "modified": 2,
  "removed": 5,
  "version": {
    "timestamp": 1655198528000,
    "id":"8a834dd389ed80e0759ba8ee338b3f1fd160a114",
    "name": "My devices v2.0",
    "author": "John Doe"
  },
  "error": null
}

Available for users with 'TENANT_ADMIN' authority.

get/api/entities/vc/version/{requestId}/status

Path parameters

requestIdstring uuid required

A string value representing the version control request id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

addedinteger
modifiedinteger
removedinteger
errorstring
doneboolean