Skip to content
getgeolens.com
GeoLens Docs

List Attributes Endpoint

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

List all attribute metadata for a dataset.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
include_removed
Include Removed
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AttributeMetadataListResponse
object
attributes
required
Attributes
Array<object>
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>
total
required
Total
integer
Example generated
{
  "attributes": [
    {
      "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"
      ]
    }
  ],
  "total": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}