ASaspect
Metadata

Get Attribute

Get a single metadata attribute by ID.

System global attributes are readable by any authenticated user. For share users, hidden attributes (configured in share settings) return 404.

get/metadata/attributes/{attribute_id}

Request

  • Base URL
    https://api.aspect.inc
  • URL
    https://api.aspect.inc/metadata/attributes/{attribute_id}
  • Auth
    API key in header Authorization

Path parameters

attribute_idstring uuid required

Attribute ID

Response

Successful Response

idstring uuid required

Unique identifier for this attribute

project_idstring uuid nullable

Project ID for project-specific attributes, null for system global

namestring required

Human-readable display name

data_type'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'single_select' | 'multi_select' | 'user_id' | 'person_id' | 'object_id' | 'directory_id' required

Type of value an attribute holds.

  • string: Text.
  • integer: A whole number.
  • float: A decimal number.
  • boolean: True or false.
  • datetime: A date and time.
  • single_select: One of the attribute's options.
  • multi_select: Any number of the attribute's options.
  • user_id: Users.
  • person_id: People recognized in the asset. Used by the built-in People attribute.
  • object_id: Objects recognized in the asset. Used by the built-in Objects attribute.
  • directory_id: The directories containing the asset. Used by the built-in Path attribute.
source'system' | 'user' | 'asset' required

Source of metadata attribute or value.

categorystring nullable

Grouping category for UI display

is_filterableboolean required

Whether this attribute can be used in filters

is_editableboolean required

Whether values for this attribute can be edited through metadata APIs

is_sortableboolean required

Whether assets can be sorted by this attribute

created_by_user_idstring uuid nullable

User who created the attribute; null for system attributes and ones created before creators were recorded

createdstring date-time required

When the attribute was created

updatedstring date-time required

When the attribute was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.