Consider the following guidelines when working with the Business 360 REST APIs:
•All resources and attributes are case sensitive.
•Use the login resource to start a REST API session. The session expires after 30 minutes of inactivity.
•Use the logout resource to log out of the Business 360 session included in the request header.
•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 is not configured, Business 360 uses JSON by default.
•For requests in XML, use an enclosing tag to define an object.
•XML responses that include a list of objects return the objects enclosed in the tag.
•For all resources except login, use a placeholder for the session ID in request headers. Replace the placeholder with the session ID data returned when you log in to a session.
•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.
•For POST requests, you must include all fields in the request object unless you submit the request in the 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.
•After you add or update records, the records take about a second to become searchable through the Search API.
•Specify the MODEL_VERSION header to avoid request failures due to version differences. To enhance performance and avoid failures, use the same model version parameter in successive request headers. For more information about the MODEL_VERSION header, see Request header.
•REST APIs aren't designed for batch operations due to potential performance impacts.
•To process a large volume of data efficiently, use batch jobs instead of REST APIs.
•If records are created through the MDM SaaS user interface, the Boolean field values remain undefined unless you explicitly set the values to true or false through an API.
•To search for records, use the search API because the use of the search match API is resource-intensive. Use the search match API only when the search API doesn't meet your requirements. The performance of the search match API depends on match models, match rules, and data volume.
•When you use a job instance API, avoid sending multiple sequential job instance requests. Monitor jobs and ensure that the previously triggered job is complete before you send the next request.
•The performance of the business entity record APIs depends on the complexity and the number of data quality rule associations.