blob: 00a8defd986497dea1490dec694a813c53172c4c (
plain)
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
|
# `labels` - [Sessions API](../README.md#sessions-api)
The `labels` methods of the sessions API allow for better organization of sessions.
## Read labels
Reads all labels of a session.
### HTTP Request
`GET /api/sessions/<token>/labels`
### Response Payload
```json
"Array<String>"
```
#### Example
**Request:**
`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`
**Response:**
```json
["label1", "label2", "label3"]
```
## Update labels
Update all labels of a session.
### HTTP Request
`PUT /api/sessions/<token>/labels`
### Request Payload
```json
"Array<String>"
```
The array of labels provided in the request payload will replace all existing labels of the session.
#### Example
**Request:**
`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`
**Response:**
```json
["label1", "label2", "label3"]
```
**Request:**
`PUT /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`
```json
["label4", "label5"]
```
**Request:**
`GET /api/sessions/afd4ecb0-c339-11e9-b66c-eca76c2bea9c/labels`
**Response:**
```json
["label4", "label5"]
```
|
