The createScheduledSearchFromPackageTemplate() GraphQL mutation field may be used to create a scheduled search from a package scheduled search template.

This mutation is deprecated. Use instead GenerateScheduledSearchFromPackageTemplate().

For more information on scheduled searches, see the Scheduled Searches documentation page. You may also want to look at the Packages page for related information and at the Searching Data documentation page as it relates to saving queries.

Syntax

Below is the syntax for the createScheduledSearchFromPackageTemplate() mutation field:

graphql
createScheduledSearchFromPackageTemplate(
      searchDomainName: RepoOrViewName!
      packageId: VersionedPackageSpecifier!
      scheduledSearchTemplateName: string!
      scheduledSearchName: string!
   ): ScheduledSearch!

Given and Returned Datatypes

The given datatypes RepoOrViewName and VersionedPackageSpecifier are scalars. The returned datatype ScheduledSearch has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: ScheduledSearch

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
actions[string]yes List of unique identifiers for actions to fire on query result.
actionsV2[Action]yes List of actions to fire on query result. See Action.
allowedActions[AssetAction]yes The allowed asset actions. See AssetAction.
backfillLimitintegeryes User-defined limit, which caps the number of missed searches to backfill, e.g. in the event of a shutdown.
descriptionstring  A description of the scheduled search.
enabledbooleanyes Whether the scheduled search is enabled.
endstringyes The end of the relative time interval for the query.
idstringyes The unique identifier of the scheduled search.
isStarredbooleanyes Whether the calling user has 'starred' the scheduled search. This has been deprecated and is no longer in use and has no effect. It will be removed in version 1.213.
labels[string]yes The labels added to the scheduled search.
lastErrorstring  The last error encountered while running the search.
lastExecutedlong  Unix timestamp for end of search interval for last query execution.
lastScheduledSearchlong  The UNIX timestamp at which the last query result was processed. This is deprecated and replaced with lastExecuted and lastTriggered.
lastTriggeredlong  Unix timestamp for end of search interval for last query execution that triggered.
lastWarnings[string]yes The Last warnings encountered while running the scheduled search.
modifiedInfoModifiedInfoyes User or token used to modify the asset. See ModifiedInfo.
namestringyes The name of the scheduled search.
packagePackageInstallationyes The related package. See PackageInstallation.
packageIdVersionedPackageSpecifieryes The unique identifier for the related package. VersionedPackageSpecifier is a scalar.
queryOwnershipQueryOwnershipyes Ownership of the query run by this scheduled search. See QueryOwnership.
queryStringstringyes The LogScale query to execute.
runAsUserUseryes The unique identifier of the user as which the scheduled search is running. See User.
schedulestringyes The cron pattern describing the schedule to execute the query on.
startstringyes The start of the relative time interval for the query.
timeOfNextPlannedExecutionlong  The UNIX timestamp for next planned search.
timeZonestringyes Time zone of the schedule. Currently, this field only supports UTC offsets like 'UTC', 'UTC-01' or 'UTC+12:45'.
yamlTemplateyamlyes A template that can be used to recreate the scheduled search.