OUouterport
Knowledge Bases

Update knowledge base

Changed on

Update a knowledge base.

put/api/v0/knowledge-bases/{kb_id}

Request

Path parameters

kb_idstring uuid required

Request body

namestring nullable

New name for the knowledge base.

descriptionstring nullable

New description for the knowledge base.

Response

Successful Response

idstring uuid required

The ID of the knowledge base.

namestring required

The name of the knowledge base.

descriptionstring required

The description of the knowledge base.

document_countinteger required

The number of documents in the knowledge base.

created_atstring date-time required

When the knowledge base was created.

updated_atstring date-time required

When the knowledge base was last updated.

graph_enabledboolean

Whether the collection has graph capabilities enabled.

graph_status'disabled' | 'ready' | 'stale'

Graph projection status: disabled, ready, or stale.

graph_source_revisioninteger nullable

Counter bumped every time the graph's inputs change: a document joining or leaving the collection, or a member drawing's annotation being edited. Null when no graph layer exists.

graph_projected_revisioninteger nullable

The source revision the last projection ran against. Equal to graph_source_revision exactly when the projection is current, which is what graph_status reports as 'ready'. Null when no graph layer exists.

graph_packagesstring[]

Slugs of the ontology packages this collection's graph subscribes, sorted. Empty when no graph layer exists.

Changes

  • ecd5b922e78aRevision changes
    • info

      added the optional property // to the response with the status

  • 7f81908bcdfeRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status