โ† API reference
Mutation / jobs

deleteScheduleScenario

Permanently delete a schedule scenario. Requires scheduleScenario:delete permission.

Arguments

TypeID of the schedule scenario to delete (prefix "sch"). An id outside the caller's tenant is reported as not found.

Returns DeleteScheduleScenarioPayload!

Scalar fields at a glance

successBoolean!
โ†— View the complete DeleteScheduleScenarioPayload type

Explore in a view

Production Floor
View exact SDL
"""
Permanently delete a schedule scenario. Requires scheduleScenario:delete permission.
"""
deleteScheduleScenario(
  """
  TypeID of the schedule scenario to delete (prefix "sch"). An id outside the caller's tenant is reported as not found.
  """
  id: ScheduleScenarioID!
): DeleteScheduleScenarioPayload! @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.