List items related to one item via a relationship type
GET
/api/v1/projects/{projectId}/items/by-related
const url = 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items/by-related?relatedItemId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&relationshipTypeId=example&direction=downstream';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/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items/by-related?relatedItemId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&relationshipTypeId=example&direction=downstream'Filters by a related item on one side of the relationship: with direction downstream, the default, the related item is the downstream endpoint and the upstream items are returned; with direction upstream, the reverse.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”projectId
required
string format: uuid
Query Parameters
Section titled “Query Parameters”relatedItemId
required
string format: uuid
relationshipTypeId
required
string
direction
string
Responses
Section titled “Responses”OK
Media type*/*
Array<object>
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
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