Skip to content
getgeolens.com
GeoLens Docs

Update Attribute Endpoint

PATCH
/datasets/{dataset_id}/attributes/{attribute_id}/
 
curl --request PATCH \
  --url https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/attributes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "domain_type": "continuous", "semantic_role": "geometry", "title": "example", "units": "example" }'

Update user-editable attribute metadata fields.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Request Body required

Section titled “Request Body required ”
Media type application/json
AttributeMetadataUpdate
object
description
Any of:
string
<= 2000 characters
domain_type
Any of:
string
Allowed values: continuous discrete categorical coded codedValue boolean text date temporal geometry range
semantic_role
Any of:
string
Allowed values: geometry identifier measure temporal categorical category label foreign_key other
title
Any of:
string
<= 500 characters
units
Any of:
string
<= 50 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

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

False if column was removed in a later version

boolean
is_nullable
Any of:
boolean
ordinal_position
Any of:
integer
semantic_role
Any of:
string
title
required
Any of:
string
units
required
Any of:
string
user_modified_fields
required
User Modified Fields

Field names manually edited by a user

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

400

Section titled “400 ”

Bad request — invalid payload

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

403

Section titled “403 ”

Forbidden — caller lacks write access

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

404

Section titled “404 ”

Not found

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

409

Section titled “409 ”

Conflict — resource state prevents the operation

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

422

Section titled “422 ”

Validation error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

500

Section titled “500 ”

Internal server error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}