Identity Manager 9.1.3 - API Development Guide

HTTP requests use the following types of parameters:

• Path parameters

• Query parameters

Related topics

• Date formats

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.

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:

&parameter name=parameter value (for example, ?sortOrder=ascending)

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.

Related topics

• Response codes