states
http://www.sifassociation.org/infrastructure/3.2
Documentation
For states updatable by the Consumer, it creates a new state much like it would a single object. The actual result (state or error) is included in the response. Each functional service should define the expectations for which Adaptor is responsible for updating the phase status. NOTE: The "states" collection represented here is reserved for future capabilities.
Service Paths
[services connector]/[job name]/[job id]/[phase name]/states/state : Used exclusively by the Consumer to create a new (and therefore current) state.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | uuidType | /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. | /states/state/type | NOTAPPLICABLE, NOTSTARTED, PENDING, SKIPPED, INPROGRESS, COMPLETED, FAILED |
created | O | dateTime | The datetime this job was created. | /states/state/created | ||
lastModified | O | dateTime | The datetime this job was last modified. | /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". | /states/state/description |
Download: .xlsx
XML Structure
Download: .xml