Skip to content
Registry StackDocsDocumentation preview
Search

Get dataset dimension

GET
/v1/datasets/{dataset_id}/dimensions/{item_id}
curl --request GET \
  --url https://data.example.test/v1/datasets/example/dimensions/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
item_id
required
string

Dimension identifier

dataset_id
required
string

Dataset identifier

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
aggregates
required
Array<object>
object
aggregate_id
required
string
edr_area_href
string
edr_collection_id
string
href
required
string
codelist
string | null format: uri
field
required
string
id
required
string
label
required
string
links
required
Array<object>
object
href
required
string
rel
required
string
type
string
key
additional properties
any
queryable_via
required
Array<string>
Examplegenerated
{
  "aggregates": [
    {
      "aggregate_id": "example",
      "edr_area_href": "example",
      "edr_collection_id": "example",
      "href": "example"
    }
  ],
  "codelist": "https://example.com",
  "field": "example",
  "id": "example",
  "label": "example",
  "links": [
    {
      "href": "example",
      "rel": "example",
      "type": "example"
    }
  ],
  "queryable_via": [
    "example"
  ]
}

401

Section titled “401”

Missing or invalid bearer credential.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

403

Section titled “403”

Authenticated principal lacks the scope required for this operation.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

404

Section titled “404”

Dimension definition not found for this dataset.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}

default

Section titled “default”

Problem Details error response.

Media typeapplication/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object
code
required
string
detail
required
string
request_id
required
string
status
required
integer format: int32
title
required
string
type
required
string format: uri
key
additional properties
any
Example
{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://id.registrystack.org/problems/registry-relay/auth/missing_credential"
}