Contract-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.

---

put

Updated a contract definition with the given ID. The supplied JSON structure must be a valid JSON-LD object

Body

@contextobjectrequired

@idstringoptional

@typestringoptionalExample: https://w3id.org/edc/v0.0.1/ns/ContractDefinition

accessPolicyIdstringrequired

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

contractPolicyIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//v2/contractdefinitions' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "definition-id",
    "accessPolicyId": "asset-policy-id",
    "contractPolicyId": "contract-policy-id",
    "assetsSelector": []
  }'

204

400

404

204

No Content

Contract definition was updated successfully

---

post

Creates a new contract definition

Body

@contextobjectrequired

@idstringoptional

@typestringoptionalExample: https://w3id.org/edc/v0.0.1/ns/ContractDefinition

accessPolicyIdstringrequired

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

contractPolicyIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/contractdefinitions' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@id": "definition-id",
    "accessPolicyId": "asset-policy-id",
    "contractPolicyId": "contract-policy-id",
    "assetsSelector": []
  }'

200

400

409

200

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

contract definition was created successfully. Returns the Contract Definition Id and created timestamp

---

post

Returns all contract definitions according to a query

Body

@typestringoptionalExample: https://w3id.org/edc/v0.0.1/ns/QuerySpec

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

limitinteger · int32optional

offsetinteger · int32optional

sortFieldstringoptional

sortOrderstring · enumoptionalAvailable options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/contractdefinitions/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 Content

The contract definitions matching the query

---

get

Gets an contract definition with the given ID

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@id": "definition-id",
  "accessPolicyId": "asset-policy-id",
  "contractPolicyId": "contract-policy-id",
  "assetsSelector": [],
  "createdAt": 1688465655
}

The contract definition

---

delete

Removes a contract definition with the given ID if possible. DANGER ZONE: Note that deleting contract definitions can have unexpected results, especially for contract offers that have been sent out or ongoing or contract negotiations.

Path parameters

idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

204

400

404

204

No Content

Contract definition was deleted successfully