Job Manager APIs

GET /api/jobs/query/summary

<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Query for a summary of job infos (See JobInfoSummary schema for fields). Use /api/jobs/{jobId} to load complete job info

Request

Query parameters

namestring

Name of job. Can be an exact match or wildcard

status'NEW' | 'QUEUED' | 'RUNNING' | 'CANCELLED' | 'COMPLETED_ERROR' | 'COMPLETED_SUCCESS' | 'INCOMPLETE_ERROR'

Status of job. Exact match only

loggedInIdstring uuid

User wallet id of the logged in user that started the job. Only for sdzAdmins. Exact match only

daysToReturninteger

Limit results to jobs create in the last number of days

orderBystring[]

Order by field(s) with optional ACS or DESC keyword after each field

limitinteger

Maximum amount of job infos to return. Use orderBy to ensure consistent ordering job infos

skipinteger

Skip the X number of job infos then return the remaining job infos within the limit. Use orderBy to ensure consistent ordering of job infos

Response

OK

totalinteger

Count of total possible jobs infos for given query

limitinteger

Limit of jobs infos return for this query

skipinteger

Skip the first number of job infos for this query

Changes

No recorded changes to this operation across all 1 revision of this API.