Saved Search Job

Saved Search Job Configuration

SavedSearchConfig

Defines a Mitto Saved Search Job
type	object
properties
title	Title
	See Mitto Job documentation
	type	string
name	Name
	See Mitto Job documentation
	type	string
type	Type
	IO job only
	type	string
	pattern	^io$
input	Saved Search Input
	Input
	allOf		#/definitions/SavedSearchInput
steps	Steps
	See Mitto Job documentation
	type	array
	items
		type	object
store	Store
	See Mitto Job documentation
	type	object
output	Output
	See Mitto Job documentation
	type	object
definitions
Credentials	Credentials
	Defines the credentials used to invoke the RESTlet and Saved Search. NOTE: Most differ from the credentials used elsewhere in the connector.
	type	object
	properties
	account	Account
		The NetSuite account to be used. Example: "TSTDRV1762243"
		type	string
	email	Email
		The email address associated with the account. Example: "zed.zuar@zuar.com"
		type	string
	password	Password
		The password associated with the account/email. Example: "vpDv2yDqQL3Gch"
		type	string
	role	Role
		The internal id of the Mitto User Role. Example: 1078
		type	integer
		minimum	1
	url	Url
		If present, the value is used in place of the URL generated by the connector. If the URL does not begin with the account number and end with restlet.nl, it is likely to be incorrect. Example: "https://TSTDRV1762243.restlets.api.netsuite.com/app/site/hosting/restlet.nl"
		type	string
Restlet	Restlet
	Defines the RESTlet to be called to invoke the SavedSearch.
	type	object
	properties
	script	Script
		Script id of the NetSuite RESTlet that will be called to invoke the saved search. This is the argument to the script parameter of the EXTERNAL_URL found on the Script Deployment page for the Mitto Saved Search RESTlet. Example: If the EXTERNAL URL is https://tstdrv1762243.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=641&deploy=1 the value for script should be 641.
		type	integer
		minimum	1
	deploy	Deploy
		Deployt id of the NetSuite RESTlet that will be called to invoke the saved search. This is the argument to the deploy parameter of the EXTERNAL_URL found on the Script Deployment page for the Mitto Saved Search RESTlet. Example: If the EXTERNAL URL is https://tstdrv1762243.restlets.api.netsuite.com/app/site/hosting/restlet.nl?script=641&deploy=1 the value for deploy should be 1.
		type	integer
		minimum	1
SavedSearch	SavedSearch
	Parameters passed to the saved search RESTlet.
	type	object
	properties
	id	Id
		The id of the saved search that will be called by the RESTlet. This is the value of ID on the Saved Search page for the desired search. Example: "customsearch766".
		type	string
	record_type	Record_Type
		The record type associated with the saved search to be called by the RESTlet. Example: "Custom".
		type	string
	lower_bound	Lower_Bound
		When executed, the saved search will be filtered so as to return only records with internal ids larger than this value.
		type	integer
		default	1
	page_size	Page_Size
		Number of records to include in one page of data.
		type	integer
		default	1000
	last_modified_date	Last_Modified_Date
		If last_modified_date is None, the connector’s use of a last modified date for upserts is controlled solely by the steps in a job’s configuration. When configured for upsert, the date_time_format is used when formatting datetime objects representing the last modified date. If last_modified_date is provided, it will be used as the last modified date when invoking the saved search, overriding any value from the store. Example: "1/1/2019 04:27 pm" NOTE: The format of this string must exactly match the date and time preference set in the NetSuite account.
		type	string
	date_time_format	Date_Time_Format
		This value is used as a format specification when formatting datetime objects representing the last modified date (e.g., when formatting the last_modified_date from the store). date_time_format is eventually used as an argument to datetime.strftime(). All strftime formatting options can be used with the exception of %m and %d. NetSuite does not support leading zeros for month and day. strftime only supports leading zeros for month and day. Because of this, the connector supports specifying non-leading-zero month and day via {month} and {day}. These should be used instead of %m and %d, respectively. **NOTE:* The format specification must exactly match the format set in the account’s NetSuite preferences.
		type	string
		default	{month}/{day}/%Y %I:%M %p
	max_pages	Max_Pages
		At most max_pages of records will be processed by the connector. Intended for use in debugging and testing.
		type	integer
		default	Infinity
SavedSearchInput	SavedSearchInput
	Defines Saved Search Input
	type	object
	properties
	credentials	Credentials
		Credentials
		allOf		#/definitions/Credentials
	restlet	Restlet
		Restlet
		allOf		#/definitions/Restlet
	saved_search	SavedSearch
		Saved_Search
		allOf		#/definitions/SavedSearch
	use	Use
		Inputter to be used to get data.
		type	string
		pattern	^netsuite.io#NetsuiteSavedSearchInput$