Skip to content
AveraAveraAvera Documentation

Start a comment thread on an item

POST
/api/v1/items/{itemId}/threads
curl --request POST \
  --url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/threads \
  --header 'Content-Type: application/json' \
  --data '{ "anchorType": "ITEM", "anchorFieldId": "example", "body": "example", "contentFormat": "MARKDOWN", "severity": "CRITICAL", "category": "example", "anchorSelector": "example", "anchorText": "example" }'

A thread anchors to the whole item, to one field, or to a range in the document body. A field anchor snapshots the field’s value at creation; a body anchor carries a range selector plus the selected text, and reads report whether the anchor still resolves or has drifted as the body changed.

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
anchorType
required
string
Allowed values: ITEM FIELD LIVEDOC
anchorFieldId
string | null
body
required
string
contentFormat
required
string
Allowed values: MARKDOWN HTML PLAIN
severity
string | null
Allowed values: CRITICAL MAJOR MINOR OBSERVATION
category
string | null
anchorSelector
string | null
anchorText
string | null

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
anchorType
required
string
Allowed values: ITEM FIELD LIVEDOC
anchorItemId
required
string format: uuid
anchorItemTypeId
required
string
anchorFieldId
string | null
anchorSeq
required
integer format: int64
anchorRevision
string | null
anchorSelector
string | null
anchorText
string | null
currentAnchorText
string | null
anchorStatus
required
string
Allowed values: VALID DRIFTED MODIFIED DELETED
status
required
string
Allowed values: OPEN RESOLVED DISMISSED
resolvedAt
string | null format: date-time
resolvedBy
string | null format: uuid
resolutionNote
string | null
commentCount
required
integer format: int32
lastActivityAt
required
string format: date-time
createdAt
required
string format: date-time
createdBy
required
string format: uuid
comments
required
Array<object>
object
id
required
string format: uuid
threadId
required
string format: uuid
parentCommentId
string | null format: uuid
depth
required
integer format: int32
body
string | null
contentFormat
required
string
Allowed values: MARKDOWN HTML PLAIN
severity
string | null
Allowed values: CRITICAL MAJOR MINOR OBSERVATION
category
string | null
recommendation
string | null
resolutionState
required
string
Allowed values: OPEN RESOLVED DISMISSED
status
required
string
Allowed values: ACTIVE EDITED DELETED
version
required
integer format: int32
edited
required
boolean
deleted
required
boolean
createdByActor
required
string
Allowed values: USER AI SYSTEM
createdAt
required
string format: date-time
createdBy
required
string format: uuid
editedAt
string | null format: date-time
deletedAt
string | null format: date-time
deletedBy
string | null format: uuid