Skip to content

masterplan-optimizer-frontend


masterplan-optimizer-frontend / taskInstancesApi

Variable: taskInstancesApi

const taskInstancesApi: object

Defined in: src/lib/api.ts:1779

Client wrapper for task instance CRUD and optimisation result writes.

Type Declaration

bulkSetOptimised

bulkSetOptimised: (eventId, items) => Promise\<TaskInstance[]>

Write optimisation results to multiple task instances at once.

Parameters

eventId

number

items

object[]

Returns

Promise\<TaskInstance[]>

create

create: (data) => Promise\<TaskInstance>

Create a single task instance.

Parameters

data

TaskInstanceCreate

Returns

Promise\<TaskInstance>

createBulk

createBulk: (items) => Promise\<TaskInstance[]>

Create multiple task instances in one call.

Parameters

items

TaskInstanceCreate[]

Returns

Promise\<TaskInstance[]>

delete

delete: (id, eventId) => Promise\<void>

Delete a single task instance.

Parameters

id

number

eventId

number

Returns

Promise\<void>

deleteAll

deleteAll: (eventId) => Promise\<void>

Delete all task instances for an event.

Parameters

eventId

number

Returns

Promise\<void>

getAll

getAll: (eventId, date?) => Promise\<TaskInstance[]>

List all task instances for an event, optionally filtered by date.

Parameters

eventId

number

date?

string

Returns

Promise\<TaskInstance[]>

getById

getById: (id, eventId) => Promise\<TaskInstance>

Get a single task instance by ID.

Parameters

id

number

eventId

number

Returns

Promise\<TaskInstance>

restore

restore: (eventId) => Promise\<TaskInstance[]>

Restore task instances from Tasks table when instances were lost.

Parameters

eventId

number

Returns

Promise\<TaskInstance[]>

update

update: (id, eventId, data) => Promise\<TaskInstance>

Update a task instance (partial).

Parameters

id

number

eventId

number

data

TaskInstanceUpdate

Returns

Promise\<TaskInstance>