Skip to content
AveraAveraAvera Documentation

Update an item's attributes or document content

PATCH
/api/v1/items/{itemId}
curl --request PATCH \
  --url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "attributes": { "additionalProperty": "example" }, "liveDoc": { "attributeId": "example", "jsonContent": "example", "removedMembers": [ "example" ] }, "aiAssisted": true }'

Routed by lifecycle state: a DRAFT item is written directly, appending a new version (applied); an item in REVIEW parks the edit as a pending proposal batch with a review link (proposed), leaving the frozen version untouched; a RELEASED or OBSOLETE item refuses the edit.

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
attributes
required
object
key
additional properties
liveDoc
One of:
object
attributeId
required
string
jsonContent
required
string
removedMembers
Array<string> | null
aiAssisted
required
boolean

Example generated

{
  "attributes": {
    "additionalProperty": "example"
  },
  "liveDoc": {
    "attributeId": "example",
    "jsonContent": "example",
    "removedMembers": [
      "example"
    ]
  },
  "aiAssisted": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
applied
One of:
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
proposed
One of:
object
batchId
required
string format: uuid
actionCount
required
integer format: int32
reviewLink
required
string