Chilkat Online Tools

Node.js / Salesforce Platform APIs / Articles List

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";
    http.SetRequestHeader("Content-Type","application/json");

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/support/knowledgeArticles",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Response status code = " + http.LastStatus);
    console.log(sbResponseBody.GetAsString());

}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "Articles List",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/support/knowledgeArticles",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "support",
        "knowledgeArticles"
      ],
      "query": [
        {
          "key": "q",
          "value": "",
          "description": "Optional, Performs an SOSL search. If the query string is null, empty, or not given, an SOQL query runs.",
          "disabled": true
        },
        {
          "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": "categories",
          "value": "",
          "description": "Optional, defaults to None. Category group must be unique in each group:category pair, otherwise you get ARGUMENT_OBJECT_PARSE_ERROR",
          "disabled": true
        },
        {
          "key": "queryMethod",
          "value": "",
          "description": "values are: AT, BELOW, ABOVE, ABOVE_OR_BELOW. Only valid when categories are specified, defaults to ABOVE_OR_BELOW",
          "disabled": true
        },
        {
          "key": "sort",
          "value": "",
          "description": "Optional, a sortable field name LastPublishedDate, CreatedDate, Title, ViewScore. Defaults to LastPublishedDate for query and relevance for search.",
          "disabled": true
        },
        {
          "key": "order",
          "value": "",
          "description": "Optional, either ASC or DESC, defaults to DESC. Valid only when sort is valid",
          "disabled": true
        },
        {
          "key": "pageSize",
          "value": "",
          "description": "Optional, defaults to 20. Valid range 1 to 100",
          "disabled": true
        },
        {
          "key": "pageNumber",
          "value": "",
          "description": "Optional, defaults to 1",
          "disabled": true
        }
      ]
    },
    "description": "Get a page of online articles for the given language and category through either search or query."
  },
  "response": [
  ]
}