Process

Workflow (process) configuration: metadata, copying, members, permissions, public forms, and translations.

Endpoints

Endpoint	Arguments	Returns
v2.process.copy	unknown	processId[]
v2.process.get	processId	object
v2.process.member.add	ObjectId, unknown	boolean
v2.process.member.list	ObjectId	object[]
v2.process.member.remove	ObjectId, unknown	boolean
v2.process.meta	options	object
v2.process.permissions.deny	ObjectId, unknown, unknown	boolean
v2.process.permissions.grant	ObjectId, unknown, unknown	unknown
v2.process.publicForm.create	options	object
v2.process.publicForm.update	options	object
v2.process.star	ObjectId	object
v2.process.translation.create	processId, unknown	object
v2.process.validateFunction	unknown, unknown	unknown
v2.process.validateFunctions	WorkspaceId	unknown

v2.process.copy

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (processId \| processId[], required): One or many processIds to copy

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('v2.process.copy', [
  '507f1f77bcf86cd799439011', // One or many processIds to copy (required)
]);
console.log(result);

Returns

Array of processId.

Auth: requires an authenticated session.

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

v2.process.get

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (processId, optional): workflowId

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('v2.process.get', [
  '507f1f77bcf86cd799439011', // processId
]);
console.log(result);

Returns

Field	Type	Required	Description
coverImage	ObjectId	no
createNewLabel	string	no
description	string	no
defaultView	string	no
translations	Record<fi | en | sv, object>	no	Schema for process translations
enableAddedField	boolean	no
enableAttachments	boolean	no
enableLinkedAnnouncements	boolean	no
enableMapLocation	boolean	no
enableMessenger	boolean	no
allowGuests	boolean	no
enableGuestEditing	boolean	no
enableModifiedField	boolean	no
enableOwnerField	boolean	no
enableBallTracking	boolean	no
enableOwnerTeamField	boolean	no
ownerTeamFieldTitle	string	no
enablePredefinedName	boolean	no
enablePreselectedTeam	boolean	no
enableUniqueName	boolean	no
enableUnlinkedMode	boolean	no
fieldsOrder	ObjectId[]	no
initPhaseDescription	string	no
locationRequired	boolean	no
name	string	no
nameColumnText	string	no
nameFieldPlaceHolderText	string	no
nameFunctionEnabled	boolean	no
nameFunctionVariables	Record<string, object | object[]>	no
nameFunction	string	no
nameEditable	boolean	no
order	integer	no
members	object[]	no
personInCharge	ObjectId	no
personInChargeLabel	string	no
phases	object	no
phasesOrder	ObjectId[]	no
phasesRemoved	ObjectId[]	no
predefinedNamePrefix	string	no
preselectedTeam	object	no
tags	ObjectId[]	no
allowMultipleTags	boolean	no
allowCustomTags	boolean	no
requireFileTag	boolean	no
defaultGroupByField	ObjectId	no
color	string	no
discussionPermissions	array	no
inviteActivityCreator	boolean	no
groupNames	string[]	no
enableActivityTagging	boolean	no
activityTaggingPhaseIds	any	no
autoPickPreselectedTeam	boolean	no	Determines if the sidenav automatically picks a team if no preselected team are set
key	string	no	Process key
_id	processId	yes	Process Id
uid	userId	yes	Process creator user id
cid	WorkspaceId	yes	Process network id
created	timestamp	yes	Timestamp of when the process was created
updated	timestamp	yes	Timestamp of when the process was updated
fields	Record<string, object>	yes	Process fields
isStarred	boolean	yes	True when current client has starred the process
createdActivities	number	no	Amount of activities created in the process
publicForm	object	no	Process public form
documentTemplates	Record<string, object>	no	Process Document Templates

Auth: requires an authenticated session.

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

v2.process.member.add

Description

Add member to process.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): Network / User / Team / Group

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('v2.process.member.add', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // Network / User / Team / Group (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

v2.process.member.list

Description

List permissions

Parameters

Argument 1 (ObjectId, required): Process Id

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('v2.process.member.list', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Array of objects:

Field	Type	Required	Description
id	string	no	network_<networkId>, team_<teamId>, user_<userId>, group_<groupId>
info	object	no
permissions	admin | own | ownteam | any | edit[]	no

Auth: requires an authenticated session.

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

v2.process.member.remove

Description

Remove member of process.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

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('v2.process.member.remove', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

v2.process.meta

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
process	ObjectId	yes	Process Id
search	string	no	Optional Search String

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('v2.process.meta', [
  {
    process: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Record<string, object>

Auth: requires an authenticated session.

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

v2.process.permissions.deny

Description

Deny permission to Process for User / Team.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

Argument 3 (admin` \| `any` \| `own` \| `ownteam, optional): Permission

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('v2.process.permissions.deny', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (required)
  'admin', // Permission
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

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

v2.process.permissions.grant

Description

Grant permission to Process for User / Team.

Parameters

Argument 1 (ObjectId, required): Process Id

Argument 2 (string, required): User / Team

Argument 3 (admin` \| `any` \| `own` \| `ownteam, optional): Permission

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('v2.process.permissions.grant', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // User / Team (required)
  'admin', // Permission
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

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

v2.process.publicForm.create

Description

Generate process/dataset form key endpoint. If endpoint already exist, it will be replaced with new form key

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
processId	ObjectId	yes	Process Id
creator	string	no	Creator (User Id)
team	string	no	Team Id
account	string	no	Account Id
followers	none | creator | team	no	Valid attributes are none, creator or team
active	boolean	no	true or false, defaults to true
enableMessaging	boolean	no	Enable public form user to anonymously take part in the discussion
theme	object	no	Theme information containing colors and logo for form

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('v2.process.publicForm.create', [
  {
    processId: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
key	string	yes	Public form key
creator	userId	yes	Public form creator id
team_account	object	yes	Public form team
followers	string	yes	Public form followers
active	boolean	yes	Public form active state
enableMessaging	boolean	no
allowRead	boolean	yes	Allow listing activities in activity fields
theme	object	no	Theme information containing colors and logo for form

Auth: requires an authenticated session.

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

v2.process.publicForm.update

Description

Update process/dataset form key endpoint. Form key will not be replaced

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
processId	ObjectId	yes	Process Id
creator	string	no	Creator (User Id)
team	string	no	Team Id
account	string	no	Account Id
followers	none | creator | team	no	Valid attributes are none, creator or team
active	boolean	no	true or false
allowRead	boolean	no	true or false
enableMessaging	boolean	no	true or false, enable public form user to anonymously take part in the discussion
theme	object	no	Theme information containing colors and logo for form

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('v2.process.publicForm.update', [
  {
    processId: '507f1f77bcf86cd799439011', // Process Id
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
key	string	yes	Public form key
creator	userId	yes	Public form creator id
team_account	object	yes	Public form team
followers	string	yes	Public form followers
active	boolean	yes	Public form active state
enableMessaging	boolean	no
allowRead	boolean	yes	Allow listing activities in activity fields
theme	object	no	Theme information containing colors and logo for form

Auth: requires an authenticated session.

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

v2.process.star

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

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('v2.process.star', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
isStarred	boolean	yes

Auth: requires an authenticated session.

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

v2.process.translation.create

Description

Creates a new translation from the default network language

Parameters

Argument 1 (processId, required): workflowId

Argument 2 (fi` \| `en` \| `sv, required): ISO code of new language to be created

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('v2.process.translation.create', [
  '507f1f77bcf86cd799439011', // processId (required)
  'fi', // ISO code of new language to be created (required)
]);
console.log(result);

Returns

Record<fi\|en\|sv, object>

Auth: requires an authenticated session.

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

v2.process.validateFunction

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (string, required): Function Body

Argument 2 (string[], optional):

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('v2.process.validateFunction', [
  'string', // Function Body (required)
  ['string'],
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

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

v2.process.validateFunctions

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

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('v2.process.validateFunctions', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

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