Skip to main content
Version: Next

DatasetItem

idobjectnullable

ID of the dataset item

titlestringrequired

Title of the dataset item

Example: Example Dataset
descriptionstring[]

Description of the dataset

versionstringrequired

Version of the dataset item

Example: 1.0.0
backendUrlstringrequired

Backend URL of the dataset item

Example: http://localhost:3000
authorizationobject

Authorization header required for the backend

mediaTypeobject

Media type of the dataset item

Example: application/json
schemaRefobject

Schema reference of the dataset item

openApiSpecRefobject

OpenAPI specification reference of the dataset

policy object[]

Policy of the dataset item

  • Array [
  • typestringrequired

    Definition type of the policy

    Possible values: [default, rules, manual]

    Default value: default
    permissions object[]

    Permissions of the policy

  • Array [
  • actionstringrequired

    Action of the rule

    Example: use
    constraints object[]

    Constraints of the rule

  • Array [
  • typestringrequired

    Type of the constraint

    Example: CredentialType
    valuestringrequired

    Value of the constraint

    Example: MembershipCredential
  • ]
  • ]
  • prohibitions object[]

    Prohibitions of the policy

  • Array [
  • actionstringrequired

    Action of the rule

    Example: use
    constraints object[]

    Constraints of the rule

  • Array [
  • typestringrequired

    Type of the constraint

    Example: CredentialType
    valuestringrequired

    Value of the constraint

    Example: MembershipCredential
  • ]
  • ]
  • rawobject

    Raw serialized ODRL offer

  • ]
  • extraPropsobject

    Additional DCAT properties for the dataset item

    Example: {"dcat:keyword":["example"]}
    DatasetItem
    {
    "id": {},
    "title": "Example Dataset",
    "description": [
    "string"
    ],
    "version": "1.0.0",
    "backendUrl": "http://localhost:3000",
    "authorization": {},
    "mediaType": "application/json",
    "schemaRef": {},
    "openApiSpecRef": {},
    "policy": [
    {
    "type": "default",
    "permissions": [
    {
    "action": "use",
    "constraints": [
    {
    "type": "CredentialType",
    "value": "MembershipCredential"
    }
    ]
    }
    ],
    "prohibitions": [
    {
    "action": "use",
    "constraints": [
    {
    "type": "CredentialType",
    "value": "MembershipCredential"
    }
    ]
    }
    ],
    "raw": {}
    }
    ],
    "extraProps": {
    "dcat:keyword": [
    "example"
    ]
    }
    }