List an item's upstream and downstream relationships
GET
/api/v1/items/{itemId}/relationships
const url = 'https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/relationships';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/relationshipsEach row carries the related item’s number, title, state and type, the suspect flag (derived at read time, never stored), and on an ordered relationship type its position. A live item’s list hides links to obsolete counterparts; an obsolete item shows everything, because it is a record. Document-owned memberships are marked with whether the document’s body places the member.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”itemId
required
string format: uuid
Responses
Section titled “Responses”OK
Media type*/*
object
itemId
required
string format: uuid
upstream
required
Array<object>
object
id
required
string format: uuid
direction
required
string
relationshipTypeId
required
string
relationshipTypeName
required
string
relationshipLabel
required
string
relatedItemId
required
string format: uuid
relatedItemNumber
required
string
relatedItemTitle
string | null
relatedItemStatus
required
string
relatedItemSeq
required
integer format: int64
relatedItemRevision
string | null
relatedItemTypeId
required
string
relatedItemTypeName
required
string
suspect
required
boolean
suspectReason
string | null
createdAt
required
string format: date-time
createdBy
required
string format: uuid
position
integer | null format: int64
documentOwned
required
boolean
placed
boolean | null
guest
required
boolean
guestMarked
required
boolean
downstream
required
Array<object>
object
id
required
string format: uuid
direction
required
string
relationshipTypeId
required
string
relationshipTypeName
required
string
relationshipLabel
required
string
relatedItemId
required
string format: uuid
relatedItemNumber
required
string
relatedItemTitle
string | null
relatedItemStatus
required
string
relatedItemSeq
required
integer format: int64
relatedItemRevision
string | null
relatedItemTypeId
required
string
relatedItemTypeName
required
string
suspect
required
boolean
suspectReason
string | null
createdAt
required
string format: date-time
createdBy
required
string format: uuid
position
integer | null format: int64
documentOwned
required
boolean
placed
boolean | null
guest
required
boolean
guestMarked
required
boolean