Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Tabs

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJarrResp
    Integer iRespStatusCode
    Variant vJson
    Handle hoJson
    Boolean iCustom
    String sIconUrl
    String sLabel
    String sMiniIconUrl
    String sName
    String sSobjectName
    String sUrl
    Integer j
    Integer iCount_j
    String sColor
    String sContext
    String sTheme
    String sContentType
    Integer iHeight
    Integer iWidth
    Integer i
    Integer iCount_i
    String sTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/tabs" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonArray)) To hoJarrResp
    If (Not(IsComObjectCreated(hoJarrResp))) Begin
        Send CreateComObject of hoJarrResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJarrResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJarrResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJarrResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    // [
    //   {
    //     "colors": [
    //       {
    //         "color": "5867E8",
    //         "context": "primary",
    //         "theme": "theme4"
    //       },
    //       {
    //         "color": "236FBD",
    //         "context": "primary",
    //         "theme": "theme3"
    //       }
    //     ],
    //     "custom": false,
    //     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
    //     "icons": [
    //       {
    //         "contentType": "image/png",
    //         "height": 32,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png",
    //         "width": 32
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 16,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
    //         "width": 16
    //       },
    //       {
    //         "contentType": "image/svg+xml",
    //         "height": 0,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg",
    //         "width": 0
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 60,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png",
    //         "width": 60
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 120,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png",
    //         "width": 120
    //       }
    //     ],
    //     "label": "Accounts",
    //     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png",
    //     "name": "standard-Account",
    //     "sobjectName": "Account",
    //     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/001/o"
    //   },
    //   {
    //     "colors": [
    //       {
    //         "color": "056764",
    //         "context": "primary",
    //         "theme": "theme4"
    //       },
    //       {
    //         "color": "056764",
    //         "context": "primary",
    //         "theme": "theme3"
    //       }
    //     ],
    //     "custom": false,
    //     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
    //     "icons": [
    //       {
    //         "contentType": "image/png",
    //         "height": 32,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png",
    //         "width": 32
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 16,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
    //         "width": 16
    //       }
    //     ],
    //     "label": "Active Scratch Orgs",
    //     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png",
    //     "name": "standard-ActiveScratchOrg",
    //     "sobjectName": "ActiveScratchOrg",
    //     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o"
    //   },
    //   {
    //     "colors": [
    //       {
    //         "color": "06A59A",
    //         "context": "primary",
    //         "theme": "theme4"
    //       },
    //       {
    //         "color": "A55647",
    //         "context": "primary",
    //         "theme": "theme3"
    //       }
    //     ],
    //     "custom": false,
    //     "iconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
    //     "icons": [
    //       {
    //         "contentType": "image/png",
    //         "height": 32,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png",
    //         "width": 32
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 16,
    //         "theme": "theme3",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
    //         "width": 16
    //       },
    //       {
    //         "contentType": "image/svg+xml",
    //         "height": 0,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg",
    //         "width": 0
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 60,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png",
    //         "width": 60
    //       },
    //       {
    //         "contentType": "image/png",
    //         "height": 120,
    //         "theme": "theme4",
    //         "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png",
    //         "width": 120
    //       }
    //     ],
    //     "label": "Reports",
    //     "miniIconUrl": "https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png",
    //     "name": "standard-report",
    //     "sobjectName": "Report",
    //     "url": "https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o"
    //   }
    // ]

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

    Move 0 To i
    Get ComSize Of hoJarrResp To iCount_i
    While (i < iCount_i)
        Get ComObjectAt Of hoJarrResp i To vJson
        If (IsComObject(vJson)) Begin
            Get Create (RefClass(cComChilkatJsonObject)) To hoJson
            Set pvComObject Of hoJson To vJson
        End
        Get ComBoolOf Of hoJson "custom" To iCustom
        Get ComStringOf Of hoJson "iconUrl" To sIconUrl
        Get ComStringOf Of hoJson "label" To sLabel
        Get ComStringOf Of hoJson "miniIconUrl" To sMiniIconUrl
        Get ComStringOf Of hoJson "name" To sName
        Get ComStringOf Of hoJson "sobjectName" To sSobjectName
        Get ComStringOf Of hoJson "url" To sUrl
        Move 0 To j
        Get ComSizeOfArray Of hoJson "colors" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "colors[j].color" To sColor
            Get ComStringOf Of hoJson "colors[j].context" To sContext
            Get ComStringOf Of hoJson "colors[j].theme" To sTheme
            Move (j + 1) To j
        Loop

        Move 0 To j
        Get ComSizeOfArray Of hoJson "icons" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "icons[j].contentType" To sContentType
            Get ComIntOf Of hoJson "icons[j].height" To iHeight
            Get ComStringOf Of hoJson "icons[j].theme" To sTheme
            Get ComStringOf Of hoJson "icons[j].url" To sUrl
            Get ComIntOf Of hoJson "icons[j].width" To iWidth
            Move (j + 1) To j
        Loop

        Send Destroy of hoJson
        Move (i + 1) To i
    Loop



End_Procedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/tabs

Postman Collection Item JSON

{
  "name": "Tabs",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tabs"
      ]
    },
    "description": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm"
  },
  "response": [
    {
      "name": "Tabs",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tabs",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tabs"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 27 Sep 2023 15:29:05 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=6/15000"
        },
        {
          "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    {\n        \"colors\": [\n            {\n                \"color\": \"5867E8\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"236FBD\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/account_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Accounts\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/accounts16.png\",\n        \"name\": \"standard-Account\",\n        \"sobjectName\": \"Account\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/001/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"056764\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n                \"width\": 16\n            }\n        ],\n        \"label\": \"Active Scratch Orgs\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/wrench16.png\",\n        \"name\": \"standard-ActiveScratchOrg\",\n        \"sobjectName\": \"ActiveScratchOrg\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/2AS/o\"\n    },\n    {\n        \"colors\": [\n            {\n                \"color\": \"06A59A\",\n                \"context\": \"primary\",\n                \"theme\": \"theme4\"\n            },\n            {\n                \"color\": \"A55647\",\n                \"context\": \"primary\",\n                \"theme\": \"theme3\"\n            }\n        ],\n        \"custom\": false,\n        \"iconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n        \"icons\": [\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 32,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports32.png\",\n                \"width\": 32\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 16,\n                \"theme\": \"theme3\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n                \"width\": 16\n            },\n            {\n                \"contentType\": \"image/svg+xml\",\n                \"height\": 0,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report.svg\",\n                \"width\": 0\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 60,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_60.png\",\n                \"width\": 60\n            },\n            {\n                \"contentType\": \"image/png\",\n                \"height\": 120,\n                \"theme\": \"theme4\",\n                \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/t4v35/standard/report_120.png\",\n                \"width\": 120\n            }\n        ],\n        \"label\": \"Reports\",\n        \"miniIconUrl\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/img/icon/reports16.png\",\n        \"name\": \"standard-report\",\n        \"sobjectName\": \"Report\",\n        \"url\": \"https://nto-df17-demo-dev-ed.my.salesforce.com/00O/o\"\n    }\n]"
    }
  ]
}