Attachments - Download

  • Reference
Service:
Azure Data Manager for Agriculture
API Version:
2023-11-01-preview

Downloads and returns attachment as response for the given input filePath.

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

URI Parameters

Name In Required Type Description
attachmentId
 path True

string

Id of attachment to be downloaded.
endpoint
 path True

string

uri

The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
partyId
 path True

string

Id of the associated party.
api-version
 query True

string

The requested API version

Request Header

Name Required Type Description
Authorization True

string

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name Type Description
200 OK

file

Success

Media Types: "application/json", "application/octet-stream"
Other Status Codes

ErrorResponse

Error

Media Types: "application/json", "application/octet-stream"

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

Attachments_Download

Sample request

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

Sample response

Status code:
200 
"101010101"

Definitions

Name Description
Error

An error from the Azure AgPlatform service.
ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Error

An error from the Azure AgPlatform service.

Name Type Description
code

string

Server-defined set of error codes.
details

Error[]

Array of details about specific errors that led to this reported error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message

string

Human-readable representation of the error.
target

string

Target of the error.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name Type Description
error

Error

An error from the Azure AgPlatform service.
traceId

string

Unique trace Id.

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name Type Description
code

string

Specific error code than was provided by the containing error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.