Data Requests

Create Consent Requests For Data Request

Changed on

Creates the consent requests of a single data producer UID for a data request. A UID-based consent request is created if it does not exist yet. BURs may only be provided if the data request contains at least one BUR-based data product. When BURs are provided, they are validated against the UID's BURs in AGIS and a BUR-based consent request is created for each of them. Accessible to the consumer who owns the data request.

post/api/agreement/v1/data-requests/{id}/consent-requests

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Datenbezueger)

Path parameters

idstring uuid required

The UUID of the data request

Request body

uidstring required

UID of the data producer

bursstring[] required

BURs of the data producer. Required, but may be empty. Every BUR must belong to the UID in AGIS.

Example request

{
  "uid": "CHE101000001",
  "burs": [
    "A12345678",
    "A12345679"
  ]
}

Response

OK

idstring uuid required
dataProducerUidstring required

UID of the data producer

dataProducerBurstring

BUR of the data producer

isCreatedboolean

Example response

[
  {
    "dataProducerUid": "CHE123456789",
    "dataProducerBur": "A12345678"
  }
]

Changes

  • 75957f6bdc66Revision changes
    • warning

      changed the pattern of the request property / from ^A\d{8}$ to ^[A-Za-z0-9]{8,9}$

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • 3b78238ff219Revision changes
    • info

      endpoint added