Skip to content
AveraAveraAvera Documentation

Read a document's embedded items in one batch

POST
/api/v1/livedoc/embeds
curl --request POST \
  --url https://app.avera.io/api/v1/livedoc/embeds \
  --header 'Content-Type: application/json' \
  --data '{ "numbers": [ "example" ], "presentation": { "container": true, "nodeType": "ARRAY", "string": true, "integralNumber": true, "missingNode": true, "valueNode": true, "pojo": true, "number": true, "short": true, "int": true, "long": true, "double": true, "bigDecimal": true, "bigInteger": true, "textual": true, "boolean": true, "binary": true, "floatingPointNumber": true, "empty": true, "array": true, "null": true, "object": true, "float": true, "embeddedValue": true } }'

Resolves up to 2000 item numbers in one request and returns, for each number the branch resolves, the item with the attributes its page shows, whether it was ever released, which of its attributes are frozen records, and its related tables under the document’s presentation. A number the branch does not resolve is absent from the result. Live cards and frozen records run through the same resolver, so they are one computation.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
numbers
required
Array<string>
presentation
One of:
object
container
boolean
nodeType
string
Allowed values: ARRAY BINARY BOOLEAN MISSING NULL NUMBER OBJECT POJO STRING
string
boolean
integralNumber
boolean
missingNode
boolean
valueNode
boolean
pojo
boolean
number
boolean
short
boolean
int
boolean
long
boolean
double
boolean
bigDecimal
boolean
bigInteger
boolean
textual
boolean
boolean
boolean
binary
boolean
floatingPointNumber
boolean
empty
boolean
array
boolean
null
boolean
object
boolean
float
boolean
embeddedValue
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
embeds
required
Array<object>
object
item
required
object
id
required
string format: uuid
itemTypeId
required
string
canonicalId
required
string format: uuid
number
required
string
revision
string | null
seq
required
integer format: int64
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
workflowStateId
required
string
projectId
required
string format: uuid
branchId
required
string format: uuid
createdAt
required
string format: date-time
createdBy
required
string format: uuid
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
attributes
object | null
wasEverReleased
boolean | null
frozenAttributeIds
Array<string> | null
related
required
Array<object>
object
relationshipTypeId
required
string
direction
required
string
label
required
string
columns
required
Array<object>
object
slug
required
string
header
required
string
rows
required
Array<object>
object
number
required
string
itemTypeId
required
string
status
string | null
values
required
object
key
additional properties