Update WorkOrders
Use this operation to update any of the writable fields of an existing WorkOrder object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"WorkOrders": {
"WorkOrder": {
"WorkOrderId": "141156",
"Subject": "Build order for 1 1000032378 with lot id 0 at FBA",
"StartDate": "12-27-2024",
"StartTime": "23:00:00",
"DueDate": "12-27-2024",
"ContactName": null,
"RelatedToType": "Products",
"RelatedToValue": null,
"Status": "Not Started",
"SendNotification": "No",
"Priority": "High",
"CreatedTime": "12-27-2024 17:37:58",
"CreatedTimeUTC": "12-27-2024 12:07:58",
"ModifiedTime": "12-27-2024 17:37:58",
"ModifiedTimeUTC": "12-27-2024 12:07:58",
"Description": "Description goes here."
}
}
}
<WorkOrders>
<WorkOrder>
<WorkOrderId>141156</WorkOrderId>
<Subject>Build order for 1 1000032378 with lot id 0 at FBA</Subject>
<StartDate>12-27-2024</StartDate>
<StartTime>23:00:00</StartTime>
<DueDate>12-27-2024</DueDate>
<ContactName></ContactName>
<RelatedToType>Products</RelatedToType>
<RelatedToValue></RelatedToValue>
<Status>Not Started</Status>
<SendNotification>No</SendNotification>
<Priority>High</Priority>
<CreatedTime>12-27-2024 17:37:58</CreatedTime>
<CreatedTimeUTC>12-27-2024 12:07:58</CreatedTimeUTC>
<ModifiedTime>12-27-2024 17:37:58</ModifiedTime>
<ModifiedTimeUTC>12-27-2024 12:07:58</ModifiedTimeUTC>
<Description>Description goes here.</Description>
</WorkOrder>
</WorkOrders>
Sample Response
{
"MCM": {
"response": {
"objectType": "WorkOrders",
"syncTime": "2025-03-28 07:43:53"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"workorder_subject": "Build order for 1 1000032378 with lot id 0 at FBA",
"workorder_id": "143231"
}
}
}
}
}
}
<MCM>
<response>
<objectType>WorkOrders</objectType>
<syncTime>2025-03-28 07:43:53</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<workorder_subject>Build order for 1 1000032378 with lot id 0 at FBA</workorder_subject>
<workorder_id>143231</workorder_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="WorkOrders">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="WorkOrderId" type="xsd:string" style="body" required="true"/>
<param name="Subject" type="xsd:string" style="body" required="true"/>
<param name="StartDate" type="xsd:date" style="body" required="true"/>
<param name="StartTime" type="xsd:time" style="body" required="true"/>
<param name="DueDate" type="xsd:date" style="body"/>
<param name="AccountName" type="xsd:string" style="body"/>
<param name="ContactName" type="xsd:string" style="body"/>
<param name="RelatedToType" type="xsd:string" style="body"/>
<param name="RelatedToValue" type="xsd:string" style="body"/>
<param name="Status" type="xsd:string" style="body"/>
<param name="SendNotification" type="xsd:string" style="body"/>
<param name="ActivityType" type="xsd:string" style="body"/>
<param name="Priority" type="xsd:string" style="body"/>
<param name="CreatedTime" type="xsd:dateTime" style="body"/>
<param name="ModifiedTime" type="xsd:dateTime" style="body"/>
<param name="Description" type="xsd:string" style="body"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago