boundaries

Creates, updates, deletes, gets or lists a boundaries resource.

Overview

Name	boundaries
Type	Resource
Id	azure_extras.agrifood_farming.boundaries

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	party_id, boundary_id, endpoint		Creates or updates a boundary resource.
create_or_update	replace	party_id, boundary_id, endpoint		Creates or updates a boundary resource.
delete	delete	party_id, boundary_id, endpoint		Deletes a specified boundary resource under a particular party.
get_raw	exec	party_id, boundary_id, endpoint		Gets a specified boundary resource under a particular party.
list_raw	exec	endpoint	parentType, type, minArea, maxArea, minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of boundary resources across all parties.
search	exec	endpoint		Search for boundaries across all parties by fields and intersecting geometry.
list_by_party_id	exec	party_id, endpoint	parentType, type, minArea, maxArea, minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of boundary resources under a particular party.
search_by_party_id	exec	party_id, endpoint		Search for boundaries by fields and intersecting geometry.
get_cascade_delete_job_details	exec	job_id, endpoint		Get cascade delete job for specified boundary.
create_cascade_delete_job	exec	job_id, partyId, boundaryId, endpoint		Create a cascade delete job for specified boundary.
get_overlap	exec	party_id, boundary_id, otherPartyId, otherBoundaryId, endpoint		Returns overlapping area between two boundary Ids.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
boundaryId	string	ID of the boundary to be deleted. Required.
boundary_id	string	Id of the boundary. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
job_id	string	Job ID supplied by end user. Required.
otherBoundaryId	string	Id of the other boundary. Required.
otherPartyId	string	PartyId of the other field. Required.
partyId	string	ID of the associated party. Required.
party_id	string	Id of the party. Required.
maxArea	number	Maximum acreage of the boundary (inclusive). Default value is None.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive). Default value is None.
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive). Default value is None.
minArea	number	Minimum area of the boundary (inclusive). Default value is None.
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive). Default value is None.
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive). Default value is None.
parentType	string	Type of the parent it belongs to. Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.
type	string	Type it belongs to. Default value is None.

INSERT examples

create_or_update

Creates or updates a boundary resource.

INSERT INTO azure_extras.agrifood_farming.boundaries (
party_id,
boundary_id,
endpoint
)
SELECT 
'{{ party_id }}',
'{{ boundary_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: boundaries
props:
  - name: party_id
    value: "{{ party_id }}"
    description: Required parameter for the boundaries resource.
  - name: boundary_id
    value: "{{ boundary_id }}"
    description: Required parameter for the boundaries resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the boundaries resource.

REPLACE examples

create_or_update

Creates or updates a boundary resource.

REPLACE azure_extras.agrifood_farming.boundaries
SET 
-- No updatable properties
WHERE 
party_id = '{{ party_id }}' --required
AND boundary_id = '{{ boundary_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Deletes a specified boundary resource under a particular party.

DELETE FROM azure_extras.agrifood_farming.boundaries
WHERE party_id = '{{ party_id }}' --required
AND boundary_id = '{{ boundary_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Gets a specified boundary resource under a particular party.

EXEC azure_extras.agrifood_farming.boundaries.get_raw 
@party_id='{{ party_id }}' --required, 
@boundary_id='{{ boundary_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Returns a paginated list of boundary resources across all parties.

EXEC azure_extras.agrifood_farming.boundaries.list_raw 
@endpoint='{{ endpoint }}' --required, 
@parentType='{{ parentType }}', 
@type='{{ type }}', 
@minArea='{{ minArea }}', 
@maxArea='{{ maxArea }}', 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

search

Search for boundaries across all parties by fields and intersecting geometry.

EXEC azure_extras.agrifood_farming.boundaries.search 
@endpoint='{{ endpoint }}' --required
;

list_by_party_id

Returns a paginated list of boundary resources under a particular party.

EXEC azure_extras.agrifood_farming.boundaries.list_by_party_id 
@party_id='{{ party_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@parentType='{{ parentType }}', 
@type='{{ type }}', 
@minArea='{{ minArea }}', 
@maxArea='{{ maxArea }}', 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

search_by_party_id

Search for boundaries by fields and intersecting geometry.

EXEC azure_extras.agrifood_farming.boundaries.search_by_party_id 
@party_id='{{ party_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_cascade_delete_job_details

Get cascade delete job for specified boundary.

EXEC azure_extras.agrifood_farming.boundaries.get_cascade_delete_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_cascade_delete_job

Create a cascade delete job for specified boundary.

EXEC azure_extras.agrifood_farming.boundaries.create_cascade_delete_job 
@job_id='{{ job_id }}' --required, 
@partyId='{{ partyId }}' --required, 
@boundaryId='{{ boundaryId }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_overlap

Returns overlapping area between two boundary Ids.

EXEC azure_extras.agrifood_farming.boundaries.get_overlap 
@party_id='{{ party_id }}' --required, 
@boundary_id='{{ boundary_id }}' --required, 
@otherPartyId='{{ otherPartyId }}' --required, 
@otherBoundaryId='{{ otherBoundaryId }}' --required, 
@endpoint='{{ endpoint }}' --required
;