ListJobs

GET

/api/v1/jobs

Query Parameters

`pageSize`integer

The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 50 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

`pageToken`string

A page token, received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token. Optional.

`filter`string

A Common Expression Language (CEL) filter string. Available fields to filter by are: job_id, created_by_user_id, modified_by_user_id, created_date, modified_date, started_date, completed_date, and job_status For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

`organizationId`string

This field is only required if your user belongs to multiple organizations.

`orderBy`string

How to order the retrieved jobs. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, started_date, completed_date, job_status. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

curl -X GET "<API_URL>/api/v1/jobs?pageSize=0&pageToken=string&filter=string&organizationId=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "jobs": [
    {
      "jobId": "string",
      "organizationId": "string",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "startedDate": "2019-08-24T14:15:22Z",
      "completedDate": "2019-08-24T14:15:22Z",
      "jobType": "JOB_TYPE_UNSPECIFIED",
      "jobStatus": "JOB_STATUS_UNSPECIFIED",
      "jobStatusDetails": {
        "ruleEvaluation": {},
        "dataImport": {
          "pointsProcessed": "string",
          "pointsTotal": "string"
        }
      },
      "jobDetails": {
        "ruleEvaluation": {
          "reportId": "string"
        },
        "dataImport": {
          "dataImportId": "string"
        }
      }
    }
  ],
  "nextPageToken": "string"
}

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

organizationIdstring

orderBystring

Response

`pageSize`integer

`pageToken`string

`filter`string

`organizationId`string

`orderBy`string