Skip to content
Registry StackDocsLatest
Search

Dataset metadata

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

Returns metadata for the social_registry dataset: entities, publishers, sensitivity, update frequency, and links to JSON, JSON-LD, and SHACL artifacts.

Synthetic social registry used for OpenAPI contract generation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
dataset_id
required
string

Dataset identifier

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json

Per-dataset metadata. See /datasets/{id} for the live shape.

object
Examples
Exampledataset

Dataset summary.

{
  "access_rights": "restricted",
  "conforms_to": [
    "https://publicschema.org/concepts/Household",
    "https://schema.spdci.org/extensions/social/v1/Group"
  ],
  "dataset_id": "social_registry",
  "description": "Synthetic social registry used for OpenAPI contract generation.",
  "entities": [
    "household",
    "individual"
  ],
  "links": {
    "self": "/v1/datasets/social_registry"
  },
  "owner": "Social Ministry",
  "sensitivity": "personal",
  "standards": {
    "ogc_api_records": {
      "collection": "https://data.example.test/ogc/v1/records/collections/datasets",
      "conformance": "https://data.example.test/ogc/v1/records/conformance",
      "items": "https://data.example.test/ogc/v1/records/collections/datasets/items",
      "landing": "https://data.example.test/ogc/v1/records"
    },
    "spdci": {
      "registries": [
        {
          "entity": "household",
          "record_type": "spdci_social:Group",
          "registry": "sr",
          "sync_search": "https://data.example.test/dci/sr/registry/sync/search"
        }
      ]
    }
  },
  "title": "Social Registry",
  "update_frequency": "monthly"
}

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://registry-relay.dev/problems/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://registry-relay.dev/problems/auth/missing_credential"
}

404

Section titled “404”

Dataset not found or not visible to the caller.

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://registry-relay.dev/problems/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://registry-relay.dev/problems/auth/missing_credential"
}