Skip to content
Registry StackDocsLatest
Search

Metadata dataset

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

Returns one visible portable metadata dataset with entity field metadata.

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

Portable metadata dataset record. See /metadata/datasets/{dataset_id} for the live document.

object
access_rights
required
string
adms_status
string
applicable_legislation
Array<string>
conforms_to
Array<string>
dataset_id
required
string
description
required
string
entities
required

Entity metadata keyed by entity name.

object
key
additional properties
object
concept_uri
string | null format: uri
description
string
fields
required

Field metadata keyed by field name.

object
key
additional properties
object
codelist_scheme_iri
string format: uri
concepts
Array<string>
constraints
object
key
additional properties
any
field_type
required
string
language
string
name
required
string
required
required
boolean
unit
string
key
additional properties
any
identifiers
Array<object>
object
key
additional properties
any
name
required
string
primary_key
required
string
relationships
Array<object>
object
concept_uri
string | null format: uri
foreign_key
required
string
kind
required
string
Allowed values: belongs_to has_many has_one
links
object
key
additional properties
any
name
required
string
target
required
string
key
additional properties
any
title
string
key
additional properties
any
evidence_offerings
object
key
additional properties
any
owner
required
string
policy
object
key
additional properties
any
sensitivity
required
string
spatial_coverage
string format: uri
title
required
string
update_frequency
required
string
key
additional properties
any
Examples
Examplemetadata_dataset

Portable metadata dataset record.

{
  "access_rights": "restricted",
  "adms_status": "under_development",
  "applicable_legislation": [],
  "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": {
      "concept_uri": "https://publicschema.org/concepts/Household",
      "description": "Registered household.",
      "fields": {
        "area_geometry": {
          "concepts": [],
          "constraints": {},
          "field_type": "string",
          "name": "area_geometry",
          "required": false
        },
        "id": {
          "concepts": [
            "https://example.test/vocab/properties/householdId"
          ],
          "constraints": {},
          "field_type": "string",
          "name": "id",
          "required": true
        },
        "region": {
          "codelist_scheme_iri": "https://example.test/vocab/codelists/Region",
          "concepts": [
            "https://example.test/vocab/properties/region"
          ],
          "constraints": {},
          "field_type": "string",
          "name": "region",
          "required": false
        }
      },
      "identifiers": [],
      "name": "household",
      "primary_key": "id",
      "relationships": [
        {
          "concept_uri": "https://example.test/vocab/relationships/householdMember",
          "foreign_key": "household_id",
          "kind": "has_many",
          "links": {
            "target_schema": "https://data.example.test/metadata/schema/social_registry/individual/schema.json"
          },
          "name": "members",
          "target": "individual"
        }
      ],
      "title": "Household"
    },
    "individual": {
      "concept_uri": null,
      "description": "",
      "fields": {
        "age": {
          "concepts": [],
          "constraints": {},
          "field_type": "integer",
          "name": "age",
          "required": false
        },
        "household_id": {
          "concepts": [],
          "constraints": {},
          "field_type": "string",
          "name": "household_id",
          "required": true
        },
        "id": {
          "concepts": [],
          "constraints": {},
          "field_type": "string",
          "name": "id",
          "required": true
        }
      },
      "identifiers": [],
      "name": "individual",
      "primary_key": "id",
      "relationships": [
        {
          "foreign_key": "household_id",
          "kind": "belongs_to",
          "links": {
            "target_schema": "https://data.example.test/metadata/schema/social_registry/household/schema.json"
          },
          "name": "household",
          "target": "household"
        }
      ],
      "title": "Individual"
    }
  },
  "evidence_offerings": {},
  "owner": "Social Ministry",
  "policy": {
    "assigner": "did:web:data.example.test",
    "permissions": [
      {
        "action": "odrl:use",
        "constraints": [],
        "duties": [],
        "target": "#dataset-social_registry"
      }
    ],
    "profile": [],
    "prohibitions": [],
    "uid": "#policy-social_registry-offer"
  },
  "sensitivity": "personal",
  "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"
}