Chat now with support
Chat with Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API methods ImxClient command line program

Parameter formats

HTTP requests use the following types of parameters:

Related topics

Path parameters

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

Related topics

Query parameters

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)

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

Related topics

Response formats

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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating