WebAPI - Get work orders filtered by date and state

This method returns the work orders list filtered according to the following parameters.

The method to be used to get the filtered work orders' list is:

GET /api/mytenant/myorganization/maintenance/workorders/getWorkOrderFilter?version=AAAA&stateKey=002WORKORDER&dateTransition=2021-02-01&maxRecords=100&attachments=true

The method parameters are optional, however, the method returns the creation date, the expected date and the transition date to filter WOs. If the parameter maxRecords is not specified, it returns a maximum of 100 records. The logic is the following:

1st filter

1. datetransition: returns all WOs with a transition date after the inserted date
2. stateKey: returns all WOs with this transition state, and the WO can be in another state in that moment. Allows to define the list of values separated by “;”
3. maxRecords: number of WOs to be returned, this parameter must be an integer, equal or inferior to 200
4. version: returns all WOs assigned with a version superior to this parameter, this parameter must be base64. If not specified, the value AAAA will be considered.
5. attachments: returns the attachments with the filtered WOs
   

2nd filter

1. date: returns all WOs with a creation date equal or after the inserted date
2. expectedDate: returns all WOs with an expected date equal or after the inserted date
3. modifiedOn: returns all WOs with a changed date equal or after the inserted date 
4. stateKey: returns all WOs with these states, and the WO can be in another state in that moment. Allows to define the list of values separated by “;”
   
5. maxRecords: number of WOs to be returned, this parameter must be an integer, equal or inferior to 200
   
6. version: returns all WOs assigned with a version superior to this parameter, this parameter must be base64. If not specified, the value AAAA will be considered.
7. attachments: returns the attachments with the filtered WOs
   

The server returns an answer HttpStatusCode.OK, with the filtered WOs. If the parameter maxRecords is specified and the value is equal or inferior to 200, it returns the number of records. If the parameter value is higher than 200, it returns an error message.

 

If you add all parameters, the 1st filter will be used by default

• Related Articles

• WebAPI – How do I get work orders assigned to user?

  This method returns the work orders list assigned to each employee of a specific company. The method to be used to get the work orders list assigned to the employee is: GET ...

• WebAPI – Get work orders and technicians from workshops the authenticated user is responsible for

  This method returns the list of work orders and technicians that belong to the workshops the authenticated user is responsible for. The methods to be used to get the list are: ...

• WebAPI – Get Work Orders assigned to the employee

  This method returns the work orders list assigned to each employee of a specific company. The method to be used to get the work orders list assigned to the employee is: ...

• WebAPI – How can I change the work order state?

  This method allows you to change a work order state. The method to be used for changing the work order change is: Post {{url}/api/{{tenant}}/{{organization}}/maintenance/workorders/changeSchemaEntityState/{{companyKey}} The parameters in the method ...

• WebAPI – How do I create work orders?

  This method offers a simple way of creating a Work Order for a specific Asset, Location, Tool or Route. The method to be used to create a work order is: POST /api/mytenant/myorganization/maintenance/workorders/newWorkOrderInfo Json example to create ...