View varieties for an org
GET
OAuth Scope Required: ag2
Request URI
GET https://sandboxapi.deere.com/platform/organizations/{orgId}/varieties
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | In |
---|---|---|---|
status | string | Filters the list based on archive status. Accepted values are ARCHIVED, AVAILABLE, and ALL. The default behavior is to return only available (non-archived) varieties. Example: AVAILABLE Allowed Values: AVAILABLE,ARCHIVED,ALL | query |
embed | array | An embeddable list of properties which are optional by default. Allowed Values: documents,showRecordMetadata | query |
Response Details
Field | Type | Description & Example |
---|---|---|
@type | string | --- Example: Variety |
id | string | The primary identifier for the variety that is unique to your organization. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914 |
links | Array of object | --- |
rel | string | The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value. Example: self |
uri | string | The location of the resource Example: https://sandboxapi.deere.com/platform/ |
name | string | The common name of the variety. Example: S73-Z5 - 50lb bag |
category | string | --- Example: VARIETY Allowed Values: VARIETY |
cropName | string | The identifier of the crop type that this variety is associated with (see the Crop Types API). Example: SOYBEANS |
companyName | string | The brand of the variety. Example: NK |
archived | boolean | Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization. |
referenceGuid | string | Optional. Denotes whether this product is from the global reference list. Example: 87b4a1e7-210b-482c-8a7a-19e9f644e914 |
documents | Array of object | List of documents for the variety. For example, Tech Sheet, SDS Label. |
@type | string | --- Example: Document |
id | string | Primary identifier for resource. Example: 1f8c12b4-126f-11ec-82a8-0242ac130003 |
docType | string | Type of document for this product. Example: 24(c) Registration |
productId | string | The Unique id of the product. Example: 388ab719-277d-4032-a2c3-40a297d8f482 |
description | string | Information about the document. Example: CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed |
fileName | string | The filename of the document. Example: ld7OD026.pdf |
expirationDate | string | --- Example: 2017-03-22 |
recordMetadata | object | Data structure for record metadata capturing information about the creation and last update of an entity.
For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg).
NOTES
* Some attributes are only visible if the API Client has the required license.
* Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
|
userCreationTimestamp | string | Timestamp of entity creation Example: 2018-04-30T10:23:50.000Z |
userLastModifiedTimestamp | string | Timestamp of entity modification Example: 2018-05-01T08:11:23.000Z |