立即与支持人员聊天
与支持团队交流

Identity Manager 8.1.4 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API 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 files API Server ImxClient command line program

Parameter formats

HTTP requests use the following types of parameters:

Related topics

URL parameters

URL parameters extend the URL path. A forward slash is used as the delimiter.

If a query uses a URL 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)

Example

https://<host name>/AppServer/portal/person?orderBy=LastName

Related topics

Response formats

Most API methods return results in JSON format (application/json). Results returned in CSV and PDF formats are also supported if the result of the API method is declared as exportable.

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 applciation/pdf.

    NOTE: To obtain results in PDF format, the RPS module must be installed on your system.

Related topics
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级