Skip to main content
Agreements

Read data disclosure agreement revision

GET/v4/config/consent/data-disclosure-agreement/{dataDisclosureAgreementTemplateId}/revision/{dataDisclosureAgreementTemplateRevisionId}

Reads one revision of a data disclosure agreement template: the template as it was when the service published that revision. Use it to see the exact terms of a signed record (dataDisclosureAgreementTemplateRevision.id of the record). The revision ID alone selects the revision.

Errors: 404 when the revision does not exist.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:data-space:read

Path parameters

  • dataDisclosureAgreementTemplateIdstringrequired

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

  • dataDisclosureAgreementTemplateRevisionIdstringrequired

    ID of a revision of the template.

Response

application/json

The template as it was at the revision, and the revision.

  • 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.