← API reference
Query / jobs

listScheduleAllocations

List the allocations of one schedule scenario, ordered by start time by default. Requires scheduleScenario:read permission.

Arguments

scheduleScenarioIdScheduleScenarioID!

TypeID of the schedule scenario to list allocations from ("sch_01K…"). Required — allocations are never listed across scenarios.

Optional filters narrowing the allocations within the scenario.

Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to startAt descending.

firstInt

Forward pagination page size: how many allocations to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.

lastInt

Backward pagination page size: how many allocations to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.

afterString

Cursor to page forward from: only allocations following it in the requested sort order are returned. Cannot be combined with before.

beforeString

Cursor to page backward from: only allocations preceding it in the requested sort order are returned. Cannot be combined with after.

Returns ScheduleAllocationConnection!

Scalar fields at a glance

totalCountInt
↗ View the complete ScheduleAllocationConnection type

Explore in a view

Production Floor
View exact SDL
"""
List the allocations of one schedule scenario, ordered by start time by default. Requires scheduleScenario:read permission.
"""
listScheduleAllocations(
  """
  TypeID of the schedule scenario to list allocations from ("sch_01K…"). Required — allocations are never listed across scenarios.
  """
  scheduleScenarioId: ScheduleScenarioID!
  """Optional filters narrowing the allocations within the scenario."""
  filter: ScheduleAllocationFilterInput
  """
  Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to startAt descending.
  """
  sort: [ScheduleAllocationSortInput!]
  """
  Forward pagination page size: how many allocations to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
  """
  first: Int
  """
  Backward pagination page size: how many allocations to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
  """
  last: Int
  """
  Cursor to page forward from: only allocations following it in the requested sort order are returned. Cannot be combined with before.
  """
  after: String
  """
  Cursor to page backward from: only allocations preceding it in the requested sort order are returned. Cannot be combined with after.
  """
  before: String
): ScheduleAllocationConnection! @topic(names: ["jobs"])

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