Production

Jobs

Explore the data types and operations available in Jobs.

250 operations

getOperationProductQuery

Read a durable operation output in the current tenant; requires operation read permission

getOptimizationRunQuery

Get an optimization run by ID. Requires optimizationRun:read permission.

getProductionCellQuery

Fetch a single production cell by id, scoped to the caller's tenant. Null when no such production cell exists. Requires productionCell:read permission.

getProductionPlanQuery

A single production plan with all of its planned operations and edges. Null when no such plan exists in the caller's tenant. Requires productionPlan:read permission.

getProductionReportQuery

Fetch a production report by ID. Requires productionReport:read.

getScheduleScenarioQuery

Fetch a single schedule scenario by id, or null when it does not exist. Requires scheduleScenario:read permission.

getShiftDefinitionQuery

Fetch a single shift definition by id, or null when no definition with that id exists in the caller's tenant. Requires shiftDefinition:read permission.

getTaskQuery

Fetch a task by ID. Requires task:read permission, except for one's own task (assigned to or claimed by the caller, or unclaimed on one of their teams), which any signed-in user can read.

getTaskEventsQuery

Fetch the audit trail for a task, paginated. Requires task:read permission.

getWorkCenterQuery

Fetch a single work center by id, scoped to the caller's tenant. Null when no such work center exists. Requires workCenter:read permission.

getWorkCenterByQuery

Fetch a work center by external ID. Requires workCenter:read permission.

getWorkCenterCapabilityQuery

One capability assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.

getWorkCenterDeviceQuery

One device binding by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.

getWorkCenterShiftProfileQuery

One shift profile assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

inferOperationsMutation

Infer the required production operations for a component. Provide either componentId or spec. When imposing config is provided, returns full production-grade DAG.

issueStockToProductionMutation

Issue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.

jobCostingSummaryQuery

Get a costing summary for a job including material and operation costs. Requires job:read.

listBatchComponentsQuery

List BatchComponents with bounded pagination

listBatchContributionsQuery

List BatchContributions with bounded pagination

listBatchesQuery

List Batches with bounded pagination

listCapabilitiesQuery

List the capabilities visible to the caller's tenant — the tenant's own capabilities plus any non-tenant-scoped ones. Requires capability:list permission.

listComponentGroupsQuery

List component sections, optionally scoped to a job. Requires componentGroup:list permission.

listComponentsQuery

List components with pagination and filtering. Requires component:list permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listJobGroupsQuery

List job groups with pagination. Requires jobGroup:list permission.

listJobsQuery

List jobs with pagination and filtering. Requires job:list permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listMilestonesQuery

List milestones with pagination and filtering. Requires milestone:list permission.

listOperationCompletionsQuery

List operation completion records with pagination. Requires operation:list permission.

listOperationEdgesQuery

List every operation dependency edge of a job, ordered by `sortOrder` ascending, with pagination. Returns an empty connection for a job with no edges. Requires operation:read permission.

listOperationItemEdgesQuery

List item-level dependency edges, with pagination. Filter by job and optionally by source/target operation. Requires operation:read permission.

listOperationItemsQuery

List operation items for an operation, sorted by sortOrder, with pagination. Requires operation:read permission.

listOperationsQuery

List operations with pagination and filtering. Requires operation:list permission.

listOptimizationRunsQuery

List optimization runs for a scenario, paginated. Requires optimizationRun:list permission.

listProductionCellsQuery

List the tenant's production cells as a paginated connection, with optional filtering and sorting. Requires productionCell:list permission.

listProductionPlansQuery

Production plans of a job, newest version first, paginated. Plan headers only — no planned operations or edges. Requires productionPlan:read permission.

listProductionReportsQuery

List production reports for the tenant, paginated. Requires productionReport:list.

listScheduleAllocationsQuery

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

listScheduleScenariosQuery

List the caller's tenant's schedule scenarios as a keyset-paginated connection. Requires scheduleScenario:list permission.

listShiftDefinitionsQuery

List the current tenant's shift definitions as a connection. Requires shiftDefinition:list permission.

listTasksQuery

List all tasks with pagination. Requires task:list permission.

listWorkCenterCapabilitiesQuery

All capability assignments for one work center in the caller's tenant, returned in a single unpaginated page. Requires workCenter:read permission.

listWorkCenterDevicesQuery

List the controller devices bound to a work center, preferred first. Requires workCenter:read.

listWorkCentersQuery

List the tenant's work centers as a paginated connection, with optional filtering and sorting. Requires workCenter:list permission.