Help Center/ Cognitive Engagement Center/ API Reference/ iKBS Interface Reference/ Interface Description/ Querying the Knowledge List
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying the Knowledge List

Scenario

This interface is invoked to query the knowledge list.

Method

This interface supports only the POST method.

URI

SIA authentication: https://ip:port/rest/ccikbs/v1/columnkngapi/advancedSearch

AK/SK authentication: https://ip:port/rest/ccikbs/v1/columnkngapi/advancedSearchByAKSK

In the URL, ip and port indicate the machine-machine interface access address of the NSLB server.

Request Description

Table 1 Request header parameters

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).
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Default Value

Description

1

keyword

String

Yes

None

Keyword.

2

offset

Number

Yes

None

Pagination query offset. The default value is 0, indicating no offset.

3

limit

Number

Yes

None

Maximum number of records on a page during pagination query.

4

code

String

No

None

Code of a category or knowledge node in the category knowledge tree.

5

coluKngType

String

No

None

Category knowledge type. The options are as follows:

  • 1: category
  • 2: common knowledge
  • 3: Q&A knowledge

6

startTime

Number

No

None

Start time (timestamp).

7

endTime

Number

No

None

End time (timestamp).

8

ccId

Number

No

None

Call center ID. This parameter is mandatory for AK/SK authentication.

9

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 response data structure, see Table 3.

Table 3 Response body parameters

No.

Parameter

Type

Description

1

resultCode

String

Result code. The options are as follows:

  • 0: success
  • 1: failure

2

description

String

Request result description.

3

data

Object

Request result object. For details, see Table 4.
Table 4 Object parameters of data

No.

Parameter

Type

Description

1

total

String

Number of query records.

2

results

List

For details about object parameters of this parameter, see Table 5.
Table 5 Object parameters of results

No.

Parameter

Type

Description

1

adjs

String

Category knowledge attachment.

2

code

String

Code of a category or knowledge node in the category knowledge tree.

3

coluKngType

String

Category knowledge type. The options are as follows:

  • 1: category
  • 2: common knowledge
  • 3: Q&A knowledge

4

orderId

String

Sequence number.

5

creatorId

String

Creator employee ID.

6

modifierId

String

Modifier employee ID.

7

creatorName

String

Creator name.

8

beyondColuPath

String

Path of the category. The path of the first-level category is /.

9

contentInfo

String

Knowledge content.

10

coluKngName

String

Category knowledge name.

11

modifyTime

Number

Modification time.

12

validEndTime

Number

End time of the validity period.

13

summaryInfo

String

Summary.

14

serviceStatus

Number

Business status. The options are as follows:

  • 1: common
  • 2: hotspot
  • 3. new
  • 4: updated
  • 5: expired

15

clickNum

Number

Number of clicks.

16

keyword

String

Keyword.

17

coluKngId

String

Category knowledge ID.

18

curVersionNum

Number

Current system version.

19

validStartTime

Number

Start time of the validity period.

20

kngPath

String

Knowledge path.

21

superCode

String

Upper-level category code.

22

beyondColuId

String

Parent category ID.

23

createTime

Number

Creation time.

24

kngAdj

String

Category knowledge attachment.

25

tenantId

String

Tenant space ID.

Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
X-TenantSpaceID: ********
Authorization: ******************
  • Request parameters 
    {
    "keyword": "001",
    "offset": 0,
    "limit": 10,
    "code": "001",
    "coluKngType": "2",
    "startTime": 1658474893000,
    "endTime": 1658820502000
}
  • Response parameters 
    {
    "returnCode": "0",
    "description": "success",
    "data": {
        "total": 1,
        "results": [
            {
                "adjs": null,
                "code": "001004",
                "coluKngType": 2,
                "orderId": 3,
                "creatorId": "1662469040313943431",
                "modifierId": "1662469040313943431",
                "creatorName": "lzd0906003",
                "beyondColuPath": "/lzd0916 parent category",
                "contentInfo": "Business knowledge",
                "coluKngName": "Knowledge in the lzd parent category 0916005<font color = red>001</font color = red>",
                "modifyTime": "20220916153223",
                "validEndTime": "2022-12-16 14:22:34",
                "summaryInfo": "",
                "serviceStatus": 1,
                "clickNum": 0,
                "keyword": "",
                "coluKngId": "342ffe28003147f28b47da7d729d10e5",
                "curVersionNum": 1,
                "validStartTime": "2022-09-16 14:22:34",
                "kngPath": null,
                "superCode": "001",
                "beyondColuId": "63e3e4b42c94482b95e04e911f497fbb",
                "createTime": "2022-09-16 15:32:00",
                "kngAdj": null,
                "tenantId": "202209065604"
            }
        ]
    }
}
Parent topic: Interface Description