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

GET /canvas/roles/{canvasRoleName}

Get Canvas Roles

Description

Returns Canvas Roles

Parameters (path)

Name Required Description Values
canvasRoleName required Target Canvas Role.  

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

{
  "properties": {
    "required": [
      "name",
      "unit"
    ],
    "properties": {
      "role_name": {
        "description": "Id of the CanvasRole record",
        "type": "string",
        "format": "string",
        "readOnly": false,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "description": {
        "description": "Description of the canvas role.",
        "type": "string",
        "format": "string",
        "example": "Weight of packaging"
      },
      "enabled": {
        "description": "Boolean indicating if the role is shown",
        "type": "boolean",
        "format": "boolean",
        "example": true
      },
      "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

PUT /canvas/roles/{canvasRoleName}

Update existing CanvasRole

Description

Update the specified resource in storage.

Parameters (path)

Name Required Description Values
canvasRoleName required Target Canvas Role.  

Request body

Description

Target Canvas Role.

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

{
  "required": [
    "name",
    "unit"
  ],
  "properties": {
    "role_name": {
      "description": "Id of the CanvasRole record",
      "type": "string",
      "format": "string",
      "readOnly": false,
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "description": {
      "description": "Description of the canvas role.",
      "type": "string",
      "format": "string",
      "example": "Weight of packaging"
    },
    "enabled": {
      "description": "Boolean indicating if the role is shown",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "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

{
  "properties": {
    "required": [
      "name",
      "unit"
    ],
    "properties": {
      "role_name": {
        "description": "Id of the CanvasRole record",
        "type": "string",
        "format": "string",
        "readOnly": false,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "description": {
        "description": "Description of the canvas role.",
        "type": "string",
        "format": "string",
        "example": "Weight of packaging"
      },
      "enabled": {
        "description": "Boolean indicating if the role is shown",
        "type": "boolean",
        "format": "boolean",
        "example": true
      },
      "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"
}

403

Unauthorized request

406

not acceptable

500

Internal server error