Path parameters extend the URL path. A forward slash is used as the delimiter.
If a query uses a path parameters, they are given in URI format.
Example
https://<host name>/ApiServer/imx/sessions/exampleparameter
Path parameters extend the URL path. A forward slash is used as the delimiter.
If a query uses a path parameters, they are given in URI format.
Example
https://<host name>/ApiServer/imx/sessions/exampleparameter
Query parameter are appended to the URL with a question mark (?) or an ampersand (&).
The first query parameter must be prefixed by a question mark. In this case, you must use the following format:
?parameter name=parameter value (for example, ?orderBy=LastName)
Subsequent query parameters must be prefixed by an ampersand. In this case, you must use the following format:
¶meter name=parameter value (for example, ?sortOrder=ascending)
NOTE: Unknown query parameters are rejected by the server with error code 400. This also affects query parameters with incorrect upper and lower case spelling.
Example
https://<host name>/AppServer/portal/person?orderBy=LastName
Most API methods return results in JSON format (application/json). Furthermore, there is support for results in CSV and PDF format as long as the result of the respective API method is declared as exportable (with the AllowExport flag). Basically, an API method can return results in any format compatible with HTTP.
To obtain results in CSV format
In the query, set Accept header to text/csv.
To obtain results in PDF format
In the query, set Accept header to application/pdf.
NOTE: To obtain results in PDF format, the RPS module must be installed on your system.
Responses that are sent from the REST API use the following codes. If queries fail, an explanatory error message is displayed.
|
Response codes |
Description |
|---|---|
|
200 |
Query successful. |
|
204 |
Query successful. Response has no content. |
|
401 |
Access not authorized. The session must be authorized first. |
|
403 |
Login failed. For example, this response is sent if an incorrect user name or password is entered. |
|
404 |
The given resource could not be found. |
|
405 |
The HTTP method used is not allowed for this query. |
|
500 |
A server error occurred. The error message is sent with the response. On the ground of security, a detailed error message is not included in the response. For more information, see the application log file on the server. |
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center