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_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

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 22 of the 56 revisions of this API.12731

    • added the required property items/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

  • 52c1637abca022See the full diff
    • added the new UNBOUND_BUR_BASED_POST_VALIDATION enum value to the items/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 items/flowCode response property for the response status 200

      response-property-enum-value-added

    • removed the UNBOUND_POST_VALIDATION enum value from the items/flowCode response property for the response status 200

      response-property-enum-value-removed

    • added the required property items/dataSourceSystem/legalBasis to the response with the 200 status

      response-required-property-added

  • bf09fcfe746c11See the full diff
    • removed the optional property items/technicalDescription from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/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

    • removed the optional property items/extendedDescription from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/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

    • removed the optional property items/technicalDescription from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/extendedDescription to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClient/displayName to the response with the 200 status

      response-optional-property-added

    • added the optional property items/links to the response with the 200 status

      response-optional-property-added

    • added the optional property items/technicalDescription to the response with the 200 status

      response-optional-property-added

    • removed the optional property items/links from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/restClient/displayName from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/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

    • added the optional property items/links to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClient/displayName to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClient/url to the response with the 200 status

      response-optional-property-added

    • added the optional property items/technicalDescription to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClientChangeDetectionPathTemplate to the response with the 200 status

      response-optional-property-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the optional property items/flowCode to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClient to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClientMethodCode to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClientPathTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/restClientRequestTemplate to the response with the 200 status

      response-optional-property-added

    • added the required property items/stateCode to the response with the 200 status

      response-required-property-added