v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-306170167.5 KB

Data Products

Get Data Product

Retrieves a single data product. Acessible to users with the provider and admin role

get/api/products/v2/{id}

Path parameters

idstring uuid required

Query parameters

actingRole'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

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_POST_VALIDATION'

deprecatedSincestring date-time

restClientChangeDetectionPathTemplatestring

Template for the path for retrieving updates to the 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}}"
}