Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

entities-version-control-controller

Get version load request status (getVersionLoadRequestStatus)

Returns the status of previously made version load request. The structure contains following parameters:

  • done - if the request was successfully processed;
  • result - a list of load results for each entity type:
    • created - created entities count;
    • updated - updated entities count;
    • deleted - removed entities count.
  • error - if an error occurred during processing, error info:
    • type - error type;
    • source - an external id of remote entity;
    • target - if failed to find referenced entity by external id - this external id;
    • message - error message.

An example of successfully processed request status:

{
  "done": true,
  "result": [
    {
      "entityType": "DEVICE",
      "created": 10,
      "updated": 5,
      "deleted": 5
    },
     {
      "entityType": "ASSET",
      "created": 4,
      "updated": 0,
      "deleted": 8
    }
  ]
}

Available for users with 'TENANT_ADMIN' authority.

get/api/entities/vc/entity/{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

doneboolean

Example response

{
  "error": {
    "source": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "DEVICE"
    },
    "target": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "DEVICE"
    }
  }
}