Tasks Module API

API reference for task workflow endpoints.

BriteCore V2 tasks API endpoint wrappers.

britecore_sdk.api.api_calls.v2.tasks.create_task(due_date=None, mandatory=None, description=None, orkes_task_id=None, priority=None, assignee_id=None, policy_id=None, claim_id=None, task_definition_id=None, **kwargs)[source]

Create Task.

POST /api/v2/tasks/create_task

Parameters:

due_date (str | None)
mandatory (bool | None)
description (str | None)
orkes_task_id (str | None)
priority (str | None)
assignee_id (str | None)
policy_id (str | None)
claim_id (str | None)
task_definition_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.create_task_definition(name=None, scope=None, **kwargs)[source]

Create Task Definition.

POST /api/v2/tasks/create_task_definition

Parameters:

name (Any | None)
scope (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.modify_task(status=None, due_date=None, mandatory=None, description=None, priority=None, assignee_id=None, id=None, **kwargs)[source]

Modify Task.

POST /api/v2/tasks/modify_task

Parameters:

status (str | None)
due_date (str | None)
mandatory (bool | None)
description (str | None)
priority (str | None)
assignee_id (str | None)
id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_filter_options(**kwargs)[source]

Retrieve Filter Options.

POST /api/v2/tasks/retrieve_filter_options

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_task(id=None, **kwargs)[source]

Retrieve Task.

POST /api/v2/tasks/retrieve_task

Parameters:

id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_task_definition(id=None, **kwargs)[source]

Retrieve Task Definition.

POST /api/v2/tasks/retrieve_task_definition

Parameters:

id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_task_definitions(**kwargs)[source]

Retrieve Task Definitions.

POST /api/v2/tasks/retrieve_task_definitions

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_task_history(id=None, **kwargs)[source]

Retrieve Task History.

POST /api/v2/tasks/retrieve_task_history

Parameters:

id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.tasks.retrieve_tasks(query=None, pagination=None, sorting=None, filters=None, **kwargs)[source]

Retrieve Tasks.

POST /api/v2/tasks/retrieve_tasks

Parameters:

query (str | None)
pagination (dict[str, Any] | None)
sorting (dict[str, Any] | None)
filters (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any