Reference Guide

Request
GET https://1.2.3.4/api/rest/event?select=id,severity
Response List of all instances in the specified collection that meet the request criteria. The response includes attribute
values as a set of name:value pairs for each returned instance:
[
{
"id": "0a739865-a233-4ef0-ae20-6ed014ad06fe",
"severity": "Minor"
},
{
"id": "51c0db9e-1d2b-4289-97b7-f361d67f7807",
"severity": "Minor"
},
.
.
.
]
JSON instance response body
A JSON instance response occurs in response to a GET instance request that results in a 200 Success HTTP status code. By
default, this response body contains only the identifier of the requested resource instance. Use the select request parameter
to specify the additional attribute values to return.
Example
GET instance response for an event
The following example illustrates an instance resource. It shows an instance resource returned in response to a GET instance
request for the event resource type with an identifier of 299a2f56-fea7-4e85-af0d-992294526911. Spaces outside the quoted
strings are used for readability, and are not significant.
Request
GET https://1.2.3.4/api/rest/event/299a2f56-fea7-4e85-af0d-992294526911?
select=id,severity
Response
{
"id": "299a2f56-fea7-4e85-af0d-992294526911",
"severity": "Info"
}
JSON create response body
A JSON create response body occurs in response to a POST operation for create that results in a 201 Created HTTP return
code. This response body contains the id attribute for the new resource.
Example
Create response for a local_user
The following examples illustrate the components of a minimal instance resource. It shows a minimal instance resource returned
in response to a successful POST request for creating a new local_user resource. The request body contains the arguments
used to populate the new resource.
16
REST responses