Insights - List By Party Id Model Id And Resource

Dienst:: Azure Data Manager for Agriculture

API-Version:: 2023-11-01-preview

Gibt eine paginierte Liste von Einblickressourcen zurück.

GET {endpoint}/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights?api-version=2023-11-01-preview

Mit optionalen Parametern:

GET {endpoint}/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights?minInsightStartDateTime={minInsightStartDateTime}&maxInsightStartDateTime={maxInsightStartDateTime}&minInsightEndDateTime={minInsightEndDateTime}&maxInsightEndDateTime={maxInsightEndDateTime}&measurementFilters={measurementFilters}&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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. admaInstanceName.farmbeats.azure.net
modelId	path	True	string	ID des zugeordneten Modells.
partyId	path	True	string	ID der zugehörigen Partei.
resourceId	path	True	string	ID der zugeordneten Ressource.
resourceType	path	True	string	Dem Datensatz zugeordneter Ressourcentyp.
api-version	query	True	string	Die angeforderte API-Version
ids	query		string[]	IDs der Ressource.
maxCreatedDateTime	query		string (date-time)	Maximale Erstellungsdatum der Ressource (einschließlich).
maxInsightEndDateTime	query		string (date-time)	Maximale InsightEndDateTime-Zeit der Einblickeressourcen (einschließlich), Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
maxInsightStartDateTime	query		string (date-time)	Maximale insightStartDateTime-Zeit von Insight-Ressourcen (einschließlich), Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
maxLastModifiedDateTime	query		string (date-time)	Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximale Anzahl der benötigten Elemente (einschließlich). Minimum = 10, Maximum = 1000, Standardwert = 50.
measurementFilters	query		string[]	Filtert nach measureKey.unit/unitValue- oder measureKey.value-Paaren innerhalb des Measures-Objekts. Zb. "measureKey.unit eq {testValue}" wobei testValue eine Zeichenfolge ist. Zb. "measureKey.value eq {testValue}" wobei testValue = double.
minCreatedDateTime	query		string (date-time)	Mindesterstellungsdatum der Ressource (einschließlich).
minInsightEndDateTime	query		string (date-time)	Minimale insightEndDateTime-Uhrzeit der Insight-Ressourcen (einschließlich), Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
minInsightStartDateTime	query		string (date-time)	Minimale InsightStartDateTime-Uhrzeit der Insight-Ressourcen (einschließlich), Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
minLastModifiedDateTime	query		string (date-time)	Mindestdatum der letzten Änderung der Ressource (einschließlich).
names	query		string[]	Namen der Ressource.
propertyFilters	query		string[]	Filtert nach Schlüsselwertpaaren innerhalb des Properties-Objekts. Zb. "{testKey} eq {testValue}".
skipToken	query		string	Überspringen Sie das Token, um die nächste Gruppe von Ergebnissen zu erhalten.
statuses	query		string[]	Status der Ressource.

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	InsightListResponse	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

InsightListResponse

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

Insights_ListByPartyIdModelIdAndResource

Beispielanforderung

HTTP

GET {endpoint}/parties/PARTY123/models/modelId/resource-types/Farm/resources/farmId/insights?api-version=2023-11-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "insightId",
      "partyId": "pjparty",
      "resourceId": "farmId",
      "resourceType": "Farm",
      "modelId": "modelId",
      "modelVersion": "1.0",
      "insightStartDateTime": "2021-07-26T09:31:54Z",
      "insightEndDateTime": "2021-07-26T09:31:54Z",
      "measurements": {
        "additionalPropKey1": {
          "unit": "15m/s",
          "value": 0
        }
      },
      "createdDateTime": "2021-07-26T11:19:11Z",
      "modifiedDateTime": "2021-07-26T11:19:11Z",
      "eTag": "00000000-0000-0000-8210-0ef9229601d7",
      "name": "insightName",
      "description": "insightDescription",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    }
  ],
  "skipToken": "skipToken",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/insights?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Definitionen

Name	Beschreibung
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.
FarmHierarchyResourceType	Dem Datensatz zugeordneter Ressourcentyp.
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.
Insight	Schema der Insight-Ressource.
InsightListResponse	Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.
Measure	Schema zum Speichern des Messwerts und der Maßeinheit.

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.

FarmHierarchyResourceType

Enumeration

Dem Datensatz zugeordneter Ressourcentyp.

Wert	Beschreibung
Party
Farm
Field
SeasonalField

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.

Insight

Objekt

Schema der Insight-Ressource.

Name	Typ	Beschreibung
attachmentsLink	string	Ruft den Link für Anlagen ab.
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	ID der Ressource.
insightEndDateTime	string (date-time)	Enddatum, zu dem der Einblick verwandt ist.
insightStartDateTime	string (date-time)	Startdatum, zu dem der Einblick verwandt ist.
measurements	<string, Measure>	Measures zum Erfassen von Insights-Ergebnissen.
modelId	string	ID des zugeordneten Modells.
modelVersion	string	Version des zugeordneten Modells.
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.
partyId	string	ID der zugehörigen Partei.
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.
resourceId	string	ID der zugeordneten Ressource.
resourceType	FarmHierarchyResourceType	Dem Datensatz zugeordneter Ressourcentyp.
status	string minLength: 0 maxLength: 100	Status der Ressource.

InsightListResponse

Objekt

Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.

Name	Typ	Beschreibung
nextLink	string	Fortsetzungslink (absoluter URI) zur nächsten Seite der Ergebnisse in der Liste.
skipToken	string	Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn null ist, gibt es keine zusätzlichen Seiten.
value	Insight[]	Liste der angeforderten Objekte.

Measure

Objekt

Schema zum Speichern des Messwerts und der Maßeinheit.

Name	Typ	Beschreibung
unit	string minLength: 1 maxLength: 50	Dateneinheit.
value	number (double)	Datenwert.