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'

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

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
}

Changes

Changed in 10 of the 56 revisions of this API.815

Aug 13, 2026a0609096db651See the full diff
- ○
  added the required property consentRequired to the response with the 200 status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 202652c1637abca022See the full diff
- ●
  added the new UNBOUND_BUR_BASED_POST_VALIDATION enum value to the flowCode response property for the response status 200
  response-property-enum-value-added
- ●
  added the new UNBOUND_UID_BASED_POST_VALIDATION enum value to the flowCode response property for the response status 200
  response-property-enum-value-added
- ○
  removed the UNBOUND_POST_VALIDATION enum value from the flowCode response property for the response status 200
  response-property-enum-value-removed
- ○
  added the required property dataSourceSystem/legalBasis to the response with the 200 status
  response-required-property-added
Jul 13, 2026bf09fcfe746c11See the full diff
- ●
  removed the optional property technicalDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property extendedDescription to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 202673b93bab6c7b11See the full diff
- ●
  removed the optional property extendedDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property technicalDescription to the response with the 200 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 20264f907e17648112See the full diff
- ●
  removed the optional property technicalDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property extendedDescription to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property restClient/displayName to the response with the 200 status
  response-optional-property-added
Jul 6, 2026bfb5aa26b19b2See the full diff
- ○
  added the optional property links to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property technicalDescription to the response with the 200 status
  response-optional-property-added
Jul 2, 2026aec259103b953See the full diff
- ●
  removed the optional property links from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property restClient/displayName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property technicalDescription from the response with the 200 status
  response-optional-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 2, 202616bdeed9be544See the full diff
- ○
  added the optional property links to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property restClient/displayName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property restClient/url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property technicalDescription to the response with the 200 status
  response-optional-property-added
Jun 19, 2026a3a5891898921See the full diff
- ○
  added the optional property restClientChangeDetectionPathTemplate to the response with the 200 status
  response-optional-property-added
Jun 16, 2026b600fb5ed2801See the full diff
- ○
  endpoint added
  endpoint-added

Full history