Appearance
Phase
Workflow phase membership and permissions.
Endpoints
| Endpoint | Arguments | Returns |
|---|---|---|
v2.process.phase.member.add | ObjectId, ObjectId, unknown | boolean |
v2.process.phase.member.list | ObjectId, ObjectId | object[] |
v2.process.phase.member.remove | ObjectId, ObjectId, unknown | boolean |
v2.process.phase.permissions.deny | ObjectId, ObjectId, unknown, unknown | boolean |
v2.process.phase.permissions.grant | ObjectId, ObjectId, unknown, unknown | boolean |
v2.process.phase.member.add
Description
Add member to phase.
Parameters
Argument 1 (ObjectId, required): Process Id
Argument 2 (ObjectId, required): Phase Id
Argument 3 (string, required): User / Team / Workspace
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('v2.process.phase.member.add', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team / Workspace (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.phase.member.list
Description
Undocumented
This endpoint has no description in the source yet.
Parameters
Argument 1 (ObjectId, required): Process Id
Argument 2 (ObjectId, required): Phase 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('v2.process.phase.member.list', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'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.phase.member.remove
Description
Remove member of phase.
Parameters
Argument 1 (ObjectId, required): Process Id
Argument 2 (ObjectId, required): Phase Id
Argument 3 (string, required): User / Team / Workspace
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('v2.process.phase.member.remove', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team / Workspace (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.phase.permissions.deny
Description
Deny permission to Process for User / Team.
Parameters
Argument 1 (ObjectId, required): Process Id
Argument 2 (ObjectId, required): Phase Id
Argument 3 (string, required): User / Team
Argument 4 (edit, required): Permission
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('v2.process.phase.permissions.deny', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
'edit', // Permission (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.phase.permissions.grant
Description
Grant permission to Phase for User / Team.
Parameters
Argument 1 (ObjectId, required): Process Id
Argument 2 (ObjectId, required): Phase Id
Argument 3 (string, required): User / Team
Argument 4 (edit, required): Permission
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('v2.process.phase.permissions.grant', [
'507f1f77bcf86cd799439011', // ObjectId (required)
'507f1f77bcf86cd799439011', // ObjectId (required)
'string', // User / Team (required)
'edit', // Permission (required)
]);
console.log(result);Returns
boolean
Auth: requires an authenticated session.
Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.