Calling Detail APIs

Access Detail APIs with GET HTTP requests. Detail APIs return specific information about an entry in a resource collection.

REST Detail requests use the following types of APIs depending on the Name of the resource that is specified:

  • getName
  • getNameDetails
  • getNameHierarchy
  • getNameList

For example, Detail requests for orders use getOrderDetails, and Detail requests for organizations use getOrganizationHierarchy. To see the complete list of resources and APIs, view the REST Javadoc files.

Request format

Use the following HTTP request format to call Detail APIs:

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

Name is the type of resource, and id is the value of its primary key, NameKey.

The following example shows a Detail API call for an order with OrderKey = 12345:
GET https://host:port/contextRoot/restapi/order/12345

Most Detail APIs support arbitrary identifier parameters. To specify these parameters in the request URL, replace id with the detail resource and append the parameters after a question mark.

The following example shows a Detail API call that uses the detail resource with parameters:
GET https://host:port/contextRoot/restapi/order/detail?EnterpriseKey=DEFAULT&OrderNo=Y1234&DocumentType=0003