SIF Infrastructure (Global) 3.2.1
jobs
http://www.sifassociation.org/infrastructure/3.2.1
Documentation
All functional services must use this object design to track state. While Events may be published back to the objects creator, they must not be published to the Consumer when the event was generated based on its request (since results were included in the response). Each functional service should define the expectations of how management of the job is managed for both the Consumer and Provider. For instance, certain optional fields may need to be included in-order-to successfully cause a job to be created.
Tree
Table
| Name | Mandatory | Characteristics | Type | Description | XPath | Format |
|---|---|---|---|---|---|---|
| @id | uuidType | /jobs/job/@id | [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} | |||
| name | * | M | token | The name of the job, e.g. "grading" or "sre". | /jobs/job/name | |
| description | O | string | A description of the job, e.g. "Bowers Elementary School Final Marks" | /jobs/job/description | ||
| state | O | jobStateType | The current enumerable state of the job. | /jobs/job/state | NOTSTARTED, INPROGRESS, COMPLETED, FAILED | |
| stateDescription | O | string | A descriptive message elaborating on the current state, e.g. if the current state is "FAILED" the stateDescription may be "Timeout occured". | /jobs/job/stateDescription | ||
| created | O | dateTime | The datetime this job was created. | /jobs/job/created | ||
| lastModified | O | dateTime | The datetime this job was last modified. | /jobs/job/lastModified | ||
| timeout | O | duration | The ammount of time after creation before this job is automatically deleted. | /jobs/job/timeout | ||
| name | * | M | token | The name of the Phase unique within the context of the owning job. | /jobs/job/phases/phase/name | |
| @id | uuidType | /jobs/job/phases/phase/states/state/@id | [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} | |||
| type | * | M | phaseStateType | The type of this State object. | /jobs/job/phases/phase/states/state/type | NOTAPPLICABLE, NOTSTARTED, PENDING, SKIPPED, INPROGRESS, COMPLETED, FAILED |
| created | O | dateTime | The datetime this job was created. | /jobs/job/phases/phase/states/state/created | ||
| lastModified | O | dateTime | The datetime this job was last modified. | /jobs/job/phases/phase/states/state/lastModified | ||
| description | O | string | A descriptive message ellaborating the condition of this state, e.g. if the state is "FAILED" the stateDescription may be "Timeout occured". | /jobs/job/phases/phase/states/state/description | ||
| required | * | M | boolean | Whether or not this phase is required for the job to complete successfully. | /jobs/job/phases/phase/required | |
| @type | * | M | string | The type of the requested Access Right | /jobs/job/phases/phase/rights/right/@type | QUERY, CREATE, UPDATE, DELETE, PROVIDE, SUBSCRIBE, ADMIN |
| right | * | rightType | /jobs/job/phases/phase/rights/right | APPROVED, SUPPORTED, UNSUPPORTED, REJECTED, REQUESTED | ||
| @type | * | M | string | The type of the requested Access Right | /jobs/job/phases/phase/statesRights/right/@type | QUERY, CREATE, UPDATE, DELETE, PROVIDE, SUBSCRIBE, ADMIN |
| right | * | rightType | /jobs/job/phases/phase/statesRights/right | APPROVED, SUPPORTED, UNSUPPORTED, REJECTED, REQUESTED | ||
| phaseName | O | token | Name of initialization phase the payload corresponds to. | /jobs/job/initialization/phaseName | ||
| payload | * | M | anyType | Information matching the initialization phase, should result in corresponding phase having an INPROGRESS, COMPLETED, or FAILED state. | /jobs/job/initialization/payload |
Download: .xlsx
XML Structure
Download: .xml
