API Docs
Retrieve Jobs
Contents
This Web service returns a list of jobs that can be submitted.
The Jobs API supports 2 job types:
Manual jobs - Perform actions on a pre-defined set of records. Available in the "Run a job" list in the Alma UI.
Scheduled jobs - Jobs that might be running periodically. In the Alma UI, it is possible to see these jobs (if they have a defined schedule) in the Scheduled tab of the Monitor Jobs page.
See Working with the Alma Jobs API for more details.
Resource URL
GET /almaws/v1/conf/jobs
API Description
URL Parameters
None
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
category | xs:string | Optional. | For filtering jobs by their category. Optional. For manual, possible values are from HPaTaskChain.type code table. For scheduled and other, possible values are from the systemJobsGroups code table. By default, all jobs will be retrieved. |
type | xs:string | Optional. | For filtering jobs by their type. Optional. Possible values are MANUAL/SCHEDULED/OTHER. If no type is given, all types of jobs will be retrieved. |
profile_id | xs:string | Optional. | For filtering jobs by their profile ID. Optional. Relevant only for scheduled jobs. |
Body Parameters
None
Output
This method returns a Jobs List
object. See doc
Possible Error Codes
Code | Message |
---|---|
40166410 | Invalid category. |
40166410 | Invalid type. |
402219 | Failed to retrieve jobs list. |