Sign in
Datasets - Metadata

Update Attribute Endpoint

Update user-editable attribute metadata fields.

patch/datasets/{dataset_id}/attributes/{attribute_id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

dataset_idstring uuid required
attribute_idstring uuid required

Request body

titlestring nullable

Human-friendly column display name

descriptionstring nullable
unitsstring nullable

Measurement units, e.g. meters, kg

semantic_role'geometry' | 'identifier' | 'measure' | 'temporal' | 'categorical' | 'category' | 'label' | 'foreign_key' | 'other' nullable

Column role: geometry, identifier, measure, etc.

domain_type'continuous' | 'discrete' | 'categorical' | 'coded' | 'codedValue' | 'boolean' | 'text' | 'date' | 'temporal' | 'geometry' | 'range' nullable

Value domain: continuous, categorical, coded, etc.

Response

Successful Response

idstring uuid required
dataset_idstring uuid required
field_namestring required
titlestring nullable required
descriptionstring nullable required
data_typestring nullable required
unitsstring nullable required
domain_typestring nullable required
semantic_rolestring nullable

Inferred role: geometry, identifier, measure, etc.

ordinal_positioninteger nullable

Column position in the table (1-based)

is_nullableboolean nullable
is_currentboolean required

False if column was removed in a later version

user_modified_fieldsstring[] required

Field names manually edited by a user

Changes

No recorded changes to this operation across all 50 revisions of this API.