Solution Inference - Fetch

Riferimento

Servizio:: Azure Data Manager for Agriculture

Versione API:: 2023-11-01-preview

Recupera i dettagli del processo attivato per una soluzione.

POST {endpoint}/solutions/{solutionId}:fetch?api-version=2023-11-01-preview

Parametri dell'URI

Nome In Necessario Tipo Descrizione

endpoint

path

True

string

uri

Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net

solutionId

path

True

string

ID della soluzione.

Criterio di espressione regolare: ^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$

api-version

query

True

string

Versione dell'API richiesta

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
requestPath	True	string	RequestPath contenente la versione api, i parametri di query e la route del percorso da chiamare per la richiesta partner. Il formato previsto è "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Se non si segue questo formato, è possibile che si verifichino errori di convalida.
partnerRequestBody			Parametri di input api richiesti dal partner per attivare/annullare la richiesta di processo.
partnerRequestHeaders		object	Intestazioni aggiuntive inviate al partner.

Risposte

Nome

Tipo

Descrizione

200 OK

Operazione completata

Other Status Codes

Errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

SolutionInference_Fetch

Esempio di richiesta

HTTP

POST {endpoint}/solutions/solution.solutionId:fetch?api-version=2023-11-01-preview

{
  "requestPath": "string"
}

Risposta di esempio

Codice di stato:: 200

{
  "source": "Manual",
  "name": "Application data for North Farm",
  "description": "some description"
}

Definizioni

Nome	Descrizione
Error	Errore del servizio Azure AgPlatform.
ErrorResponse	Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.
InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
SolutionInference	Modello di richiesta SolutionInference.

Error

Errore del servizio Azure AgPlatform.

Nome	Tipo	Descrizione
code	string	Set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.

Nome	Tipo	Descrizione
error	Error	Errore del servizio Azure AgPlatform.
traceId	string	ID di traccia univoco.

InnerError

Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

SolutionInference

Modello di richiesta SolutionInference.

Nome	Tipo	Descrizione
partnerRequestBody		Parametri di input api richiesti dal partner per attivare/annullare la richiesta di processo.
partnerRequestHeaders	object	Intestazioni aggiuntive inviate al partner.
requestPath	string	RequestPath contenente la versione api, i parametri di query e la route del percorso da chiamare per la richiesta partner. Il formato previsto è "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Se non si segue questo formato, è possibile che si verifichino errori di convalida.