Reference Guide

Request
POST https://1.2.3.4/api/rest/local_user
Request
body
{
"name": "User1",
"password": "myPassword",
"role_id": "1"
}
Response
{
"id": "4"
}
Response with no body
A response with no body occurs in response to a DELETE request that results in a 204 No Content status code. In this
circumstance, response headers are returned with the empty response body. A response with no body also occurs in response
to an action POST request that does not have output data. This response with no body also occurs in response to a successful
synchronous DELETE instance request that does not have output data and that results in a 204 No Content status code.
JSON job response body
A JSON response body occurs in response to an asynchronous request that results in a 202 Accepted HTTP return code.
This response body contains the job id. You can query the job resource instance to find out whether the job completed and to
get the response to the asynchronous request. For a description of the job resource type, see the job topic in the Reference
content on page 43.
Example
Deletion response for a local_user
The following example returns a job resource instance in response to a successful asynchronous DELETE request.
Request
DELETE https://1.2.3.4/api/rest/local_user/4?is_async=true
Response
{
"id": "476c903a-1bc2-4370-9a4b-426594ed9604"
}
Error response
An error response is returned in response to an unsuccessful request; that is, a request that returns a 4xx or 5xx HTTP status
code. Unlike the response bodies returned by successful requests, an error response cannot be queried independently.
For a description of the error response attributes, see the Reference content on page 43.
Example
Error response for a POST request
The following example returns an error response in response to an unsuccessful POST request:
REST responses
17