Meegle API — Setting (Space Setting)
APIs under this skill: Get Work Item Types in Space, Get Business Line Details in Space.
Get Work Item Types in Space
Obtain the list of all work item types in the space and their docking identifiers (work_item_type_key / api_name) for use in subsequent APIs. Permission: Permission Management > Configuration Categories.
When to Use
- When you need work_item_type_key or api_name for other interfaces (work item CRUD, workflow, lists, etc.)
- When building space configuration UIs or listing available work item types (story, issue, version, sprint, chart, sub_task, etc.)
- When checking is_disable or enable_model_resource_lib per type
API Spec: get_work_item_types_in_space
name: get_work_item_types_in_space
type: api
description: >
Obtain all work item types in the space (WorkItemKeyType). Returns type_key, name,
api_name, is_disable, enable_model_resource_lib for each type.
auth:
type: plugin_access_token
header: X-Plugin-Token
user_header: X-User-Key
http:
method: GET
url: https://{domain}/open_api/{project_key}/work_item/all-types
headers:
X-Plugin-Token: "{{resolved_token}}"
X-User-Key: "{{user_key}}"
path_params:
project_key:
type: string
required: true
description: >
Space unique identifier (project_key). Double-click space name in Meegle project space to obtain.
outputs:
data:
type: array
description: >
List of work item types per WorkItemKeyType: type_key, name, is_disable,
api_name, enable_model_resource_lib. type_key / api_name are used as work_item_type_key in other APIs.
constraints:
- Permission: Permission Management – Configuration Categories
error_mapping:
10023: User not exist (X-User-Key in header incorrect or user not found)
Usage notes
- type_key and api_name: Use as work_item_type_key in work item, workflow, list, and other APIs (e.g.
story, issue, version, sub_task).
- is_disable: Indicates whether the type is disabled (value meaning per product; typically 2 = enabled).
- enable_model_resource_lib: Whether the type supports model resource library.
- X-User-Key: Must be a valid user key; invalid or missing key returns 10023.
Get Business Line Details in Space
Obtain the business line information of the space. Response follows the Business structure (tree with id, name, role_owners, watchers, level_id, parent, children, etc.). For the platform feature, see Business Line Configuration. Permission: Permission Management – Configuration.
When to Use
- When building business-line UIs or selectors that need the full business line tree for the space
- When you need role_owners, watchers, super_masters, or hierarchy (parent, children, level_id) per business line
- When validating or displaying business line IDs (id) for work items or filters
API Spec: get_business_line_details_in_space
name: get_business_line_details_in_space
type: api
description: >
Obtain business line information of the space. Returns list of Business objects
(tree: id, name, role_owners, watchers, level_id, parent, children, disabled, labels, order, project, super_masters).
auth:
type: plugin_access_token
header: X-Plugin-Token
user_header: X-User-Key
http:
method: GET
url: https://{domain}/open_api/{project_key}/business/all
headers:
X-Plugin-Token: "{{resolved_token}}"
X-User-Key: "{{user_key}}"
path_params:
project_key:
type: string
required: true
description: >
Space unique identifier (project_key). Double-click space name in Meegle project space to obtain.
outputs:
data:
type: array
description: >
List of Business objects. Each has id, name, role_owners (role, owners, name),
watchers, level_id, parent, disabled, labels, order, project, super_masters,
children (nested Business objects with same structure).
constraints:
- Permission: Permission Management – Configuration
error_mapping:
1000052062: Project key is wrong (not found simple name; project_key incorrect)
Usage notes
- data: Root-level array may represent top-level business lines; each item can have children forming a tree. parent links to parent id; level_id indicates depth.
- role_owners: Can be array of
{ role, owners } or object keyed by role (e.g. role_test: { name, owners, role }); owners are user_key lists.
- watchers / super_masters: user_key arrays. project is the space/project identifier.
- For business line configuration in the product, refer to Business Line Configuration in the platform docs.
1---2name: meegle-api-setting-space-setting3description: Meegle OpenAPI for space-level setting: work item types, business lines.4---5
6# Meegle API — Setting (Space Setting)
7
8APIs under this skill: Get Work Item Types in Space, Get Business Line Details in Space.
9
10---
11
12## Get Work Item Types in Space
13
14Obtain the list of all work item types in the space and their docking identifiers (**work_item_type_key** / **api_name**) for use in subsequent APIs. Permission: Permission Management > Configuration Categories.
15
16### When to Use
17
18- When you need **work_item_type_key** or **api_name** for other interfaces (work item CRUD, workflow, lists, etc.)
19- When building space configuration UIs or listing available work item types (story, issue, version, sprint, chart, sub_task, etc.)
20- When checking **is_disable** or **enable_model_resource_lib** per type
21
22### API Spec: get_work_item_types_in_space
23
24```yaml
25name: get_work_item_types_in_space
26type: api
27description: >
28 Obtain all work item types in the space (WorkItemKeyType). Returns type_key, name,
29 api_name, is_disable, enable_model_resource_lib for each type.
30
31auth:
32 type: plugin_access_token
33 header: X-Plugin-Token
34 user_header: X-User-Key
35
36http:
37 method: GET
38 url: https://{domain}/open_api/{project_key}/work_item/all-types
39 headers:
40 X-Plugin-Token: "{{resolved_token}}"
41 X-User-Key: "{{user_key}}"
42
43path_params:
44 project_key:
45 type: string
46 required: true
47 description: >
48 Space unique identifier (project_key). Double-click space name in Meegle project space to obtain.
49
50outputs:
51 data:
52 type: array
53 description: >
54 List of work item types per WorkItemKeyType: type_key, name, is_disable,
55 api_name, enable_model_resource_lib. type_key / api_name are used as work_item_type_key in other APIs.
56
57constraints:
58 - Permission: Permission Management – Configuration Categories
59
60error_mapping:
61 10023: User not exist (X-User-Key in header incorrect or user not found)
62```
63
64### Usage notes
65
66- **type_key** and **api_name**: Use as **work_item_type_key** in work item, workflow, list, and other APIs (e.g. `story`, `issue`, `version`, `sub_task`).
67- **is_disable**: Indicates whether the type is disabled (value meaning per product; typically 2 = enabled).
68- **enable_model_resource_lib**: Whether the type supports model resource library.
69- **X-User-Key**: Must be a valid user key; invalid or missing key returns 10023.
70
71---
72
73## Get Business Line Details in Space
74
75Obtain the business line information of the space. Response follows the Business structure (tree with id, name, role_owners, watchers, level_id, parent, children, etc.). For the platform feature, see Business Line Configuration. Permission: Permission Management – Configuration.
76
77### When to Use
78
79- When building business-line UIs or selectors that need the full business line tree for the space
80- When you need role_owners, watchers, super_masters, or hierarchy (parent, children, level_id) per business line
81- When validating or displaying business line IDs (id) for work items or filters
82
83### API Spec: get_business_line_details_in_space
84
85```yaml
86name: get_business_line_details_in_space
87type: api
88description: >
89 Obtain business line information of the space. Returns list of Business objects
90 (tree: id, name, role_owners, watchers, level_id, parent, children, disabled, labels, order, project, super_masters).
91
92auth:
93 type: plugin_access_token
94 header: X-Plugin-Token
95 user_header: X-User-Key
96
97http:
98 method: GET
99 url: https://{domain}/open_api/{project_key}/business/all
100 headers:
101 X-Plugin-Token: "{{resolved_token}}"
102 X-User-Key: "{{user_key}}"
103
104path_params:
105 project_key:
106 type: string
107 required: true
108 description: >
109 Space unique identifier (project_key). Double-click space name in Meegle project space to obtain.
110
111outputs:
112 data:
113 type: array
114 description: >
115 List of Business objects. Each has id, name, role_owners (role, owners, name),
116 watchers, level_id, parent, disabled, labels, order, project, super_masters,
117 children (nested Business objects with same structure).
118
119constraints:
120 - Permission: Permission Management – Configuration
121
122error_mapping:
123 1000052062: Project key is wrong (not found simple name; project_key incorrect)
124```
125
126### Usage notes
127
128- **data**: Root-level array may represent top-level business lines; each item can have **children** forming a tree. **parent** links to parent id; **level_id** indicates depth.
129- **role_owners**: Can be array of `{ role, owners }` or object keyed by role (e.g. `role_test: { name, owners, role }`); **owners** are user_key lists.
130- **watchers** / **super_masters**: user_key arrays. **project** is the space/project identifier.
131- For business line configuration in the product, refer to **Business Line Configuration** in the platform docs.