Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Articles List

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/support/knowledgeArticles', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END


    EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0
    EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO

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