Production
Jobs
Explore the data types and operations available in Jobs.
250 operations
Lists the shift profiles of one work center within the caller's tenant, ordered by validFrom ascending. Requires workCenter:read.
listWorkCenterStatusEventsQueryList status transition events for a work center
lockScheduleScenarioMutationFreeze a schedule scenario by stamping lockedAt. Scenario edits and allocation writes are rejected until unlockScheduleScenario clears the lock. Fails if it is already locked. Requires scheduleScenario:write permission.
logTaskTimeMutationLog time spent on a task by hand. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
myRunningTimerQueryThe caller's running timer, on any task, or null. Any signed-in user; no permission needed: the timer is their own.
myTaskCountsQueryCount the caller's open tasks by bucket, overdue and personal. Any signed-in user; no permission needed.
myTasksQueryList the caller's own tasks: assigned to or claimed by them, or unclaimed on one of their teams. Any signed-in user; no permission needed.
myTimeEntriesQueryThe caller's own time entries on any task, newest first, voided ones included. Readable even once the task is no longer theirs to read. Any signed-in user; no permission needed: the entries are their own.
pingQueryHealth check endpoint
previewPlannedOperationAuditQueryPreview waste, yield, duration and constant-rate pace for a stored planned operation. Optionally assess its stored plan's item statuses and downstream dependencies, plus booked timing in an explicit schedule scenario. No writes or audit events. Inspect coverage and limitations; this is not a delivery-date guarantee.
producibilityIntelligenceQueryCombined producibility intelligence: rule-based feasibility, ML predictions, risk analysis, and similar historical jobs in a single query. All ML fields degrade to null when no models are trained.
productionBoardQueryFetch active production jobs with components, operations, and order context. Requires job:list.
productionDayQueryStatus history, published plan and shifts for up to 100 active work centers of one cell over a window of at most 36 hours. Schedule and shift permissions are checked independently.
productionOutputBalanceQueryDerive accepted output quantities after corrections without inventory reads. Use these quantities instead of summing unadjusted receipts.
productionSnapshotQueryRead production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.
projectWorkCenterTwinQueryProject one work centre over the next N hours: per-shift bands of expected busy and lost minutes, a down-probability strip and per-allocation ends, from the machine's behaviour profile and its published plan. Synchronous; persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES, 336 hours and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
recordWorkCenterStatusEventMutationRecord a work centre's status. A status is held until it changes: when it equals the current status, the current event's lastSeenAt is refreshed and that event is returned; otherwise a new event is appended. A timestamp before the current event's is recorded as history. Requires workCenter:write permission.
refreshWorkCenterBehaviorProfileMutationRebuild a work centre's behaviour profile from its history now, writing a new version. Requires workCenterBehaviorProfile:write permission.
reindexEntityNotesMutationQueue bounded recoverable indexing work using the current model
releaseTaskMutationRelease a claimed team task back to its team: clears the claim and returns it to CREATED. The claimer or a task:write holder.
removeJobFromJobGroupMutationRemove a job from its group (job survives). Requires jobGroup:write permission.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
replaceJobAssemblyMutationAtomically replace or clear a job assembly graph. Validates job membership, cycles, containers and sibling precedence. Requires job:write, job:read and component:read. Inferred edges are saved only when explicitly supplied by the caller.
resolveAssemblyQueryResolve supplied assembly data and optionally return an SVG using generic hints and vertical heuristics. Requires job:read. No persistence.
resolveJobAssemblyQueryRead a tenant-scoped job assembly, report uncertainties and optionally generate its SVG. Requires job:read and component:read. Does not persist inference.
scenarioSimulationProgressSubscriptionStream progress events for a simulation run. The first event reflects the persisted state, so a subscriber joining after the run ended receives its terminal status and the stream finishes. Requires scenarioSimulationRun:read permission.
scenarioSimulationRunQueryA simulation run by id, or null when none exists. Requires scenarioSimulationRun:read permission.
scenarioSimulationRunsQuerySimulation runs, paginated. Requires scenarioSimulationRun:list permission.
scheduleOptimizationProgressSubscriptionStream real-time progress events for a schedule optimization run.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchEntityNotesQueryRead operational notes with current target permissions
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setOperationProducerMutationDelegate job work to batch component work, or clear an unexecuted assignment.
simulateScheduleScenarioMutationQueue a Monte-Carlo replay of a scenario's allocations against the work centres' learned behaviour profiles. Returns immediately with a QUEUED run; stream progress with scenarioSimulationProgress or poll scenarioSimulationRun. Requires scenarioSimulationRun:execute.
simulateWorkloadQuerySynchronous what-if over hypothetical work, optionally overlaid on a base scenario's allocations. Persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
startMilestoneMutationMark a milestone as started now. Does not change its completion. Requires milestone:write permission.
startScheduleOptimizationMutationStart a background schedule optimization. Returns immediately with the run ID. Use scheduleOptimizationProgress subscription to stream progress.
startTaskTimerMutationStart a timer on an open task. A person runs one timer at a time: a timer running on another task is stopped first, in the same write. Starting it again on the same task returns the running timer. Two starts racing leave one timer; the other gets WRITE_CONFLICT. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
statusEventsSubscriptionSubscribe to committed status transitions. Requires read permission on each requested entity type.
stopTaskTimerMutationStop the caller's running timer on a task, recording the span between start and now. Only the timer's owner.
topicExamplesQueryFetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
transitionOperationMutationTransition operation to a new status. Requires operation:execute permission.
transitionOperationItemMutationTransition operation item to a new status. Requires operation:execute permission.
transitionTaskMutationTransition a task's status. Requires task:transition permission, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
twinBehaviorAttributesQueryThe behaviour attributes the active vertical declares, highest priority first, so a custom app can render hypothetical inputs from the schema. Requires workCenterBehaviorProfile:read permission.
uncancelMilestoneMutationClear the cancellation state of a milestone. Requires milestone:write permission.
uncompleteMilestoneMutationMark a milestone as not completed. Requires milestone:write permission.
unlockScheduleScenarioMutationClear lockedAt so the scenario can be edited and published again. Fails if it is not locked. Requires scheduleScenario:write permission.
unstartMilestoneMutationClear a milestone's start. Requires milestone:write permission.