API Docs

Submit a manual or scheduled job

This Web service submits a job according to a given job id.
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.
In order to submit a manual job by API, the relevant parameters should be supplied in the input.
See Working with the Alma Jobs API for more details.
To maintain optimum performance the following threshold will be used: The job will run only if:
a. not more than 3 jobs initiated by the API are running currently.
b. not more of 5 of the specific job were started in the previous hour.
The submission of scheduled jobs is supported for: ERP (Export Invoices, Import confirmation), Metadata Import, Remote Storage (Inventory Update, Send Requests to Remote Storage), Export/Import to Bursar, General Publishing and Student Information System (Import, Synchronize and Export).

Resource URL

POST /almaws/v1/conf/jobs/{job_id}

API Description

• WADL documentation: Download
• Swagger (OpenAPI) documentation: Download

URL Parameters

Querystring Parameters

Body Parameters

This method takes a Job object. See doc

Output

This method returns a Job Details object. See doc

Possible Error Codes