Attachments - Get

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Hämtar en angiven bifogad resurs under en viss part.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
attachmentId	path	True	string	ID för den bifogade filen.
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
partyId	path	True	string	ID för den associerade parten.
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Svar

Name	Typ	Description
200 OK	Attachment	Klart
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

Attachments_Get

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "ATTACHMENT123",
  "partyId": "PARTY123",
  "resourceId": "PARTY123",
  "resourceType": "Party",
  "originalFileName": "attachment-file",
  "name": "John Smith's Field",
  "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"
}

Definitioner

Name	Description
Attachment	Schema för resursen för bifogade filer.
AttachmentResourceType	Associerad resurstyp för den här bifogade filen.
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Attachment

Schema för resursen för bifogade filer.

Name	Typ	Description
createdBy	string	Skapat av användar-/klient-ID.
createdDateTime	string	Datum då resursen skapades.
description	string	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
id	string	Unikt ID.
modifiedBy	string	Ändrat av användar-/klientorganisations-ID.
modifiedDateTime	string	Datum då resursen senast ändrades.
name	string	Namn för att identifiera resurs.
originalFileName	string	Ursprungligt filnamn för den här bifogade filen.
partyId	string	PartyId-ID för den här bifogade filen.
resourceId	string	Associerat resurs-ID för den här bifogade filen.
resourceType	AttachmentResourceType	Associerad resurstyp för den här bifogade filen.
source	string	Resursens källa.
status	string	Status för resursen.

AttachmentResourceType

Associerad resurstyp för den här bifogade filen.

Name	Typ	Description
ApplicationData	string
Farm	string
Field	string
HarvestData	string
Party	string
PlantTissueAnalysis	string
PlantingData	string
Prescription	string
SeasonalField	string
TillageData	string

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.