Using the Checkpoint Inspection REST API

This REST service provides a standard mechanism for showing checkpoint information contained in a checkpoint binary object. The storage of the checkpoint depends on the Hub connection. For a Service Cloud connection, the checkpoint storage may be in the Service Cloud database. For web service connections, the storage location will be an implementation of the web service connection.

For the permissions required to access the Checkpoint Inspection REST API, see Role Permissions for Intelligent Advisor REST APIs.

POST request

The request format looks like:

{"checkpoint":"UEsDBBQACAgIAD2J0UYAAAAAAAAA ... FwcERhdGFQSwUGAAAAAAUABQAjAQAAAAUAAAAA"}

POST response

The response format looks like:

{
   "rulebaseId": "DataTypes:2014-07-07T11:08:31Z",
   "productVersion": "12.2.0.56",
   "dataModel": {
      "type": "global",
      "inferred": false,
      "properties": {
         "timeofday_in": {
            "type": "time of day",
            "text": "time of day in"
         },
         ...
         "boolean_in": {
            "type": "boolean",
            "text": "boolean in"
         }
      }
   },
   "instanceData": {
      "@id": "global",
      "timeofday_in": "12:32:13",
      "text_in": "this is a text line",
      "number_in": 100,
      "dateandtime_in": "2003-03-03T14:32:22",
      "currency_in": 123457.89,
      "date_in": "2001-05-17",
      "boolean_in": true
   },
   "attachments": [],
   "links": [
     ...
   ]
}

The top-level properties of the response are:

Property Name	Description
rulebaseId	The identifier compiled into the policy model. Depending on the version of Policy Modeling that compiled the policy model, this may be a GUID, or may contain information about the policy model name and timestamp.
productVersion	The version identifier of Policy Modeling that compiled the policy model.
dataModel	The data model of the policy model, similar in format to that of the Batch Assess REST service.
instanceData	The instance data contained in the checkpoint, similar in format to that of the Batch Assess REST service.
attachments	A list of any attachments contained in the checkpoint.