API Docs

Rest Job Instance

Overview


Job instance object represents a specific submittion of the job.

Data Dictionary

Click here to download rest_job_instance.xsd

job_instance

Description: job_instance Object.

FieldTypeDescription
idstring
Unique id of the specific job instance. Should be used in subsequent queries.
external_idstring
External id of the specific job instance.
namestringThe job instance name.
submitted_bystring with attr.
The person who ran the job.
This can be "System" for system jobs, "API" for jobs which were initiated by API, or the praimary_id of a specific staff.
In case of a staff, the "desc" attribute will contain the user's full name.
submit_timedateTimeThe date and time when the job was submitted.
start_timedateTimeThe date and time when the job started.
end_timedateTimeThe date and time when the job ended.
progressdecimalThe progress (percent) of the job instance so far.
statusstring with attr.
The current status of the job.
Possible codes are listed in 'systemJobStatus' code table

The valid values for this parameter are controlled by the code-table: systemJobStatus. These are the currently defined values for your institution:
CodeDescription
status_datedateThe date in which the status was last updated.
alertsalerts
List of Alerts that are related to the job run.
counterscounters
List of the job instance's related counters.
In the Alma UI, theses are "counters", "statistics" and "errors" lists.
actionsactions
Relevant for MD import job instances.
List of the job instance's related actions.
job_infojob_info
Related job information.

 

alerts

Description:
List of Alerts thar are related to the job instance.

FieldTypeDescription
alertstring with attr.
Specific alert.
Possible codes are listed in 'SystemJobReportAlertMessage' code table.

The valid values for this parameter are controlled by the code-table: SystemJobReportAlertMessage. These are the currently defined values for your institution:
CodeDescription

 

counters

Description:
List of the job instance's related counters.
In the Alma UI, theses are "counters", "statistics" and "errors" lists.

FieldTypeDescription
countercounterSpecific counter.

 

counter

Description: Specific counter.

FieldTypeDescription
typestring with attr.
The counter type. Mandatory.
valuestring
The counter value. Mandatory.

 

actions

Description:
Relevant for MD import job instances.
List of the job instance's related actions.

FieldTypeDescription
actionactionSpecific action.

 

action

Description: Specific action.

FieldTypeDescription
typestring with attr.
The action type. Currently, only CREATE_SET is supported.
This action is parallel to the "create title set" option from the Alma UI for MD import job instance.
Note that in order to submit this action, you can use the link URL with POST.
populationstring with attr.
The population that will be part of the "create set" action.
membersint
The estimated numbers of members in the population.

 

job_info

Description: Related job information.

FieldTypeDescription
idstring
The job id.
namestringThe job name.
descriptionstringThe job description.
typestring with attr.
The type of the job: MANUAL or SCHEDULED.

The valid values for this parameter are controlled by the code-table: . These are the currently defined values for your institution:
CodeDescription
categorystring with attr.
The sub type of the job.
For manual jobs, possible codes are listed in 'HPaTaskChain.type' code table.
For scheduled jobs, possible codes are listed in 'systemJobsGroups' code table.

The valid values for this parameter are controlled by the code-table: HPaTaskChain.type. These are the currently defined values for your institution:
CodeDescription

 

Samples

XML
JSON
__