v1

latestOpenAPI 3.0.02026-07-132849114.2 KB
Exports

Initiate a new export request.

Step one in requesting a data product. The method will return an Export ID which the caller will use in subsequent GET requests. The following contentTypes may be requested:

  • application/vnd.climate.acrsi.geojson (Beta) Exports the planting activities accessible by the authenticated user and optionally filtered by resource owner as a GeoJSON Feature Collection.

    The export request definition must contain the following properties:

    • plantingStartDate
    • plantingEndDate
    • resourceOwnerId

    Requires exports:read and plantingActivitySummary:read scope.

  • application/vnd.climate.harvest.geojson Exports the harvesting activities accessible by the authenticated user and optionally filtered by resource owner as a GeoJSON Feature Collection.

    The export request definition must contain the following properties:

    • harvestStartDate
    • harvestEndDate
    • resourceOwnerId

    Requires exports:read and plantingActivitySummary:read scope.

  • application/vnd.climate.yield-analysis.pdf Exports a PDF Yield Analysis Report (also called Harvest Summary Report) for all the fields in all the harvest seasons of the given year. If no year definition is provided then the current year is used.

    The export request definition can contain the following properties:

    • year

    Requires exports:read and reports:read scope.

  • application/vnd.climate.yield-analysis.json Exports a JSON Yield Analysis Report (also called Harvest Summary Report) for all the fields in all the harvest seasons of the given year. If no year definition is provided then the current year is used.

    The export request definition can contain the following properties:

    • year

    Requires exports:read and reports:read scope.

post/v4/exports

Request body

contentType'application/vnd.climate.acrsi.geojson' | 'application/vnd.climate.harvest.geojson' mime-type required

Content type representing data being exported (e.g. application/vnd.climate.acrsi.geojson).

definitionobject

Additional specifications for a client's data export request, dependent on the content type.

Response

OK

idstring uuid required

Unique identifier for the export.