Action Logs (GET, POST)

Retrieve a paginated list of Explainability action logs. Create an Explainability action log.

Resource

1/connect/decision-explainer/action-logs

Example for GET

1https://{yourInstance}.salesforce.com/services/data/{vXX.X}/connect/
2decision-explainer/action-logs?actionContextCode=001x0000005DmI3AAK

{vXX.X} is the API version.

{yourInstance} is the domain name of your Salesforce instance.

Example for POST

1https://{yourInstance}.salesforce.com/services/data/{vXX.X}/connect/
2decision-explainer/action-logs

Available Version

54.0

Requires Chatter

HTTP Methods

GET, POST

Request Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`actionContextCode`	String	The record ID within the context of the associated application’s action that’s used to retrieve action logs.	Required	54.0
`applicationSubType`	String	The subtype of the associated application for which the explainability log is generated. This matches one of the valid values in the ExplainabilityActionDef `ApplicationSubtype` field.	Optional	54.0
`applicationType`	String	The name of the application for which the explainability service is run. This matches one of the valid values in the ExplainabilityActionDef `ApplicationType` field.	Optional	54.0
`createdAfter`	String	A valid date time after which the explainability action log records are returned.	Optional	54.0
`createdBefore`	String	A valid date time before which the explainability action log records are returned.	Optional	54.0
`pageSize`	Integer	The number of explainability action log records to return. The value can range from 200 to 500.	Optional	54.0
`processType`	String	The process type of the associated application for which the explainability action log is generated. This matches one of the valid values in the ExplainabilityActionDef `ProcessType` field.	Optional	54.0
`queryMore`	String	A string returned from the previous request, which you must pass to the next request to get the next page.	Optional	54.0

Response Body for GET

Explainability Action Logs

Request Body for POST

JSON Example

1{
2"specificationName" : "EAD1",
3"name" : "testEAL1",
4"actionLog" : "{\"input\":{\"input\":{\"input\":2}},\"ruledefinition\":{\"calculationProcedureId\":\"0k0xx00000000JNAAY\",
5\"variables\":{\"details\":[{\"apiName\":\"total\",\"isEditable\":true,\"defaultValue\":null,\"displayName\":null,\"dataType\"
6:\"Number\",\"precision\":2,\"calculationMatrixName\":null,\"name\":\"total\",\"isUserDefined\":true,\"uiDisplayOrder\":null,
7\"id\":\"0kJxx000000018zEAA\"},{\"apiName\":\"input\",\"isEditable\":true,\"defaultValue\":\"10\",\"displayName\":null,\"dataType\"
8:\"Number\",\"precision\":2,\"calculationMatrixName\":null,\"name\":\"input\",\"isUserDefined\":true,\"uiDisplayOrder\":null,\"id\"
9:\"0kJxx00000001AbEAI\"}]},\"code\":null,\"endDate\":null,\"description\":null,\"message\":null,\"enabled\":true,\"versionNumber\":2,
10\"versionId\":\"0k1xx00000000knAAA\",\"root\":{\"steps\":[\"0mqxx00000001TxAAI\"]},\"name\":\"es1 V1 CLONE\",\"rank\":2,\"step\":
11{\"details\":{\"0mqxx00000001TxAAI\":{\"inputVariablesFormatText\":\"[{\\\"name\\\":\\\"input\\\",\\\"dataType\\\":\\\"Number\\\",
12\\\"alias\\\":\\\"input\\\"}]\",\"stepType\":\"Calculation\",\"outputVariablesFormatText\":\"{\\\"name\\\":\\\"total\\\",\\\"dataType\\\":
13\\\"Number\\\",\\\"alias\\\":\\\"total\\\"}\",\"conditionsUiFormattedText\":\"{\\\"bypass\\\":{},\\\"stepNumber\\\":3}\",
14\"formulaUiFormattedText\":null,\"description\":null,\"outputVariablesMappingText\":\"{\\\"total\\\":\\\"total\\\"}\",
15\"conditionsExpressionText\":null,\"calculationMatrixId\":null,\"isResultIncluded\":true,\"formulaExpressionText\":\"10 * input\",\"stage\":
16\"Calculation\",\"name\":\"Calculation\",\"childStepIds\":[],\"referenceCalculationProcedureId\":null,\"id\":\"0mqxx00000001TxAAI\",
17\"returnMessageValueSet\":\"{\\\"true\\\":\\\"\\\",\\\"false\\\":\\\"\\\"}\"}}},\"constants\":{\"details\":[]},\"startDate\":1637684784000,
18\"isSuccess\":null},\"runtime\":{\"output\":[{\"aggregationResults\":{},\"calculationResults\":[{\"total\":20,\"ID\":\"input\"}]}],\"simulate\"
19:{\"0mqxx00000001TxAAI\":{\"stepInputs\":{\"input\":2},\"stepResults\":{\"total\":20}}}}}",
20"actionLogDate" : "2021-09-15T03:18:30.081Z",
21"actionContextCode" : "0f0xx0000000001AAA"
22}

Properties

Name	Type	Description	Required or Optional	Available Version
`actionContextCode`	String	The valid Salesforce record ID that’s used to retrieve the explainability action logs.	Required	54.0
`actionLog`	String	The contents of the explainability action log.	Required	54.0
`actionLogDate`	String	The date and time when the explainability action log was generated by the application’s action.	Required	54.0
`actionLogOwnerId`	String	The ID of the user who owns the action log.	No	54.0
`additionalFilter`	String	The string that’s used as an additional filter criteria to fetch the explainability action logs.	Optional	57.0
`name`	String	A name to identify the explainability action log record.	No	54.0
`primaryFilter`	String	The string that’s used as the primary filter criteria to fetch the explainability action logs.	Optional	57.0
`secondaryFilter`	String	The string that’s used as the secondary filter criteria to fetch the explainability action logs.	Optional	57.0
`specificationName`	String	A unique name that identifies an active explainability action log record.	Required	54.0

Response Body for POST

Explainability Action Log Create