Skip to content

Bpmn Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

a Reusable, customizable and workflow based task service

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

EventController

EventController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/count

Permissions
16002

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event model count loopback.Count

EventController.mapEventToWorkflow

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "eventKey": "string",
  "workflowKey": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/mapping',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "eventKey": "string",
  "workflowKey": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/mapping',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /events/mapping

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "eventKey": "string",
  "workflowKey": "string"
}

Parameters

Name In Type Required Description
body body EventWorkflowMapping false none

Responses

Status Meaning Description Schema

EventController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/{id}

Permissions
16002

Parameters

Name In Type Required Description
id path string true none
filter query events.Filter false none

Example responses

200 Response

1
2
3
4
5
6
7
8
{
  "id": "string",
  "key": "string",
  "description": "string",
  "source": "string",
  "payload": {},
  "timestamp": 0
}

Responses

Status Meaning Description Schema
200 OK Event model instance EventWithRelations

EventController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events

Permissions
16002

Parameters

Name In Type Required Description
filter query events.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
  {
    "id": "string",
    "key": "string",
    "description": "string",
    "source": "string",
    "payload": {},
    "timestamp": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Event model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EventWithRelations] false none [(tsType: EventWithRelations, schemaOptions: { includeRelations: true })]
» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»» id string false none none
»» key string true none An identifier for a particular event queued by a service or a user
»» description string true none A short description of an event
»» source string true none Origination of an event- can be a service or from a user
»» payload object true none A dynamic object that contains information to be run in the workers of a bpmn engine
»» timestamp number true none A short message to indicate the progression of the event

TaskController

TaskController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks/count

Permissions
16003

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Task model count loopback.Count

TaskController.mapTaskToWorkflow

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowKey": "string",
  "taskKey": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/mapping',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowKey": "string",
  "taskKey": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/mapping',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /tasks/mapping

Permissions
16006

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowKey": "string",
  "taskKey": "string"
}

Parameters

Name In Type Required Description
body body TaskWorkFlowMapping false none

Responses

Status Meaning Description Schema

TaskController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks/{id}

Permissions
16003

Parameters

Name In Type Required Description
id path string true none
filter query tasks.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "key": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "priority": "string",
  "severity": "string",
  "type": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "assigneeId": "string",
  "metadata": {},
  "externalId": "string",
  "userTasks": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "taskId": "string",
      "status": "string",
      "externalId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Task model instance TaskWithRelations

TaskController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /tasks/{id}

Permissions
16008

Parameters

Name In Type Required Description
id path string true none
cascade query boolean false none

Responses

Status Meaning Description Schema
204 No Content Task DELETE by id success None

TaskController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks

Permissions
16003

Parameters

Name In Type Required Description
filter query tasks.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "key": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "priority": "string",
    "severity": "string",
    "type": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "assigneeId": "string",
    "metadata": {},
    "externalId": "string",
    "userTasks": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "name": "string",
        "taskId": "string",
        "status": "string",
        "externalId": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Task model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TaskWithRelations] false none [(tsType: TaskWithRelations, schemaOptions: { includeRelations: true })]
» TaskWithRelations TaskWithRelations false none (tsType: TaskWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» key string true none An identifier for a particular task within an event
»» name string true none A name given by the consumer service for this task
»» description string false none A short description of this task
»» status string false none A short message to indicate the progression of the task
»» priority string true none none
»» severity string true none none
»» type string true none none
»» startDate string(date-time) false none none
»» dueDate string(date-time) false none none
»» endDate string(date-time) false none none
»» assigneeId string false none none
»» metadata object true none none
»» externalId string false none none
»» userTasks [UserTaskWithRelations] false none [(tsType: UserTaskWithRelations, schemaOptions: { includeRelations: true })]
»»» UserTaskWithRelations UserTaskWithRelations false none (tsType: UserTaskWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» name string true none none
»»»» taskId string true none none
»»»» status string true none none
»»»» externalId string true none none

TaskController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /tasks

Permissions
16008

Parameters

Name In Type Required Description
where query object false none
cascade query boolean false none

Responses

Status Meaning Description Schema
204 No Content Tasks DELETE success None

TaskUserTaskController

TaskUserTaskController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks/{taskId}/user-tasks/count

Permissions
16004

Parameters

Name In Type Required Description
taskId path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Task model count loopback.Count

TaskUserTaskController.completeTask

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{userTaskId}/complete',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{userTaskId}/complete',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /tasks/{taskId}/user-tasks/{userTaskId}/complete

Permissions
16005

Parameters

Name In Type Required Description
taskId path string true none
userTaskId path string true none

Responses

Status Meaning Description Schema

TaskUserTaskController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{userTaskId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{userTaskId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks/{taskId}/user-tasks/{userTaskId}

Permissions
16004

Parameters

Name In Type Required Description
taskId path string true none
userTaskId path string true none
filter query user_tasks.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "taskId": "string",
  "status": "string",
  "externalId": "string"
}

Responses

Status Meaning Description Schema
200 OK UserTask model instance UserTaskWithRelations

TaskUserTaskController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /tasks/{taskId}/user-tasks/{id}

Permissions
16009

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content UserTasks DELETE by id success None

TaskUserTaskController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /tasks/{taskId}/user-tasks

Permissions
16004

Parameters

Name In Type Required Description
taskId path string true none
filter query user_tasks.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "name": "string",
    "taskId": "string",
    "status": "string",
    "externalId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of UserTask model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [UserTaskWithRelations] false none [(tsType: UserTaskWithRelations, schemaOptions: { includeRelations: true })]
» UserTaskWithRelations UserTaskWithRelations false none (tsType: UserTaskWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» name string true none none
»» taskId string true none none
»» status string true none none
»» externalId string true none none

TaskUserTaskController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/tasks/{taskId}/user-tasks',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /tasks/{taskId}/user-tasks

Permissions
16009

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content UserTasks DELETE success None

WorkflowController

WorkflowController.startWorkflow

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
const inputBody = '{
  "workflowVersion": 0,
  "input": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}/execute',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
const fetch = require('node-fetch');
const inputBody = {
  "workflowVersion": 0,
  "input": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}/execute',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /workflows/{id}/execute

Permissions
CreateWorkflow
2

Body parameter

1
2
3
4
{
  "workflowVersion": 0,
  "input": {}
}

Parameters

Name In Type Required Description
id path string true none
body body ExecuteWorkflowDto false none

Responses

Status Meaning Description Schema
200 OK Workflow instance None

WorkflowController.deleteVersionById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}/version/{version}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}/version/{version}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /workflows/{id}/version/{version}

Permissions
DeleteWorkflow
4

Parameters

Name In Type Required Description
id path string true none
version path number true none

Responses

Status Meaning Description Schema
204 No Content Workflow DELETE success None

WorkflowController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /workflows/{id}

Permissions
UpdateWorkflow
3

Body parameter

1
2
3
4
5
6
{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body WorkflowDtoPartial false none

Responses

Status Meaning Description Schema
204 No Content Workflow PATCH success None

WorkflowController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /workflows/{id}

Permissions
ViewWorkflow
1

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Workflow Model None

WorkflowController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /workflows/{id}

Permissions
DeleteWorkflow
4

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Workflow DELETE success None

WorkflowController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const inputBody = '{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /workflows

Permissions
CreateWorkflow
2

Body parameter

1
2
3
4
5
6
{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}

Parameters

Name In Type Required Description
body body NewWorkflow false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowVersion": 0,
  "externalIdentifier": "string",
  "name": "string",
  "provider": "string",
  "inputSchema": {},
  "description": "string"
}

Responses

Status Meaning Description Schema
200 OK Workflow model instance Workflow

WorkflowController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/workflows',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /workflows

Permissions
ViewWorkflow
1

Parameters

Name In Type Required Description
filter query workflows.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "workflowVersion": 0,
    "externalIdentifier": "string",
    "name": "string",
    "provider": "string",
    "inputSchema": {},
    "description": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Workflow model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Workflow] false none none
» Workflow Workflow false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» workflowVersion number true none Last deployed workflow version
»» externalIdentifier string true none The key that is used to identify the workflow in the respective workflow engine.
»» name string false none Name of the workflow
»» provider string true none Provider could be the engine that will handle the workflow - camunda, zeebe, etc
»» inputSchema object true none Schema used for validation during workflow execution
»» description string false none Description of the workflow

Schemas

Workflow

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowVersion": 0,
  "externalIdentifier": "string",
  "name": "string",
  "provider": "string",
  "inputSchema": {},
  "description": "string"
}

Workflow

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
workflowVersion number true none Last deployed workflow version
externalIdentifier string true none The key that is used to identify the workflow in the respective workflow engine.
name string false none Name of the workflow
provider string true none Provider could be the engine that will handle the workflow - camunda, zeebe, etc
inputSchema object true none Schema used for validation during workflow execution
description string false none Description of the workflow

NewWorkflow

1
2
3
4
5
6
{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}

NewWorkflow

Properties

Name Type Required Restrictions Description
name string true none none
bpmnFile string true none none
inputSchema object true none none
description string false none none

WorkflowDto

1
2
3
4
5
6
{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}

WorkflowDto

Properties

Name Type Required Restrictions Description
name string true none none
bpmnFile string true none none
inputSchema object true none none
description string false none none

WorkflowDtoPartial

1
2
3
4
5
6
{
  "name": "string",
  "bpmnFile": "string",
  "inputSchema": {},
  "description": "string"
}

WorkflowDtoPartial

Properties

Name Type Required Restrictions Description
name string false none none
bpmnFile string false none none
inputSchema object false none none
description string false none none

ExecuteWorkflowDto

1
2
3
4
{
  "workflowVersion": 0,
  "input": {}
}

ExecuteWorkflowDto

Properties

Name Type Required Restrictions Description
workflowVersion number false none none
input object true none none

EventWithRelations

1
2
3
4
5
6
7
8
{
  "id": "string",
  "key": "string",
  "description": "string",
  "source": "string",
  "payload": {},
  "timestamp": 0
}

EventWithRelations

Properties

Name Type Required Restrictions Description
id string false none none
key string true none An identifier for a particular event queued by a service or a user
description string true none A short description of an event
source string true none Origination of an event- can be a service or from a user
payload object true none A dynamic object that contains information to be run in the workers of a bpmn engine
timestamp number true none A short message to indicate the progression of the event

EventWorkflowMapping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "eventKey": "string",
  "workflowKey": "string"
}

EventWorkflowMapping

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
eventKey string true none An identifier for a particular event queued by a service or a user
workflowKey string true none An identifier for a particular workflow

UserTaskWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "taskId": "string",
  "status": "string",
  "externalId": "string"
}

UserTaskWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
name string true none none
taskId string true none none
status string true none none
externalId string true none none

TaskWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "key": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "priority": "string",
  "severity": "string",
  "type": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "assigneeId": "string",
  "metadata": {},
  "externalId": "string",
  "userTasks": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "taskId": "string",
      "status": "string",
      "externalId": "string"
    }
  ]
}

TaskWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
key string true none An identifier for a particular task within an event
name string true none A name given by the consumer service for this task
description string false none A short description of this task
status string false none A short message to indicate the progression of the task
priority string true none none
severity string true none none
type string true none none
startDate string(date-time) false none none
dueDate string(date-time) false none none
endDate string(date-time) false none none
assigneeId string false none none
metadata object true none none
externalId string false none none
userTasks [UserTaskWithRelations] false none [(tsType: UserTaskWithRelations, schemaOptions: { includeRelations: true })]

TaskWorkFlowMapping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "workflowKey": "string",
  "taskKey": "string"
}

TaskWorkFlowMapping

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
workflowKey string true none An identifier for a particular workflow
taskKey string true none An identifier for a particular task within an event

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

events.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "id": true,
    "key": true,
    "description": true,
    "source": true,
    "payload": true,
    "timestamp": true
  }
}

events.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» key boolean false none none
»» description boolean false none none
»» source boolean false none none
»» payload boolean false none none
»» timestamp boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

events.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "key": true,
    "description": true,
    "source": true,
    "payload": true,
    "timestamp": true
  }
}

events.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» id boolean false none none
»» key boolean false none none
»» description boolean false none none
»» source boolean false none none
»» payload boolean false none none
»» timestamp boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

user_tasks.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "name": true,
    "taskId": true,
    "status": true,
    "externalId": true
  }
}

user_tasks.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» name boolean false none none
»» taskId boolean false none none
»» status boolean false none none
»» externalId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

user_tasks.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "name": true,
    "taskId": true,
    "status": true,
    "externalId": true
  }
}

user_tasks.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» name boolean false none none
»» taskId boolean false none none
»» status boolean false none none
»» externalId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

tasks.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

tasks.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

tasks.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "userTasks",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

tasks.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope tasks.ScopeFilter false none none

Enumerated Values

Property Value
relation userTasks

tasks.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "key": true,
    "name": true,
    "description": true,
    "status": true,
    "priority": true,
    "severity": true,
    "type": true,
    "startDate": true,
    "dueDate": true,
    "endDate": true,
    "assigneeId": true,
    "metadata": true,
    "externalId": true
  },
  "include": [
    {
      "relation": "userTasks",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

tasks.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» key boolean false none none
»» name boolean false none none
»» description boolean false none none
»» status boolean false none none
»» priority boolean false none none
»» severity boolean false none none
»» type boolean false none none
»» startDate boolean false none none
»» dueDate boolean false none none
»» endDate boolean false none none
»» assigneeId boolean false none none
»» metadata boolean false none none
»» externalId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous tasks.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

tasks.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "key": true,
    "name": true,
    "description": true,
    "status": true,
    "priority": true,
    "severity": true,
    "type": true,
    "startDate": true,
    "dueDate": true,
    "endDate": true,
    "assigneeId": true,
    "metadata": true,
    "externalId": true
  },
  "include": [
    {
      "relation": "userTasks",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

tasks.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» key boolean false none none
»» name boolean false none none
»» description boolean false none none
»» status boolean false none none
»» priority boolean false none none
»» severity boolean false none none
»» type boolean false none none
»» startDate boolean false none none
»» dueDate boolean false none none
»» endDate boolean false none none
»» assigneeId boolean false none none
»» metadata boolean false none none
»» externalId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous tasks.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

workflows.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

workflows.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

workflows.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "workflowVersions",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

workflows.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope workflows.ScopeFilter false none none

Enumerated Values

Property Value
relation workflowVersions

workflows.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "workflowVersion": true,
    "externalIdentifier": true,
    "name": true,
    "provider": true,
    "inputSchema": true,
    "description": true
  },
  "include": [
    {
      "relation": "workflowVersions",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

workflows.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» workflowVersion boolean false none none
»» externalIdentifier boolean false none none
»» name boolean false none none
»» provider boolean false none none
»» inputSchema boolean false none none
»» description boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous workflows.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none