Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_ActionListContext
string ls_ActionTarget
string ls_ActionTargetType
string ls_ApiName
string ls_ExternalId
string ls_IconUrl
string ls_Id
string ls_IsMassAction
string ls_Label
string ls_LwcComponent
string ls_PrimaryColor
string ls_RelatedListRecordId
string ls_RelatedSourceObject
string ls_Section
string ls_SourceObject
string ls_Subtype
string ls_TargetObject
string ls_TargetUrl
string ls_V_type
string ls_V_Url
string ls_ETag
string ls_Url
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "actions": {
// "Sample_Lightning_page": {
// "actions": [
// {
// "actionListContext": "Flexipage",
// "actionTarget": "/services/data/v58.0/quickActions/LogACall/describe",
// "actionTargetType": "Describe",
// "apiName": "Global.LogACall",
// "externalId": "00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png",
// "id": "0JV4H0000295294WAA",
// "isMassAction": "false",
// "label": "Log a Call",
// "lwcComponent": null,
// "primaryColor": "06A59A",
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": null,
// "sourceObject": "Sample_Lightning_page",
// "subtype": "LogACall",
// "targetObject": "Task",
// "targetUrl": null,
// "type": "QuickAction"
// },
// {
// "actionListContext": "Flexipage",
// "actionTarget": "/services/data/v58.0/quickActions/NewAccount/describe",
// "actionTargetType": "Describe",
// "apiName": "Global.NewAccount",
// "externalId": "00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s",
// "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png",
// "id": "0JV4H0000295295WAA",
// "isMassAction": "false",
// "label": "New Account",
// "lwcComponent": null,
// "primaryColor": "5867E8",
// "relatedListRecordId": null,
// "relatedSourceObject": null,
// "section": null,
// "sourceObject": "Sample_Lightning_page",
// "subtype": "Create",
// "targetObject": "Account",
// "targetUrl": null,
// "type": "QuickAction"
// }
// ],
// "links": [
// ],
// "url": "/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page"
// }
// },
// "eTag": "ff4486597111fb5e059e5dab793c8231",
// "url": "/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_V_Url = loo_JResp.StringOf("actions.Sample_Lightning_page.url")
ls_ETag = loo_JResp.StringOf("eTag")
ls_Url = loo_JResp.StringOf("url")
i = 0
li_Count_i = loo_JResp.SizeOfArray("actions.Sample_Lightning_page.actions")
do while i < li_Count_i
loo_JResp.I = i
ls_ActionListContext = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].actionListContext")
ls_ActionTarget = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].actionTarget")
ls_ActionTargetType = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].actionTargetType")
ls_ApiName = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].apiName")
ls_ExternalId = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].externalId")
ls_IconUrl = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].iconUrl")
ls_Id = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].id")
ls_IsMassAction = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].isMassAction")
ls_Label = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].label")
ls_LwcComponent = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].lwcComponent")
ls_PrimaryColor = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].primaryColor")
ls_RelatedListRecordId = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].relatedListRecordId")
ls_RelatedSourceObject = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].relatedSourceObject")
ls_Section = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].section")
ls_SourceObject = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].sourceObject")
ls_Subtype = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].subtype")
ls_TargetObject = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].targetObject")
ls_TargetUrl = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].targetUrl")
ls_V_type = loo_JResp.StringOf("actions.Sample_Lightning_page.actions[i].type")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("actions.Sample_Lightning_page.links")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES
Postman Collection Item JSON
{
"name": "Get Lightning Page Actions",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"flexipage",
":FLEXIPAGE_NAMES"
],
"variable": [
{
"key": "FLEXIPAGE_NAMES",
"value": "",
"description": "A Lightning page name, or a comma-delimited list of Lightning page names."
}
]
},
"description": "Get the actions on Lightning pages (FlexiPages)."
},
"response": [
{
"name": "Get Lightning Page Actions",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/flexipage/:FLEXIPAGE_NAMES",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"ui-api",
"actions",
"flexipage",
":FLEXIPAGE_NAMES"
],
"variable": [
{
"key": "FLEXIPAGE_NAMES",
"value": "Sample_Lightning_page",
"description": "A Lightning page name, or a comma-delimited list of Lightning page names."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Fri, 06 Oct 2023 11:45:49 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "ETag",
"value": "\"ff4486597111fb5e059e5dab793c8231--gzip\""
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"actions\": {\n \"Sample_Lightning_page\": {\n \"actions\": [\n {\n \"actionListContext\": \"Flexipage\",\n \"actionTarget\": \"/services/data/v58.0/quickActions/LogACall/describe\",\n \"actionTargetType\": \"Describe\",\n \"apiName\": \"Global.LogACall\",\n \"externalId\": \"00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png\",\n \"id\": \"0JV4H0000295294WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"Log a Call\",\n \"lwcComponent\": null,\n \"primaryColor\": \"06A59A\",\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": null,\n \"sourceObject\": \"Sample_Lightning_page\",\n \"subtype\": \"LogACall\",\n \"targetObject\": \"Task\",\n \"targetUrl\": null,\n \"type\": \"QuickAction\"\n },\n {\n \"actionListContext\": \"Flexipage\",\n \"actionTarget\": \"/services/data/v58.0/quickActions/NewAccount/describe\",\n \"actionTargetType\": \"Describe\",\n \"apiName\": \"Global.NewAccount\",\n \"externalId\": \"00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s\",\n \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png\",\n \"id\": \"0JV4H0000295295WAA\",\n \"isMassAction\": \"false\",\n \"label\": \"New Account\",\n \"lwcComponent\": null,\n \"primaryColor\": \"5867E8\",\n \"relatedListRecordId\": null,\n \"relatedSourceObject\": null,\n \"section\": null,\n \"sourceObject\": \"Sample_Lightning_page\",\n \"subtype\": \"Create\",\n \"targetObject\": \"Account\",\n \"targetUrl\": null,\n \"type\": \"QuickAction\"\n }\n ],\n \"links\": [],\n \"url\": \"/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page\"\n }\n },\n \"eTag\": \"ff4486597111fb5e059e5dab793c8231\",\n \"url\": \"/services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page\"\n}"
}
]
}
