Query the Developer Portal from Claude, Codex, Cursor, or VS Code!
Connect with MCP
Ctrlk
Collibra sitesRequest a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jobs

Job endpoints provide the ability to retrieve job progress.

Find jobs

get

Returns jobs matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters
nameMatchModestring · enumOptional

The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

Default: ANYWHEREExample: EXACTPossible values:
namestringOptional

The name of the job to search for.

Example: Sample job
typestring[]Optional

The list of types of the jobs.

Example: IMPORT
userstring · uuidOptional

The ID of the user who created the searched job.

Example: 387ca4ee-d48c-4902-b887-9cbfe11f4dac
sortFieldstring · enumOptional

The field that should be used as reference for sorting, in addition to the CREATED_ON field in DESC order.

Example: NAMEPossible values:
sortOrderstring · enumOptional

The order of sorting.

Default: DESCExample: ASCPossible values:
cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If this parameter is missing, the API returns the resources starting from the first available resource, at index 0.

pageSizeinteger · min: 1 · max: 50Optional

The maximum number of resources to retrieve.

If not set, the default limit of 10 is be used. The maximum value for this parameter is 50.

Default: 10
Responses
200

The paged response with jobs matching filter criteria

application/json
nextCursorstringOptional

The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.

Example: Y3Vyc29yV2hLblRoZXJlSXNNb3JlRGF0YQo
get/jobs
GET /rest/jobs/v1/jobs HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "nextCursor": "Y3Vyc29yV2hLblRoZXJlSXNNb3JlRGF0YQo",
  "results": [
    {
      "id": "495756bd-419c-4fea-beb4-8a70253d8079",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": "2017-07-21T17:32:28Z",
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": "2017-07-21T17:32:28Z",
      "user": "387ca4ee-d48c-4902-b887-9cbfe11f4dac",
      "selfManaged": false,
      "endDate": "2017-07-21T17:32:28Z",
      "message": "Import finished in 12s.",
      "name": "Sample job.",
      "progressPercentage": 50,
      "result": "SUCCESS",
      "startDate": "2017-07-21T17:32:28Z",
      "state": "COMPLETED",
      "type": "SAMPLE"
    },
    {
      "id": "495756bd-419c-4fea-beb4-8a70253d8079",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": "2017-07-21T17:32:28Z",
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": "2017-07-21T17:32:28Z",
      "user": "387ca4ee-d48c-4902-b887-9cbfe11f4dac",
      "selfManaged": false,
      "endDate": "2017-07-21T17:32:28Z",
      "message": "Import finished in 12s.",
      "name": "Sample job.",
      "progressPercentage": 50,
      "result": "SUCCESS",
      "startDate": "2017-07-21T17:32:28Z",
      "state": "COMPLETED",
      "type": "SAMPLE"
    }
  ]
}

Get Job.

get

Retrieves the Job identified by the given UUID.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobIdstring · uuidRequired

The ID of the job.

Example: 387ca4ee-d48c-4902-b887-9cbfe11f4dac
Responses
200

Job found.

application/json
idstring · uuidRequired

The UUID of the represented object (entity).

Example: 495756bd-419c-4fea-beb4-8a70253d8079
createdBystring · uuidOptional

The UUID of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb
createdOnstring · date-timeOptional

Date and time the job was created on.

Example: 2017-07-21T17:32:28Z
lastModifiedBystring · uuidOptional

The UUID of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe
lastModifiedOnstring · date-timeOptional

Date and time the job was modified on.

Example: 2017-07-21T17:32:28Z
userstring · uuidOptional

The UUID of the user that initiated this job.

Example: 387ca4ee-d48c-4902-b887-9cbfe11f4dac
selfManagedbooleanOptional

Whether this is a self managed job, processed outside of DG.

Default: falseExample: false
endDatestring · date-timeOptional

Date and time the job was ended on.

Example: 2017-07-21T17:32:28Z
messagestringOptional

The message of the job.

Example: Import finished in 12s.
namestringOptional

The name of the job.

Example: Sample job.
progressPercentageinteger · int32Optional

The progress percentage of the job.

Example: 50
resultstringOptional

The result of the job.

Possible values are:

  • NOT_SET
  • SUCCESS
  • COMPLETED_WITH_ERROR
  • FAILURE
  • ABORTED
Example: SUCCESS
startDatestring · date-timeOptional

Date and time the job was started on.

Example: 2017-07-21T17:32:28Z
statestringOptional

The state of the job.

Possible values are:

  • WAITING — The job has been created but is not yet executing. It is either queued for a worker, scheduled to start at a future time, or blocked waiting on another job to finish. This is the initial state for newly created jobs.
  • RUNNING — A worker is actively executing the job.
  • COMPLETED — Terminal state. The job finished its work. Completion does not imply business success; the accompanying job result indicates whether the outcome was a success or a failure.
  • FAILED — Terminal state. The job execution threw an exception that was not (or could not be) retried.
  • DELETED — Terminal state. The job was cancelled or removed, either by a user via the API or by the system.
  • NOT_APPLICABLE — Terminal state. The job's work is no longer relevant and it will not run (e.g. a continuation job whose parent finished in a state that makes the child meaningless). This state is set by the system only and cannot be set by clients via the API.
Example: COMPLETED
typestringOptional

The type of the job.

Example: SAMPLE
get/jobs/{jobId}
GET /rest/jobs/v1/jobs/{jobId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "495756bd-419c-4fea-beb4-8a70253d8079",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": "2017-07-21T17:32:28Z",
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": "2017-07-21T17:32:28Z",
  "user": "387ca4ee-d48c-4902-b887-9cbfe11f4dac",
  "selfManaged": false,
  "endDate": "2017-07-21T17:32:28Z",
  "message": "Import finished in 12s.",
  "name": "Sample job.",
  "progressPercentage": 50,
  "result": "SUCCESS",
  "startDate": "2017-07-21T17:32:28Z",
  "state": "COMPLETED",
  "type": "SAMPLE"
}

Soft delete Job.

delete

Soft deletes the Job identified by the given UUID. Users can delete their own jobs and Admins can delete any job.

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobIdstring · uuidRequired

The ID of the job.

Example: 387ca4ee-d48c-4902-b887-9cbfe11f4dac
Query parameters
messagestring · max: 128Optional

An optional message for the job deletion.

Default: Deleted by user
Body
messagestringOptional

The message of the job.

Example: Import finished in 12s.
Responses
204

Job successfully deleted.

No content
delete/jobs/{jobId}
DELETE /rest/jobs/v1/jobs/{jobId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

No content
PreviousJob REST API (Version 1)
NextModels

Last updated

Was this helpful?