Skip to content
Registry StackDocsDocumentation preview
Search

Dataset policy (ODRL JSON-LD)

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

Returns the ODRL access-policy document for one visible dataset.

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”

ODRL JSON-LD dataset policy

Media typeapplication/ld+json
object
Examples
Exampledataset_policy

One dataset ODRL policy document.

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

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

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