Chilkat Online Tools

PowerBuilder / Salesforce Platform APIs / Articles Details

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody

// 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_Http.SetRequestHeader("Content-Type","application/json")

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}}/support/knowledgeArticles/:ARTICLE_ID",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

Write-Debug "Response status code = " + string(loo_Http.LastStatus)
Write-Debug loo_SbResponseBody.GetAsString()


destroy loo_Http
destroy loo_SbResponseBody

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": [
  ]
}