API DocumentationCcaas
Knowledge Base Module▼
1.Create a new knowledge base : Create a new Knowledge base using this API
Request
Posthttps://api.worktual.co.uk/services/ccaas/v1/knowledgeBase
Headers Authorisation : token
Body :
Copy code
[ { "companyName": "string", "companyType": "string", "description": "string", "webSiteUrl": "string" } ]
Response : 200
Copy code
[ { "web_id": 638, "errcode": 0, "errmsg": "Website Scraper Added Successfully" } ]
2.Update a particular knowledge base : Update the particular knowledge base using this API
Request
Patchhttps://api.worktual.co.uk/services/ccaas/v1/knowledgeBase/{id}
Headers Authorisation : token
Parameters
id- knowledge base id.
Body :
Copy code
[ { "companyName": "string", "companyType": "string", "description": "string", "webSiteUrl": "string" } ]
Response : 200
Copy code
[ { "web_id": 638, "errcode": 0, "errmsg": "Website Scraper Updated Successfully" } ]
3.Get all knowledge base list : Retrieve the all knowledge base details in the account using this API
Request
Gethttps://api.worktual.co.uk/services/ccaas/v1/knowledgeBase
Headers Authorisation : token
Query Parameters :
offset- Default value is 0, increase by 1.
limit- Maximum records is 100. Default Value is 100.
Response : 200
Copy code
[ { "web_id": 521, "websiteId": "e22244cf-72e1-4558-85d1-44b8a89df3bb", "websiteUrl": "https://worktual.com/", "baseName": "worktual us", "discription": "", "CategoryCount": 0, "ArticlesCount": 0, "CompanyType": null } ]
4.Get particular knowledge base list : Retrieve the particular knowledge base details using this API
Request
Gethttps://api.worktual.co.uk/services/ccaas/v1/knowledgeBase/{id}
Headers Authorisation : token
Parameters :
Id- knowledge base id.
Query Parameters :
offset- Default value is 0, increase by 1.
limit- Maximum records is 100. Default Value is 100.
Response : 200
Copy code
[ { "web_id": 521, "websiteId": "e22244cf-72e1-4558-85d1-44b8a89df3bb", "websiteUrl": "https://worktual.com/", "baseName": "worktual us", "discription": "", "CategoryCount": 0, "ArticlesCount": 0, "CompanyType": null } ]
