Datasets - Get

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Ruft ein angegebenes Dataset ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
datasetId	path	True	string	ID des Datasets.
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	Dataset	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Datasets_Get

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "type": "Chemical",
  "recordsSchema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "minLength": 2,
        "maxLength": 100
      },
      "code": {
        "type": "string"
      },
      "Company": {
        "type": "string"
      },
      "MatterStateCode": {
        "type": "string"
      },
      "RegulatorNumbers": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "ChemicalTypeCodes": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "ChemicalTypeNames": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "SubstanceCodes": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "SubstanceNames": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "SubstancePercentages": {
        "type": "number",
        "maximum": 100,
        "minimum": 0
      },
      "CreatedAtDate": {
        "type": "string",
        "format": "date-time"
      },
      "UpdatedAtDate": {
        "type": "string",
        "format": "date-time"
      }
    },
    "required": [
      "Company",
      "name"
    ],
    "additionalProperties": false
  },
  "id": "Dataset1",
  "eTag": "43009725-0000-0700-0000-652ec9ec0000",
  "status": "string",
  "createdDateTime": "2023-10-17T17:52:44Z",
  "modifiedDateTime": "2023-10-17T17:52:44Z",
  "source": "Partner",
  "name": "Chemical Dataset",
  "description": "Chemical Dataset",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definitionen

Name	Beschreibung
Dataset	Schema der Datasetressource.
DatasetType	Typ des Datasets. Unterstützte Typen: CropProduct, ChemicalProduct, Equipment.
Error	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Dataset

Objekt

Schema der Datasetressource.

Name	Typ	Beschreibung
createdBy	string	Erstellt von der Benutzer-/Mandanten-ID.
createdDateTime	string (date-time)	Datum-Uhrzeit der Erstellung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textbeschreibung der Ressource.
eTag	string	Der ETag-Wert, der optimistische Parallelität implementiert.
id	string	Eindeutige Ressourcen-ID.
modifiedBy	string	Geändert von Benutzer-/Mandanten-ID.
modifiedDateTime	string (date-time)	Datum-Uhrzeit der letzten Änderung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Name zum Identifizieren der Ressource.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf nicht über einen Schlüssel größer als 50 Zeichen verfügen und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Numeral- und Datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
recordsSchema		Schema für Datensätze unter dem Dataset.
solutionId	string	Lösungs-ID der Datasetlösung.
source	string minLength: 2 maxLength: 100	Quelle der Ressource.
status	string minLength: 0 maxLength: 100	Status der Ressource.
type	DatasetType	Typ des Datasets. Unterstützte Typen: CropProduct, ChemicalProduct, Equipment.

DatasetType

Enumeration

Typ des Datasets. Unterstützte Typen: CropProduct, ChemicalProduct, Equipment.

Wert	Beschreibung
ChemicalProduct
Crop
CropProduct
FarmEquipment

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.