Dataset Records - List

Riferimento

Servizio:: Azure Data Manager for Agriculture

Versione API:: 2023-11-01-preview

Restituisce un elenco impaginato di record.

GET {endpoint}/datasets/{datasetId}/records?api-version=2023-11-01-preview

Con parametri facoltativi:

GET {endpoint}/datasets/{datasetId}/records?recordFilters={recordFilters}&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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
datasetId	path	True	string	ID set di dati.
endpoint	path	True	string uri	Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Versione dell'API richiesta
ids	query		string[]	ID della risorsa.
maxCreatedDateTime	query		string date-time	Data massima di creazione della risorsa (inclusiva).
maxLastModifiedDateTime	query		string date-time	Data massima modificata della risorsa (inclusiva).
maxPageSize	query		integer int32	Numero massimo di elementi necessari (inclusi). Minimo = 10, Massimo = 1000, Valore predefinito = 50.
minCreatedDateTime	query		string date-time	Data minima di creazione della risorsa (inclusiva).
minLastModifiedDateTime	query		string date-time	Data minima dell'ultima modifica della risorsa (inclusiva).
names	query		string[]	Nomi della risorsa.
propertyFilters	query		string[]	Filtra le coppie chiave-valore all'interno dell'oggetto Properties. Ad esempio: "{testKey} eq {testValue}".
recordFilters	query		string[]	Filtra le coppie chiave-valore all'interno dell'oggetto Record. Applicabile solo per le chiavi di primo livello con valore di tipo string, datetime o number. Ad esempio: "{testKey} eq {testValue}".
skipToken	query		string	Ignorare il token per ottenere il set di risultati successivo.
statuses	query		string[]	Stati della risorsa.

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.

Risposte

Nome	Tipo	Descrizione
200 OK	DatasetRecordListResponse	Operazione completata
Other Status Codes	ErrorResponse	Errore Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

DatasetRecordListResponse

Operazione completata

Other Status Codes

ErrorResponse

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

DatasetRecords_List

Esempio di richiesta

HTTP

GET {endpoint}/datasets/Dataset1/records?api-version=2023-11-01-preview

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "datasetId": "Dataset1",
      "record": {
        "name": "Cimegra",
        "code": "cimegra",
        "Company": "BASF",
        "MatterStateCode": "liquid",
        "RegulatorNumbers": [
          "33666"
        ],
        "ChemicalTypeCodes": [
          "insecticide"
        ],
        "ChemicalTypeNames": [
          "Insecticide"
        ],
        "SubstanceCodes": [
          "broflanilide"
        ],
        "SubstanceNames": [
          "Broflanilide"
        ],
        "SubstancePercentages": 10,
        "CreatedAtDate": "2023-05-30T11:10:21Z",
        "UpdatedAtDate": "2023-06-30T11:10:21Z"
      },
      "id": "Record1",
      "status": "string",
      "source": "string",
      "name": "string",
      "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"
}

Definizioni

Nome	Descrizione
DatasetRecord	Schema dei record del set di dati.
DatasetRecordListResponse	La risposta di paging contiene un elenco di oggetti richiesti e un skipToken per ottenere il set di risultati successivo.
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.

DatasetRecord

Schema dei record del set di dati.

Nome	Tipo	Descrizione
createdBy	string	Creato dall'ID utente/tenant.
createdDateTime	string	Data e ora di creazione della risorsa, formato di esempio: a-MM-ggTHH:mm:ssZ.
datasetId	string	ID set di dati per questo record.
description	string	Descrizione testuale della risorsa.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
id	string	ID risorsa univoco.
modifiedBy	string	Modificato dall'ID utente/tenant.
modifiedDateTime	string	Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
name	string	Nome che identifica la risorsa.
properties		Raccolta di coppie chiave-valore appartenenti alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie chiave-valore per una risorsa e sono supportati solo valori stringa, numerali e datetime (aa-MM-ggTHH:mm:ssZ).
record		Oggetto Record.
source	string	Origine della risorsa.
status	string	Stato della risorsa.

DatasetRecordListResponse

La risposta di paging contiene un elenco di oggetti richiesti e un skipToken per ottenere il set di risultati successivo.

Nome	Tipo	Descrizione
nextLink	string	Collegamento di continuità (URI assoluto) alla pagina successiva dell'elenco.
skipToken	string	Token usato per recuperare la pagina successiva. Se null, non sono presenti pagine aggiuntive.
value	DatasetRecord[]	Elenco di oggetti richiesti.

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.

Condividi tramite

Dataset Records - List

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

Authorization

Esempio

DatasetRecords_List

Esempio di richiesta

Risposta di esempio

Definizioni

DatasetRecord

DatasetRecordListResponse

Error

ErrorResponse

InnerError

Risorse aggiuntive