你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Crop Products - List

参考

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

返回作物产品资源的分页列表。

GET {endpoint}/crop-products?api-version=2023-11-01-preview

With optional parameters:

GET {endpoint}/crop-products?cropIds={cropIds}&brands={brands}&products={products}&treatments={treatments}&traits={traits}&traitStacks={traitStacks}&locations={locations}&companyNames={companyNames}&referenceDatasetIds={referenceDatasetIds}&referenceRecordIds={referenceRecordIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	命名空间的主机名，例如 admaInstanceName.farmbeats.azure.net
api-version	query	True	string	请求的 API 版本
brands	query		string[]	作物产品的品牌。
companyNames	query		string[]	作物产品的公司名称。
cropIds	query		string[]	作物产品的 CropIds。
ids	query		string[]	资源的 ID。
locations	query		string[]	作物产品的位置。
maxCreatedDateTime	query		string date-time	资源的最大创建日期 (非独占) 。
maxLastModifiedDateTime	query		string date-time	资源 (（含) ）的最大上次修改日期。
maxPageSize	query		integer int32	(非独占) 所需的最大项数。最小值 = 10，最大值 = 1000，默认值 = 50。
minCreatedDateTime	query		string date-time	资源 (非独占) 的最小创建日期。
minLastModifiedDateTime	query		string date-time	资源 (（含) ）的最小上次修改日期。
names	query		string[]	资源的名称。
products	query		string[]	作物产品的产品。
propertyFilters	query		string[]	对 Properties 对象中的键值对进行筛选。例如 “{testKey} eq {testValue}”。
referenceDatasetIds	query		string[]	作物产品的引用数据集 ID。
referenceRecordIds	query		string[]	作物产品的引用记录 ID。
skipToken	query		string	跳过令牌以获取下一组结果。
statuses	query		string[]	资源的状态。
traits	query		string[]	作物产品的特征。
traitStacks	query		string[]	作物产品的特征。
treatments	query		string[]	作物产品的处理。

请求头

名称	必需	类型	说明
Authorization	True	string	请为授权的 API 调用提供有效的持有者令牌。请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

响应

名称	类型	说明
200 OK	CropProductListResponse	Success
Other Status Codes	ErrorResponse	错误 Headers x-ms-error-code: string

名称

类型

说明

200 OK

CropProductListResponse

Success

Other Status Codes

ErrorResponse

错误

Headers

x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

Type: apiKey
In: header

示例

CropProducts_List

Sample Request

HTTP

GET {endpoint}/crop-products?api-version=2023-11-01-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "SEED123",
      "brand": "BRAND123",
      "product": "AGTECH",
      "relativeMaturity": {
        "unit": "string",
        "value": 0
      },
      "treatments": [
        "string"
      ],
      "name": "John Smith's Crop",
      "status": "Active",
      "description": "Some description",
      "source": "source",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "modifiedBy": "00000000-0000-0000-0000-000000000000",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/crop-products/{{cropProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定义

名称	说明
Company	公司/制造商的详细信息。
CropProduct	作物产品资源的架构。
CropProductListResponse	分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
Reference	对数据集记录的引用。
RelativeMaturityMeasure	相对成熟度度量值。

Company

公司/制造商的详细信息。

名称	类型	说明
description	string	制造公司说明。
name	string	制造公司的名称。
registrationNumber	string	公司的注册号。

CropProduct

作物产品资源的架构。

名称	类型	说明
brand	string	作物产品的商业品牌。
company	Company	公司/制造商的详细信息。
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
cropIds	string[]	与化学产品关联的作物的 ID。注意：最多可以有 25 个作物与 cropProduct 相关联。
description	string	资源的文本说明。
eTag	string	用于实现乐观并发的 ETag 值。
id	string	唯一的资源 ID。
location	string	特质。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用于标识资源的名称。
product	string	作物产品的商业产品名称。
properties		属于资源的键值对的集合。每对的键不能超过 50 个字符，并且值不能大于 150 个字符。注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
reference	Reference	对数据集记录的引用。
relativeMaturity	RelativeMaturityMeasure	相对成熟度度量值。
source	string	资源的源。
status	string	资源的状态。
traitStack	string	表型表达式，如 CONV、RR2。这些是 Phenotypic 表达式，例如 CONV (常规) 、RR2 (RoundUpReady) 。
traits	string	堆栈中的特征。
treatments	string[]	种子涂层应用于真菌、昆虫等。

CropProductListResponse

分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。

名称	类型	说明
nextLink	string	列表中下一页结果的继续链接（绝对 URI）。
skipToken	string	检索下一页时使用的令牌。如果为 null，则没有其他页。
value	CropProduct[]	请求的对象列表。

Error

Azure AgPlatform 服务出错。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	有关导致此报告错误的特定错误的详细信息数组。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名称	类型	说明
error	Error	Azure AgPlatform 服务出错。
traceId	string	唯一跟踪 ID。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

名称	类型	说明
code	string	包含错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

Reference

对数据集记录的引用。

名称	类型	说明
datasetId	string	数据集 ID。
recordId	string	记录 ID。

RelativeMaturityMeasure

相对成熟度度量值。

名称	类型	说明
method	string	用于确定产品的相对成熟度的方法。示例包括比较相对成熟度或热单位。
unit	string	数据单位。
value	number	数据值。

通过

Crop Products - List

URI 参数

请求头

响应

安全性

Authorization

示例

CropProducts_List

Sample Request

Sample Response

定义

Company

CropProduct

CropProductListResponse

Error

ErrorResponse

InnerError

Reference

RelativeMaturityMeasure

其他资源