Contract-Negotiations

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.

---

Initiates a contract negotiation for a given offer and with the given counter part. Please note that successfully invoking this endpoint only means that the negotiation was initiated. Clients must poll the /{id}/state endpoint to track the state

post

/v2/contractnegotiations

Body

@contextobjectrequired

@typestring

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

callbackAddressesobject[]

Example: null

connectorAddressstringDeprecated

please use counterPartyAddress instead

counterPartyAddressstringrequired

offerobjectDeprecated

please use policy instead of offer

policyobjectrequired

ODRL offer

Example: {"@context":"http://www.w3.org/ns/odrl.jsonld","@type":"odrl:Offer","@id":"offer-id","assigner":"providerId","target":"assetId","permission":[],"prohibition":[],"obligation":[]}

protocolstringrequired

providerIdstringDeprecated

please use policy.assigner instead

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/contractnegotiations' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "https://w3id.org/edc/v0.0.1/ns/ContractRequest",
    "counterPartyAddress": "http://provider-address",
    "protocol": "dataspace-protocol-http",
    "policy": {
      "@context": "http://www.w3.org/ns/odrl.jsonld",
      "@type": "odrl:Offer",
      "@id": "offer-id",
      "assigner": "providerId",
      "permission": [],
      "prohibition": [],
      "obligation": [],
      "target": "assetId"
    },
    "callbackAddresses": [
      {
        "transactional": false,
        "uri": "http://callback/url",
        "events": [
          "contract.negotiation",
          "transfer.process"
        ],
        "authKey": "auth-key",
        "authCodeId": "auth-code-id"
      }
    ]
  }'

200

400

200

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

The negotiation was successfully initiated. Returns the contract negotiation ID and created timestamp

---

Returns all contract negotiations according to a query

post

/v2/contractnegotiations/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/contractnegotiations/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 contract negotiations that match the query

---

Gets a contract negotiation with the given ID

get

/v2/contractnegotiations/{id}

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

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

---

Gets a contract agreement for a contract negotiation with the given ID

get

/v2/contractnegotiations/{id}/agreement

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/contractnegotiations/{id}/agreement'

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 that is attached to the negotiation, or null

---

---

---

Gets the state of a contract negotiation with the given ID

get

/v2/contractnegotiations/{id}/state

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//v2/contractnegotiations/{id}/state'

200

400

404

200

No body

The contract negotiation's state

---

Terminates the contract negotiation.

post

/v2/contractnegotiations/{id}/terminate

Path parameters

idstringrequired

Body

@idstring

@typestring

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

reasonstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//v2/contractnegotiations/{id}/terminate' \
  --header 'Content-Type: application/json' \
  --data '{
    "@context": {
      "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "https://w3id.org/edc/v0.0.1/ns/TerminateNegotiation",
    "@id": "negotiation-id",
    "reason": "a reason to terminate"
  }'

200

400

404

200

No body

ContractNegotiation is terminating