Batch Job Instruction



The Batch Job Instruction is used to enqueue a group of batch operations.

BatchJobInstruction [Schema]

Name Type Required Description
HoldingDate xsd:dateTime no Optional date, used to defer execution of the job until a future point in time.
ValidateOnly xsd:boolean yes Used to determine if the actions should be validated only or commited.
Instructions yes A list of batch commands to be executed.

Instructions must be of type BatchItemBase



BatchItemBase [Schema]

Name Type Required Description
Href Query element of type:
xsd:string
no Represents the API target resource location for the batch item action.

DELETE

Interits from: BatchItemBase

Defines a deletion batch item instruction. Used to deleted the targeted resource.

Name Type Required Description

PATCH

Interits from: BatchItemBase

Defines a patch batch item instruction. Used to update an existing resource with a partial object graph.

Name Type Required Description
Body Query element of type:
xsd:string
no The partial content to be merged into the specified resource. Should be partial object graph, formatted as XML and wrapped in a CDATA block.
Example: <![CDATA[<Employer><Name>New Name></Employer>]]>

POST

Interits from: BatchItemBase

Defines a post batch item instruction. Used to insert a complete object into a parent collection.

Name Type Required Description

PUT

Interits from: BatchItemBase

Defines a put batch item instruction. Used to insert/update a complete object into a specific resource location.

Name Type Required Description

[PUT] and [POST] both require a body element. The body element must indicate the data type using a xsi:type attribute.

<PUT Href="/Employer/ER001/PaySchedule/TEST001">
    <Body xsi:type="PaySchedule">
    <Name>Pay schedule Name</Name>
    <PayFrequency>Monthly</PayFrequency>
    </Body>
</PUT>
<POST Href="/Employer/ER001/PaySchedules">
    <Body xsi:type="PaySchedule">
    <Name>Pay schedule Name</Name>
    <PayFrequency>Monthly</PayFrequency>
    </Body>
</POST>