Gets a page of job documents. Note on dereference parameter: The main function of this parameter is to pull in extra information on jobs that would not ordinarily be included. If the output of a Gen 2 workflow job is needed, the dereference parameter may be given a value of 'output'. This will look up the output for each job and place the resulting value under the 'output' property at the top level of the job document. Note that the output of a Gen 1 workflow job is just its job variables, and so the caller may refer to the 'variables' property to obtain that information. If the inputs and outputs of individual tasks are needed, the dereference parameter may be given a value of 'task'. This will look up all iterations (runs) of each task in each job, and will place those documents under the 'iterations' array in each task definition in each job. If a job is a child of another job, and details on the parent job are needed, the dereference parameter may be given a value of 'parent'. This will place the full parent job document under the property 'parent.job'. Please see the search documentation page for further information: https://docs.itential.com/docs/search-api-4
Route
GET /operations-manager/jobs
Roles
adminengineeringapireadoperations
Parameters
DetailsExampleSchema
Name
Type
Required
Description
queryParameters
object
yes
Parameters for filtering, paginating, projecting, and sorting job documents.
Copied to Clipboard
{
"queryParameters": {
"limit": 50,
"skip": 10,
"order": 1,
"sort": "name",
"include": "name",
"exclude": "_id",
"in": "Duis labore",
"not-in": "dolor",
"equals": "officia Lorem sed deserunt eiusmod",
"contains": "in ipsum irure deserunt eu",
"starts-with": "esse anim",
"ends-with": "pariatur culpa enim reprehenderit nisi",
"dereference": "reprehenderit in eiusmod ex sint",
"gt": "tempor occaecat et in",
"gte": "Ut ullamco nulla",
"lt": "sint eiusmod laborum",
"lte": "deserunt",
"q": "nulla dolore"
}
}
