Skip to content
Registry StackDocsLatest
Search

Metadata profile

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
profile
required
string

Profile 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
Example
{
  "entities": {
    "additionalProperty": {
      "relationships": [
        {
          "kind": "belongs_to"
        }
      ]
    }
  }
}

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