The following list is a summary of rules and guidelines to follow when working with the IDMC REST API:
•Use the login resource to start a REST API session. Reuse the session ID that's returned in the login response in all of the requests that you make during the session.
You can use a placeholder for the session ID in request headers. Replace the placeholder with the session ID data that's returned in the login response.
•A REST API session expires after 30 minutes of inactivity. However, best practice is to log out before the session expires. To continue work with the REST API, start a new session.
•Do not include icSessionId or INFA-SESSION-ID in the request header for login and register resources.
•Don't log out of a REST API session until all the requests that you've sent have been executed.
•For all resources except login, use a placeholder for the base URL. For version 2 resources, replace the placeholder with the URL returned in the serverUrl. For version 3 resources, replace the placeholder with the URL returned in the baseApiUrl.
•All resources and attributes are case-sensitive.
•Specify the format of the request and response in the header. Use the Content-Type attribute to specify the request format and the Accept attribute to specify the response format.
•If a request or response type isn't configured, IDMC uses JSON by default.
•For requests in JSON that use version 2 resources, you can optionally use the @type attribute to define an object. For requests in JSON that use version 3 resources, do not use the @type attribute.
•For requests in XML, use an enclosing <object name> tag to define an object.
•XML responses that include a list of objects return the objects enclosed in the <root> tag.
•For POST requests, you must include all fields in the request object unless you submit the request in JSON format using partial mode. Partial mode is not applicable to most resources. By default, the REST API uses full mode.
•Where indicated, enclose POST request attributes in the specified object. When no object is specified, include attributes in the request body.