Resource URI patterns
To access objects of a specific resource type, use the base URI request pattern of:
https://<URL>/<version>/<resource>?<parameters>
The following components comprise a full request URI:
| Component | Description | Example |
|---|---|---|
| <URL> | The URL of your Coro environment. Options include: api.secure.coro.net, api.secure-ca.coro.net, api.secure-eu.coro.net | api.secure.coro.net |
| <version> | The published API version | v1 |
| <resource> | The name of the resource you are making the requests against | tickets |
| <parameters> | (Optional) The query string used to modify a GET request to obtain a specific set of results | enrollmentCode=string&page=0&pageSize=50 |
Some requests might also require specific HTTP headers, such as the Workspace identifier or authentication token.
POST requests are supplemented with a request payload containing the object you want to store for that resource. This payload is represented by a JSON structure containing the key:value pairs from the resource specification.