Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Resources by Version

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sTooling
    String sMetadata
    String sEclair
    String sFolders
    String sPrechatForms
    String sContact_tracing
    String sJsonxform
    String sChatter
    String sPayments
    String sTabs
    String sAppMenu
    String sQuickActions
    String sQueryAll
    String sCommerce
    String sWave
    String sIot
    String sAnalytics
    String sSearch
    String sSmartdatadiscovery
    String sIdentity
    String sComposite
    String sParameterizedSearch
    String sFingerprint
    String sTheme
    String sNouns
    String sDomino
    String sV_event
    String sServiceTemplates
    String sRecent
    String sConnect
    String sLicensing
    String sLimits
    String sProcess
    String sDedupe
    String sAsync_queries
    String sQuery
    String sJobs
    String sMatch
    String sLocalizedvalue
    String sMobile
    String sEmailConnect
    String sConsent
    String sTokenizer
    String sCompactLayouts
    String sKnowledgeManagement
    String sSobjects
    String sActions
    String sSupport
    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}}/" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

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

    Showln "Response Body:"
    Get ComEmit Of hoJResp 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)

    // {
    //   "tooling": "/services/data/v58.0/tooling",
    //   "metadata": "/services/data/v58.0/metadata",
    //   "eclair": "/services/data/v58.0/eclair",
    //   "folders": "/services/data/v58.0/folders",
    //   "prechatForms": "/services/data/v58.0/prechatForms",
    //   "contact-tracing": "/services/data/v58.0/contact-tracing",
    //   "jsonxform": "/services/data/v58.0/jsonxform",
    //   "chatter": "/services/data/v58.0/chatter",
    //   "payments": "/services/data/v58.0/payments",
    //   "tabs": "/services/data/v58.0/tabs",
    //   "appMenu": "/services/data/v58.0/appMenu",
    //   "quickActions": "/services/data/v58.0/quickActions",
    //   "queryAll": "/services/data/v58.0/queryAll",
    //   "commerce": "/services/data/v58.0/commerce",
    //   "wave": "/services/data/v58.0/wave",
    //   "iot": "/services/data/v58.0/iot",
    //   "analytics": "/services/data/v58.0/analytics",
    //   "search": "/services/data/v58.0/search",
    //   "smartdatadiscovery": "/services/data/v58.0/smartdatadiscovery",
    //   "identity": "https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO",
    //   "composite": "/services/data/v58.0/composite",
    //   "parameterizedSearch": "/services/data/v58.0/parameterizedSearch",
    //   "fingerprint": "/services/data/v58.0/fingerprint",
    //   "theme": "/services/data/v58.0/theme",
    //   "nouns": "/services/data/v58.0/nouns",
    //   "domino": "/services/data/v58.0/domino",
    //   "event": "/services/data/v58.0/event",
    //   "serviceTemplates": "/services/data/v58.0/serviceTemplates",
    //   "recent": "/services/data/v58.0/recent",
    //   "connect": "/services/data/v58.0/connect",
    //   "licensing": "/services/data/v58.0/licensing",
    //   "limits": "/services/data/v58.0/limits",
    //   "process": "/services/data/v58.0/process",
    //   "dedupe": "/services/data/v58.0/dedupe",
    //   "async-queries": "/services/data/v58.0/async-queries",
    //   "query": "/services/data/v58.0/query",
    //   "jobs": "/services/data/v58.0/jobs",
    //   "match": "/services/data/v58.0/match",
    //   "localizedvalue": "/services/data/v58.0/localizedvalue",
    //   "mobile": "/services/data/v58.0/mobile",
    //   "emailConnect": "/services/data/v58.0/emailConnect",
    //   "consent": "/services/data/v58.0/consent",
    //   "tokenizer": "/services/data/v58.0/tokenizer",
    //   "compactLayouts": "/services/data/v58.0/compactLayouts",
    //   "knowledgeManagement": "/services/data/v58.0/knowledgeManagement",
    //   "sobjects": "/services/data/v58.0/sobjects",
    //   "actions": "/services/data/v58.0/actions",
    //   "support": "/services/data/v58.0/support"
    // }

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

    Get ComStringOf Of hoJResp "tooling" To sTooling
    Get ComStringOf Of hoJResp "metadata" To sMetadata
    Get ComStringOf Of hoJResp "eclair" To sEclair
    Get ComStringOf Of hoJResp "folders" To sFolders
    Get ComStringOf Of hoJResp "prechatForms" To sPrechatForms
    Get ComStringOf Of hoJResp "contact-tracing" To sContact_tracing
    Get ComStringOf Of hoJResp "jsonxform" To sJsonxform
    Get ComStringOf Of hoJResp "chatter" To sChatter
    Get ComStringOf Of hoJResp "payments" To sPayments
    Get ComStringOf Of hoJResp "tabs" To sTabs
    Get ComStringOf Of hoJResp "appMenu" To sAppMenu
    Get ComStringOf Of hoJResp "quickActions" To sQuickActions
    Get ComStringOf Of hoJResp "queryAll" To sQueryAll
    Get ComStringOf Of hoJResp "commerce" To sCommerce
    Get ComStringOf Of hoJResp "wave" To sWave
    Get ComStringOf Of hoJResp "iot" To sIot
    Get ComStringOf Of hoJResp "analytics" To sAnalytics
    Get ComStringOf Of hoJResp "search" To sSearch
    Get ComStringOf Of hoJResp "smartdatadiscovery" To sSmartdatadiscovery
    Get ComStringOf Of hoJResp "identity" To sIdentity
    Get ComStringOf Of hoJResp "composite" To sComposite
    Get ComStringOf Of hoJResp "parameterizedSearch" To sParameterizedSearch
    Get ComStringOf Of hoJResp "fingerprint" To sFingerprint
    Get ComStringOf Of hoJResp "theme" To sTheme
    Get ComStringOf Of hoJResp "nouns" To sNouns
    Get ComStringOf Of hoJResp "domino" To sDomino
    Get ComStringOf Of hoJResp "event" To sV_event
    Get ComStringOf Of hoJResp "serviceTemplates" To sServiceTemplates
    Get ComStringOf Of hoJResp "recent" To sRecent
    Get ComStringOf Of hoJResp "connect" To sConnect
    Get ComStringOf Of hoJResp "licensing" To sLicensing
    Get ComStringOf Of hoJResp "limits" To sLimits
    Get ComStringOf Of hoJResp "process" To sProcess
    Get ComStringOf Of hoJResp "dedupe" To sDedupe
    Get ComStringOf Of hoJResp "async-queries" To sAsync_queries
    Get ComStringOf Of hoJResp "query" To sQuery
    Get ComStringOf Of hoJResp "jobs" To sJobs
    Get ComStringOf Of hoJResp "match" To sMatch
    Get ComStringOf Of hoJResp "localizedvalue" To sLocalizedvalue
    Get ComStringOf Of hoJResp "mobile" To sMobile
    Get ComStringOf Of hoJResp "emailConnect" To sEmailConnect
    Get ComStringOf Of hoJResp "consent" To sConsent
    Get ComStringOf Of hoJResp "tokenizer" To sTokenizer
    Get ComStringOf Of hoJResp "compactLayouts" To sCompactLayouts
    Get ComStringOf Of hoJResp "knowledgeManagement" To sKnowledgeManagement
    Get ComStringOf Of hoJResp "sobjects" To sSobjects
    Get ComStringOf Of hoJResp "actions" To sActions
    Get ComStringOf Of hoJResp "support" To sSupport


End_Procedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Resources by Version",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        ""
      ]
    },
    "description": "Lists available resources for the specified API version, including resource name and URI."
  },
  "response": [
    {
      "name": "Resources by Version",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            ""
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 26 Sep 2023 13:29:43 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=3/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    \"tooling\": \"/services/data/v58.0/tooling\",\n    \"metadata\": \"/services/data/v58.0/metadata\",\n    \"eclair\": \"/services/data/v58.0/eclair\",\n    \"folders\": \"/services/data/v58.0/folders\",\n    \"prechatForms\": \"/services/data/v58.0/prechatForms\",\n    \"contact-tracing\": \"/services/data/v58.0/contact-tracing\",\n    \"jsonxform\": \"/services/data/v58.0/jsonxform\",\n    \"chatter\": \"/services/data/v58.0/chatter\",\n    \"payments\": \"/services/data/v58.0/payments\",\n    \"tabs\": \"/services/data/v58.0/tabs\",\n    \"appMenu\": \"/services/data/v58.0/appMenu\",\n    \"quickActions\": \"/services/data/v58.0/quickActions\",\n    \"queryAll\": \"/services/data/v58.0/queryAll\",\n    \"commerce\": \"/services/data/v58.0/commerce\",\n    \"wave\": \"/services/data/v58.0/wave\",\n    \"iot\": \"/services/data/v58.0/iot\",\n    \"analytics\": \"/services/data/v58.0/analytics\",\n    \"search\": \"/services/data/v58.0/search\",\n    \"smartdatadiscovery\": \"/services/data/v58.0/smartdatadiscovery\",\n    \"identity\": \"https://login.salesforce.com/id/00DB0000000DFgjMAG/005B0000003TOI6IAO\",\n    \"composite\": \"/services/data/v58.0/composite\",\n    \"parameterizedSearch\": \"/services/data/v58.0/parameterizedSearch\",\n    \"fingerprint\": \"/services/data/v58.0/fingerprint\",\n    \"theme\": \"/services/data/v58.0/theme\",\n    \"nouns\": \"/services/data/v58.0/nouns\",\n    \"domino\": \"/services/data/v58.0/domino\",\n    \"event\": \"/services/data/v58.0/event\",\n    \"serviceTemplates\": \"/services/data/v58.0/serviceTemplates\",\n    \"recent\": \"/services/data/v58.0/recent\",\n    \"connect\": \"/services/data/v58.0/connect\",\n    \"licensing\": \"/services/data/v58.0/licensing\",\n    \"limits\": \"/services/data/v58.0/limits\",\n    \"process\": \"/services/data/v58.0/process\",\n    \"dedupe\": \"/services/data/v58.0/dedupe\",\n    \"async-queries\": \"/services/data/v58.0/async-queries\",\n    \"query\": \"/services/data/v58.0/query\",\n    \"jobs\": \"/services/data/v58.0/jobs\",\n    \"match\": \"/services/data/v58.0/match\",\n    \"localizedvalue\": \"/services/data/v58.0/localizedvalue\",\n    \"mobile\": \"/services/data/v58.0/mobile\",\n    \"emailConnect\": \"/services/data/v58.0/emailConnect\",\n    \"consent\": \"/services/data/v58.0/consent\",\n    \"tokenizer\": \"/services/data/v58.0/tokenizer\",\n    \"compactLayouts\": \"/services/data/v58.0/compactLayouts\",\n    \"knowledgeManagement\": \"/services/data/v58.0/knowledgeManagement\",\n    \"sobjects\": \"/services/data/v58.0/sobjects\",\n    \"actions\": \"/services/data/v58.0/actions\",\n    \"support\": \"/services/data/v58.0/support\"\n}"
    }
  ]
}