YOWO7 API
Knowledge

POST

/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}/pages/search

Scope knowledge:read

Search knowledge pages on a site by title or slug.

Pfad

siteIdPflicht
string (uuid)
Knowledge site identifier.
workspaceIdPflicht
string
Workspace that owns the resource.

Request

application/json · KnowledgeSearchRequestDto

query
string
Query.
locale
string
Language code.
limit
integer (int32)
Limit.

Antworten

200KnowledgePageTreeNodeDto[]The request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Knowledge page tree node.

id
string (uuid)
Identifier.
parentPageId
string (uuid)
Identifier of the parent page.
title
string
Title.
slug
string
Stable slug used in paths and API calls.
hasUnpublishedChanges
boolean
Whether unpublished changes is set.
sortOrder
integer (int32)
Order among siblings. Lower numbers come first.
depth
integer (int32)
Depth.
locale
string
Language code.
translationGroupId
string (uuid)
Identifier of the translation group.
isTranslated
boolean
Whether this is translated.
createdAt
string (date-time)
When this was created.
updatedAt
string (date-time)
When this was last updated.
publishedAt
string (date-time)
When the published was recorded.
createdByUserId
string (uuid)
Member who created this.
apiRefKey
string
API ref key.
children
KnowledgePageTreeNodeDto[]
Children.
400ApiProblemThe request is invalid.
401ApiProblemThe private app token is missing or invalid.
403ApiProblemThe token is missing the required scope, or this action is not allowed.
404ApiProblemThe workspace or resource was not found.
defaultApiProblemError response.
Search pages · YOWO7 API