Get Job Status

Understand the parameters and response schema of the jobs endpoints

This page describes the jobs endpoint.

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Endpoints and methods

Method	Endpoint	Description
GET	/jobs	Get bulk job status for a given job type and ID.
GET	/jobs/search	Search jobs based on user permissions and ownership.
GET	/jobs/summary	Get a summary of jobs based on user.
POST	/jobs/statuses	Get job status and output.

GET /jobs

Gets the bulk job status for a given job type and ID.

curl \
  --request GET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer dea464c07bd07300095caa8" \
  https://your-immuta-url.com/jobs?bulkId=example-bulk-id

Query parameter

Parameter	Description	Required or optional
bulkId string	The bulk ID of the jobs to search for.	Required

Response

Returns the status of the requested jobs.

{
  "cefb58a0-cd71-11ec-8e29-81c20d280994": {
  "id": "cefb58a0-cd71-11ec-8e29-81c20d280994",
  "state": "completed",
  "output": null
  }
}

Response attributes

Attribute	Description
id string	The job's globally unique identifier.
state string	The job state: active, cancelled, completed, created, expired, failed, or retry.
output string	The output of the job, if it exists.

GET /jobs/search

Search jobs based on user permissions and ownership.

curl \
  --request GET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer dea464c07bd07300095caa8" \
  https://your-immuta-url.com/jobs/search

Query parameters

Parameter	Description	Required or optional
jobType array	List of job types to filter by.	Optional
state string	The job state to filter by: active, cancelled, completed, created, expired, failed, or retry.	Optional
startDate string	The start date to filter jobs from.	Optional
endDate string	The end date to filter jobs to.	Optional
offset integer	The number of results to skip for pagination.	Optional
size integer	The maximum number of results to return.	Optional

Response

Returns a list of job objects.

{
  "jobs": [
  {
    "id": "1234124123123",
    "name": "policySync",
    "state": "active",
    "createdon": "2022-06-02T17:37:24.515Z",
    "startedon": "2023-06-02T17:37:24.515Z",
    "data": {},
    "output": {}
  }
  ],
  "next": "2"
}

GET /jobs/summary

Get a summary of jobs based on user permissions and ownership.

curl \
  --request GET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer dea464c07bd07300095caa8" \
  https://your-immuta-url.com/jobs/summary

Query parameters

Parameter	Description	Required or optional	Accepted values
jobType array	List of job types to filter by.	Optional	updatePolicies updateDataPolicies updateSubscriptionPolicies createPolicySearchRecord
startDate string	The start date to filter jobs from.	Optional	-
endDate string	The end date to filter jobs to.	Optional	-

Response

Returns a detailed list of job status organized by job type.

{
  "ingestCsv": {
  "pending": 2,
  "inProgress": 1,
  "completed": 45,
  "retry": 0,
  "failed": 3,
  "expired": 0,
  "cancelled": 1
  },
  "policySync": {
  "pending": 0,
  "inProgress": 0,
  "completed": 150,
  "retry": 1,
  "failed": 0,
  "expired": 0,
  "cancelled": 0
  },
  "dataMaskingUpdate": {
  "pending": 1,
  "inProgress": 2,
  "completed": 8,
  "retry": 0,
  "failed": 1,
  "expired": 0,
  "cancelled": 0
  }
}

POST /jobs/statuses

Get the status and output of the provided jobs.

curl \
  --request POST \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer dea464c07bd07300095caa8" \
  --data @example_payload.json \
  https://your-immuta-url.com/jobs/statuses

Payload

{
  "jobIds": [
    "cefb58a0-cd71-11ec-8e29-81c20d280994"
  ],
  "wait": 0,
  "pollInterval": 1
}

Body parameters

Parameter	Description	Required or optional	Default values	Accepted values
jobIds array	List of job IDs.	Required	-	-
wait integer	Number of seconds to wait before returning if all jobs have not yet completed. Use -1 to wait indefinitely.	Optional	0	-
pollInterval integer	Number of seconds to wait between subsequent polls. Ignored if not using wait.	Optional	1	The minimum is 1

Response

Returns the state and output for the requested jobs.

{
  "cefb58a0-cd71-11ec-8e29-81c20d280994": {
    "id": "cefb58a0-cd71-11ec-8e29-81c20d280994",
    "state": "completed",
    "output": null
  }
}

Job object attributes

Attribute	Description
id string	The job's globally unique identifier.
name string	The internal job type or queue name associated with the job.
state string	The job state: active, cancelled, completed, created, expired, failed, or retry.
createdon timestamp	The date and time when the job was created or queued.
startedon timestamp	The date and time when execution of the job started. This value may be unavailable if the job has not started.
data object	The input payload and execution context of the job.
output object	The output of the job, if it exists.