API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Retrieve Job Instance Event Details

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

This Web service returns a list of events for a job-instance for the given job id and instance id. For now it accepts jobs in the category and type of USERS/SIS.

TRY IT NOW

Resource URL

GET /almaws/v1/conf/jobs/{job_id}/instances/{instance_id}/events

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

URL Parameters

Parameter	Type	Description
`job_id`	xs:string	Unique id of the job. Mandatory.
`instance_id`	xs:string	Unique id of the specific job instance. Mandatory.

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.

Body Parameters

None

Output

This method returns a Job Events By Instance object. See doc

Possible Error Codes

Code	Message
402215	Invalid job id format.
402216	Invalid job id.
402218	Invalid job instance id.
60333	Error retrieving events.
60332	This service will only work for the job category and type of USERS/SIS.