Search tenant jobs

get

https://{host}/platform/tenantdata/v1/jobs

Query Params

filter

string

Query string to select response data based on property values.

Depending on the property, supports comparison operators, list operators, and logical operators.

Property	Type	Comparison	List
`endedAt`	`YYY-MM-DD`	`=`
`entitlement`	`String`		`IN`
`jobId`	`Number`	`=`	`IN`
`name`	`String`	`=`
`platformOperationType`	`String`	`=`	`IN`
`resourceGroupId`	`String`	`=`	`IN`
`startedAt`	`YYY-MM-DD`	`=`
`status`	`String`	`=`
`type`	`String`	`=`	`IN`
`userName`	`String`	`=`

All properties support the AND logical operator, e.g. jobId="100" AND status="FINISHED". To learn more, see Response Filtering.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: jobId, name, status, submittedAt, type. See Response Pagination.

limit

int32

1 to 100

Defaults to 10

Number of records returned per page. See Response Pagination.

offset

int32

Defaults to 0

Number of page displaying the returned records.

includeArchivedJobs

boolean

Defaults to false

Include archived jobs in the response. Jobs are automatically archived after 30 days. If true and the archived data is not yet ready, returns 202 with an empty object. Retry the request to get the full response with 200.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Success

202Accepted: Archived job data is not yet ready. Retry the request after a delay.

400Bad Request

401Unauthorized

403Forbidden

404The requested resource was not found.

500Internal Server Error