Skip to content
AveraAveraAvera Documentation

Summarize an item's changes since its last released version

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

Resolves the last RELEASED version as the baseline and returns, per changed attribute, the baseline and current values plus the change lineage folded from each version’s typed change reason. Powers the review-phase redline.

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
canonicalId
required
string format: uuid
baseline
One of:
object
id
required
string format: uuid
seq
required
integer format: int64
revision
string | null
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
current
required
object
id
required
string format: uuid
seq
required
integer format: int64
revision
string | null
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
attributes
required
Array<object>
object
slug
required
string
kind
required
string
Allowed values: MODIFIED UNCHANGED
baselineValue
string | null
currentValue
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
lineage
required
Array<object>
object
seq
required
integer format: int64
previousValue
string | null
newValue
string | null
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
changeAuthorActor
required
string
originatingItemActionId
string | null format: uuid