v50

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

Get Data Products

Retrieves the list of all available data products. Accessible to users with the producer, consumer, admin, or provider role.

get/api/products/v1

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_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}}"
  }
]