Adaptive Search Queries: Smart Action
The smart actions indicate the list of actions which can be performed on that record. Smart Actions are the list of actions which can be performed on the record. The responses include the actions and additional information such as whether the action requires user input, privileges which grant access to the actions etc for the entity.
The smart action end point to a document is structured as :
GET <root>/11.13.18.05/entities/<entity name>/<id>/smartActions?metaModeluuid=<metaModelUuid>Sample POST Request for Fetching Collection
POST /crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
HTTP/1.1
Content-Type: application/json
Preference: transient
{ "entity":"Lead",
"smartActions":{"type":"detail"}
}
{
"items": [
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100000525143,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"Condition": "$StatusCode != 'QUALIFIED' &&$StatusCode != 'CONVERTED' &&$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174891,
"Method": "PATCH",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": "{undefined}",
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [
{
"Value": "leadId",
"UserActionId": 100100107174891,
"URLBindingName": "leadId",
"URLBindingId": 100100107174893,
"Binding": "RUNTIME"
}
],
"UserActionRequestPayload": [
{
"Value": "QUALIFIED",
"UserActionId": 100100107174891,
"RequestPayloadId": 100100107174892,
"RequestPayloadName": "StatusCode",
"ValueStruct": "JSONARRAYSTRING",
"MandatoryFlag": "Y",
"Binding": "STATIC"
}
],
"DisplayLabel": "Qualify",
"SystemActionFlag": "N",
"UserPrivilege": "{[{\"Resource\":\"privilege:MKL_MANAGE_SALES_LEAD_PRIV\",\"ResourceType\":\"oracle.adf.share.security.authorization.MethodPermission\",\"Action\":\"invoke\"}]}",
"Href": "/crmRestApi/resources/11.13.18.05/leads/leadId",
"UserActionName": "mklQualify",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
},
{
"Condition": "$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174903,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": null,
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "convertLeadToOpty",
"UserActionId": 100100107174903,
"RequestPayloadId": 100100107174904,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": "Y",
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 100100107174903,
"RequestPayloadId": 100100107174905,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": "Y",
"Binding": null
}
],
"DisplayLabel": "Convert Lead",
"SystemActionFlag": "N",
"UserPrivilege": null,
"Href": "/crmRestApi/resources/11.13.18.05/leads/",
"UserActionName": "CUST-mklConvert",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
},
{
"Condition": "$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174906,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": null,
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "runAssignment",
"UserActionId": 100100107174906,
"RequestPayloadId": 100100107174907,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": "Y",
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 100100107174906,
"RequestPayloadId": 100100107174908,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": "Y",
"Binding": null
}
],
"DisplayLabel": "Run Assignment",
"SystemActionFlag": "N",
"UserPrivilege": null,
"Href": "/crmRestApi/resources/11.13.18.05/leads/",
"UserActionName": "CUST-mklAssign",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
},
{
"Condition": "StatusCode != 'RETIRED' && StatusCode != 'NULL'",
"UserActionId": 300100176320389,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": "[{ \"name\" : \"MKL_CONVERT_SALES_LEAD_DATA\", \"object\" : \"MKL_LM_LEADS\", \"objectKey\" : \"LeadId\"}]",
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "convertLeadToOpty",
"UserActionId": 300100176320389,
"RequestPayloadId": 300100176320390,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": null,
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 300100176320389,
"RequestPayloadId": 300100176320391,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": null,
"Binding": null
}
],
"DisplayLabel": "Convert Lead",
"SystemActionFlag": "Y",
"UserPrivilege": "[ \"MKL_CONVERT_SALES_LEAD_PRIV\"]",
"Href": "/crmRestApi/resources/11.13.18.05/leads",
"UserActionName": "SDA-ConvertLeadToOpty",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
}
],
"links": [
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com:9011/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100000525143?metaModelUuid=ec544aad-8e1a-496e-8a54-284b4b22280c",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "QUALIFIED",
"LeadId": 300100104382044,
"StatusCode_localizedValue": "Qualified",
"_entity": "Lead",
"_smartActions": [
{
"Condition": "$StatusCode != 'UNQUALIFIED' &&$StatusCode != 'CONVERTED' &&$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174894,
"Method": "PATCH",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": "{undefined}",
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [
{
"Value": "leadId",
"UserActionId": 100100107174894,
"URLBindingName": "leadId",
"URLBindingId": 100100107174896,
"Binding": "RUNTIME"
}
],
"UserActionRequestPayload": [
{
"Value": "UNQUALIFIED",
"UserActionId": 100100107174894,
"RequestPayloadId": 100100107174895,
"RequestPayloadName": "StatusCode",
"ValueStruct": "JSONARRAYSTRING",
"MandatoryFlag": "Y",
"Binding": "STATIC"
}
],
"DisplayLabel": "Unqualify",
"SystemActionFlag": "N",
"UserPrivilege": "{[{\"Resource\":\"privilege:MKL_MANAGE_SALES_LEAD_PRIV\",\"ResourceType\":\"oracle.adf.share.security.authorization.MethodPermission\",\"Action\":\"invoke\"}]}",
"Href": "/crmRestApi/resources/11.13.18.05/leads/leadId",
"UserActionName": "mklUnqualify",
"ContentType": "application/vnc.oracle.adf.resourceitem+json",
"Entity": "leads"
},
{
"Condition": "$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174903,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": null,
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "convertLeadToOpty",
"UserActionId": 100100107174903,
"RequestPayloadId": 100100107174904,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": "Y",
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 100100107174903,
"RequestPayloadId": 100100107174905,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": "Y",
"Binding": null
}
],
"DisplayLabel": "Convert Lead",
"SystemActionFlag": "N",
"UserPrivilege": null,
"Href": "/crmRestApi/resources/11.13.18.05/leads/",
"UserActionName": "CUST-mklConvert",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
},
{
"Condition": "$StatusCode != 'RETIRED' &&$StatusCode != 'NULL'",
"UserActionId": 100100107174906,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": null,
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "runAssignment",
"UserActionId": 100100107174906,
"RequestPayloadId": 100100107174907,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": "Y",
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 100100107174906,
"RequestPayloadId": 100100107174908,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": "Y",
"Binding": null
}
],
"DisplayLabel": "Run Assignment",
"SystemActionFlag": "N",
"UserPrivilege": null,
"Href": "/crmRestApi/resources/11.13.18.05/leads/",
"UserActionName": "CUST-mklAssign",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
},
{
"Condition": "StatusCode != 'RETIRED' && StatusCode != 'NULL'",
"UserActionId": 300100176320389,
"Method": "POST",
"UserActionUserInput": [],
"ActiveFlag": "Y",
"DataPrivilege": "[{ \"name\" : \"MKL_CONVERT_SALES_LEAD_DATA\", \"object\" : \"MKL_LM_LEADS\", \"objectKey\" : \"LeadId\"}]",
"IncludedIn": "MklLeadVO",
"UserActionURLBinding": [],
"UserActionRequestPayload": [
{
"Value": "convertLeadToOpty",
"UserActionId": 300100176320389,
"RequestPayloadId": 300100176320390,
"RequestPayloadName": "name",
"ValueStruct": null,
"MandatoryFlag": null,
"Binding": "STATIC"
},
{
"Value": "[{\"name\":\"leadId\", \"value\":\"LeadId\",\"mandatory\":true,\"binding\":\"RUNTIME\"}]",
"UserActionId": 300100176320389,
"RequestPayloadId": 300100176320391,
"RequestPayloadName": "parameters",
"ValueStruct": "JSON_ARRAY_STRING",
"MandatoryFlag": null,
"Binding": null
}
],
"DisplayLabel": "Convert Lead",
"SystemActionFlag": "Y",
"UserPrivilege": "[ \"MKL_CONVERT_SALES_LEAD_PRIV\"]",
"Href": "/crmRestApi/resources/11.13.18.05/leads",
"UserActionName": "SDA-ConvertLeadToOpty",
"ContentType": "application/vnd.oracle.adf.action+json",
"Entity": "leads"
}
],
"links": [
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com:9011/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100104382044?metaModelUuid=ec544aad-8e1a-496e-8a54-284b4b22280c",
"kind": "item",
"name": "canonical"
}
]
}
],
"count": 2,
"hasMore": true,
"limit": 2,
"offset": 0,
"totalResults": 4
}
Post Request with only key
POST /crmRestApi/searchResources/11.13.18.05/custom-actions/queries?
HTTP/1.1
Host: servername.fa.us2.oraclecloud.com
Authorization: Basic c2FsZXNfYWRtaW46V2VsY29tZTE=
Content-Type: application/json
Preference: transient
{ "entity":"Lead",
"smartActions":{"type":"key"}
}
{
"items": [
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100168676553,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100168676553?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176647632,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176647632?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100169867402,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100169867402?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176308688,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176308688?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176801723,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176801723?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "QUALIFIED",
"LeadId": 300100000525143,
"StatusCode_localizedValue": "Qualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743392",
"DisplayLabel": "Unqualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100000525143?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176308579,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176308579?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176308868,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176308868?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176647676,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176647676?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
},
{
"StatusCode": "UNQUALIFIED",
"LeadId": 300100176308690,
"StatusCode_localizedValue": "Unqualified",
"_entity": "Lead",
"_smartActions": [
{
"UserActionId": "300100176743389",
"DisplayLabel": "Lead Assign"
},
{
"UserActionId": "300100176743398",
"DisplayLabel": "Qualify"
},
{
"UserActionId": "300100176743395",
"DisplayLabel": "Qualify"
}
],
"links": [
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/searchResources/11.13.18.05/entities/Lead/300100176308690?metaModelUuid=6ea2d6c7-9db9-46aa-8cd8-c3401f46f4b1",
"kind": "item",
"name": "canonical"
}
]
}
],
"count": 10,
"hasMore": true,
"limit": 10,
"offset": 0,
"totalResults": 22
}