Data Products

Get Data Product

Changed on

Retrieves a single data product. Accessible to users with the provider and admin role. Producers and support users can only retrieve active data products.

get/api/products/v2/{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_Datenanbieter, agridata.ch.Agridata_Einwilliger, agridata.ch.Agridata_Support)

Path parameters

idstring uuid required

Query parameters

actingRole'PROVIDER' | 'PRODUCER' | 'ADMIN' | 'SUPPORT'

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
dataSourceSystemCodestring

Code of data source system from which this product originates

restClientPathTemplatestring

Template for the path where the data product is fetched from

restClientRequestTemplatestring

Template of the request body for fetching the data product

restClientMethodCode'POST' | 'GET'
flowCode'UID_BASED_PRE_VALIDATION' | 'UID_BASED_POST_VALIDATION' | 'BUR_BASED_PRE_VALIDATION' | 'BUR_BASED_POST_VALIDATION' | 'UNBOUND_UID_BASED_POST_VALIDATION' | 'UNBOUND_BUR_BASED_POST_VALIDATION'
deprecatedSincestring date-time
restClientChangeDetectionPathTemplatestring

Template for the path for retrieving updates to the data product

consentRequiredboolean required

If a consent is required for this data product

paymentRequiredboolean required

If a payment is required for this data product

Example response

{
  "dataSourceSystemCode": "AGIS",
  "dataSourceSystem": {
    "code": "AGIS",
    "dataProvider": {
      "code": "BLW",
      "uid": "CHE123456789"
    }
  },
  "restClient": {
    "code": "AGIS_API",
    "displayName": "Agis",
    "url": "http://example.com/agis"
  },
  "deprecatedSince": "2022-03-10T12:15:50",
  "restClientChangeDetectionPathTemplate": "v1/animal-updates/{{uid}}?since={{LAST_CHANGED_SINCE}}",
  "consentRequired": true,
  "paymentRequired": true
}

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

    • info

      the security scope agridata.ch.Agridata_Einwilliger was added to the endpoint's security scheme SecurityScheme

    • info

      the security scope agridata.ch.Agridata_Support was added to the endpoint's security scheme SecurityScheme

    • info

      added the new enum value PRODUCER to the query request parameter actingRole

    • info

      added the new enum value SUPPORT to the query request parameter actingRole

  • 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