This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /canvas/tasks

Get list of Canvas Tasks

Description

Returns list of Canvas Tasks

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by. Without sort specified it will sort first by ref and then name. title, description, created_at, updated_at
sortDirection optional Direction of sort. asc, desc
keyword[ct] optional Search for . Allowed expression(s): ct  
created_at[gt] optional Search for . Allowed expression(s): gt, lt, lte, gte  
updated_at[gt] optional Search for . Allowed expression(s): gt, lt, lte, gte  
include optional The resources that can be included in this request, delimited by a comma: responsible_employee, backup_employee  

Responses

200

successful operation

406

not acceptable

500

internal server error

POST /canvas/tasks

Create new canvas task

Description

Create a new Canvas Task

Request body

Description

Target Canvas Task.

Required

This parameter is required.

Request body JSON schema 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

{
  "required": [
    "title",
    "canvas_role_name",
    "canvas_step_name"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "backup_employee_id": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "canvas_role_name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "canvas_step_name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "description": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "frequency": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "frequency_text": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "responsible_employee_id": {
      "description": "No description is available",
      "type": "integer",
      "format": "int32",
      "example": 1234
    },
    "template_key": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "title": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

200

successful operation

Response content JSON schema 
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

{
  "properties": {
    "required": [
      "title",
      "canvas_role_name",
      "canvas_step_name"
    ],
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "backup_employee_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "canvas_role_name": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "canvas_step_name": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "description": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "frequency": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "frequency_text": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "responsible_employee_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "template_key": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "title": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error