Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Articles Details

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/support/knowledgeArticles/:ARTICLE_ID",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Articles Details",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/support/knowledgeArticles/:ARTICLE_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "support",
        "knowledgeArticles",
        ":ARTICLE_ID"
      ],
      "query": [
        {
          "key": "channel",
          "value": "",
          "description": "Optional, defaults to user’s context. For information on channel values, see Valid channel Values.\nApp: Visible in the internal Salesforce Knowledge application\nPkb: Visible in the public knowledge base\nCsp: Visible in the Customer Portal\nPrm: Visible in the Partner Portal",
          "disabled": true
        },
        {
          "key": "updateViewStat",
          "value": "",
          "description": "Optional, defaults to true. If true, API updates the view count in the given channel as well as the total view count.",
          "disabled": true
        },
        {
          "key": "isUrlName",
          "value": "",
          "description": "Optional, defaults to false. If true, indicates that the last portion of the endpoint is a URL name instead of an article ID. Available in API v44.0 and later",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "ARTICLE_ID",
          "value": ""
        }
      ]
    },
    "description": "Get all online article fields, accessible to the user."
  },
  "response": [
  ]
}