Insights.GetInsightsByPartyIdModelIdAndResourceAsync Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

Package:: Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

Source:: Insights.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a paginated list of insight resources.

public virtual Azure.AsyncPageable<BinaryData> GetInsightsByPartyIdModelIdAndResourceAsync (string partyId, string modelId, string resourceType, string resourceId, DateTimeOffset? minInsightStartDateTime = default, DateTimeOffset? maxInsightStartDateTime = default, DateTimeOffset? minInsightEndDateTime = default, DateTimeOffset? maxInsightEndDateTime = default, System.Collections.Generic.IEnumerable<string> measurementFilters = default, System.Collections.Generic.IEnumerable<string> ids = default, System.Collections.Generic.IEnumerable<string> names = default, System.Collections.Generic.IEnumerable<string> propertyFilters = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? minCreatedDateTime = default, DateTimeOffset? maxCreatedDateTime = default, DateTimeOffset? minLastModifiedDateTime = default, DateTimeOffset? maxLastModifiedDateTime = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);

abstract member GetInsightsByPartyIdModelIdAndResourceAsync : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetInsightsByPartyIdModelIdAndResourceAsync : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetInsightsByPartyIdModelIdAndResourceAsync (partyId As String, modelId As String, resourceType As String, resourceId As String, Optional minInsightStartDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxInsightStartDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minInsightEndDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxInsightEndDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional measurementFilters As IEnumerable(Of String) = Nothing, Optional ids As IEnumerable(Of String) = Nothing, Optional names As IEnumerable(Of String) = Nothing, Optional propertyFilters As IEnumerable(Of String) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional minCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

partyId: String

Id of the associated party.

modelId: String

Id of the associated model.

resourceType: String

Resource type associated with the record.

resourceId: String

Id of the associated resource.

minInsightStartDateTime: Nullable<DateTimeOffset>

Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

maxInsightStartDateTime: Nullable<DateTimeOffset>

Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

minInsightEndDateTime: Nullable<DateTimeOffset>

Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

maxInsightEndDateTime: Nullable<DateTimeOffset>

Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

measurementFilters: IEnumerable<String>

Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. eg. "measureKey.unit eq {testValue}" where testValue is string. eg. "measureKey.value eq {testValue}" where testValue = double.

ids: IEnumerable<String>

Ids of the resource.

names: IEnumerable<String>

Names of the resource.

propertyFilters: IEnumerable<String>

Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".

statuses: IEnumerable<String>

Statuses of the resource.

minCreatedDateTime: Nullable<DateTimeOffset>

Minimum creation date of resource (inclusive).

maxCreatedDateTime: Nullable<DateTimeOffset>

Maximum creation date of resource (inclusive).

minLastModifiedDateTime: Nullable<DateTimeOffset>

Minimum last modified date of resource (inclusive).

maxLastModifiedDateTime: Nullable<DateTimeOffset>

Maximum last modified date of resource (inclusive).

maxPageSize: Nullable<Int32>

Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.

skipToken: String

Skip token for getting next set of results.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

AsyncPageable<BinaryData>

The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

partyId, modelId, resourceType or resourceId is null.

ArgumentException

partyId, modelId, resourceType or resourceId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetInsightsByPartyIdModelIdAndResourceAsync with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetInsightsClient(<2022-11-01-preview>);

await foreach (var data in client.GetInsightsByPartyIdModelIdAndResourceAsync("<partyId>", "<modelId>", "<resourceType>", "<resourceId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetInsightsByPartyIdModelIdAndResourceAsync with all parameters, and how to parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetInsightsClient(<2022-11-01-preview>);

await foreach (var data in client.GetInsightsByPartyIdModelIdAndResourceAsync("<partyId>", "<modelId>", "<resourceType>", "<resourceId>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, new String[]{"<measurementFilters>"}, new String[]{"<ids>"}, new String[]{"<names>"}, new String[]{"<propertyFilters>"}, new String[]{"<statuses>"}, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, "<skipToken>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("modelId").ToString());
    Console.WriteLine(result.GetProperty("resourceType").ToString());
    Console.WriteLine(result.GetProperty("resourceId").ToString());
    Console.WriteLine(result.GetProperty("modelVersion").ToString());
    Console.WriteLine(result.GetProperty("attachmentsLink").ToString());
    Console.WriteLine(result.GetProperty("insightStartDateTime").ToString());
    Console.WriteLine(result.GetProperty("insightEndDateTime").ToString());
    Console.WriteLine(result.GetProperty("measurements").GetProperty("<test>").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("measurements").GetProperty("<test>").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("status").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("createdBy").ToString());
    Console.WriteLine(result.GetProperty("modifiedBy").ToString());
    Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());
}

Remarks

Below is the JSON schema for one item in the pageable response.

Response Body:

Schema for InsightListResponseValue:

{
  partyId: string, # Optional. Id of the associated party.
  modelId: string, # Optional. Id of the associated model.
  resourceType: "Party" | "Farm" | "Field" | "SeasonalField" | "Boundary", # Optional. Resource type associated with the record.
  resourceId: string, # Optional. Id of the associated resource.
  modelVersion: string, # Optional. Version of the associated model.
  attachmentsLink: string, # Optional. Gets link for attachments.
  insightStartDateTime: string (ISO 8601 Format), # Optional. Start date to which the insight is related.
  insightEndDateTime: string (ISO 8601 Format), # Optional. End date to which the insight is related.
  measurements: Dictionary<string, Measure>, # Optional. Measures to capture insights results.
  id: string, # Optional. Id of the resource.
  status: string, # Optional. Status of the resource.
  createdDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
  modifiedDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and
only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}

Applies to

Aracılığıyla paylaş