Save Arguments
API Function
In some cases, you must also add a header to trigger the app server to perform a function as part of an API call. For example, when creating a Work Order, to load a Work Order Template you must provide the SaveArgument header parameter as well as including the wo_template_no value in the payload.
Below is a list of Save Arguments
Load a Template to an order
Applicable endpoints: JmWorkOrder, MoMediaOrder, XmTransmissionOrder
Loads Work Order Template to an order.
This replaces LoadTemplate as an improved method that includes the option to append or replace existing transactions. (Available from release 26.1)
saveArgument : {"LoadTemplateOption":1}
//option to load child templates
saveArgument : {"LoadTemplateOption":1,"LoadChildTemplates":"Y"}Options:
1 = append template transactions to existing order transactions
0 = replace any existing order transactions with the template transactions
Applies to POST, PATCH and PUT methods. Requires the wo_template_no to exist in the payload.
Example:
POST - create Work Order and load template
curl --location --globoff '{APIBaseURL}/JmWorkOrder' \
--header 'Content-Type: application/json' \
--header 'saveArgument: {"LoadTemplateOption":1,"LoadChildTemplates":"Y"}' \
--header 'Authorization: Basic ********' \
--data '{
"jm_work_order": [
{
"wo_no_seq": {
"wo_no_seq": "+1"
},
"wo_desc": "Match2006",
"wo_begin_dt": "2026-08-22T10:00:00.000Z",
"wo_end_dt": "2026-08-22T16:00:00.000Z",
"wo_template_no": {
"wo_template_no": 1050
},
"wo_type_no": {
"wo_type_no": 3275
},
"phase_code": {
"phase_code": "Hold"
},
"rate_card_no": {
"rate_card_no": 1
},
"cust_id": {
"cust_id": "1157"
}
}
]
}'Load Template - prior method still supported.
Where the number represents the number of the template to load.
To load child templates (available from release 11.3), add an additional parameter called 'LoadChildTemplates'
Example when creating an order using a POST call. The template number must be provided in both the header and the payload.
Load a Service Template
For transmission orders, you can load a Service Template
And populate the XmTransmissionOrder payload with service_template_no value
Multiple Service Templates can be loaded by including comma separated values:
In this scenario you can leave the "service_template_no" in the body as null.
Void a Work Order
Applicable endpoints: JmWorkOrder, MoMediaOrder, XmTransmissionOrder
Function to void an Order.
Where the number represents the Work Order number sequence.
Example using a PATCH call:
Un-Void a Work Order
Applicable endpoints: JmWorkOrder, MoMediaOrder, XmTransmissionOrder
Provides the ability to un-void an Order.
Example using a PATCH call with the header Content-Type : application/json-patch+json
Actualise Work Order actuals
Applicable endpoints: JmActual
v11.1
To actualize selected or all transactions. This save argument will update the transaction and order phase, effectively posting the actuals.
Variations:
Intended to be used in conjunction with the POST of actual actions. This save argument then performs the action of actualization.
Example single transaction actualization without times:
Post Time Card Batch
Applicable endpoint: TcBatch
v11.1
Replicates the action UI menu item to 'Post' the batch.
Example PATCH payload:
Set the default Group of a Scheduling Resource
Applicable endpoints: SchResource
Function to set the default Group of a scheduling resource. The Group must already be assigned to the Resource in the Group list.
Example using a PATCH call with the header Content-Type : application/json-patch+json
Approve a Bid
Applicable endpoints: BidVersion
Changes the bid approval state of a Bid using number that represents the approval type.
Approval number types:
0
Approval
1
Unapproval
2
ApproveAsChangeMemo
3
ApproveAndUnApproveOriginal
4
Abort
Example using a PATCH call to set the 'approved' value and the header save argument.
Multiple Save Arguments
Where applicable, multiple save arguments can be used as an array separated by a comma.
Example:
Last updated