Chilkat Online Tools

delphiAx / Salesforce Platform APIs / Get Photo Actions

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
actionListContext: WideString;
actionTarget: WideString;
actionTargetType: WideString;
apiName: WideString;
externalId: WideString;
iconUrl: WideString;
id: WideString;
isMassAction: WideString;
label: WideString;
lwcComponent: WideString;
primaryColor: WideString;
relatedListRecordId: WideString;
relatedSourceObject: WideString;
section: WideString;
sourceObject: WideString;
subtype: WideString;
targetObject: WideString;
targetUrl: WideString;
v_type: WideString;
v_Url: WideString;
eTag: WideString;
url: WideString;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://domain.com/services/data/v{{version}}/ui-api/actions/photo/:RECORD_IDS',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "actions": {
//     "0F94H000000UF2xSAG": {
//       "actions": [
//         {
//           "actionListContext": "Photo",
//           "actionTarget": null,
//           "actionTargetType": "Invoke",
//           "apiName": "ViewPhotoAction",
//           "externalId": "00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png",
//           "id": "0JV4H0000301820WAA",
//           "isMassAction": "false",
//           "label": "View Photo",
//           "lwcComponent": null,
//           "primaryColor": "939393",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": "Page",
//           "sourceObject": "0F94H000000UF2xSAG",
//           "subtype": null,
//           "targetObject": null,
//           "targetUrl": null,
//           "type": "StandardButton"
//         },
//         {
//           "actionListContext": "Photo",
//           "actionTarget": null,
//           "actionTargetType": "Invoke",
//           "apiName": "UpdatePhotoAction",
//           "externalId": "00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png",
//           "id": "0JV4H0000301821WAA",
//           "isMassAction": "false",
//           "label": "Update Photo",
//           "lwcComponent": null,
//           "primaryColor": "939393",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": "Page",
//           "sourceObject": "0F94H000000UF2xSAG",
//           "subtype": null,
//           "targetObject": null,
//           "targetUrl": null,
//           "type": "StandardButton"
//         },
//         {
//           "actionListContext": "Photo",
//           "actionTarget": null,
//           "actionTargetType": "Invoke",
//           "apiName": "DeletePhotoAction",
//           "externalId": "00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction",
//           "iconUrl": "https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png",
//           "id": "0JV4H0000301822WAA",
//           "isMassAction": "false",
//           "label": "Delete Photo",
//           "lwcComponent": null,
//           "primaryColor": "939393",
//           "relatedListRecordId": null,
//           "relatedSourceObject": null,
//           "section": "Page",
//           "sourceObject": "0F94H000000UF2xSAG",
//           "subtype": null,
//           "targetObject": null,
//           "targetUrl": null,
//           "type": "StandardButton"
//         }
//       ],
//       "links": [
//       ],
//       "url": "/services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG"
//     }
//   },
//   "eTag": "802f98780c61a3109be0a574d2915772",
//   "url": "/services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

v_Url := jResp.StringOf('actions.0F94H000000UF2xSAG.url');
eTag := jResp.StringOf('eTag');
url := jResp.StringOf('url');
i := 0;
count_i := jResp.SizeOfArray('actions.0F94H000000UF2xSAG.actions');
while i < count_i do
  begin
    jResp.I := i;
    actionListContext := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].actionListContext');
    actionTarget := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].actionTarget');
    actionTargetType := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].actionTargetType');
    apiName := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].apiName');
    externalId := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].externalId');
    iconUrl := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].iconUrl');
    id := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].id');
    isMassAction := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].isMassAction');
    label := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].label');
    lwcComponent := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].lwcComponent');
    primaryColor := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].primaryColor');
    relatedListRecordId := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].relatedListRecordId');
    relatedSourceObject := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].relatedSourceObject');
    section := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].section');
    sourceObject := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].sourceObject');
    subtype := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].subtype');
    targetObject := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].targetObject');
    targetUrl := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].targetUrl');
    v_type := jResp.StringOf('actions.0F94H000000UF2xSAG.actions[i].type');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('actions.0F94H000000UF2xSAG.links');
while i < count_i do
  begin
    jResp.I := i;
    i := i + 1;
  end;

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/ui-api/actions/photo/:RECORD_IDS

Postman Collection Item JSON

{
  "name": "Get Photo 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/photo/:RECORD_IDS",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "ui-api",
        "actions",
        "photo",
        ":RECORD_IDS"
      ],
      "variable": [
        {
          "key": "RECORD_IDS",
          "value": ""
        }
      ]
    },
    "description": "Get the photo actions for pages. Currently, only group and user pages support photo actions."
  },
  "response": [
    {
      "name": "Get Photo Actions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/ui-api/actions/photo/:RECORD_IDS",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "ui-api",
            "actions",
            "photo",
            ":RECORD_IDS"
          ],
          "variable": [
            {
              "key": "RECORD_IDS",
              "value": "0F94H000000UF2xSAG",
              "description": "A single record ID, or a comma-delimited list of record IDs."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 11:50:11 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": "\"802f98780c61a3109be0a574d2915772--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        \"0F94H000000UF2xSAG\": {\n            \"actions\": [\n                {\n                    \"actionListContext\": \"Photo\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"ViewPhotoAction\",\n                    \"externalId\": \"00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:ViewPhotoAction\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png\",\n                    \"id\": \"0JV4H0000301820WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"View Photo\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"939393\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0F94H000000UF2xSAG\",\n                    \"subtype\": null,\n                    \"targetObject\": null,\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                },\n                {\n                    \"actionListContext\": \"Photo\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"UpdatePhotoAction\",\n                    \"externalId\": \"00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:UpdatePhotoAction\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png\",\n                    \"id\": \"0JV4H0000301821WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Update Photo\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"939393\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0F94H000000UF2xSAG\",\n                    \"subtype\": null,\n                    \"targetObject\": null,\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                },\n                {\n                    \"actionListContext\": \"Photo\",\n                    \"actionTarget\": null,\n                    \"actionTargetType\": \"Invoke\",\n                    \"apiName\": \"DeletePhotoAction\",\n                    \"externalId\": \"00D58000000arpq:0F94H000000UF2xSAG::Photo:Desktop:StandardButton:DeletePhotoAction\",\n                    \"iconUrl\": \"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/email_120.png\",\n                    \"id\": \"0JV4H0000301822WAA\",\n                    \"isMassAction\": \"false\",\n                    \"label\": \"Delete Photo\",\n                    \"lwcComponent\": null,\n                    \"primaryColor\": \"939393\",\n                    \"relatedListRecordId\": null,\n                    \"relatedSourceObject\": null,\n                    \"section\": \"Page\",\n                    \"sourceObject\": \"0F94H000000UF2xSAG\",\n                    \"subtype\": null,\n                    \"targetObject\": null,\n                    \"targetUrl\": null,\n                    \"type\": \"StandardButton\"\n                }\n            ],\n            \"links\": [],\n            \"url\": \"/services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG\"\n        }\n    },\n    \"eTag\": \"802f98780c61a3109be0a574d2915772\",\n    \"url\": \"/services/data/v58.0/ui-api/actions/photo/0F94H000000UF2xSAG\"\n}"
    }
  ]
}