Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Articles List

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    String sTemp1
    Integer iTemp1

    // 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}}/support/knowledgeArticles" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLastStatus Of hoHttp To iTemp1
    Showln "Response status code = " iTemp1
    Get ComGetAsString Of hoSbResponseBody To sTemp1
    Showln sTemp1


End_Procedure

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