Contract-Definitions

This page may take a moment to fully load because the data is being fetched and parsed live from the original OpenAPI specification file. GitBook could also adjust the page width for this page so that the content can be displayed better.

Welcome to the OpenAPI Documentation page! This section provides a comprehensive overview of all the available APIs that adhere to the OpenAPI Specification. Here, you'll find detailed information on each API's endpoints, request/response formats, authentication methods, and more. Whether you're integrating with our services or building your own application, this documentation is designed to help you navigate and utilize our APIs efficiently and effectively. All APIs listed here are loaded directly from the OpenAPI specification files in our Community Edition repository, which are originally located here: Link

---

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

PUThttps://[MY_EDC_FQDN]/api/management/v2/contractdefinitions

Body

*/*

@idstring

@typestring

Example: "https://w3id.org/edc/v0.0.1/ns/ContractDefinition"

accessPolicyIdstring

assetsSelectorarray of Criterion (object)

contractPolicyIdstring

Response

204400404

Contract definition was updated successfully

Request

JavaScriptCurlPython

const response = await fetch('https://[MY_EDC_FQDN]/api/management/v2/contractdefinitions', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "@context": {
        "edc": "https://w3id.org/edc/v0.0.1/ns/"
      },
      "@id": "definition-id",
      "accessPolicyId": "asset-policy-id",
      "contractPolicyId": "contract-policy-id",
      "assetsSelector": []
    }),
});
const data = await response.json();

Response

400404

null

---

Creates a new contract definition

POSThttps://[MY_EDC_FQDN]/api/management/v2/contractdefinitions

Body

*/*

@idstring

@typestring

Example: "https://w3id.org/edc/v0.0.1/ns/ContractDefinition"

accessPolicyIdstring

assetsSelectorarray of Criterion (object)

contractPolicyIdstring

Response

200400409

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

Body

application/json

@idstring

createdAtinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://[MY_EDC_FQDN]/api/management/v2/contractdefinitions', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "@context": {
        "edc": "https://w3id.org/edc/v0.0.1/ns/"
      },
      "@id": "definition-id",
      "accessPolicyId": "asset-policy-id",
      "contractPolicyId": "contract-policy-id",
      "assetsSelector": []
    }),
});
const data = await response.json();

Response

200400409

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

---

Returns all contract definitions according to a query

POSThttps://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/request

Body

*/*

@typestring

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

filterExpressionarray of Criterion (object)

limitinteger (int32)

offsetinteger (int32)

sortFieldstring

sortOrderenum

ASCDESC

Response

200400

The contract definitions matching the query

Body

application/json

@idstring

@typestring

Example: "https://w3id.org/edc/v0.0.1/ns/ContractDefinition"

accessPolicyIdstring

assetsSelectorarray of Criterion (object)

contractPolicyIdstring

createdAtinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/request', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "@context": {
        "edc": "https://w3id.org/edc/v0.0.1/ns/"
      },
      "@type": "QuerySpec",
      "offset": 5,
      "limit": 10,
      "sortOrder": "DESC",
      "sortField": "fieldName",
      "filterExpression": []
    }),
});
const data = await response.json();

Response

200400

null

---

Gets an contract definition with the given ID

GEThttps://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/{id}

Path parameters

id*string

Response

200400404

The contract definition

Body

application/json

@idstring

@typestring

Example: "https://w3id.org/edc/v0.0.1/ns/ContractDefinition"

accessPolicyIdstring

assetsSelectorarray of Criterion (object)

contractPolicyIdstring

createdAtinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

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

---

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.

DELETEhttps://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/{id}

Path parameters

id*string

Response

200400404

Contract definition was deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('https://[MY_EDC_FQDN]/api/management/v2/contractdefinitions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

null