Skip to content

List an item type's attribute assignments

GET
/api/v1/projects/{projectId}/schema/item-types/{itemTypeId}/attributes
curl --request GET \
--url 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema/item-types/example/attributes?includeDeleted=false'

Returns live attribute assignments by default, which is what form building and validation must see. With includeDeleted=true, deleted definitions are also returned, flagged isDeleted, so a value captured before an attribute was deleted can still render retired and read-only instead of being dropped silently.

projectId
required
string format: uuid
itemTypeId
required
string
includeDeleted
boolean

OK

Media type*/*
Array<object>
object
id
required
string
name
required
string
label
required
string
description
string | null
dataType
required
string
Allowed values: STRING TEXT INTEGER DECIMAL BOOLEAN DATE DATETIME ENUM USER_REFERENCE ROLE_REFERENCE ITEM_REFERENCE FILE_REFERENCE JSON PROMPT_LIST
unique
required
boolean
validation
string | null
enumValues
Array<string> | null
enumNumericValues
Array<integer> | null
formulaExpression
string | null
formulaDependencies
Array<string> | null
isDeleted
required
boolean
displayOrder
required
integer format: int32
required
required
boolean
defaultValue
string | null
readOnly
required
boolean
restricted
required
boolean
formulaKind
string | null
Allowed values: EXACT MAINTAINED ON_DEMAND