insights

Creates, updates, deletes, gets or lists an insights resource.

Overview

Name	insights
Type	Resource
Id	azure_extras.agrifood_farming.insights

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, model_id, resource_type, resource_id, insight_id, endpoint		Creates or updates insight entity.
create_or_update	replace	party_id, model_id, resource_type, resource_id, insight_id, endpoint		Creates or updates insight entity.
delete	delete	party_id, model_id, resource_type, resource_id, insight_id, endpoint		Deletes a specified insight resource.
get_raw	exec	party_id, model_id, resource_type, resource_id, insight_id, endpoint		Gets a specified insight resource under a particular party.
list_by_party_id_model_id_and_resource	exec	party_id, model_id, resource_type, resource_id, endpoint	minInsightStartDateTime, maxInsightStartDateTime, minInsightEndDateTime, maxInsightEndDateTime, minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of insight resources.
get_cascade_delete_job_details	exec	job_id, endpoint		Get a cascade delete job for specified insight.
create_cascade_delete_job	exec	job_id, partyId, modelId, resourceType, resourceId, insightId, endpoint		Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.

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
endpoint	string	The service endpoint host (no scheme). (default: )
insightId	string	Insight id. Required.
insight_id	string	Id of the insight resource. Required.
job_id	string	Job ID supplied by end user. Required.
modelId	string	Id of the associated model. Required.
model_id	string	Id of the associated model. Required.
partyId	string	ID of the associated party. Required.
party_id	string	Id of the associated party. Required.
resourceId	string	Id of the associated resource. Required.
resourceType	string	Resource Type. Required.
resource_id	string	Id of the associated resource. Required.
resource_type	string	Resource type associated with the record. Required.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive). Default value is None.
maxInsightEndDateTime	string (date-time)	Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
maxInsightStartDateTime	string (date-time)	Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive). Default value is None.
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive). Default value is None.
minInsightEndDateTime	string (date-time)	Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
minInsightStartDateTime	string (date-time)	Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive). Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.

INSERT examples

create_or_update

Creates or updates insight entity.

INSERT INTO azure_extras.agrifood_farming.insights (
party_id,
model_id,
resource_type,
resource_id,
insight_id,
endpoint
)
SELECT 
'{{ party_id }}',
'{{ model_id }}',
'{{ resource_type }}',
'{{ resource_id }}',
'{{ insight_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: insights
props:
  - name: party_id
    value: "{{ party_id }}"
    description: Required parameter for the insights resource.
  - name: model_id
    value: "{{ model_id }}"
    description: Required parameter for the insights resource.
  - name: resource_type
    value: "{{ resource_type }}"
    description: Required parameter for the insights resource.
  - name: resource_id
    value: "{{ resource_id }}"
    description: Required parameter for the insights resource.
  - name: insight_id
    value: "{{ insight_id }}"
    description: Required parameter for the insights resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the insights resource.

REPLACE examples

create_or_update

Creates or updates insight entity.

REPLACE azure_extras.agrifood_farming.insights
SET 
-- No updatable properties
WHERE 
party_id = '{{ party_id }}' --required
AND model_id = '{{ model_id }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_id = '{{ resource_id }}' --required
AND insight_id = '{{ insight_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Deletes a specified insight resource.

DELETE FROM azure_extras.agrifood_farming.insights
WHERE party_id = '{{ party_id }}' --required
AND model_id = '{{ model_id }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_id = '{{ resource_id }}' --required
AND insight_id = '{{ insight_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Gets a specified insight resource under a particular party.

EXEC azure_extras.agrifood_farming.insights.get_raw 
@party_id='{{ party_id }}' --required, 
@model_id='{{ model_id }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_id='{{ resource_id }}' --required, 
@insight_id='{{ insight_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_by_party_id_model_id_and_resource

Returns a paginated list of insight resources.

EXEC azure_extras.agrifood_farming.insights.list_by_party_id_model_id_and_resource 
@party_id='{{ party_id }}' --required, 
@model_id='{{ model_id }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_id='{{ resource_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minInsightStartDateTime='{{ minInsightStartDateTime }}', 
@maxInsightStartDateTime='{{ maxInsightStartDateTime }}', 
@minInsightEndDateTime='{{ minInsightEndDateTime }}', 
@maxInsightEndDateTime='{{ maxInsightEndDateTime }}', 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

get_cascade_delete_job_details

Get a cascade delete job for specified insight.

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

create_cascade_delete_job

Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.

EXEC azure_extras.agrifood_farming.insights.create_cascade_delete_job 
@job_id='{{ job_id }}' --required, 
@partyId='{{ partyId }}' --required, 
@modelId='{{ modelId }}' --required, 
@resourceType='{{ resourceType }}' --required, 
@resourceId='{{ resourceId }}' --required, 
@insightId='{{ insightId }}' --required, 
@endpoint='{{ endpoint }}' --required
;