CloudBees DocSite API / ListContentResult

Back to index

ListContentResult

href
Stringoptional
URL to retrieve the content detail - typically /api/contents/{id}
similarity
Numberoptional
Similarity to search term (0 to 1)
summary
Stringoptional
Brief summary / description of the search hit
uuid
Stringrequired
UUID of the content
data
Stringoptional
The data for this content record (note this will be in an abbreviated Markdown format, and will not necessarily render back to what the Docs system shows)
path
Stringrequired
Path to resource
componentGroup
String | nullrequired
The component group the resource is part of
component
Stringrequired
The component the resource is part of
version
Stringrequired
The version of the resource
type
Stringrequired
The datatype for this response (typically "page")
Possible values: "page"
title
String | nullrequired
Title for the match
lastModified
Stringrequired
Last modified date