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

Attachments - List By Party Id

参考

服务:: Azure Data Manager for Agriculture

API 版本:: 2023-11-01-preview

返回特定参与方下的附件资源的分页列表。

GET {endpoint}/parties/{partyId}/attachments?api-version=2023-11-01-preview

具有可选参数:

GET {endpoint}/parties/{partyId}/attachments?resourceIds={resourceIds}&resourceTypes={resourceTypes}&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
partyId	path	True	string	关联方 ID。
api-version	query	True	string	请求的 API 版本
ids	query		string[]	资源的 ID。
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[]	资源的名称。
propertyFilters	query		string[]	筛选 Properties 对象中的键值对。例如 “{testKey} eq {testValue}”。
resourceIds	query		string[]	资源的资源 ID。
resourceTypes	query		string[]	资源类型。即 Party、Farm、Field、SeasonalField、ApplicationData、HarvestData、TillageData、PlantingData、PlantTissueAnalysis、Prescription。
skipToken	query		string	跳过用于获取下一组结果的令牌。
statuses	query		string[]	资源的状态。

请求头

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

响应

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

名称

类型

说明

200 OK

AttachmentListResponse

Success

Other Status Codes

ErrorResponse

错误

标头

x-ms-error-code: string

安全性

Authorization

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

类型: apiKey
在: header

示例

Attachments_ListByPartyId

示例请求

HTTP

GET {endpoint}/parties/PARTY123/attachments?api-version=2023-11-01-preview

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "ATTACHMENT123",
      "partyId": "PARTY123",
      "resourceId": "PARTY123",
      "resourceType": "Party",
      "originalFileName": "attachment-file",
      "name": "John Smith's attachment",
      "status": "Active",
      "description": "Some description",
      "source": "source",
      "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}}/attachments/{{attachmentId}}?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"
}

定义

名称	说明
Attachment	附件资源的架构。
AttachmentListResponse	分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。
AttachmentResourceType	此附件的关联资源类型。
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

Attachment

附件资源的架构。

名称	类型	说明
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期。
description	string	资源的文本说明。
eTag	string	实现乐观并发的 ETag 值。
id	string	唯一 ID。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期。
name	string	用于标识资源的名称。
originalFileName	string	此附件的原始文件名。
partyId	string	此附件的 PartyId ID。
resourceId	string	此附件的关联资源 ID。
resourceType	AttachmentResourceType	此附件的关联资源类型。
source	string	资源的源。
status	string	资源的状态。

AttachmentListResponse

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

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

AttachmentResourceType

此附件的关联资源类型。

名称	类型	说明
ApplicationData	string
Farm	string
Field	string
HarvestData	string
Party	string
PlantTissueAnalysis	string
PlantingData	string
Prescription	string
SeasonalField	string
TillageData	string

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 服务的错误响应。请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

名称	类型	说明
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 。

通过

Attachments - List By Party Id

URI 参数

请求头

响应

安全性

Authorization

示例

Attachments_ListByPartyId

示例请求

示例响应

定义

Attachment

AttachmentListResponse

AttachmentResourceType

Error

ErrorResponse

InnerError

其他资源