attachments

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

Overview

Name	attachments
Type	Resource
Id	azure_extras.agrifood_farming.attachments

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
delete	delete	party_id, attachment_id, endpoint		Deletes a specified attachment resource under a particular party.
get_raw	exec	party_id, attachment_id, endpoint		Gets a specified attachment resource under a particular party.
list_by_party_id	exec	party_id, endpoint	minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of attachment resources under a particular party.
download	exec	party_id, attachment_id, endpoint		Downloads and returns attachment as response for the given input filePath.

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
attachment_id	string	Id of attachment to be downloaded. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
party_id	string	Id of the associated party. Required.
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.
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.
skipToken	string	Skip token for getting next set of results. Default value is None.

DELETE examples

delete

Deletes a specified attachment resource under a particular party.

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

Lifecycle Methods

get_raw

Gets a specified attachment resource under a particular party.

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

list_by_party_id

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

EXEC azure_extras.agrifood_farming.attachments.list_by_party_id 
@party_id='{{ party_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

download

Downloads and returns attachment as response for the given input filePath.

EXEC azure_extras.agrifood_farming.attachments.download 
@party_id='{{ party_id }}' --required, 
@attachment_id='{{ attachment_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;