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.

---

Collect filtered data for the Contract Agreement Page

post

/wrapper/ui/pages/contract-agreement-page

Body

terminationStatusstring · enum

Optionally filter the resulting contract agreements by their termination status.

Options: ONGOING, TERMINATED

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://my-connector/api/management/wrapper/ui/pages/contract-agreement-page' \
  --header 'Content-Type: application/json' \
  --data '{
    "terminationStatus": "ONGOING"
  }'

default

default

{
  "contractAgreements": [
    {
      "contractAgreementId": "text",
      "contractNegotiationId": "text",
      "direction": "CONSUMING",
      "counterPartyAddress": "text",
      "counterPartyId": "text",
      "contractSigningDate": "2025-03-14T15:28:01.434Z",
      "asset": {
        "dataSourceAvailability": "LIVE",
        "assetId": "text",
        "connectorEndpoint": "text",
        "participantId": "text",
        "title": "text",
        "creatorOrganizationName": "text",
        "onRequestContactEmail": "[e-mail]",
        "onRequestContactEmailSubject": "Department XYZ Data Offer Request - My Product, My API",
        "language": "text",
        "description": "text",
        "descriptionShortText": "text",
        "isOwnConnector": true,
        "publisherHomepage": "text",
        "licenseUrl": "text",
        "version": "text",
        "keywords": [
          "text"
        ],
        "mediaType": "text",
        "landingPageUrl": "text",
        "httpDatasourceHintsProxyMethod": true,
        "httpDatasourceHintsProxyPath": true,
        "httpDatasourceHintsProxyQueryParams": true,
        "httpDatasourceHintsProxyBody": true,
        "dataCategory": "text",
        "dataSubcategory": "text",
        "dataModel": "text",
        "geoReferenceMethod": "text",
        "transportMode": "text",
        "sovereignLegalName": "text",
        "geoLocation": "text",
        "nutsLocations": [
          "text"
        ],
        "dataSampleUrls": [
          "text"
        ],
        "referenceFileUrls": [
          "text"
        ],
        "referenceFilesDescription": "text",
        "conditionsForUse": "text",
        "dataUpdateFrequency": "text",
        "temporalCoverageFrom": "2025-03-14",
        "temporalCoverageToInclusive": "2025-03-14",
        "assetJsonLd": "text",
        "customJsonAsString": "text",
        "customJsonLdAsString": "text",
        "privateCustomJsonAsString": "text",
        "privateCustomJsonLdAsString": "text"
      },
      "contractPolicy": "[Circular Reference]",
      "transferProcesses": [
        {
          "transferProcessId": "text",
          "lastUpdatedDate": "2025-03-14T15:28:01.434Z",
          "state": {
            "name": "text",
            "code": 1,
            "simplifiedState": "RUNNING"
          },
          "errorMessage": "text"
        }
      ],
      "terminationStatus": "ONGOING",
      "terminationInformation": {
        "terminatedAt": "2025-03-14T15:28:01.434Z",
        "reason": "text",
        "detail": "text",
        "terminatedBy": "SELF"
      }
    }
  ]
}

default response

---

Get a single contract agreement card by its identifier

get

/wrapper/ui/pages/contract-agreement-page/{contractAgreementId}

Path parameters

contractAgreementIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://my-connector/api/management/wrapper/ui/pages/contract-agreement-page/{contractAgreementId}'

default

default

{
  "contractAgreementId": "text",
  "contractNegotiationId": "text",
  "direction": "CONSUMING",
  "counterPartyAddress": "text",
  "counterPartyId": "text",
  "contractSigningDate": "2025-03-14T15:28:01.434Z",
  "asset": {
    "dataSourceAvailability": "LIVE",
    "assetId": "text",
    "connectorEndpoint": "text",
    "participantId": "text",
    "title": "text",
    "creatorOrganizationName": "text",
    "onRequestContactEmail": "[e-mail]",
    "onRequestContactEmailSubject": "Department XYZ Data Offer Request - My Product, My API",
    "language": "text",
    "description": "text",
    "descriptionShortText": "text",
    "isOwnConnector": true,
    "publisherHomepage": "text",
    "licenseUrl": "text",
    "version": "text",
    "keywords": [
      "text"
    ],
    "mediaType": "text",
    "landingPageUrl": "text",
    "httpDatasourceHintsProxyMethod": true,
    "httpDatasourceHintsProxyPath": true,
    "httpDatasourceHintsProxyQueryParams": true,
    "httpDatasourceHintsProxyBody": true,
    "dataCategory": "text",
    "dataSubcategory": "text",
    "dataModel": "text",
    "geoReferenceMethod": "text",
    "transportMode": "text",
    "sovereignLegalName": "text",
    "geoLocation": "text",
    "nutsLocations": [
      "text"
    ],
    "dataSampleUrls": [
      "text"
    ],
    "referenceFileUrls": [
      "text"
    ],
    "referenceFilesDescription": "text",
    "conditionsForUse": "text",
    "dataUpdateFrequency": "text",
    "temporalCoverageFrom": "2025-03-14",
    "temporalCoverageToInclusive": "2025-03-14",
    "assetJsonLd": "text",
    "customJsonAsString": "text",
    "customJsonLdAsString": "text",
    "privateCustomJsonAsString": "text",
    "privateCustomJsonLdAsString": "text"
  },
  "contractPolicy": {
    "policyJsonLd": "text",
    "expression": {
      "type": "EMPTY",
      "expressions": "[Circular Reference]",
      "constraint": {
        "left": "text",
        "operator": "EQ",
        "right": {
          "type": "STRING",
          "value": "text",
          "valueList": [
            "text"
          ]
        }
      }
    },
    "errors": [
      "text"
    ]
  },
  "transferProcesses": [
    {
      "transferProcessId": "text",
      "lastUpdatedDate": "2025-03-14T15:28:01.434Z",
      "state": {
        "name": "text",
        "code": 1,
        "simplifiedState": "RUNNING"
      },
      "errorMessage": "text"
    }
  ],
  "terminationStatus": "ONGOING",
  "terminationInformation": {
    "terminatedAt": "2025-03-14T15:28:01.434Z",
    "reason": "text",
    "detail": "text",
    "terminatedBy": "SELF"
  }
}

default response

---

Initiate a Transfer Process via a custom Transfer Process JSON-LD. Fields such as connectorId, assetId, providerConnectorId, providerConnectorAddress will be set automatically.

post

/wrapper/ui/pages/contract-agreement-page/transfers/custom

Body

contractAgreementIdstringrequired

Contract Agreement ID

transferProcessRequestJsonLdstringrequired

Partial TransferProcessRequestJsonLd JSON-LD. Fields participantId, connectorEndpoint, assetId and contractId can be omitted, they will be overridden with information from the contract.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://my-connector/api/management/wrapper/ui/pages/contract-agreement-page/transfers/custom' \
  --header 'Content-Type: application/json' \
  --data '{
    "contractAgreementId": "text",
    "transferProcessRequestJsonLd": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-03-14T15:28:01.434Z"
}

default response

---

---

Terminates a contract agreement designated by its contract agreement id.

post

/wrapper/ui/pages/content-agreement-page/{contractAgreementId}/terminate

Path parameters

contractAgreementIdstringrequired

Body

detailstring · max: 1000required

A user explanation to detail why the contract was terminated.

reasonstring · max: 100required

A short reason why this contract was terminated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://my-connector/api/management/wrapper/ui/pages/content-agreement-page/{contractAgreementId}/terminate' \
  --header 'Content-Type: application/json' \
  --data '{
    "detail": "text",
    "reason": "text"
  }'

default

default

{
  "id": "text",
  "lastUpdatedDate": "2025-03-14T15:28:01.434Z"
}

default response