Chamando APIs Detail

Acesse as APIs Detail com as solicitações HTTP GET. As APIs Detail retornam informações específicas sobre uma entrada em uma coleção de origem.

As solicitações REST Detail usam os seguintes tipos de APIs dependendo do Name do recurso que é especificado:

  • getName
  • getNameDetails
  • getNameHierarchy
  • getNameList

Por exemplo, solicitações Detail para pedidos usam getOrderDetails, e as solicitações Detail para organizações usam getOrganizationHierarchy. Para ver a lista completa de recursos e APIs, visualize os arquivos REST Javadoc.

Formato da solicitação

Use o formato de solicitação de HTTP a seguir para chamar APIs Detail:

GET https://host:port/contextRoot/restapi/Name/id

Name é o tipo de recurso, e id é o valor de sua chave primária, NameKey.

O exemplo a seguir mostra uma chamada da API Detail para um pedido com OrderKey = 12345:
GET https://host:port/contextRoot/restapi/order/12345

A maioria das APIs Detail suporta parâmetros do identificador arbitrários. Para especificar esses parâmetros na URL de solicitação, substitua id pelo recurso detail e anexe os parâmetros após o ponto de interrogação.

O exemplo a seguir mostra uma chamada da API Detail que usa o recurso detail com parâmetros:
GET https://host:port/contextRoot/restapi/order/detail?EnterpriseKey=DEFAULT&OrderNo=Y1234&DocumentType=0003