> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/job/models.md).

# Models

## The JobDelete object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobDelete":{"allOf":[{"$ref":"#/components/schemas/JobMessage"}],"deprecated":true,"description":"(Deprecated) Represents a body for delete job. Use the message query parameter instead. Deprecated, will be removed in 2026.06."},"JobMessage":{"properties":{"message":{"description":"The message of the job.","type":"string"}},"type":"object"}}}}
```

## The JobPagedResponse object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobPagedResponse":{"properties":{"nextCursor":{"description":"The cursor pointing to the next page. If the cursor is missing,  there are no additional pages of resources available after the current one.","type":"string"},"results":{"description":"The list of results.","items":{"$ref":"#/components/schemas/Job"},"type":"array"}},"type":"object"},"Job":{"allOf":[{"properties":{"id":{"description":"The UUID of the represented object (entity).","format":"uuid","type":"string"},"createdBy":{"description":"The UUID of the user that created this resource.","format":"uuid","type":"string"},"createdOn":{"description":"Date and time the job was created on.","format":"date-time","type":"string"},"lastModifiedBy":{"description":"The UUID of the user who modified this resource the last time.","format":"uuid","type":"string"},"lastModifiedOn":{"description":"Date and time the job was modified on.","format":"date-time","type":"string"},"user":{"description":"The UUID of the user that initiated this job.","format":"uuid","type":"string"},"selfManaged":{"default":false,"description":"Whether this is a self managed job, processed outside of DG.","type":"boolean"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/JobEndDate"},{"$ref":"#/components/schemas/JobMessage"},{"$ref":"#/components/schemas/JobName"},{"$ref":"#/components/schemas/JobProgressPercentage"},{"$ref":"#/components/schemas/JobResult"},{"$ref":"#/components/schemas/JobStartDate"},{"$ref":"#/components/schemas/JobState"},{"$ref":"#/components/schemas/JobType"}],"description":"Represents a job."},"JobEndDate":{"properties":{"endDate":{"description":"Date and time the job was ended on.","format":"date-time","type":"string"}},"type":"object"},"JobMessage":{"properties":{"message":{"description":"The message of the job.","type":"string"}},"type":"object"},"JobName":{"properties":{"name":{"description":"The name of the job.","type":"string"}},"type":"object"},"JobProgressPercentage":{"properties":{"progressPercentage":{"description":"The progress percentage of the job.","format":"int32","type":"integer"}},"type":"object"},"JobResult":{"properties":{"result":{"description":"The result of the job.\n\nPossible values are:\n  * NOT_SET\n  * SUCCESS\n  * COMPLETED_WITH_ERROR\n  * FAILURE\n  * ABORTED\n","type":"string"}},"type":"object"},"JobStartDate":{"properties":{"startDate":{"description":"Date and time the job was started on.","format":"date-time","type":"string"}},"type":"object"},"JobState":{"properties":{"state":{"description":"The state of the job.\n\nPossible values are:\n  * `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.\n  * `RUNNING` — A worker is actively executing the job.\n  * `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.\n  * `FAILED` — Terminal state. The job execution threw an exception that was not (or could not be) retried.\n  * `DELETED` — Terminal state. The job was cancelled or removed, either by a user via the API or by the system.\n  * `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.\n","type":"string"}},"type":"object"},"JobType":{"properties":{"type":{"description":"The type of the job.","type":"string"}},"type":"object"}}}}
```

## The Job object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"Job":{"allOf":[{"properties":{"id":{"description":"The UUID of the represented object (entity).","format":"uuid","type":"string"},"createdBy":{"description":"The UUID of the user that created this resource.","format":"uuid","type":"string"},"createdOn":{"description":"Date and time the job was created on.","format":"date-time","type":"string"},"lastModifiedBy":{"description":"The UUID of the user who modified this resource the last time.","format":"uuid","type":"string"},"lastModifiedOn":{"description":"Date and time the job was modified on.","format":"date-time","type":"string"},"user":{"description":"The UUID of the user that initiated this job.","format":"uuid","type":"string"},"selfManaged":{"default":false,"description":"Whether this is a self managed job, processed outside of DG.","type":"boolean"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/JobEndDate"},{"$ref":"#/components/schemas/JobMessage"},{"$ref":"#/components/schemas/JobName"},{"$ref":"#/components/schemas/JobProgressPercentage"},{"$ref":"#/components/schemas/JobResult"},{"$ref":"#/components/schemas/JobStartDate"},{"$ref":"#/components/schemas/JobState"},{"$ref":"#/components/schemas/JobType"}],"description":"Represents a job."},"JobEndDate":{"properties":{"endDate":{"description":"Date and time the job was ended on.","format":"date-time","type":"string"}},"type":"object"},"JobMessage":{"properties":{"message":{"description":"The message of the job.","type":"string"}},"type":"object"},"JobName":{"properties":{"name":{"description":"The name of the job.","type":"string"}},"type":"object"},"JobProgressPercentage":{"properties":{"progressPercentage":{"description":"The progress percentage of the job.","format":"int32","type":"integer"}},"type":"object"},"JobResult":{"properties":{"result":{"description":"The result of the job.\n\nPossible values are:\n  * NOT_SET\n  * SUCCESS\n  * COMPLETED_WITH_ERROR\n  * FAILURE\n  * ABORTED\n","type":"string"}},"type":"object"},"JobStartDate":{"properties":{"startDate":{"description":"Date and time the job was started on.","format":"date-time","type":"string"}},"type":"object"},"JobState":{"properties":{"state":{"description":"The state of the job.\n\nPossible values are:\n  * `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.\n  * `RUNNING` — A worker is actively executing the job.\n  * `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.\n  * `FAILED` — Terminal state. The job execution threw an exception that was not (or could not be) retried.\n  * `DELETED` — Terminal state. The job was cancelled or removed, either by a user via the API or by the system.\n  * `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.\n","type":"string"}},"type":"object"},"JobType":{"properties":{"type":{"description":"The type of the job.","type":"string"}},"type":"object"}}}}
```

## The JobEndDate object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobEndDate":{"properties":{"endDate":{"description":"Date and time the job was ended on.","format":"date-time","type":"string"}},"type":"object"}}}}
```

## The JobMessage object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobMessage":{"properties":{"message":{"description":"The message of the job.","type":"string"}},"type":"object"}}}}
```

## The JobName object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobName":{"properties":{"name":{"description":"The name of the job.","type":"string"}},"type":"object"}}}}
```

## The JobProgressPercentage object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobProgressPercentage":{"properties":{"progressPercentage":{"description":"The progress percentage of the job.","format":"int32","type":"integer"}},"type":"object"}}}}
```

## The JobResult object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobResult":{"properties":{"result":{"description":"The result of the job.\n\nPossible values are:\n  * NOT_SET\n  * SUCCESS\n  * COMPLETED_WITH_ERROR\n  * FAILURE\n  * ABORTED\n","type":"string"}},"type":"object"}}}}
```

## The JobStartDate object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobStartDate":{"properties":{"startDate":{"description":"Date and time the job was started on.","format":"date-time","type":"string"}},"type":"object"}}}}
```

## The JobState object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobState":{"properties":{"state":{"description":"The state of the job.\n\nPossible values are:\n  * `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.\n  * `RUNNING` — A worker is actively executing the job.\n  * `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.\n  * `FAILED` — Terminal state. The job execution threw an exception that was not (or could not be) retried.\n  * `DELETED` — Terminal state. The job was cancelled or removed, either by a user via the API or by the system.\n  * `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.\n","type":"string"}},"type":"object"}}}}
```

## The JobType object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"JobType":{"properties":{"type":{"description":"The type of the job.","type":"string"}},"type":"object"}}}}
```

## The StandardErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Job API","version":"1.0.0"},"components":{"schemas":{"StandardErrorResponse":{"properties":{"statusCode":{"description":"HTTP response code","type":"integer"},"titleMessage":{"description":"The title of the error.","type":"string"},"helpMessage":{"description":"A message that can help the user to understand the error.","type":"string"},"userMessage":{"description":"A message that can be shown to the user.","type":"string"},"errorCode":{"description":"The error code.","type":"string"},"errorContext":{"description":"Span context ID related to the error.","type":"string"}},"required":["errorCode","statusCode"],"type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.collibra.com/api/references/job/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.