Resource Paths

This is the relative URI, relative to a specific server host, used to refer to an application resource.

All URIs must have the following in order:

1. context root for the REST API web module i.e. logisticsRestApi.
2. the application within the web module i.e. data or data-int if bypassing SSO.
3. the version of the API.

Therefore, all URIs will start with:

/logisticsRestApi/data/v1

The main part of resource path which follows the version, is the relative path or endpoint of the target REST resource and includes the resource names and IDs. In the remainder of the document this is referred to as the 'resource path' where the application context is assumed. The leftmost element, or root, in the path, corresponds to the root resource, though there are currently only the exportRequests and exportStatuses resources in the Data Export API.

Examples

To refer to a collection of export statuses resources:

/exportStatuses

To refer to a specific exportStatuses resource with a request ID of 123456:

/exportStatuses/123456