Llamada a las API Detail

Acceder a las API Detail con solicitudes GET de HTTP. Las API Detail devuelven información específica sobre una entrada en una colección de recursos.

Las solicitudes Detail de REST utilizan los siguientes tipos de API, en función del Nombre del recurso que se ha especificado:

  • getName
  • getNameDetails
  • getNameHierarchy
  • getNameList

Por ejemplo, las solicitudes Detail para las órdenes utilizan getOrderDetails y las solicitudes Detail para las organizaciones utilizan getOrganizationHierarchy. Para ver la lista completa de recursos y API, vea los archivos Javadoc de REST.

Formato de solicitud

Utilice el siguiente formato de solicitud HTTP para llamar a las API Detail:

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

Nombre es el tipo de recurso y id es el valor de su clave primaria, NameKey.

El ejemplo siguiente muestra una llamada de la API Detail para una orden con OrderKey = 12345:
GET https://host:port/contextRoot/restapi/order/12345

La mayoría de las API Detail soportan parámetros de identificador arbitrarios. Para especificar estos parámetros en el URL de solicitud, sustituya id por el recurso detail y añada los parámetros después de un signo de interrogación.

El ejemplo siguiente muestra una llamada de API Detail que utiliza el recurso detail con parámetros:
GET https://host:port/contextRoot/restapi/order/detail?EnterpriseKey=DEFAULT&OrderNo=Y1234&DocumentType=0003