Public Data Products

Get Public Data Product

Changed on

Retrieves a single publicly available data product, including its technical information. Publicly accessible.

get/public/api/products/v2/{id}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

Response

OK

idstring uuid required
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
consentRequiredboolean required

If a consent is required for this data product

paymentRequiredboolean required

If a payment is required for this data product

restClientPathTemplatestring

Path template for the request

restClientRequestTemplatestring

Body template for the request

Example response

{
  "dataSourceSystem": {
    "code": "AGIS",
    "dataProvider": {
      "code": "BLW",
      "uid": "CHE123456789"
    }
  },
  "deprecatedSince": "2022-03-10T12:15:50",
  "consentRequired": true,
  "paymentRequired": true,
  "restClientPathTemplate": "/farm-data/uid/{{uid}}",
  "restClientRequestTemplate": "{\n  \"surveyYear\": \"{{year}}\",\n  \"ids\": {\n    \"ber\": \"{{bur}}\"\n  },\n  \"dataTypes\": {\n    \"structureType\": [\"animalData\"]\n  }\n}"
}

Changes

  • 48ab7e1541c3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 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