Skip to content
AveraAveraAvera Documentation

List the version history of an item

GET
/api/v1/items/{canonicalId}/history
curl --request GET \
  --url 'https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/history?page=0&pageSize=50'

Addressed by the canonical id that identifies the item across all its versions. Versions are returned newest first. A version’s place on the timeline is its seq, which is project-wide and therefore not contiguous per item.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
canonicalId
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
page
integer format: int32
0
pageSize
integer format: int32
default: 50

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
items
required
Array<object>
object
id
required
string format: uuid
canonicalId
required
string format: uuid
itemTypeId
required
string
number
required
string
revision
string | null
seq
required
integer format: int64
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
current
required
boolean
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
required
Array<object>
object
id
required
string format: uuid
attributeDefinitionId
required
string
value
string | null
valueType
required
string
Allowed values: STRING TEXT INTEGER DECIMAL BOOLEAN DATE DATETIME ENUM USER_REFERENCE ROLE_REFERENCE ITEM_REFERENCE FILE_REFERENCE JSON PROMPT_LIST
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
contentModified
required
boolean
changeReason
string | null
changeAuthorActor
string | null
originatingItemActionId
string | null format: uuid
originatingAIProposalId
string | null format: uuid
total
required
integer format: int64
page
required
integer format: int32
pageSize
required
integer format: int32
hasNext
required
boolean
totalIsLowerBound
required
boolean