InsightAttachments.GetInsightAttachmentsByPartyIdModelIdAndResource Method

Definition

Returns a paginated list of insight resources.

public virtual Azure.Pageable<BinaryData> GetInsightAttachmentsByPartyIdModelIdAndResource (string partyId, string modelId, string resourceType, string resourceId, System.Collections.Generic.IEnumerable<string> insightIds = 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 GetInsightAttachmentsByPartyIdModelIdAndResource : string * string * string * string * seq<string> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetInsightAttachmentsByPartyIdModelIdAndResource : string * string * string * string * seq<string> * seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetInsightAttachmentsByPartyIdModelIdAndResource (partyId As String, modelId As String, resourceType As String, resourceId As String, Optional insightIds 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 Pageable(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.

insightIds
IEnumerable<String>

List of insight IDs.

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

The Pageable<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

partyId, modelId, resourceType or resourceId is null.

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

Service returned a non-success status code.

Examples

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

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

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

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

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

foreach (var data in client.GetInsightAttachmentsByPartyIdModelIdAndResource("<partyId>", "<modelId>", "<resourceType>", "<resourceId>", new String[]{"<insightIds>"}, 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("insightId").ToString());
    Console.WriteLine(result.GetProperty("modelId").ToString());
    Console.WriteLine(result.GetProperty("resourceType").ToString());
    Console.WriteLine(result.GetProperty("resourceId").ToString());
    Console.WriteLine(result.GetProperty("originalFileName").ToString());
    Console.WriteLine(result.GetProperty("partyId").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("source").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("eTag").ToString());
}

Remarks

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

Response Body:

Schema for InsightAttachmentListResponseValue:

{
  insightId: string, # Required. InsightID for this InsightAttachment.
  modelId: string, # Optional. ModelID for this InsightAttachment.
  resourceType: "Party" | "Farm" | "Field" | "SeasonalField" | "Boundary", # Optional. Associated Resource type for this attachment.
  resourceId: string, # Optional. Associated Resource id for this attachment.
  originalFileName: string, # Optional. Original File Name for this attachment.
  partyId: string, # Optional. PartyId id for this attachment.
  id: string, # Optional. Unique id.
  status: string, # Optional. Status of the resource.
  createdDateTime: string (ISO 8601 Format), # Optional. Date when resource was created.
  modifiedDateTime: string (ISO 8601 Format), # Optional. Date when resource was last modified.
  source: string, # Optional. Source of the resource.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
}

Applies to