Como obter o registo de consumos por OData?

É possível realizar pedidos OData em todas as entidades. 

Nos pedidos OData, é necessário ter atenção à seguinte sintaxe:

1. $select: expressão que determina quais os campos do pedido que são incluídos no resultado;
   
2. $filter: expressão utilizada para restringir a informação enviada no pedido;
   
3. $orderby: expressão utilizada para ordenar a informação enviada;
   
4. $skip: expressão que ignora os primeiros registos, por exemplo: $skip = 100. Neste caso, são ignorados os 100 primeiros registos;
5. $top: expressão que retorna os primeiros N registos do pedido;
   
6. $expand: expressão que permite relacionar entidades, por exemplo obter a lista de consumos e as respetivas peças consumidas.

Quando se realizam pedidos OData, existem duas expressões que devem ser utilizadas:

1. $select: expressão obrigatória. Deve indicar quais os campos que se pretende obter;
   
2. $filter: como limitamos a 100 registos por pedido, recomendamos que indique o filtro pelo campo ModifiedOn para obter apenas os registos novos ou alterados.

Exemplos

De seguida, estão descritos exemplos de pedidos OData para as ordens de trabalho:

Pedido OData para obter a lista de consumos sem as linhas:

1. https://cloud.valuekeep.com/api/{Tenant}/{Organization}/maintenance/WorkOrderReportConsumptions/odata?$select=WorkOrderReportConsumptionKey,WorkOrder,ReportDate,Location,Equipment,Tool,Employee,Remarks

Pedido OData para obter informação dos consumos e das linhas:

1. 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)

Pedido OData para obter informação dos consumos da ordem de trabalho com as respetivas linhas, ignorando os 100 primeiros registos e ordenados por data de alteração:

1. 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

Os campos inseridos na expressão Select devem iniciar por maiúsculas.

Consulte o artigo de apoio para saber quais os campos a utilizar na expressão Select.

• Related Articles

• Como obter uma lista de ordens de trabalho por OData?

  É possível realizar pedidos OData em todas as entidades. Nos pedidos OData é necessário ter atenção à seguinte sintaxe: $select: expressão que determina quais os campos do pedido que são incluídos no resultado; $filter: expressão utilizada para ...

• Como configurar a integração de consumos do ERP v10 para o Valuekeep?

  O Valuekeep está totalmente integrado com o ERP v10 para que possa usufruir das funcionalidades dos dois produtos. Esta integração é biderecional, ou seja, partilham dados e mantém a comunicação entre si. Para auxiliar na operação, estão disponíveis ...

• Web API - Como criar uma peça com extensão de inventário?

  Este método permite, de forma simplificada, criar uma peça do tipo Peça com extensão de inventário. Para criar uma peça com extensão de inventário é necessário utilizar o seguinte método: POST ...

• WebAPI - Como obter o registo da webapi?

  No momento em que é realizada a subscrição no Valuekeep CMMS o subscriber recebe um email com as credenciais da subscrição, compostas por client_Id e um Cliente_Secret. Estas credencias devem ser guardadas, caso contrário não será possível utilizar a ...

• Webapi - Como obter a lista de registos de consumos das ordens de trabalho?

  Este método permite, de forma simplificada, obter a lista dos registos de consumos das ordens de trabalho. O método a utilizar para a obtenção da lista dos registos de consumos das ordens de trabalho é : ...