HTTP API GET

GET Basics

The GET verb is used to fetch existing resources. The GET method is called on a collection resource or a singular resource.

GET Collection Resource

Get on the collection resource is supported through query semantics. It is used to query for the collection resource with the query parameters. Please refer to Query API to see all the options possible.

GET Singular Resource

Get on the singular resource is supported in two ways:

  1. Query on the primary key of the resource. It can be fetched through

    http://<host>:<port>/[api-context-root]/[resource name]/<resource primary key>

  2. Fetch on the functional key of the resource. It can be fetched through

    http://<host>:<port>/[api-context-root]/[resource name]/key/<resource functional key>

When using a functional key based GET, there is no need to know internal id’s. This is most useful in integration scenario’s (machine-machine communication). A functional key based GET uses the same request/response payload representation as the primary key based GET operation.

Functional key based GET is only supported on resources that have a "code" property. Exception: Policy: It is identified by code and version uniquely. If Functional key based GET is used for policy resource, the method is applied to the latest version of policy with that code.

The resource representation for the GET calls is detailed in document Default Resource Representation (GET). This default representation can also be influenced, this is detailed in the document Influence Resource Representation.