Read WorkOrders
Retrieves the details of a WorkOrder object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=Subject,eq,NewWorkOrders;Test CheckBox,eq,no&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=Subject,eq,New WorkOrders;Test CheckBox,eq,no&pageSize=10&key=xyzkey |
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."
},
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<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>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</WorkOrders>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="WorkOrders">
<method name="GET">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="Subject" type="xsd:string" style="query" required="true"/>
<param name="StartDate" type="xsd:date" style="query"/>
<param name="EndDate" type="xsd:date" style="query"/>
<param name="Filter" type="xsd:string" style="query"/>
</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 21 days ago