Breaking API change: products field

Created on 4 February 2024, 10 months ago
Updated 18 February 2024, 9 months ago

Problem/Motivation

Start using the products key instead of product. For now this will be a list with a single product, but may be multiple in the future.

Also start using a applicationProductTotals key.

From JD:

What is Changing?

Currently the Field Operations response contains a single product field that includes details about the application product or tank mix that was applied during an application operation. This data contract will be changing to include a products field that could contain a list of application products or tank mixes applied during an application operation. The structure of each individual product element in the list will remain unchanged.

In addition, the Field Operation Measurements response contains a productTotals list, area, averageSpeed, totalMaterial, and averageMaterial that will be replaced with an applicationProductTotals list for all Single Product and Tank Mix Operations. The new list will allow for a reference back to the Tank Mix to which the product is associated.​​​​​​

Why is it Changing?

Currently when multiple application products or different tank mixes are applied on a single field the data is separated into multiple Field Operations. In the future, the data will be grouped into a single field operation when it was applied as part of a single application.

Actions Required:

Update all API calls to the Field Operations endpoints listed below to reference the “products” list in the response instead of the single “product” object.

Additionally, update all API calls to either the Field Operation Measurements endpoints or calls containing the “embed=measurementTypes” query parameter, listed below, to reference the “applicationProductTotals” list in the response instead of the former “productTotals” list. The new list is structured differently and includes a reference to the associated Tank Mix where applicable.

Impacted API Endpoints?
List Field Operations
GET https://partnerapi.deere.com/organizations/{orgId}/fields/{fieldId}/fieldOperations
View a Field Operation
GET https://partnerapi.deere.com/fieldOperations/{operationId}
Field Operations Measurments
​​GET https://partnerapi.deere.com/fieldOperations/{operationId}/measurementTypes
GET https://partnerapi.deere.com/fieldOperations/{operationId}/measurementTypes/{measurementType}

Dates:
Currently the products list is available in the response and will be populated with the single application product or tank mix. The individual product field will still be available.
Currently the new applicationProductTotals list is available in the response and will be populated with the same data that is in the productTotals list. The productTotals list, area, averageSpeed, totalMaterial, and averageMaterial fields will still be available
July 10, 2024: The products list may start including multiple application products and/or tank mixes within a single field operation. The individual product field will be fully deprecated and removed from the response.

Additionally, the productTotals list, area, averageSpeed, totalMaterial, and averageMaterial fields provided with the Field Operation Measurements response, will be fully deprecated and removed for all Single Application and Tank Mix Operations.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Version

1.0

Component

Code

Created by

🇺🇸United States paul121 Spokane, WA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024