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. resources or resources-int if bypassing SSO.

Therefore, the minimum valid relative URI is:

/logisticsRestApi/resources

This URI corresponds to the list of supported versions of the API. Typically, the URI will always contain a specific version; the current version is "v2".

/logisticsRestApi/resources/v2

This URI will return the information about version 'v2' e.g. active status or deprecation date.

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. Many root resources in the application have complex parent/child structures, where there can be many different kinds of child resources and even child resources nested within these child resources (referred to here as grandchild resources). The general structure for such resource paths is as follows:

<root resource>/<root ID>/<child resource>/<child ID>/<grandchild resource>/...etc...

Only the root resource is mandatory for all URLs and by appending more path elements it is possible to narrow down the selected resources. To access a collection of child resources, or a specific child resource by ID, the relative parent ID must be specified.

Examples

To refer to a collection of order release root resources:

/orderReleases

To refer to a specific order release root resource with GID value of GUEST.OR_GID_1:

/orderReleases/GUEST.OR_GID_1

To refer to a collection of order release lines:

/orderReleases/GUEST.OR_GID_1/lines