Query parameters are included in the URI path using a question mark or ampersand. For example, to receive a list of people ordered by their surname, after specifying the table person as a path parameter, you specify an orderBy as a query parameter. The following shows the URI format for this request:
<BaseURL>/api/entities/{table}
Example:
https://<Hostname>/AppServer/api/entities/person?orderBy=LastName
The first query parameter is preceded by a question mark, using the following format:
?parameterName=parameterValue
Subsequent query parameters are preceded by an ampersand, using the following format:
¶meterName=parameterValue
For example, to get all people who are marked as external ordered by their company membership, use the following request:
https://<Hostname>/AppServer/api/entities/person?where=IsExternal%3D0&orderBy=CompanyMember
NOTE: If a parameter is not shown in a request’s URI format with a slash, it is a query parameter; the URI format for a request shows only the path parameters. The description that follows each URI format provides information on the query parameters, if any.
Query parameters to be used in WHERE clauses and predefined WHERE clauses can be provided in the form @paramname=value. Per default they have the type string. Additionally, it is possible to pass the type with the name: @otherParam[int]=3. Types originate from DbVal class.
Depending on the HTTP request, use one of the following HTTP request methods:
-
Get: Use for requests that retrieve elements from the application server.
-
Put: Use for requests that change elements on the application server.
-
Post: Use for requests that create an element on the application server.
-
Delete: Use for request that delete an element on the application server.
The request methods Put and Post will also be used if:
Each request description specifies which HTTP request method to use.
To use these request methods on an application server they must be permitted by the web server.
Code-issued requests to the API should always return JSON, based on the request headers.
To return JSON output
Responses from the REST API use the codes listed below. When method executions fail, a descriptive error message is displayed.
Table 1: HTTP response codes
|
200 |
Success. |
|
204 |
Success. No content returned. |
|
401 |
Unauthorized. To use the One Identity Manager REST API, you first have to authenticate it against the application server. |
|
404 |
Not found. The requested entity is not found. |
|
405 |
Method not allowed. The HTTP request method that was specified is not the correct method for the request. |
|
500 |
Internal server error. The error message is returned in the property error string of the response.
{
"responseStatus": {
"message": "Sample text"},
"errorString": "Sample text",
"exceptions": [{
"number": 810017,
"message": "Sample text"}
]
}
Due to security, the detailed error message will not be returned to the caller. More information can be retrieved from the application server log on the application server. |
