Creates a schedule for a workflow definition.
Tip
Number of schedules, and the minimum duration for a given schedule is defined at Workflow System Limits.
Input parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| Object | Yes | The account scope. Contains |
| Object | Yes | The workflow definition to schedule. Contains |
| String | Yes | Cron expression defining the schedule frequency (e.g., |
| String | Yes | Timezone for the schedule (e.g., |
| Object | No | Optional configuration. Contains |
logLevel option
The logLevel option controls the amount of logging information generated during workflow execution.
Available values:
NONE(default): No log outputs will be generated.INFO: Outputs step level information.DEBUG: Adds attribute to the step started logs with all the action step inputs.
Sample request
Use the Query Builder to create and edit a workflow. See NerdGraph API explorer.
mutation { workflowAutomationCreateSchedule( scope: { id: "12345678", type: ACCOUNT } definition: { name: "healthyHeartbeat", version: 1 } cronExpression: "0 0 * * *" timezone: "Asia/Kolkata" options: { logLevel: DEBUG } ) { scheduleId }}Sample response
The mutation returns:
{ "data": { "workflowAutomationCreateSchedule": null }, "extensions": { "nrOnly": { "_docs": "https://pages.datanerd.us/unified-api/nerdgraph-documentation/querying/debugging/", "httpRequestLog": [ { "body": "{\"query\":\"mutation {\\n createSchedule(scope: { id: \\\"12345678\\\", type: ACCOUNT }, definition: { name: \\\"healthyHeartbeat\\\", version: 1 }, cronExpression: \\\"0 0 * * *\\\", timezone: \\\"Asia/Kolkata\\\", options: { logLevel: DEBUG }) {\\n __typename\\n scheduleId\\n }\\n}\",\"extensions\":{\"authorizedAccountIds\":{\"error\":\"Failed to fetch Authorized Account Ids.\",\"value\":null,\"success\":false}},\"variables\":{}}", "curl": "echo eyJxdWVyeSI6Im11dGF0aW9uIHtcbiAgY3JlYXRlU2NoZWR1bGUoc2NvcGU6IHsgaWQ6IFwiMTIzNDU2NzhcIiwgdHlwZTogQUNDT1VOVCB9LCBkZWZpbml0aW9uOiB7IG5hbWU6IFwiaGVhbHRoeUhlYXJ0YmVhdFwiLCB2ZXJzaW9uOiAxIH0sIGNyb25FeHByZXNzaW9uOiBcIjAgMCAqICogKlwiLCB0aW1lem9uZTogXCJBc2lhL0tvbGthdGFcIiwgb3B0aW9uczogeyBsb2dMZXZlbDogREVCVUcgfSkge1xuICAgIF9fdHlwZW5hbWVcbiAgICBzY2hlZHVsZUlkXG4gIH1cbn0iLCJleHRlbnNpb25zIjp7ImF1dGhvcml6ZWRBY2NvdW50SWRzIjp7ImVycm9yIjoiRmFpbGVkIHRvIGZldGNoIEF1dGhvcml6ZWQgQWNjb3VudCBJZHMuIiwidmFsdWUiOm51bGwsInN1Y2Nlc3MiOmZhbHNlfX0sInZhcmlhYmxlcyI6e319 | base64 -D | curl -i -X POST 'https://ng-workflow-service.service.nr-ops.net/graphql' -H 'Content-Type: application/json' -H 'X-Login-Context: access-token:RGk5VGJZZERyRklVdlJBN0pzZkJXRWpmdHdFVkVIU1AwSmErRzJTTnJaVXp3RUdacUpRWTV5SHRjM3JjU1ExNGhOQjNCdkJ2eE1hR3Z4WThvWTdmL0JyZ0xPUC9WSjh0U0d2QWRmNWlKM3BDM1JoYUtvN1h4YTBMZVVMZ3FPV21xWk9OSFZCZjdnVFB4U0JaSjcvSEVRbG85S0E1a2ZaMWIzVmJkb04rcThRbkdURXBNQU9NSFltU0c1TlBzK2VuRk8ySXYrWlBqOThNWG1NZTViM0JzdStlbm5mTjhlSFkraUZSNkNieXdjTmM0Q3JVZGdKdTBKaWV3MzZlOWVsZzdVcjNQWWVFU25NQWE5WG1GT0p4Q0NaMkRWTFJrL0UwUjhaVXh1aEJVS2xWMmZFTlpzRnhiZ0pSdHM5dTFJRyt4SjdVV3VkZjVFbmFyeS9kRUFCb0ZSTUl1bGUzTjQ5MlFFRWVlTXpGcjJLc056dFJKV2htWGcxRjZVWUlmUG5TSExaNlNsd2MxcTVWSTZiYWgxTzFuUTEwaHB4QmFKYWRkVzJobGJzK29sRjJUYW1LWnVLTTNHTHBEQ3B3aDhiNWNxV1ROcVB6dkc1Q0ZwSHVrWGw5ditHVlBzaVhjUjc1K3pMK3dNWnh5ZVdBUy96MEZJNklqdW5vdkRFRm0yRVQrdFFsczErS0NSMzZmblpQVnlRYTdpUENYcWR6cGRncHl1dnJ2UG1MTlZvY0cwZXNzVlFybmpVL3VMdlQ5Nk9HMmJkM2loeUdWRkdKd1dTWnMrZ21SUVpGTVVGbE5kVWdxUUUzT3JkaHEzdktoL3M4MExBODJ6YzhYNkNRNzF2MytyZWNtbEdleUZEUXJFN01VRFJPdDFvbUdVRzZGRG0ydVlma3lTT1dwY3M9' -H 'newrelic-originating-region-id: 1' -d @-" } ] } }, "errors": [ { "message": "User does not have required capabilities", "path": [ "workflowAutomationCreateSchedule" ], "extensions": { "classification": "DataFetchingException", "errorClass": "ACCESS_DENIED", "nrOnly": { "internalMessage": "User does not have required capabilities", "owningTeam": "#help-nomad" } }, "locations": [ { "line": 2, "column": 5 } ] } ]}