Skip to content
getgeolens.com

Get Attribute Endpoint

GET
/datasets/{dataset_id}/attributes/{attribute_id}/
curl --request GET \
--url https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/attributes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
--header 'Authorization: Bearer <token>'

Get a single attribute metadata entry.

dataset_id
required
Dataset Id
string format: uuid
attribute_id
required
Attribute Id
string format: uuid

Successful Response

Media type application/json
AttributeMetadataResponse
object
id
required
Id
string format: uuid
dataset_id
required
Dataset Id
string format: uuid
field_name
required
Field Name
string
title
required
Any of:
string
description
required
Any of:
string
data_type
required
Any of:
string
units
required
Any of:
string
domain_type
required
Any of:
string
semantic_role
Any of:
string
example_values
Any of:
Array
ordinal_position
Any of:
integer
is_nullable
Any of:
boolean
is_current
required
Is Current

False if column was removed in a later version

boolean
user_modified_fields
required
User Modified Fields

Field names manually edited by a user

Array<string>
Example generated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"field_name": "example",
"title": "example",
"description": "example",
"data_type": "example",
"units": "example",
"domain_type": "example",
"semantic_role": "example",
"example_values": [
"example"
],
"ordinal_position": 1,
"is_nullable": true,
"is_current": true,
"user_modified_fields": [
"example"
]
}

Bad request — invalid payload

Unauthorized — missing or invalid credentials

Forbidden — caller lacks write access

Not found

Conflict — resource state prevents the operation

Validation error

Internal server error