Skip to main content
Agreements

Update data disclosure agreement

PUT/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}

Changes a data disclosure agreement template. Send only the fields that change; the service keeps the others.

Send active: true to publish the template, or to keep a published template published. An update without active: true saves the template as a draft, also when it was published before. To publish, the template needs purpose and purposeDescription, from this request or from before.

Each update of a published template raises the major version (1.0.0 to 2.0.0). Each publication makes a revision, and the service tells your data marketplace about it. Records that data using services signed before keep the template revision that they signed.

To base the template on another data agreement revision, send dataAgreementId, dataAgreementRevisionId and dataAgreementRevisionHash together. The service then copies the data attributes and the OpenAPI specification of that revision.

Errors:

  • 400: a field is not valid, purpose or purposeDescription is missing when you publish, only some of the three data agreement fields are there, or the data agreement revision does not fit.
  • 404: the template, the data agreement, its revision or the presentation definition does not exist.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-space:update

Path parameters

  • dataDisclosureAgreementTemplateIdstringrequired

    ID of the data disclosure agreement template (@id), 24 hexadecimal characters.

Body

application/json
  • dataDisclosureAgreementTemplateobjectrequired

    The fields to change. Send only the fields that change; the service keeps the other values. Inside dataController and dataSharingRestrictions you can also send only some fields.

Response

application/json

The changed template and its latest revision. For a draft, the revision has an empty id.

  • dataDisclosureAgreementTemplateobject

    The terms under which your organisation, as a data source, offers data to data using services. A data using service signs a data disclosure agreement record against a published template. The data attributes and the OpenAPI specification come from the revision of the data agreement that the template names.

  • revisionobject

    A locked snapshot of a data disclosure agreement template or record. The service makes a revision each time it publishes a template or changes a record. A new revision links to the one before it through predecessorHash, and the one before it gets the successorId of the new revision.