requeue_tasks

imerit_ango.sdk.SDK.

requeue_tasks(project_id, to_stage_id, filters, options)

Move tasks from one stage to another within your project, with control over which tasks are requeued and how they are processed.

Parameters

• project_id: string

  • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

• to_stage_id: string

  • The identifier of the target stage to which the tasks will be requeued. This stage must exist within the specified project.

• filters: dict, default None

  • Criteria to select which tasks should be requeued. If no filters are provided, all tasks will be requeued.

    • taskIds: List[str]

      • List of task IDs

    • externalIds: List[str]

      • List of external IDs

    • assetIds: List[str]

      • List of asset IDs

    • batches: List[str]

      • List of batch IDs

    • fromStageIds: List[str]

      • List of stage IDs from which tasks should be requeued

• options: dict, default None

  • Settings that customize how tasks are requeued. Supported options:

    • removeAnnotations: bool

      • Remove existing annotations before requeuing.

    • removeAssignee: bool

      • Unassign the current assignee from the task.

    • removeStageHistory: bool

      • Clear the task’s stage history.

Setting removeAnnotations: true permanently deletes all annotations on the affected tasks. This cannot be undone. Ensure you have exported or backed up annotations before proceeding.

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

The target stage (to_stage_id) must already exist within the specified project. If needed, update the workflow using the update_workflow_stages function.

It is not allowed to requeue tasks into the Consensus and Logic stages.

How to verify in Ango Hub?

After successfully executing the requeue_tasks function, you can validate the changes directly in Ango Hub.

Navigate to: Projects → [Your Project] → Tasks

• Filter the relevant tasks as needed.

• Confirm that the tasks have been forwarded to the correct workflow stages.

Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.

Example

Requeue all the tasks to the specified stage from other stages

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

stage_id = '<YOUR STAGE ID>'
sdk_response = ango_sdk.requeue_tasks(project_id=project_id, to_stage_id=stage_id)

curl

Requeue specific tasks only

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

stage_id = '<YOUR STAGE ID>'
external_id_list = ["<EXTERNAL ID 1>", "<EXTERNAL ID 2>", "<EXTERNAL ID 3>"]

sdk_response = ango_sdk.requeue_tasks(
    project_id=project_id,
    to_stage_id=stage_id,
    filters={"externalIds": external_id_list}
)

curl

Requeue tasks with configurable preferences

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

stage_id = '<YOUR STAGE ID>'

sdk_response = ango_sdk.requeue_tasks(
    project_id=project_id,
    to_stage_id=stage_id,
    options={
        "removeAnnotations":True, 
        "removeAssignee": True, 
        "removeStageHistory": True
    }
)

curl

See also

get_project