requeue_tasks

imerit_ango.sdk.SDK.

requeue_tasks(project_id, to_stage_id, filters, options)

Allows you to requeue tasks from one stage to another within a project. The function supports filtering tasks and applying optional settings to control how the requeue operation is handled.

Parameters

  • project_id: string

  • 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

    • A dictionary of filters to specify the tasks to requeue.

      • taskIds: List[str]

      • externalIds: List[str]

      • assetIds: List[str]

      • fromStageIds: List[str]

  • options: dict, default None

    • A dictionary of optional settings to customize the requeue operation. Supported options:

      • removeAnnotations: bool

      • removeAssignee: bool

      • removeStageHistory: bool

Returns:

  • output: dict

    • A dictionary containing the result of the operation.

Example

Requeue all the tasks to the specified stage from other stages

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)

Requeue specific tasks only

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})

Requeue tasks with configurable preferences

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})

See also

get_project

Last updated