Skip to content

Explain who can do what to an item right now

GET
/api/v1/items/{itemId}/access
curl --request GET \
--url 'https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access?branchId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Per role, with explanations, for the item as resolved on the given branch. Project-admin gated.

itemId
required
string format: uuid
branchId
required
string format: uuid

OK

Media type*/*
object
itemId
required
string format: uuid
itemNumber
required
string
stateId
required
string
stateName
required
string
roles
required
Array<object>
object
roleId
required
string
roleName
required
string
edit
required
object
stateId
required
string
allowed
required
boolean
sources
required
Array<object>
object
kind
required
string
Allowed values: RULE NO_RULE PRINCIPAL_DIRECT NO_PROJECT_ROLES DECISION
detail
required
string
roleId
string | null
stateId
string | null
comment
required
object
stateId
required
string
allowed
required
boolean
sources
required
Array<object>
object
kind
required
string
Allowed values: RULE NO_RULE PRINCIPAL_DIRECT NO_PROJECT_ROLES DECISION
detail
required
string
roleId
string | null
stateId
string | null
directPrincipals
required
Array<string>
transitions
required
Array<object>
object
transitionId
required
string
name
required
string
mayFire
required
Array<string>
requiresSignature
required
boolean
separationOfDuties
required
boolean
endorsementSlots
required
Array<string>
distinctUsers
integer | null format: int32