你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Farm Equipments - List
返回服务器场设备资源的分页列表。
GET {endpoint}/farm-equipments?api-version=2023-11-01-preview
GET {endpoint}/farm-equipments?cropIds={cropIds}&brands={brands}&equipmentSeries={equipmentSeries}&models={models}&serial={serial}&types={types}&ownership={ownership}&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[] |
农场设备品牌。 |
|
company
|
query |
string[] |
农场设备的公司名称。 |
|
crop
|
query |
string[] |
农场设备的 CropIds。 |
|
equipment
|
query |
string[] |
设备系列农场设备。 |
|
ids
|
query |
string[] |
资源的 ID。 |
|
locations
|
query |
string[] |
农场设备的位置。 |
|
max
|
query |
string date-time |
资源的最大创建日期 (非独占) 。 |
|
max
|
query |
string date-time |
资源 ((含) )的最大上次修改日期。 |
|
max
|
query |
integer int32 |
(非独占) 所需的最大项数。 最小值 = 10,最大值 = 1000,默认值 = 50。 |
|
min
|
query |
string date-time |
资源 (非独占) 的最小创建日期。 |
|
min
|
query |
string date-time |
资源 ((含) )的最小上次修改日期。 |
|
models
|
query |
string[] |
农场设备的模型。 |
|
names
|
query |
string[] |
资源的名称。 |
|
ownership
|
query |
string[] |
农场设备的所有权。 |
|
property
|
query |
string[] |
对 Properties 对象中的键值对进行筛选。 例如 “{testKey} eq {testValue}”。 |
|
reference
|
query |
string[] |
服务器场设备的引用数据集 ID。 |
|
reference
|
query |
string[] |
服务器场设备的引用记录 ID。 |
|
serial
|
query |
string[] |
农场设备的序列。 |
|
skip
|
query |
string |
跳过令牌以获取下一组结果。 |
|
statuses
|
query |
string[] |
资源的状态。 |
|
types
|
query |
string[] |
农场设备类型。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 Headers x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
Type:
apiKey
In:
header
示例
FarmEquipments_List
Sample Request
GET {endpoint}/farm-equipments?api-version=2023-11-01-preview
Sample Response
{
"value": [
{
"id": "Equipment123",
"cropIds": [
"CropId"
],
"reference": {
"datasetId": "datasetId",
"recordId": "recordId"
},
"brand": "string",
"series": "H",
"model": "1234",
"serial": "1234",
"type": "Harvester",
"ownership": "Personal",
"location": "US",
"company": {
"name": "Company123",
"description": "Equipment manufacturer",
"registrationNumber": "1234"
},
"status": "Active",
"source": "Manufacturer",
"name": "Equipment1",
"description": "string",
"properties": {
"key1": "value1",
"key2": 123.45
},
"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}}/chemical-products/{{chemicalProductId}}?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 |
公司/制造商的详细信息。 |
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。 |
Farm |
FarmEquipment 资源的架构。 |
Farm |
分页响应包含请求的对象列表和用于获取下一组结果的 skipToken。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Reference |
对数据集记录的引用。 |
Company
公司/制造商的详细信息。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
制造公司说明。 |
name |
string |
制造公司的名称。 |
registrationNumber |
string |
公司的注册号。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
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 |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
FarmEquipment
FarmEquipment 资源的架构。
名称 | 类型 | 说明 |
---|---|---|
brand |
string |
化工产品的商业品牌。 |
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 |
使用设备的区域。 |
model |
string |
场设备的型号。 |
modifiedBy |
string |
由用户/租户 ID 修改。 |
modifiedDateTime |
string |
上次修改资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
name |
string |
用于标识资源的名称。 |
ownership |
string |
拥有、出租、共享等。 |
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH:mm:ssZ) 值。 |
|
reference |
对数据集记录的引用。 |
|
serial |
string |
场设备的序列号。 |
series |
string |
服务器场设备的序列号。 |
source |
string |
资源的源。 |
status |
string |
资源的状态。 |
type |
string |
农场设备类型 (耕种机、播种机、收割机、喷洒机...) 。 |
FarmEquipmentListResponse
分页响应包含请求的对象列表和用于获取下一组结果的 skipToken。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
列表中下一页结果的继续链接(绝对 URI)。 |
skipToken |
string |
检索下一页时使用的令牌。 如果为 null,则没有其他页。 |
value |
请求的对象列表。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Reference
对数据集记录的引用。
名称 | 类型 | 说明 |
---|---|---|
datasetId |
string |
数据集 ID。 |
recordId |
string |
记录 ID。 |