TaskActivity API

Task Activity API

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

Quick Reference

Method	Description
bulkCreate	Bulk create activities
create	Create a new task activity
createPrestart	Create a prestart activity
delete	Delete a task activity
deleteOlder	Delete older activities (cleanup)
get	Get a specific task activity
getByStatus	Get activities by status
getByThread	Get activities by thread ID
getByType	Get activities by type
getDetailsWithActivities	Get task details with activities
getRecent	Get recent activities
getStatistics	Get activity statistics overview
list	List all task activities
update	Update a task activity

Methods

---

bulkCreate

client.taskActivity.bulkCreate(data: CreateTaskActivityRequest[]): Promise<TaskActivity[]>

Bulk create activities

Parameter	Type	Required	Description
data	CreateTaskActivityRequest[]	Yes

Returns: Promise<TaskActivity[]>

Full reference →

---

create

client.taskActivity.create(data: CreateTaskActivityRequest): Promise<TaskActivity>

Create a new task activity

Parameter	Type	Required	Description
data	CreateTaskActivityRequest	Yes

Returns: Promise<TaskActivity>

Full reference →

---

createPrestart

client.taskActivity.createPrestart(data: CreatePrestartActivityRequest): Promise<TaskActivity>

Create a prestart activity

Parameter	Type	Required	Description
data	CreatePrestartActivityRequest	Yes

Returns: Promise<TaskActivity>

Full reference →

---

delete

client.taskActivity.delete(taskId: string): Promise<void>

Delete a task activity

Parameter	Type	Required	Description
taskId	string	Yes

Returns: Promise<void>

Full reference →

---

deleteOlder

client.taskActivity.deleteOlder(params?: TaskActivityCleanupParams): Promise<void>

Delete older activities (cleanup)

Parameter	Type	Required	Description
params	TaskActivityCleanupParams	No

Returns: Promise<void>

Full reference →

---

get

client.taskActivity.get(taskId: string): Promise<TaskActivity>

Get a specific task activity

Parameter	Type	Required	Description
taskId	string	Yes

Returns: Promise<TaskActivity>

Full reference →

---

getByStatus

client.taskActivity.getByStatus(status: string): Promise<TaskActivity[]>

Get activities by status

Parameter	Type	Required	Description
status	string	Yes

Returns: Promise<TaskActivity[]>

Full reference →

---

getByThread

client.taskActivity.getByThread(threadId: string): Promise<TaskActivity[]>

Get activities by thread ID

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<TaskActivity[]>

Full reference →

---

getByType

client.taskActivity.getByType(type: string): Promise<TaskActivity[]>

Get activities by type

Parameter	Type	Required	Description
type	string	Yes

Returns: Promise<TaskActivity[]>

Full reference →

---

getDetailsWithActivities

client.taskActivity.getDetailsWithActivities(taskId: string): Promise<TaskDetailsWithActivities>

Get task details with activities

Parameter	Type	Required	Description
taskId	string	Yes

Returns: Promise<TaskDetailsWithActivities>

Full reference →

---

getRecent

client.taskActivity.getRecent(): Promise<TaskActivity[]>

Get recent activities

No parameters.

Returns: Promise<TaskActivity[]>

Full reference →

---

getStatistics

client.taskActivity.getStatistics(): Promise<TaskActivityStatistics>

Get activity statistics overview

No parameters.

Returns: Promise<TaskActivityStatistics>

Full reference →

---

list

client.taskActivity.list(params?: TaskActivityListParams): Promise<TaskActivity[]>

List all task activities

Parameter	Type	Required	Description
params	TaskActivityListParams	No

Returns: Promise<TaskActivity[]>

Full reference →

---

update

client.taskActivity.update(taskId: string, data: UpdateTaskActivityRequest): Promise<TaskActivity>

Update a task activity

Parameter	Type	Required	Description
taskId	string	Yes
data	UpdateTaskActivityRequest	Yes

Returns: Promise<TaskActivity>

Full reference →