API Docs

__METHOD= POST . __PATH= /almaws/v1/conf/jobs/{job_id} .

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

URL Parameters

ParameterTypeDescription
job_idxs:stringUnique id of the job. Mandatory.

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringRequiredThe operation to perform on the job. Currently op=run is supported for manual and scheduled jobs.

Body Parameters

This method takes a Job object. See doc

Output

This method returns a Job Details object. See doc

Possible Error Codes

CodeMessage
402215Invalid job id format.
402216Invalid job id.
402220Operation was not provided.
402221Operation is not supported.
402222/402223Execution threshold reached.
402224/402225/402226An internal error occured.
402228Mandatory parameter is missing from input.
402229Mandatory parameter value is empty.
402248Cannot submit scheduled job.
402249Invalid scheduled job category.
402231Job in consisted of more than one task - executing such job is currently not supported via the API.