Platform REST Methods

The Platform REST API uses the same workflow mechanism as the standard Platform user interface. For instance, triggers designed to run on object record creation will run if a record is created through the REST API.

Each REST method is accessed through URLs of the form:

https://app.infiniteblue.com/rest/api/{method_name}

Parameters to methods can be supplied as URL parameters for GET calls or in the HTTP request for POST calls. An XML document or JSON object containing the result of the call or an error message will be returned as a response.

Example of a GET call:

https://app.infiniteblue.com/rest/api/logout?sessionId=ba0787e245befcb47@1482&output=xml

A successful response:

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok"></resp>

An error response:

 <?xml version="1.0" encoding="UTF-8" ?>
<resp status="login">
    <err>Session expired or invalid login credentials</err>
</resp>

Most REST methods require the logged-in user to have the appropriate permission for the type of object used in the method call. For example, calling the the create method to create a Customer record requires the logged-in user to have Create permission on the Customer object. The documentation for each method includes the required permissions.

See REST Metadata Methods for information about REST metadata methods.

Rate limiting

REST API requests can be rejected when they exceed the applicable Rate Limit Profile rule. Rate-limit rules can be specific to an endpoint and HTTP verb and can include a separate burst limit.

  • When a request exceeds the configured limit, the server returns a throttling response containing a message that identifies the exceeded period and allowed maximum. API clients should use the response returned by the server when implementing retry behavior.

    For administrator configuration and troubleshooting information, see Rate Limit.

  • The HTTP status code, retry headers, and reset-time information should be added only after they are confirmed as part of the supported API response contract.