Contract-Agreements

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.

---

post

Gets all contract agreements according to a particular 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/contractagreements/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 agreements matching the query

---

get

Gets an contract agreement with the given ID

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@type": "https://w3id.org/edc/v0.0.1/ns/ContractAgreement",
  "@id": "negotiation-id",
  "providerId": "provider-id",
  "consumerId": "consumer-id",
  "assetId": "asset-id",
  "contractSigningDate": 1688465655,
  "policy": {
    "@context": "http://www.w3.org/ns/odrl.jsonld",
    "@type": "Set",
    "@id": "offer-id",
    "permission": [
      {
        "target": "asset-id",
        "action": "display"
      }
    ]
  }
}

The contract agreement

---

get

Gets a contract negotiation with the given contract agreement ID

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/contractagreements/{id}/negotiation'

200

400

404

200

{
  "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
  },
  "@type": "https://w3id.org/edc/v0.0.1/ns/ContractNegotiation",
  "@id": "negotiation-id",
  "type": "PROVIDER",
  "protocol": "dataspace-protocol-http",
  "counterPartyId": "counter-party-id",
  "counterPartyAddress": "http://counter/party/address",
  "state": "VERIFIED",
  "contractAgreementId": "contract:agreement:id",
  "errorDetail": "eventual-error-detail",
  "createdAt": 1688465655,
  "callbackAddresses": [
    {
      "transactional": false,
      "uri": "http://callback/url",
      "events": [
        "contract.negotiation",
        "transfer.process"
      ],
      "authKey": "auth-key",
      "authCodeId": "auth-code-id"
    }
  ]
}

The contract negotiation