Import Results

Additional information about finished import jobs

List the errors of a finished import job

get

Returns a list of errors of a finished import job with the specified ID. By default the maximum number of results is limited to 1000.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

jobIdstring · uuidRequired

The ID of the job

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

Responses

200

Import errors paged response

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

400

Import job is not finished

404

Import job not found

get/import/results/{jobId}/errors

HTTPcURLJavaScriptPython

GET /rest/2.0/import/results/{jobId}/errors HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "errorType": "VALIDATION",
      "resourceType": "COMMUNITY",
      "errorMessage": "text",
      "command": {
        "indices": [
          1
        ],
        "identifier": "text"
      }
    }
  ]
}

Retrieve a summary of a finished import job

get

Returns details about a finished import job with the specified ID such as the total number of resources and types of resources that were added, removed or updated and the number of errors.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

jobIdstring · uuidRequired

The ID of the job

Responses

200

Import job summary

application/json

A summary of the import.

errorsCountinteger · int32Optional

The total number of errors the occurred during the import.

importJobStatestring · enumOptional

Import job state.

Possible values:

400

Import job is not finished

404

Import job not found

get/import/results/{jobId}/summary

HTTPcURLJavaScriptPython

GET /rest/2.0/import/results/{jobId}/summary HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "resourceTypes": [
    {
      "resourceType": "COMMUNITY",
      "counters": {
        "added": 1,
        "removed": 1,
        "updated": 1
      },
      "subcategories": [
        {
          "category": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          },
          "counters": {
            "added": 1,
            "removed": 1,
            "updated": 1
          }
        }
      ]
    }
  ],
  "errorsCount": 1,
  "importJobState": "COMPLETED"
}