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
To obtain results in PDF format
Related topics
Responses that are sent from the REST API use the following codes. If queries fail, an explanatory error message is displayed.
|
200 |
Query successful. |
|
204 |
Query successful. Response has no content. |
|
401 |
Access not authorized. The session must be authorized first. |
|
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. |
Related topics
API development includes a lot of asynchronous code with async/await constructs. To avoid deadlocks, use the ConfigureAwait(false) method for every await keyword.
For more information, see https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html and https://devblogs.microsoft.com/dotnet/configureawait-faq/.
Examples and help – Software Development Kit
To make it easier for you to start developing your API, One Identity provides a Software Development Kit (SDK) with lots of commented code example.
The SDK can be found on the installation medium in the directory QBM\dvd\AddOn\ApiSamples.
