[]
        
(Showing Draft Content)

Admin

Admin

[DELETE] /api/v2/admin/approvers

Remove all the approver roles and abandon their ACLs when the document draft is disabled

Response

Status Code: 204

No Content

Status Code: 400

Bad Request

ServerPluginError

[GET] /api/v2/admin/knowledge-base

Get all knowledge base files

Response

Status Code: 200

Returns the list of knowledge base files

KnowledgeViewModel

Status Code: 400

If there was an error retrieving the knowledge base files

ServerPluginError

[POST] /api/v2/admin/knowledge-base

Upload a new knowledge base file

Response

Status Code: 200

Returns the created knowledge base file information

KnowledgeViewModel

Status Code: 400

If the file is empty, invalid type, too large, or there was an error uploading

ServerPluginError

[GET] /api/v2/admin/knowledge-base/{id}/download

Download a knowledge base file

Parameters

Name Type Located In Description
idRequired string path The ID of the knowledge base file

Response

Status Code: 200

Returns the file content

binary

Status Code: 400

There was an error with downloading

ServerPluginError

Status Code: 404

The knowledge base was not found

ServerPluginError

[DELETE] /api/v2/admin/knowledge-base/{id}

Delete a knowledge base file

Parameters

Name Type Located In Description
idRequired string path The ID of the knowledge base file to delete

Response

Status Code: 204

If the file was successfully deleted

Status Code: 400

There was an error deleting

ServerPluginError

Status Code: 404

The knowledge base was not found

ServerPluginError

[POST] /api/v2/admin/knowledge-base/{id}/rename

Rename a knowledge base file

Parameters

Name Type Located In Description
idRequired string path The ID of the knowledge base file to rename

Request Schema

KnowledgeRenameMode

Response

Status Code: 200

Returns the updated knowledge base file information

KnowledgeViewModel

Status Code: 400

There was an error with renaming

ServerPluginError

Status Code: 404

The knowledge base was not found

[GET] /api/v2/admin/knowledge-base/search

Search knowledge base content

Parameters

Name Type Located In Description
query string query Search query string

Response

Status Code: 200

Returns the list of search results

KnowledgeSearchResultViewModel

Status Code: 400

If an error occurs during the search process

ServerPluginError

Models

Ƭ ServerPluginError

Server plugin error

Name Type Description Example
codeNullable string error code
messageNullable string error message
contextNullable string error context
innerError ServerPluginError
extensionsNullable any Extended result

Ƭ KnowledgeViewModel

Knowledge View Model

Name Type Description Example
idNullable string Id
nameNullable string Name
typeNullable string Type
size int64 Size
createTime ISO DateTime Sting CreateTime

Ƭ KnowledgeRenameMode

Name Type Description Example
newNameNullable string

Ƭ KnowledgeSearchResultViewModel

Name Type Description Example
resultsNullable KnowledgeSearchResultViewModel+SearchResultItem

Ƭ KnowledgeSearchResultViewModel+SearchResultItem

Name Type Description Example
score any
resultNullable string