API Docs
Rest Job Instance
Contents
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.
| Field | Type | Description | ||
|---|---|---|---|---|
id | string | Unique id of the specific job instance. Should be used in subsequent queries. | ||
external_ | string | External id of the specific job instance. | ||
name | string | The job instance name. | ||
submitted_ | string 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_ | dateTime | The date and time when the job was submitted. | ||
start_ | dateTime | The date and time when the job started. | ||
end_ | dateTime | The date and time when the job ended. | ||
progress | decimal | The progress (percent) of the job instance so far. | ||
status | string with attr. | The current status of the job. Possible codes are listed in 'systemJobStatus' code table
| ||
status_ | date | The date in which the status was last updated. | ||
alerts | alerts | List of Alerts that are related to the job run. | ||
counters | counters | List of the job instance's related counters. In the Alma UI, theses are "counters", "statistics" and "errors" lists. | ||
actions | actions | Relevant for MD import job instances. List of the job instance's related actions. | ||
job_ | job_info | Related job information. |
alerts
Description:
List of Alerts thar are related to the job instance.
| Field | Type | Description | ||
|---|---|---|---|---|
alert | string with attr. | Specific alert. Possible codes are listed in 'SystemJobReportAlertMessage' code table.
|
counters
Description:
List of the job instance's related counters.
In the Alma UI, theses are "counters", "statistics" and "errors" lists.
| Field | Type | Description |
|---|---|---|
counter | counter | Specific counter. |
counter
Description: Specific counter.
| Field | Type | Description |
|---|---|---|
type | string with attr. | The counter type. Mandatory. |
value | string | The counter value. Mandatory. |
actions
Description:
Relevant for MD import job instances.
List of the job instance's related actions.
| Field | Type | Description |
|---|---|---|
action | action | Specific action. |
action
Description: Specific action.
| Field | Type | Description |
|---|---|---|
type | string 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. |
population | string with attr. | The population that will be part of the "create set" action. |
members | int | The estimated numbers of members in the population. |
job_info
Description: Related job information.
| Field | Type | Description | ||
|---|---|---|---|---|
id | string | The job id. | ||
name | string | The job name. | ||
description | string | The job description. | ||
type | string with attr. | The type of the job: MANUAL or SCHEDULED.
| ||
category | string 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.
|
Samples
XML
JSON
__