Querying a Category
Scenario
This interface is invoked to query category information.
Method
This interface supports only the POST method.
URI
SIA authentication: https://ip:port/rest/ccikbs/v1/columnkngapi/queryColumnsBySuperCode
AK/SK authentication: https://ip:port/rest/ccikbs/v1/columnkngapi/queryColumnsBySuperCodeByAKSK
In the URL, ip and port indicate the machine-machine interface access address of the NSLB server.
Request Description
No. |
Parameter |
Type |
Mandatory or Not |
Default Value |
Description |
---|---|---|---|---|---|
1 |
Content-Type |
String |
Yes |
None |
The value is fixed at application/json;charset=UTF-8 (both authentication modes). |
2 |
X-TenantSpaceID |
String |
Yes |
None |
Tenant ID (required for SIA authentication). |
3 |
X-Access-Token |
String |
Yes |
None |
For details about the generation mode, see SIA Authentication (required for SIA authentication). |
4 |
Authorization |
String |
Yes |
None |
For details about the generation method, see Authentication Mode of Knowledge Base Interfaces (required for AK/SK authentication). |
No. |
Parameter |
Type |
Mandatory or Not |
Default Value |
Description |
---|---|---|---|---|---|
1 |
beyondColuId |
String |
Yes |
None |
Category ID. The ID of the first-level category is 0. |
2 |
ccId |
Number |
No |
None |
Call center ID. This parameter is mandatory for AK/SK authentication. |
3 |
vdn |
Number |
No |
None |
VDN ID. This parameter is mandatory for AK/SK authentication. |
Response Description
If this interface fails to be called, the corresponding error code is returned. For details about the error code data structure, see Table 3.
No. |
Parameter |
Type |
Description |
---|---|---|---|
1 |
resultCode |
String |
Result code. The options are as follows:
|
2 |
description |
String |
Request result description. |
3 |
datas |
List |
Request result object. For details, see Table 4. |
No. |
Parameter |
Type |
Description |
---|---|---|---|
1 |
coluKngId |
String |
Category knowledge ID. |
2 |
coluKngName |
String |
Category knowledge name. |
3 |
coluKngType |
String |
Category knowledge type. |
4 |
beyondColuId |
Number |
Category ID. The ID of the first-level category is 0. |
5 |
beyondColuPath |
Number |
Path of the category. The path of the first-level category is /. |
6 |
coluType |
Number |
Category type. |
7 |
code |
Number |
Category code. Code of a category or knowledge node in the category knowledge tree. |
8 |
superCode |
Number |
Upper-level category code. |
9 |
id |
String |
AppCube ID. |
Example
- Request header
Content-Type: application/json;charset=UTF-8 X-TenantSpaceID: ******** Authorization: ******************
- Request parameters
{ "beyondColuId": "0" }
- Response parameters
{ "returnCode": "0", "description": "success", "datas": [ { "coluKngName": "lzd0916 parent category", "code": "001", "coluType": 1, "coluKngType": 1, "superCode": "-1", "id": "caBE000000wqY7oYeYPA", "beyondColuId": "0", "beyondColuPath": "/", "coluKngId": "63e3e4b42c94482b95e04e911f497fbb" } ] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot