Skip to content
Registry StackDocsLatest
Search

BRegDCAT-AP catalog (JSON-LD)

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

Returns the visible metadata catalog as a BRegDCAT-AP JSON-LD document.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
profile
required
string

DCAT application profile identifier

Responses

Section titled “Responses”

200

Section titled “200”

BRegDCAT-AP JSON-LD catalog

Media typeapplication/ld+json
object
Examples
Examplebregdcat_ap

BRegDCAT-AP JSON-LD catalog with embedded SHACL shape.

{
  "@context": {
    "adms": "http://www.w3.org/ns/adms#",
    "dcat": "http://www.w3.org/ns/dcat#",
    "dcat:dataset": {
      "@type": "@id"
    },
    "dcat:landingPage": {
      "@type": "@id"
    },
    "dcatap": "http://data.europa.eu/r5r/",
    "dcterms": "http://purl.org/dc/terms/",
    "foaf": "http://xmlns.com/foaf/0.1/",
    "odrl": "http://www.w3.org/ns/odrl/2/",
    "odrl:hasPolicy": {
      "@type": "@id"
    },
    "sh": "http://www.w3.org/ns/shacl#"
  },
  "@id": "https://data.example.test/metadata/dcat.bregdcat-ap.jsonld",
  "@type": "dcat:Catalog",
  "dcat:dataset": [
    {
      "@id": "#dataset-social_registry",
      "@type": "dcat:Dataset",
      "adms:status": "under_development",
      "dcat:landingPage": "https://data.example.test/v1/datasets/social_registry",
      "dcterms:accessRights": "restricted",
      "dcterms:accrualPeriodicity": "monthly",
      "dcterms:description": "Synthetic social registry used for OpenAPI contract generation.",
      "dcterms:identifier": "social_registry",
      "dcterms:publisher": {
        "@type": "foaf:Agent",
        "foaf:name": "Ministry of Delivery"
      },
      "dcterms:rightsHolder": "Social Ministry",
      "dcterms:title": "Social Registry",
      "odrl:hasPolicy": {
        "@context": {
          "dcterms": "http://purl.org/dc/terms/",
          "odrl": "http://www.w3.org/ns/odrl/2/",
          "odrl:action": {
            "@type": "@id"
          },
          "odrl:assigner": {
            "@type": "@id"
          },
          "odrl:target": {
            "@type": "@id"
          },
          "odrl:uid": {
            "@type": "@id"
          }
        },
        "@id": "#policy-social_registry-offer",
        "@type": "odrl:Offer",
        "odrl:assigner": {
          "@id": "did:web:data.example.test"
        },
        "odrl:permission": [
          {
            "odrl:action": {
              "@id": "odrl:use"
            },
            "odrl:assigner": {
              "@id": "did:web:data.example.test"
            },
            "odrl:target": {
              "@id": "#dataset-social_registry"
            }
          }
        ],
        "odrl:uid": "#policy-social_registry-offer"
      }
    }
  ],
  "dcat:landingPage": "https://data.example.test",
  "dcterms:identifier": "registry-relay",
  "dcterms:publisher": {
    "@type": "foaf:Agent",
    "foaf:name": "Ministry of Delivery"
  },
  "dcterms:title": "Registry Relay API",
  "sh:shapesGraph": [
    {
      "@id": "#shape-social_registry-household",
      "@type": "sh:NodeShape",
      "sh:nodeKind": "sh:IRI",
      "sh:property": [
        {
          "@type": "sh:PropertyShape",
          "sh:name": "id",
          "sh:path": "https://example.test/vocab/properties/householdId"
        },
        {
          "@type": "sh:PropertyShape",
          "sh:name": "region",
          "sh:path": "https://example.test/vocab/properties/region"
        },
        {
          "@type": "sh:PropertyShape",
          "sh:name": "area_geometry",
          "sh:path": "area_geometry"
        }
      ],
      "sh:targetClass": "https://publicschema.org/concepts/Household"
    },
    {
      "@id": "#shape-social_registry-individual",
      "@type": "sh:NodeShape",
      "sh:nodeKind": "sh:IRI",
      "sh:property": [
        {
          "@type": "sh:PropertyShape",
          "sh:name": "id",
          "sh:path": "id"
        },
        {
          "@type": "sh:PropertyShape",
          "sh:name": "household_id",
          "sh:path": "household_id"
        },
        {
          "@type": "sh:PropertyShape",
          "sh:name": "age",
          "sh:path": "age"
        }
      ],
      "sh:targetClass": "https://publicschema.org/concepts/Record"
    }
  ]
}

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"
}

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"
}