Last changed in 27/12/2024
In all Entities we have the possibility of making Odata requests.
In Odata requests you must pay attention to the following syntax:
- $select: expression that determines which request fields are included in the result;
- $filter: expression used to restrict the information sent in the
request; - $orderby: expression used to organize the information sent;
- $skip: expression which ignores the first records. Example $skip = 100 - ignores the first 100 records;
- $Top: expression that returns the first N request records;
- $expand: expression that allows you to relate entities, for
example get the list of consumptions and respective parts consumed.
When making Odata requests there are two expressions that must be used:
- $select: mandatory expression, must indicate which fields you want to get
- $filter: as we limit the number of records per request to 100, we recommend you filter by the ModifiedOn field, so that you only get new or modified records.
Example
Below you will find a set of examples of Odata requests for work orders:
Odata request to obtain the consumption list without the lines
Odata request to obtain information on consumption and lines
- https://cloud.valuekeep.com/api/{Tenant}/{Organization}/maintenance/WorkOrderReportConsumptions/odata?$select=WorkOrderReportConsumptionKey,WorkOrder,ReportDate,Location,Equipment,Tool,Employee,Remarks&$expand=WOConsumptionLines($select=Description,Quantity,Unit,Warehouse,Currency,TotalCostAmount)
Odata request to obtain work order consumption information with the respective lines ignoring the first 100 records and organized by modification date
- https://cloud.valuekeep.com/api/{Tenant}/{Organization}/maintenance/WorkOrderReportConsumptions/odata?$select=WorkOrderReportConsumptionKey,WorkOrder,ReportDate,Location,Equipment,Tool,Employee,Remarks&$expand=WOConsumptionLines($select=Description,Quantity,Unit,Warehouse,Currency,TotalCostAmount)&skip=100&Orderby=ModifiedOn
Fields placed in the Select field must begin with Uppercase letters. You can get the name of the user fields in the select
field from the
support article.
Bookmark or share this article
