Climate FieldView Platform APIs

Chunked upload of data Send chunked data for an **Upload**.

Retrieve Boundaries in batch Retrieve multiple **Boundaries** (up to 10 per request).

Retrieve a Boundary by ID Retrieve a **Boundary** by ID.

Retrieve the binary contents of a processed export request. Downloads larger than `5MiB` (`5242880 bytes`) in size must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`).

Retrieve the status of an Export. Check the status of an **Export** by ID.

Retrieve a specific farm organization by organization type and ID Retrieve a given **farm organization** by organization type and ID.

Retrieve a specific Field by ID Retrieve a given **Field** by ID.

Retrieve list of Fields Retrieve list of **Fields**. Filter the results by field name if the `fieldName` query parameter is specified.

Retrieve the operations accessible to a a given user. Retrieve the **operations** accessible to the authenticated user. Filter the results by resource owner if the `resourceOwnerId` query parameter is specified.

Retrieve Upload status Check the status of an **Upload** by ID.

Retrieve Upload statuses in batch Check the status of multiple **Uploads** (up to 100 per request).

Retrieve a resource owner by ID Retrieve a resource owner for the given `resourceOwnerId`.

Retrieve a list of application activities. The id in the response is used for GET /v4/layers/asApplied/{activityId}/contents.

Retrieve the summary of an activity as applied agronomic data Retrieve an individual application activity summary by id. Ids are retrieved via the /layers/asApplied route.

Retrieve the raw application activity Retrieve an individual application activity by id. Ids are retrieved via the /layers/asApplied route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.

Retrieve a list of harvest activities. The id in the response is used for GET /v4/layers/asHarvested/{activityId}/contents.

Retrieve the summary of an activity as harvested agronomic data Retrieve an individual harvest activity summary by id. Ids are retrieved via the /layers/asHarvested route.

Retrieve the raw harvest activity Retrieve an individual harvest activity by id. Ids are retrieved via the /layers/asHarvested route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.

Retrieve a list of planting activities. The id in the response is used for GET /v4/layers/asPlanted/{activityId}/contents.

Retrieve the summary of an activity as planted agronomic data Retrieve an individual planting activity summary by id. Ids are retrieved via the /layers/asPlanted route.

Retrieve the raw planting activity Retrieve an individual planting activity by id. Ids are retrieved via the /layers/asPlanted route. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`). The data is compressed using .zip format.

Retrieve a list of scouting observations created or updated by the user identified by the Authorization header.

Retrieve individual scouting observation Retrieve an individual scouting observation by id. Ids are retrieved via the /layers/scoutingObservations route.

Retrieve attachments associated with a given scouting observation. Photos added to scouting notes in the FieldView app are capped to 20MB, and we won’t store photos larger than that in a scouting note.

Retrieve the binary contents of a scouting observation’s attachment. Photos added to scouting notes in the FieldView app are capped to `20MiB` (`20971520 bytes`), and we won’t store photos larger than that in a scouting note. Downloads larger than `5MiB` (`5242880 bytes`) in size, must be downloaded in chunks no larger than `5MiB` (`5242880 bytes`) and no smaller than `1MiB` (`1048576 bytes`). The last chunk could be less than `1MiB` (`1048576 bytes`).

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](https://tools.ietf.org/html/rfc7946#page-12). 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](https://tools.ietf.org/html/rfc7946#page-12). 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.

Initiate a new upload Step one in uploading a data product. The method will return an **Upload** ID which the caller will use in subsequent `PUT` requests. The following `contentTypes` may be uploaded: __image/vnd.climate.thermal.geotiff__ Allows for the upload of a thermal image. The image is a single band geotiff with 64 bit signed floating point values in degrees Celsius. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The following metadata entries are required to be embedded in the geotiff: * acquisitionStartDate - ISO8601 date * acquisitionEndDate - ISO8601 date * isCalibrated - boolean The following metadata entries are optional: * sourceId - uuid referencing the asset in the partner's system * fieldId - uuid referencing a field in the Climate system * boundaryId - uuid referencing a boundary in the Climate system * brandId - uuid referencing a partner's branding in the Climate system * name - name of the layer. The maximum number of characters that will be accepted as input is 20. Requires either imagery:write or platform scope. __image/vnd.climate.ndvi.geotiff__ Allows for the upload of a NDVI image. The image is a single band geotiff with 64 bit signed floating point values in the range of -1 to 1 inclusive. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The following metadata entries are required to be embedded in the geotiff: * acquisitionStartDate - ISO8601 date * acquisitionEndDate - ISO8601 date The following metadata entries are optional: * sourceId - uuid referencing the asset in the partner's system * fieldId - uuid referencing a field in the Climate system * boundaryId - uuid referencing a boundary in the Climate system * brandId - uuid referencing a partner's branding in the Climate system * name - name of the layer. The maximum number of characters that will be accepted as input is 20. Requires either imagery:write or platform scope. __image/vnd.climate.rgb.geotiff__ Allows for the upload of a true color image. The image is a multi band geotiff with 24-bit composite values. Each band is 8 bits with values in the range of 0 to 255. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The geotiff must contain 3 bands in the order Red, Green, Blue. The following metadata entries are required to be embedded in the geotiff: * acquisitionStartDate - ISO8601 date * acquisitionEndDate - ISO8601 date * isCalibrated - boolean The following metadata entries are optional: * sourceId - uuid referencing the asset in the partner's system * fieldId - uuid referencing a field in the Climate system * boundaryId - uuid referencing a boundary in the Climate system * brandId - uuid referencing a partner's branding in the Climate system * reflectanceComputeMethod - either TOA or GROUND * name - name of the layer. The maximum number of characters that will be accepted as input is 20. Requires either imagery:write or platform scope. __image/vnd.climate.rgb-nir.geotiff__ Allows for the upload of a Near Infrared (NIR) image. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The following metadata entries are required to be embedded in the geotiff: * acquisitionStartDate - ISO8601 date * acquisitionEndDate - ISO8601 date * isCalibrated - boolean The following metadata entries are optional: * sourceId - uuid referencing the asset in the partner's system * fieldId - uuid referencing a field in the Climate system * boundaryId - uuid referencing a boundary in the Climate system * brandId - uuid referencing a partner's branding in the Climate system * reflectanceComputeMethod - either TOA or GROUND * name - name of the layer. The maximum number of characters that will be accepted as input is 20. Requires either imagery:write or platform scope. __image/vnd.climate.rgb-cir.geotiff__ Allows for the upload of a Color Infrared (CIR) image. The Coordinate Reference System (CRS) must be UTM with WGS84 datum. The following metadata entries are required to be embedded in the geotiff: * acquisitionStartDate - ISO8601 date * acquisitionEndDate - ISO8601 date * isCalibrated - boolean The following metadata entries are optional: * sourceId - uuid referencing the asset in the partner's system * fieldId - uuid referencing a field in the Climate system * boundaryId - uuid referencing a boundary in the Climate system * brandId - uuid referencing a partner's branding in the Climate system * reflectanceComputeMethod - either TOA or GROUND * name - name of the layer. The maximum number of characters that will be accepted as input is 20. Requires either imagery:write or platform scope. __application/vnd.climate.rx.planting.shp__ Allows for the upload of a planting prescription in shapefile format. The upload must be an archive in the zip format. It should contain one and only one of each of the following file types: * .shp * .shx * .dbf All files with the above suffixes must have the same prefix, ie Back40.shp, Back40.shx and Back40.dbf. Requires either rx:write or platform scope. __application/vnd.climate.prescription.zones.shp__ Allows for the upload of a zones prescription in shapefile format. The upload must be an archive in the zip format. It should contain one and only one of each of the following file types: * .shp * .shx * .dbf All files with the above suffixes must have the same prefix, ie Back40.shp, Back40.shx and Back40.dbf. The following metadata entries are required: * fieldId - field identifier for prescription zones. Requires either rxZones:write or platform scope. __application/vnd.climate.modus.xml__ Allows for the upload of a soil sampling file in the modus 1.0 format with some restrictions. The upload must be a single xml file. The following elements are required to be present in the modus file. * EventCode - Max length of 64 bytes * EventDate - Must be in ISO8601 * SoilSample - Has a maxOccurs of 20k * Depth - Has a maxOccurs of 50 * LabName - Must be non-empty. * StartingDepth - 0 to 36 inclusive, default 0 * EndingDepth - 1 - 36 inclusive, default 1 * ColumnDepth * DepthUnit - must be inches * Geometry - point in wgs84 Requires the soil:write scope. __application/vnd.climate.as-applied.zip__ Allows for the upload of a valid application data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US). The following metadata entries are required: * fileName - name of the file being uploaded. The following metadata entries are optional: * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner. Requires `asApplied:write` scope. __application/vnd.climate.as-planted.zip__ Allows for the upload of a valid planting data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US). The following metadata entries are required: * fileName - name of the file being uploaded. The following metadata entries are optional: * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner. Requires `asPlanted:write` scope. __application/vnd.climate.as-harvested.zip__ Allows for the upload of a valid harvest data [supported formats](https://support.climate.com/kt#/kA02A000000DjvOSAS/en_US). The following metadata entries are required: * fileName - name of the file being uploaded. The following metadata entries are optional: * resourceOwner - the grower's account email, where dealer/partner wants to upload data. As a prerequisite the grower must share their operation with the dealer/partner. Requires `asHarvested:write` scope.

Upload a boundary Upload a **Boundary** entry by passing the geometry of the boundary. This will store the boundary but will not create field in Climate FieldView and will not link to an existing field in Climate FieldView. This is restricted to callers with **boundaries:write** scope. To upload a field boundary for field creation in Climate FieldView, please use **POST /v4/uploads**.