Contract Revisions

Get Contract Revision

Changed on

Retrieves a specific contract revision by its ID. Accessible by the consumer or provider that owns the associated datarequest.

get/api/agreement/v1/contract-revisions/{id}

Request

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

Path parameters

idstring uuid required

Query parameters

actingRole'CONSUMER' | 'PROVIDER' | 'ADMIN'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

idstring uuid required
dataRequestIdstring uuid required
dataConsumerNamestring required

LegalName of the data consumer taken from the uid register

dataConsumerCitystring required

City of the data consumer

dataProviderNamestring required

Name of the data provider

dataProviderCitystring required

City of the data provider

consumerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'
providerSignatureType'INDIVIDUAL_SIGNATURE' | 'COLLECTIVE_SIGNATURE'
sealState'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

Example response

{
  "dataConsumerName": "Bio Suisse, Vereinigung Schweizer Biolandbau-Organisationen",
  "dataConsumerCity": "Basel",
  "dataProviderName": "BLW",
  "dataProviderCity": "Bern",
  "dataRequestContext": {
    "dataConsumerLogoBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  },
  "consumerSignatures": [
    {
      "name": "John Doe",
      "timestamp": "2022-03-10T12:15:50"
    }
  ],
  "providerSignatures": [
    {
      "name": "John Doe",
      "timestamp": "2022-03-10T12:15:50"
    }
  ]
}

Changes

  • 75957f6bdc66Revision changes
    • 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

  • 1aa7b6ad5bccRevision changes
    • warning

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

    • warning

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