Version 2
Version 2 of the API introduces the following features:
Features
Feature | Description |
Canonical Links | Some response bodies and headers now include canonical links to API objects. Links are provided in the link field of the response header, or the link property of the response body. |
Sync Endpoint Responses | Some Open Integration API endpoints now include additional data in their responses, such as a canonical link, a response message, and the object sourceId. |
204 Response Status | Endpoints that do not return response body content when a request is successfully processed now return responses with an HTTP status code of 204 instead of 200. |
Example curl Command
Use a curl command similar to the following to access version 2 of the API:
Note: Text surrounded in < > indicates a variable. You must replace variables with your own data to run the examples in this documentation. For example, replace the <username> variable with your username.
curl -u <username>:<password> -H "Version:2" https://<host>:<port>/primeapi/restapi/<endpoint>