Safety Net Blueprint — Client Reference: Workflow

Queues (5)

▶ listQueues() You can provide a client instance returned by `createClient()` instead of API ref → #

workflow.listQueues({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ createQueue() Create a queue API ref → #

workflow.createQueue({ body: { ... } })

Parameters

body

object

body

required

▶ deleteQueue(queueId) Delete a queue API ref → #

workflow.deleteQueue({ path: { queueId: string } })

Parameters

queueId

string

path

required

▶ getQueue(queueId) Get a queue API ref → #

workflow.getQueue({ path: { queueId: string } })

Parameters

queueId

string

path

required

▶ updateQueue(queueId) Update a queue API ref → #

workflow.updateQueue({ path: { queueId: string }, body: { ... } })

Parameters

queueId	string	path	required
body	object	body	required

Tasks (5)

▶ listTasks() List tasks API ref → #

workflow.listTasks({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

▶ createTask() Create a task API ref → #

workflow.createTask({ body: { ... } })

Parameters

body

object

body

required

▶ deleteTask(taskId) Delete a task API ref → #

workflow.deleteTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

▶ getTask(taskId) Get a task API ref → #

workflow.getTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

▶ updateTask(taskId) Update a task API ref → #

workflow.updateTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Metrics (2)

▶ listMetrics() List metrics API ref → #

workflow.listMetrics({
  query: { q?: string, limit?: number, offset?: number, sort?: string, groupBy?: string, from?: string, to?: string, queueId?: string, program?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional
groupBy	string	query	optional
from	string	query	optional
to	string	query	optional
queueId	string	query	optional
program	string	query	optional

▶ getMetric(metricId) Get a metric API ref → #

workflow.getMetric({
  path: { metricId: string },
  query: { groupBy?: string, from?: string, to?: string, queueId?: string, program?: string },
})

Parameters

metricId	string	path	required
groupBy	string	query	optional
from	string	query	optional
to	string	query	optional
queueId	string	query	optional
program	string	query	optional

Claim (1)

▶ claimTask(taskId) Claim task API ref → #

workflow.claimTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

Complete (1)

▶ completeTask(taskId) Complete task API ref → #

workflow.completeTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Release (1)

▶ releaseTask(taskId) Release task API ref → #

workflow.releaseTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Escalate (1)

▶ escalateTask(taskId) Escalate task API ref → #

workflow.escalateTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

De Escalate (1)

▶ deEscalateTask(taskId) De escalate task API ref → #

workflow.deEscalateTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Cancel (1)

▶ cancelTask(taskId) Cancel task API ref → #

workflow.cancelTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Reopen (1)

▶ reopenTask(taskId) Reopen task API ref → #

workflow.reopenTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Await Client (1)

▶ awaitClientTask(taskId) Await client task API ref → #

workflow.awaitClientTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Await Verification (1)

▶ awaitVerificationTask(taskId) Await verification task API ref → #

workflow.awaitVerificationTask({
  path: { taskId: string },
  body: { ... },
})

Parameters

taskId	string	path	required
body	object	body	required

Resume (1)

▶ resumeTask(taskId) Resume task API ref → #

workflow.resumeTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

Auto Resume (1)

▶ autoResumeTask(taskId) Auto resume task API ref → #

workflow.autoResumeTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Sla Escalate (1)

▶ slaEscalateTask(taskId) Sla escalate task API ref → #

workflow.slaEscalateTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Auto Cancel (1)

▶ autoCancelTask(taskId) Auto cancel task API ref → #

workflow.autoCancelTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

Submit For Review (1)

▶ submitForReviewTask(taskId) Submit for review task API ref → #

workflow.submitForReviewTask({ path: { taskId: string } })

Parameters

taskId

string

path

required

Approve (1)

▶ approveTask(taskId) Approve task API ref → #

workflow.approveTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Return To Worker (1)

▶ returnToWorkerTask(taskId) Return to worker task API ref → #

workflow.returnToWorkerTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Assign (1)

▶ assignTask(taskId) Assign task API ref → #

workflow.assignTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Set Priority (1)

▶ setPriorityTask(taskId) Set priority task API ref → #

workflow.setPriorityTask({ path: { taskId: string }, body: { ... } })

Parameters

taskId	string	path	required
body	object	body	required

Types (30)

▶ Queue 2 fields #

interface Queue {
  name: string
  description?: string
}

▶ QueueCreate 2 fields #

interface QueueCreate {
  name?: string
  description?: string
}

▶ QueueList 5 fields #

interface QueueList {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ QueueUpdate 2 fields #

interface QueueUpdate {
  name?: string
  description?: string
}

▶ Task 18 fields #

interface Task {
  name: string
  description?: string
  status: enum (8 values)
  taskType?: string
  subjectType?: enum: "application", "case", "document", "appointment"
  subjectId?: string
  programType?: enum: "snap", "medicaid", "chip", "tanf", "aca"
  isExpedited?: boolean
  queueId?: string
  priority?: number
  startedAt?: string
  completedAt?: string
  escalatedAt?: string
  cancelledAt?: string
  blockedAt?: string
  assignedToId?: string
  outcome?: string
  completionNotes?: string
}

▶ TaskCreate 18 fields #

interface TaskCreate {
  name?: string
  description?: string
  status?: enum (8 values)
  taskType?: string
  subjectType?: enum: "application", "case", "document", "appointment"
  subjectId?: string
  programType?: enum: "snap", "medicaid", "chip", "tanf", "aca"
  isExpedited?: boolean
  queueId?: string
  priority?: number
  startedAt?: string
  completedAt?: string
  escalatedAt?: string
  cancelledAt?: string
  blockedAt?: string
  assignedToId?: string
  outcome?: string
  completionNotes?: string
}

▶ TaskList 4 fields #

interface TaskList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ TaskUpdate 18 fields #

interface TaskUpdate {
  name?: string
  description?: string
  status?: enum (8 values)
  taskType?: string
  subjectType?: enum: "application", "case", "document", "appointment"
  subjectId?: string
  programType?: enum: "snap", "medicaid", "chip", "tanf", "aca"
  isExpedited?: boolean
  queueId?: string
  priority?: number
  startedAt?: string
  completedAt?: string
  escalatedAt?: string
  cancelledAt?: string
  blockedAt?: string
  assignedToId?: string
  outcome?: string
  completionNotes?: string
}

▶ Metric 1 field #

interface Metric {
  aggregate: enum: "count", "ratio", "duration"
}

▶ MetricList 4 fields #

interface MetricList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ MetricTarget 6 fields #

interface MetricTarget {
  stat?: string
  operator?: enum: "<", "<=", ">", ">=", "=="
  amount?: number
  unit?: enum: "hours", "minutes", "days", "percent", "count"
  label?: string
  direction?: enum: "up", "down"
}

▶ CompleteTaskRequest 3 fields #

interface CompleteTaskRequest {
  outcome: string
  notes?: string
  createFollowUp?: boolean
}

▶ ReleaseTaskRequest 1 field #

interface ReleaseTaskRequest {
  reason: string
}

▶ EscalateTaskRequest 1 field #

interface EscalateTaskRequest {
  reason: string
}

▶ DeEscalateTaskRequest 1 field #

interface DeEscalateTaskRequest {
  notes?: string
}

▶ CancelTaskRequest 1 field #

interface CancelTaskRequest {
  reason: string
}

▶ ReopenTaskRequest 1 field #

interface ReopenTaskRequest {
  reason: string
}

▶ AwaitClientRequest 1 field #

interface AwaitClientRequest {
  notes?: string
}

▶ AwaitVerificationRequest 1 field #

interface AwaitVerificationRequest {
  notes?: string
}

▶ SystemResumeTaskRequest 1 field #

interface SystemResumeTaskRequest {
  causationid?: string
}

▶ SystemEscalateTaskRequest 1 field #

interface SystemEscalateTaskRequest {
  reason: string
}

▶ ApproveTaskRequest 2 fields #

interface ApproveTaskRequest {
  outcome: string
  notes?: string
}

▶ ReturnToWorkerRequest 1 field #

interface ReturnToWorkerRequest {
  reason: string
}

▶ AssignTaskRequest 2 fields #

interface AssignTaskRequest {
  assignedToId: string
  queueId?: string
}

▶ SetPriorityRequest 2 fields #

interface SetPriorityRequest {
  priority: number
  reason?: string
}

▶ QueueWritable 2 fields #

interface QueueWritable {
  name: string
  description?: string
}

▶ QueueListWritable 5 fields #

interface QueueListWritable {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ TaskWritable 18 fields #

interface TaskWritable {
  name: string
  description?: string
  status: enum (8 values)
  taskType?: string
  subjectType?: enum: "application", "case", "document", "appointment"
  subjectId?: string
  programType?: enum: "snap", "medicaid", "chip", "tanf", "aca"
  isExpedited?: boolean
  queueId?: string
  priority?: number
  startedAt?: string
  completedAt?: string
  escalatedAt?: string
  cancelledAt?: string
  blockedAt?: string
  assignedToId?: string
  outcome?: string
  completionNotes?: string
}

▶ TaskListWritable 4 fields #

interface TaskListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ MetricListWritable 4 fields #

interface MetricListWritable {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}