Skip to main content
Version: 2.2.0

ARTICLES

From a provided search term, this method fetches and returns a collection of articles, with superficial data, through a REST endpoint.

GET /apigateway/se/exp/chatbot/api/articles.php

Query parameters:

Query parametersTypeRequiredDescription
fgLanguageNumericYesLanguage code
nmSearchTermStringYesTerm to be searched
oidKnowledgeBaseStringNoPrimary key of a knowledge base (KBKNOWLEDGEBASE.OID)

Request example:

curl --location 'https://my-domain.softexpert.com/apigateway/se/exp/chatbot/api/articles.php?fgLanguage=2&nmSearchTerm=Data%20Integration&oidKnowledgeBase=null' \
--header 'Authorization: <your_api_token>' \

Response example:

200 OK

{
"success": true,
"response": {
"total": 1,
"results": [
{
"oid": "873f51d4d9ece7d82a5a66b3463a4a12",
"identifier": "DI218",
"title": "Data Integration 2.1.8",
"knowledgeBaseTitle": "Release Notes 2.1",
"excerpt": "Article Text",
"shareLink": "https://my-domain.softexpert.com/machete/knowledge-base/public-articles/qHz57/data-integration-218",
"isPublic": false
}
]
}
}