Skip to content

List items grouped by a related item type

GET
/api/v1/projects/{projectId}/items/by-related-group
curl --request GET \
--url 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/items/by-related-group?groupByItemTypeId=example'

Groups items by their related item of the given type, for example risks by hazardous situation. Meta-model driven, so any item type can be the grouping axis; items with no such relation fall into a group without a group item.

projectId
required
string format: uuid
groupByItemTypeId
required
string
itemTypeId
string

OK

Media type*/*
Array<object>
object
groupItemId
string | null
groupItemNumber
string | null
groupItemName
string | null
items
required
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
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