Skip to content

Read a document's tree

GET
/api/v1/items/{itemId}/tree
curl --request GET \
--url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tree

The section tree the given document item version sees, with its members in order, derived outline numbers and verdicts. The tree is a projection of the saved body, resolved through the request’s branch: a historic version id reads the tree of the content that version saw. Responds 204 when the item has no content for the field.

itemId
required
string format: uuid
field
string

OK

Media type*/*
object
contentId
required
string format: uuid
staleCount
required
integer format: int32
sections
required
Array<object>
object
blockId
required
string
level
required
integer format: int32
ordinal
required
integer format: int32
parentBlockId
string | null
title
required
string
number
string | null
memberCount
required
integer format: int32
staleCount
required
integer format: int32
members
required
Array<object>
object
position
required
integer format: int32
canonicalId
required
string format: uuid
itemNumber
required
string
itemTypeId
required
string
title
string | null
sectionBlockId
required
string
outlineNumber
required
string
frozenSeq
integer | null format: int64
verdict
required
string