Read WorkOrders
Retrieves the details of a WorkOrder object that has been previously created.
Parameters
| Path Params | |
|---|---|
| yourCompany: | string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/WorkOrders will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/WorkOrders |
| Query Params | |
|---|---|
| filter: | string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. Subject,eq,WorkOrders subject 1. To fetch WorkOrders with subject equal to New WorkOrders and custom field(Test CheckBox) value is no or off, the following url must be used<https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=Subject,eq,New WorkOrders;Test CheckBox,eq,no&key=xyzkey 2. To fetch WorkOrders with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey 3. To fetch WorkOrders with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use | between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey 4. To fetch WorkOrders with WorkOrderId equal to 3422, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=WorkOrderId,eq,3422&key=xyzkey List of condition abbrevations to be used: "cs": contain string (string contains value) "sw": start with (string starts with value) "ew": end with (string end with value) "neq": not equal (string or number should not match) "eq": equal (string or number matches exactly) "lt": lower than (number is lower than value) "le": lower or equal (number is lower than or equal to value) "ge": greater or equal (number is higher than or equal to value) "gt": greater than (number is higher than value) "bt": between (number is between two comma separated values) |
| customview: | string In this parameter customview name needs to be provided to fetch related details.For eg. To fetch WorkOrders customview with name as ABC Customview, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?customview=ABC Customview&key=xyzkey |
| page: | int Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch WorkOrders with subject equal to New WorkOrders and custom field(Test CheckBox) value is no or off and page equal to 10, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/WorkOrders?filter=Subject,eq,NewWorkOrders;Test CheckBox,eq,no&page=10&key=xyzkey |
| pageSize: | int In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch WorkOrders with subject equal to New WorkOrders and custom field(Test CheckBox) value is no or off and page size equal to 10, the following url must be used 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 Response header need to be passed for eg. application/json or application/xml. |
| Query Auth | |
|---|---|
| key: | string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0. |
| Header Auth | |
|---|---|
| apiKey: | string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0. |
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 5 days ago