Activity kanban

Internal

These endpoints are internal to Hailer and not part of the supported public API.

Kanban board views of activities.

Endpoints

Endpoint	Arguments	Returns
v3.activity.kanban.list	processId: string, options?: { filter?: any, sort?: any, limit?: number }	object
v3.activity.kanban.load	activityId: string	object

v3.activity.kanban.list

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (processId, required): workflowId

Argument 2 (object, optional):

Field	Type	Required	Description
filter	object	no
search	string	no	Default: null.
limit	integer	no	Default: 20.
page	integer	no	Default: 1.
skip	integer	no	Default: 1.
phase	ObjectId	no	Limits query to one phase only.
includeUsers	boolean	no	Include available user & field list. Default true Default: true.
includeTeams	boolean	no	Includes available team & account list. Default true. Default: true.

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.activity.kanban.list', [
  '507f1f77bcf86cd799439011', // processId (required)
  {
    filter: {
      user: { /* ... */ },
      account: '507f1f77bcf86cd799439011',
    },
    search: 'string',
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
map	Record<string, object>	no	The map contains phases grouped by phaseId containing activities and meta for phase

map: { [phaseId: string]: {
  activities: {
    _id: validObjectId.required(),
    followers: Joi.array().items(Joi.string().hex().length(24)),
    name: Joi.string(),
    fields: ,
    files: Joi.array().items(validObjectId),
    primaryDateField: JoiDate,
    priority: Joi.number(),
  }[]
  meta: {
    count: number,
    totalPrimaryNumericValue: number,
    primaryNumericFieldUnit: string \| null
  }
}
``` |
| `meta` | object | no |  |

**Auth:** requires an authenticated session.

**Errors:** on failure returns the standard Hailer error object `{ code, msg, details?, debug? }`.

## `v3.activity.kanban.load`

**Description**

::: warning Undocumented
This endpoint has no description in the source yet.
:::

**Parameters**

**Argument 1 (`ObjectId`, required):** Activity id

**Example**

```javascript
const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.activity.kanban.load', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
activity	object	no
process	processId	no	workflowId
phase	phaseId	no	phaseId (phase in a Workflow)

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.