Create scheduled run - Veryfront

createScheduledRun(projectReference: String!, scheduleId: ID!, runName: String, idempotencyKey: String): ScheduledRunCreateResult!

The run kind follows the schedule target. Requires project.runs.write.

Arguments

Argument	Type	Required	Description
`projectReference`	`String!`	Yes
`scheduleId`	`ID!`	Yes
`runName`	`String`	No
`idempotencyKey`	`String`	No	A retry with the same key returns the same run.

Response

Returns ScheduledRunCreateResult!. Open the type for its fields and nested types.

Field	Type
`runId`	`ID!`
`runExecutionId`	`ID!`
`scheduleId`	`ID!`

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation CreateScheduledRun($projectReference: String!, $scheduleId: ID!, $runName: String, $idempotencyKey: String) {
  createScheduledRun(projectReference: $projectReference, scheduleId: $scheduleId, runName: $runName, idempotencyKey: $idempotencyKey) {
    runId
    runExecutionId
    scheduleId
  }
}

{
  "projectReference": "example",
  "scheduleId": "00000000-0000-4000-8000-000000000001"
}