Policy-Definitions

This section provides an overview of all available APIs that adhere to the OpenAPI specification. All APIs are loaded from the OpenAPI specification file: Link. Please note that the API base-paths may differ depending on the connector, the specific API base-path can be seen in the UI dashboard.

---

Creates a new policy definition

post

/v2/policydefinitions

Body

@contextobjectrequired

@idstring

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/PolicyDefinition

policyobjectrequired

ODRL policy

Example: {"@context":"http://www.w3.org/ns/odrl.jsonld","@id":"0949ba30-680c-44e6-bc7d-1688cbe1847e","@type":"odrl:Set","permission":{"target":"http://example.com/asset:9898.movie","action":{"type":"http://www.w3.org/ns/odrl/2/use"},"constraint":{"leftOperand":"https://w3id.org/edc/v0.0.1/ns/left","operator":"eq","rightOperand":"value"}},"prohibition":[],"obligation":[]}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/policydefinitions' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "definition-id",
    "policy": {
      "@context": "http://www.w3.org/ns/odrl.jsonld",
      "@type": "Set",
      "uid": "http://example.com/policy:1010",
      "permission": [
        {
          "target": "http://example.com/asset:9898.movie",
          "action": "display",
          "constraint": [
            {
              "leftOperand": "spatial",
              "operator": "eq",
              "rightOperand": "https://www.wikidata.org/wiki/Q183",
              "comment": "i.e Germany"
            }
          ]
        }
      ]
    }
  }'

200

400

409

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "id-value",
  "createdAt": 1688465655
}

policy definition was created successfully. Returns the Policy Definition Id and created timestamp

---

Returns all policy definitions according to a query

post

/v2/policydefinitions/request

Body

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/QuerySpec

filterExpressionobject[]

Example: {"@context":{"@vocab":"https://w3id.org/edc/v0.0.1/ns/"},"@type":"Criterion","operandLeft":"fieldName","operator":"=","operandRight":"some value"}

limitinteger · int32

offsetinteger · int32

sortFieldstring

sortOrderstring · enum

Options: ASC, DESC

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/policydefinitions/request' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "QuerySpec",
    "offset": 5,
    "limit": 10,
    "sortOrder": "DESC",
    "sortField": "fieldName",
    "filterExpression": []
  }'

200

400

200

No body

The policy definitions matching the query

---

Gets a policy definition with the given ID

get

/v2/policydefinitions/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/policydefinitions/{id}'

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "definition-id",
  "policy": {
    "@context": "http://www.w3.org/ns/odrl.jsonld",
    "@type": "Set",
    "uid": "http://example.com/policy:1010",
    "permission": [
      {
        "target": "http://example.com/asset:9898.movie",
        "action": "display",
        "constraint": [
          {
            "leftOperand": "spatial",
            "operator": "eq",
            "rightOperand": "https://www.wikidata.org/wiki/Q183",
            "comment": "i.e Germany"
          }
        ]
      }
    ]
  },
  "createdAt": 1688465655
}

The policy definition

---

Updates an existing Policy, If the Policy is not found, an error is reported

put

/v2/policydefinitions/{id}

Path parameters

idstringrequired

Body

@contextobjectrequired

@idstring

@typestring

Example: https://w3id.org/edc/v0.0.1/ns/PolicyDefinition

policyobjectrequired

ODRL policy

Example: {"@context":"http://www.w3.org/ns/odrl.jsonld","@id":"0949ba30-680c-44e6-bc7d-1688cbe1847e","@type":"odrl:Set","permission":{"target":"http://example.com/asset:9898.movie","action":{"type":"http://www.w3.org/ns/odrl/2/use"},"constraint":{"leftOperand":"https://w3id.org/edc/v0.0.1/ns/left","operator":"eq","rightOperand":"value"}},"prohibition":[],"obligation":[]}

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//v2/policydefinitions/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "definition-id",
    "policy": {
      "@context": "http://www.w3.org/ns/odrl.jsonld",
      "@type": "Set",
      "uid": "http://example.com/policy:1010",
      "permission": [
        {
          "target": "http://example.com/asset:9898.movie",
          "action": "display",
          "constraint": [
            {
              "leftOperand": "spatial",
              "operator": "eq",
              "rightOperand": "https://www.wikidata.org/wiki/Q183",
              "comment": "i.e Germany"
            }
          ]
        }
      ]
    }
  }'

204

400

404

204

No body

policy definition was updated successfully.

---

Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced by a contract definition, in which case an error is returned. DANGER ZONE: Note that deleting policy definitions can have unexpected results, do this at your own risk!

delete

/v2/policydefinitions/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//v2/policydefinitions/{id}'

204

400

404

409

204

No body

Policy definition was deleted successfully