Skip to main content
Native tasks, targets and assignment metadata.

Target Objects

Target identity and scope, without labels, media or subset contents.

DataUnitTarget Objects

An entire data unit, including a data group.

DataUnitSliceTarget Objects

A named slice of one data unit; range contents are not embedded.

DatasetTarget Objects

A whole dataset, without a single data-unit identifier.

DataGroupSubsetTarget Objects

A named subset of a data group; member contents are not embedded.

DatasetSubsetTarget Objects

A named dataset subset; member contents are not embedded.

UnknownTarget Objects

An unfamiliar target type; specialized access may require an SDK upgrade.

Assignment Objects

Assignment snapshot; assigned_to and assigned_by are opaque user IDs, not emails.

Task Objects

Read-only snapshot of one visit to a stage, identified separately from its target. Actions leave this snapshot unchanged; use workflow.get_task() to refresh it. Sent mutations are not automatically retried. A lost response may leave the outcome uncertain; a stale-task error does not establish an earlier success.

ExternalTask Objects

A task at an External stage.

submit

Submit an entered External task through an outgoing pathway. Select by ID or exact, case-sensitive name, not both. Omit both only when the stage has one outgoing pathway. Requires project management access. Unavailable tasks raise StaleTaskError. Leaves this snapshot unchanged; sent requests are not automatically retried.

ManualTask Objects

A task supporting manual assignment and release.

assign

Assign this task to an eligible user by email. Non-managers may assign only to themselves. Leaves this snapshot unchanged; sent requests are not automatically retried.

release

Release this task’s current assignment without completing or moving it. Requires project management access and acts on the current assignment, not this snapshot’s holder. Releasing a valid unassigned task succeeds. Unavailable tasks raise StaleTaskError. Leaves this snapshot unchanged; sent requests are not automatically retried.

AnnotationTask Objects

A task at an Annotation stage.

submit

Submit an Annotation task through an outgoing pathway; save labels separately first. Select by ID or exact, case-sensitive name, not both. Omit both only when the stage has one outgoing pathway. Non-managers must hold the assignment and remain eligible to work at the stage. Comments require a DataUnitTarget. Backend pathway rules apply. Leaves this snapshot unchanged; sent requests are not automatically retried.

ReviewTask Objects

A task at a Review stage.

submit

Submit through an outgoing pathway without changing individual label decisions. Select by ID or exact, case-sensitive name, not both. Omit both only when the stage has one outgoing pathway. Non-managers must hold the assignment and remain eligible to work at the stage. Comments require a DataUnitTarget. Backend pathway rules apply. Leaves this snapshot unchanged; sent requests are not automatically retried.