> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/xytech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/xytech/rest-api/save-arguments.md). # Save Arguments 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** ```json 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. ``` SaveArgument : {"LoadTemplate":"2"} ``` 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' ``` SaveArgument: {"LoadTemplate":"1012","LoadChildTemplates":"Y"} ``` Example when creating an order using a POST call. The template number must be provided in both the header and the payload. ```json curl --location 'http://{APIbaseURL}/JmWorkOrder' \ --header 'Content-Type: application/json' \ --header 'SaveArgument: {"LoadTemplate":"15"}' \ --header 'Authorization: Basic ••••••' \ --data '{ "jm_work_order": [ { "wo_desc": "100m Finals", "wo_begin_dt": "2024-08-22T10:00:00.000Z", "wo_end_dt": "2024-08-22T16:00:00.000Z", "wo_type_no": 17, "phase_code": "RQST", "rate_card_no": 1, "cust_id": 27, "wo_template_no": 15 } ] }' ``` *** ### Load a Service Template For transmission orders, you can load a Service Template ``` SaveArgument : {"LoadServiceTemplate":"10"} ``` And populate the XmTransmissionOrder payload with service\_template\_no value ```json "service_template_no":10 ``` Multiple Service Templates can be loaded by including comma separated values: ``` SaveArgument : {"LoadServiceTemplate":"10","11"} ``` 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. ``` SaveArgument: {"VoidWorkOrder":"36914-1"} ``` Where the number represents the Work Order number sequence. Example using a PATCH call: ```json curl --location --request PATCH 'http://{APIbaseURL}/JmWorkOrder/wo_no_seq=2626-1' \ --header 'Content-Type: application/json' \ --header 'SaveArgument: {"VoidWorkOrder":"2626-1"}' \ --header 'Authorization: Basic ••••••' \ --data '[ { "op": "replace", "path": "cancel_no", "value": 1 } ]' ``` *** ### Un-Void a Work Order #### Applicable endpoints: JmWorkOrder, MoMediaOrder, XmTransmissionOrder Provides the ability to un-void an Order. ``` SaveArgument : {"UnVoidWorkOrder":"1067982-1"} ``` Example using a PATCH call with the header Content-Type : application/json-patch+json ```json curl --location --request PATCH 'http://{APIbaseURL}/JmWorkOrder/wo_no_seq=1067982-1' \ --header 'SaveArgument: {"UnVoidWorkOrder":"1067982-1"}' \ --header 'Content-Type: application/json-patch+json' \ --header 'Authorization: ••••••' \ --data '' ``` *** ### 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. ``` saveArgument : { "ActualizeSelected":"38521,38522", "ActualizeUpdatePhase":"Y"} ``` Variations: ``` saveArgument : { "ActualizeAll":"-2", "ActualizeUpdatePhase":"Y"} SaveArgument : { "ActualizeSelected":"-2,200003,200004", "ActuallizeUpdatePhase":"Y"} ``` 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: ```json curl --location 'http://{APIbaseURL}/JmActual/' \ --header 'Content-Type: application/json' \ --header 'SaveArgument: { "ActualizeSelected":"1259520", "ActualizeUpdatePhase":"Y"}' \ --header 'Authorization: ••••••' \ --data '{     "jm_actual_header": [         {             "actual_hdr_no": {                 "actual_hdr_no": -1             },             "wo_no": 9453,             "wo_seq": 1,             "wo_no_seq": {                 "wo_no_seq": "1075881-1"             },             "actual_status": "Y",             "jm_actual_detail": [                 {                     "actual_hdr_no": -1,                     "actual_det_no": -2,                     "action_code": {                         "action_code": "I"                     },                     "actual_unit": 4,                     "actual": "Y"                 }             ],             "jm_actual_link": [                 {                     "actual_link_no": -3,                     "actual_det_no": -2,                     "trx_no": 1259520                 }             ]         }     ] }' ``` *** ### Post Time Card Batch #### Applicable endpoint: TcBatch v11.1 Replicates the action UI menu item to 'Post' the batch. ``` saveArgument : {"Post":""} ``` Example PATCH payload: ```json curl --location --request PATCH '/TcBatch/batch_no=7572' \ --header 'Content-Type: application/json-patch+json' \ --header 'saveArgument: {"Post":""}' \ --header 'Authorization: Basic aHR0cDovL2RldndjdW1wYXBwMjoxMTAwMC9hcGkvdjIvZGF0YWJhc2UvWFlUX01BSU5fVjp4eXRlY2hwdw==' \ --data '{ "tc_batch": [ { "batch_no": { "batch_no": "7572" } } ] }' ``` *** ### 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. ``` SaveArgument : {"GroupCode":"UKPS"} ``` Example using a PATCH call with the header Content-Type : application/json-patch+json ```json curl --location --request PATCH 'http://{APIbaseURL}/SchResource/resource_code=3' \ --header 'Content-Type: application/json-patch+json' \ --header 'SaveArgument: {"GroupCode":"TRX"}' \ --header 'Authorization: Basic ••••••' \ --data '' ``` *** ### Approve a Bid #### Applicable endpoints: BidVersion Changes the bid approval state of a Bid using number that represents the approval type. ``` SaveArgument : {"BidApproval":"0"} ``` Approval number types:
0Approval
1Unapproval
2ApproveAsChangeMemo
3ApproveAndUnApproveOriginal
4Abort
Example using a PATCH call to set the 'approved' value and the header save argument. ``` curl --location --request PATCH 'http://{APIbaseURL}/BidVersion/version_no=211' \ --header 'Content-Type: application/json' \ --header 'SaveArgument: {"BidApproval":"0"}' \ --header 'Authorization: Basic ••••••' \ --data '[ { "op": "replace", "path": "approved", "value": "Y" } ]' ``` *** ### Multiple Save Arguments Where applicable, multiple save arguments can be used as an array separated by a comma. Example: ``` SaveArgument : {"LoadServiceTemplate":"10","LoadTemplate":"2"} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://knowledgebase.fabricdata.com/xytech/rest-api/save-arguments.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.