Collaboration Mode
# Create Collaboration Mode
# Request
POST /openapi/collaborations
1
Body Parameters
| Parameter Name | Description | Type | Required |
|---|---|---|---|
project_key | Project identifier | string | Yes |
name | Collaboration mode name | string | Yes |
recycle_day | Resource recycle days, 0 means no recycle | int | No |
user_ids | User ID list | []string | No |
group_ids | User group ID list | []string | No |
workflows | Workflow list | []CollaborationWorkflow | No |
envs | Environment list | []CollaborationEnv | No |
CollaborationWorkflow Parameters
| Parameter Name | Description | Type | Required |
|---|---|---|---|
name | Workflow identifier | string | Yes |
collaboration_type | Collaboration type, share or new | string | Yes |
verbs | Operation permissions, get_workflow, edit_workflow, run_workflow, debug_workflow | []string | Yes |
CollaborationEnv Parameters
| Parameter Name | Description | Type | Required |
|---|---|---|---|
name | Environment name | string | Yes |
collaboration_type | Collaboration type, share or new | string | Yes |
verbs | Operation permissions, get_environment, config_environment, manage_environment, debug_pod | []string | Yes |
Body Parameter Example
Details
{
"envs": [
{
"collaboration_type": "share",
"name": "dev",
"verbs": [
"get_environment",
"config_environment",
"manage_environment",
"debug_pod"
]
}
],
"group_ids": [
"f0035a8b-66a7-11f0-89e1-1631ef6b4739"
],
"name": "api-test",
"project_key": "multi-chart",
"recycle_day": 0,
"user_ids": [
"00abf4dc-5c6d-11f0-8608-3abfaba6efff"
],
"workflows": [
{
"collaboration_type": "share",
"name": "multi-chart-ops-workflow",
"verbs": [
"edit_workflow",
"run_workflow",
"debug_workflow"
]
},
{
"collaboration_type": "new",
"name": "test-ops",
"verbs": [
"get_workflow",
"edit_workflow",
"run_workflow",
"debug_workflow"
]
}
]
}
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
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
# Response
{
"message": "success"
}
1
2
3
2
3
# Delete Collaboration Mode
# Request
DELETE /openapi/collaborations/<collaboration mode name>?projectKey=<project identifier>
1
# Response
{
"message": "success"
}
1
2
3
2
3
