Boundaries.GetBoundariesByPartyId 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:: Boundaries.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 boundary resources under a particular party.

public virtual Azure.Pageable<BinaryData> GetBoundariesByPartyId (string partyId, string parentType = default, string type = default, System.Collections.Generic.IEnumerable<string> parentIds = default, double? minArea = default, double? maxArea = 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 GetBoundariesByPartyId : string * string * string * seq<string> * Nullable<double> * Nullable<double> * 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.GetBoundariesByPartyId : string * string * string * seq<string> * Nullable<double> * Nullable<double> * 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 GetBoundariesByPartyId (partyId As String, Optional parentType As String = Nothing, Optional type As String = Nothing, Optional parentIds As IEnumerable(Of String) = Nothing, Optional minArea As Nullable(Of Double) = Nothing, Optional maxArea As Nullable(Of Double) = 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.

parentType: String

Type of the parent it belongs to.

type: String

Type it belongs to.

parentIds: IEnumerable<String>

Parent Ids of the resource.

minArea: Nullable<Double>

Minimum area of the boundary (inclusive).

maxArea: Nullable<Double>

Maximum acreage of the boundary (inclusive).

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

Pageable<BinaryData>

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

ArgumentNullException

partyId is null.

ArgumentException

partyId 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 GetBoundariesByPartyId with required parameters and parse the result.

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

foreach (var data in client.GetBoundariesByPartyId("<partyId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

foreach (var data in client.GetBoundariesByPartyId("<partyId>", "<parentType>", "<type>", new String[]{"<parentIds>"}, 1234, 1234, 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("parentId").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("parentType").ToString());
    Console.WriteLine(result.GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").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("properties").GetProperty("<test>").ToString());
}

Remarks

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

Response Body:

Schema for BoundaryMetadataListResponseValue:

{
  partyId: string, # Optional. Party Id.
  parentId: string, # Optional. Id of the parent it belongs to.
  area: {
    unit: string, # Optional. Data unit.
    value: number, # Optional. Data value.
  }, # Optional. Schema for storing measurement reading and unit.
  parentType: "Field" | "SeasonalField" | "Zone" | "Prescription" | "PlantTissueAnalysis" | "ApplicationData" | "PlantingData" | "TillageData" | "HarvestData", # Optional. Type of the parent it belongs to.
  type: string, # Optional. Type it belongs to.
  id: string, # Optional. Unique resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  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.
  source: string, # Optional. Source of the resource.
  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

Sdílet prostřednictvím