@mcp-abap-adt/core 2.4.2 → 2.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist/handlers/compact/high/compactLifecycleUtils.d.ts +4 -0
- package/dist/handlers/compact/high/compactLifecycleUtils.d.ts.map +1 -0
- package/dist/handlers/compact/high/compactLifecycleUtils.js +23 -0
- package/dist/handlers/compact/high/compactLifecycleUtils.js.map +1 -0
- package/dist/handlers/compact/high/compactMatrix.d.ts +4 -0
- package/dist/handlers/compact/high/compactMatrix.d.ts.map +1 -0
- package/dist/handlers/compact/high/compactMatrix.js +31 -0
- package/dist/handlers/compact/high/compactMatrix.js.map +1 -0
- package/dist/handlers/compact/high/compactObjectTypes.d.ts +3 -0
- package/dist/handlers/compact/high/compactObjectTypes.d.ts.map +1 -0
- package/dist/handlers/compact/high/compactObjectTypes.js +31 -0
- package/dist/handlers/compact/high/compactObjectTypes.js.map +1 -0
- package/dist/handlers/compact/high/compactRouter.d.ts +11 -0
- package/dist/handlers/compact/high/compactRouter.d.ts.map +1 -0
- package/dist/handlers/compact/high/compactRouter.js +254 -0
- package/dist/handlers/compact/high/compactRouter.js.map +1 -0
- package/dist/handlers/compact/high/compactSchemas.d.ts +934 -0
- package/dist/handlers/compact/high/compactSchemas.d.ts.map +1 -0
- package/dist/handlers/compact/high/compactSchemas.js +666 -0
- package/dist/handlers/compact/high/compactSchemas.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerActivate.d.ts +69 -0
- package/dist/handlers/compact/high/handleHandlerActivate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerActivate.js +27 -0
- package/dist/handlers/compact/high/handleHandlerActivate.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestResult.d.ts +39 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestResult.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestResult.js +15 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestResult.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestStatus.d.ts +33 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestStatus.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestStatus.js +15 -0
- package/dist/handlers/compact/high/handleHandlerCdsUnitTestStatus.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCheckRun.d.ts +69 -0
- package/dist/handlers/compact/high/handleHandlerCheckRun.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCheckRun.js +26 -0
- package/dist/handlers/compact/high/handleHandlerCheckRun.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCreate.d.ts +117 -0
- package/dist/handlers/compact/high/handleHandlerCreate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerCreate.js +15 -0
- package/dist/handlers/compact/high/handleHandlerCreate.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDelete.d.ts +47 -0
- package/dist/handlers/compact/high/handleHandlerDelete.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDelete.js +15 -0
- package/dist/handlers/compact/high/handleHandlerDelete.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDumpList.d.ts +48 -0
- package/dist/handlers/compact/high/handleHandlerDumpList.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDumpList.js +15 -0
- package/dist/handlers/compact/high/handleHandlerDumpList.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDumpView.d.ts +34 -0
- package/dist/handlers/compact/high/handleHandlerDumpView.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerDumpView.js +15 -0
- package/dist/handlers/compact/high/handleHandlerDumpView.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerGet.d.ts +102 -0
- package/dist/handlers/compact/high/handleHandlerGet.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerGet.js +15 -0
- package/dist/handlers/compact/high/handleHandlerGet.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerLock.d.ts +67 -0
- package/dist/handlers/compact/high/handleHandlerLock.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerLock.js +26 -0
- package/dist/handlers/compact/high/handleHandlerLock.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileList.d.ts +18 -0
- package/dist/handlers/compact/high/handleHandlerProfileList.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileList.js +15 -0
- package/dist/handlers/compact/high/handleHandlerProfileList.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileRun.d.ts +108 -0
- package/dist/handlers/compact/high/handleHandlerProfileRun.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileRun.js +57 -0
- package/dist/handlers/compact/high/handleHandlerProfileRun.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileView.d.ts +53 -0
- package/dist/handlers/compact/high/handleHandlerProfileView.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerProfileView.js +15 -0
- package/dist/handlers/compact/high/handleHandlerProfileView.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingListTypes.d.ts +29 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingListTypes.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingListTypes.js +15 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingListTypes.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingValidate.d.ts +47 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingValidate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingValidate.js +15 -0
- package/dist/handlers/compact/high/handleHandlerServiceBindingValidate.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerTransportCreate.d.ts +44 -0
- package/dist/handlers/compact/high/handleHandlerTransportCreate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerTransportCreate.js +15 -0
- package/dist/handlers/compact/high/handleHandlerTransportCreate.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestResult.d.ts +39 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestResult.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestResult.js +15 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestResult.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestRun.d.ts +123 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestRun.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestRun.js +15 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestRun.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestStatus.d.ts +33 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestStatus.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestStatus.js +15 -0
- package/dist/handlers/compact/high/handleHandlerUnitTestStatus.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnlock.d.ts +67 -0
- package/dist/handlers/compact/high/handleHandlerUnlock.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUnlock.js +26 -0
- package/dist/handlers/compact/high/handleHandlerUnlock.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUpdate.d.ts +109 -0
- package/dist/handlers/compact/high/handleHandlerUpdate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerUpdate.js +15 -0
- package/dist/handlers/compact/high/handleHandlerUpdate.js.map +1 -0
- package/dist/handlers/compact/high/handleHandlerValidate.d.ts +97 -0
- package/dist/handlers/compact/high/handleHandlerValidate.d.ts.map +1 -0
- package/dist/handlers/compact/high/handleHandlerValidate.js +40 -0
- package/dist/handlers/compact/high/handleHandlerValidate.js.map +1 -0
- package/dist/lib/config/IServerConfig.d.ts +1 -1
- package/dist/lib/config/IServerConfig.d.ts.map +1 -1
- package/dist/lib/config/ServerConfigManager.d.ts +1 -1
- package/dist/lib/config/ServerConfigManager.d.ts.map +1 -1
- package/dist/lib/config/ServerConfigManager.js +7 -3
- package/dist/lib/config/ServerConfigManager.js.map +1 -1
- package/dist/lib/config/yamlConfig.js +1 -1
- package/dist/lib/handlers/HandlerExporter.d.ts +5 -0
- package/dist/lib/handlers/HandlerExporter.d.ts.map +1 -1
- package/dist/lib/handlers/HandlerExporter.js +4 -0
- package/dist/lib/handlers/HandlerExporter.js.map +1 -1
- package/dist/lib/handlers/groups/CompactHandlersGroup.d.ts +11 -0
- package/dist/lib/handlers/groups/CompactHandlersGroup.d.ts.map +1 -0
- package/dist/lib/handlers/groups/CompactHandlersGroup.js +218 -0
- package/dist/lib/handlers/groups/CompactHandlersGroup.js.map +1 -0
- package/dist/lib/handlers/groups/index.d.ts +1 -0
- package/dist/lib/handlers/groups/index.d.ts.map +1 -1
- package/dist/lib/handlers/groups/index.js +3 -1
- package/dist/lib/handlers/groups/index.js.map +1 -1
- package/dist/server/EmbeddableMcpServer.d.ts +1 -1
- package/dist/server/EmbeddableMcpServer.d.ts.map +1 -1
- package/dist/server/EmbeddableMcpServer.js +4 -0
- package/dist/server/EmbeddableMcpServer.js.map +1 -1
- package/dist/server/launcher.js +3 -0
- package/dist/server/launcher.js.map +1 -1
- package/docs/development/roadmaps/COMPACT_FACADE_ROUTER_ROADMAP.md +71 -0
- package/docs/user-guide/AVAILABLE_TOOLS.md +672 -30
- package/docs/user-guide/AVAILABLE_TOOLS_COMPACT.md +555 -0
- package/docs/user-guide/AVAILABLE_TOOLS_HIGH.md +548 -22
- package/docs/user-guide/AVAILABLE_TOOLS_LOW.md +14 -5
- package/docs/user-guide/AVAILABLE_TOOLS_READONLY.md +101 -4
- package/docs/user-guide/HANDLERS_MANAGEMENT.md +50 -4
- package/docs/user-guide/README.md +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,555 @@
|
|
|
1
|
+
# Compact Tools - MCP ABAP ADT Server
|
|
2
|
+
|
|
3
|
+
Generated from code in `src/handlers/compact/high` (not from docs).
|
|
4
|
+
|
|
5
|
+
- Group: Compact
|
|
6
|
+
- Total tools: 22
|
|
7
|
+
|
|
8
|
+
## How It Works
|
|
9
|
+
|
|
10
|
+
Compact is a facade over existing high-level/runtime handlers.
|
|
11
|
+
You call one compact tool by intent and route by typed payload fields.
|
|
12
|
+
|
|
13
|
+
## Start Here
|
|
14
|
+
|
|
15
|
+
Pick tool by intent:
|
|
16
|
+
|
|
17
|
+
- Create object -> `HandlerCreate`
|
|
18
|
+
- Read object -> `HandlerGet`
|
|
19
|
+
- Update object -> `HandlerUpdate`
|
|
20
|
+
- Delete object -> `HandlerDelete`
|
|
21
|
+
- Validate object/binding -> `HandlerValidate`
|
|
22
|
+
- Activate object(s) -> `HandlerActivate`
|
|
23
|
+
- Lock object -> `HandlerLock`
|
|
24
|
+
- Unlock object -> `HandlerUnlock`
|
|
25
|
+
- Check run (syntax) -> `HandlerCheckRun`
|
|
26
|
+
- ABAP Unit run/status/result -> `HandlerUnitTestRun|HandlerUnitTestStatus|HandlerUnitTestResult`
|
|
27
|
+
- CDS Unit status/result -> `HandlerCdsUnitTestStatus|HandlerCdsUnitTestResult`
|
|
28
|
+
- Runtime profile run/list/view -> `HandlerProfileRun|HandlerProfileList|HandlerProfileView`
|
|
29
|
+
- Runtime dump list/view -> `HandlerDumpList|HandlerDumpView`
|
|
30
|
+
- Service binding list/validate -> `HandlerServiceBindingListTypes|HandlerServiceBindingValidate`
|
|
31
|
+
- Transport create -> `HandlerTransportCreate`
|
|
32
|
+
|
|
33
|
+
Request contract:
|
|
34
|
+
|
|
35
|
+
- CRUD: `HandlerCreate|HandlerGet|HandlerUpdate|HandlerDelete` with required `object_type`.
|
|
36
|
+
- Lifecycle: `HandlerValidate|HandlerActivate|HandlerLock|HandlerUnlock|HandlerCheckRun` with compact lifecycle params.
|
|
37
|
+
- Action-specific tools above use narrow typed payloads.
|
|
38
|
+
|
|
39
|
+
## Routing Matrix
|
|
40
|
+
|
|
41
|
+
Source of truth: `src/handlers/compact/high/compactMatrix.ts`.
|
|
42
|
+
Facade dispatch is deterministic by `object_type` and CRUD operation.
|
|
43
|
+
|
|
44
|
+
| object_type | CRUD |
|
|
45
|
+
| --- | --- |
|
|
46
|
+
| `BEHAVIOR_DEFINITION` | `create`, `get`, `update`, `delete` |
|
|
47
|
+
| `BEHAVIOR_IMPLEMENTATION` | `create`, `get`, `update`, `delete` |
|
|
48
|
+
| `CDS_UNIT_TEST` | `create`, `get`, `update`, `delete` |
|
|
49
|
+
| `CLASS` | `create`, `get`, `update`, `delete` |
|
|
50
|
+
| `DATA_ELEMENT` | `create`, `get`, `update`, `delete` |
|
|
51
|
+
| `DOMAIN` | `create`, `get`, `update`, `delete` |
|
|
52
|
+
| `FUNCTION_GROUP` | `create`, `get`, `update`, `delete` |
|
|
53
|
+
| `FUNCTION_MODULE` | `create`, `get`, `update`, `delete` |
|
|
54
|
+
| `INTERFACE` | `create`, `get`, `update`, `delete` |
|
|
55
|
+
| `LOCAL_DEFINITIONS` | `create`, `get`, `update`, `delete` |
|
|
56
|
+
| `LOCAL_MACROS` | `create`, `get`, `update`, `delete` |
|
|
57
|
+
| `LOCAL_TEST_CLASS` | `create`, `get`, `update`, `delete` |
|
|
58
|
+
| `LOCAL_TYPES` | `create`, `get`, `update`, `delete` |
|
|
59
|
+
| `METADATA_EXTENSION` | `create`, `get`, `update`, `delete` |
|
|
60
|
+
| `PACKAGE` | `create`, `get` |
|
|
61
|
+
| `PROGRAM` | `create`, `get`, `update`, `delete` |
|
|
62
|
+
| `RUNTIME_DUMP` | - |
|
|
63
|
+
| `RUNTIME_PROFILE` | - |
|
|
64
|
+
| `SERVICE_BINDING` | `create`, `get`, `update`, `delete` |
|
|
65
|
+
| `SERVICE_DEFINITION` | `create`, `get`, `update`, `delete` |
|
|
66
|
+
| `STRUCTURE` | `create`, `get`, `update`, `delete` |
|
|
67
|
+
| `TABLE` | `create`, `get`, `update`, `delete` |
|
|
68
|
+
| `TRANSPORT` | `create` |
|
|
69
|
+
| `UNIT_TEST` | `create`, `get`, `update`, `delete` |
|
|
70
|
+
| `VIEW` | `create`, `get`, `update`, `delete` |
|
|
71
|
+
|
|
72
|
+
Unsupported combinations return deterministic error:
|
|
73
|
+
- `Unsupported <operation> for object_type: <TYPE>`
|
|
74
|
+
|
|
75
|
+
## Action Recipes
|
|
76
|
+
|
|
77
|
+
Preferred dedicated compact tools and minimal payloads:
|
|
78
|
+
|
|
79
|
+
| Goal | Tool | Required fields |
|
|
80
|
+
| --- | --- | --- |
|
|
81
|
+
| Run ABAP Unit | `HandlerUnitTestRun` | `tests[]` |
|
|
82
|
+
| Unit status | `HandlerUnitTestStatus` | `run_id` |
|
|
83
|
+
| Unit result | `HandlerUnitTestResult` | `run_id` |
|
|
84
|
+
| CDS unit status | `HandlerCdsUnitTestStatus` | `run_id` |
|
|
85
|
+
| CDS unit result | `HandlerCdsUnitTestResult` | `run_id` |
|
|
86
|
+
| List binding types | `HandlerServiceBindingListTypes` | none |
|
|
87
|
+
| Validate binding | `HandlerServiceBindingValidate` | `service_binding_name`, `service_definition_name` |
|
|
88
|
+
| Create transport | `HandlerTransportCreate` | `description` |
|
|
89
|
+
| Run profiling (class/program) | `HandlerProfileRun` | `target_type` + target name |
|
|
90
|
+
| List profiler traces | `HandlerProfileList` | none |
|
|
91
|
+
| Read profiler trace | `HandlerProfileView` | `trace_id_or_uri`, `view` |
|
|
92
|
+
| List dumps | `HandlerDumpList` | none |
|
|
93
|
+
| Read dump | `HandlerDumpView` | `dump_id` |
|
|
94
|
+
|
|
95
|
+
## Minimal Payload Contracts
|
|
96
|
+
|
|
97
|
+
- `HandlerCreate|Get|Update|Delete`: always require `object_type`, plus object-specific fields.
|
|
98
|
+
- Dedicated action tools above expose narrow payloads.
|
|
99
|
+
- Common required pairs:
|
|
100
|
+
- unit tests status/result: `run_id`
|
|
101
|
+
- dump details: `dump_id`
|
|
102
|
+
- profiler details: `trace_id_or_uri` + `view` (`hitlist|statements|db_accesses`)
|
|
103
|
+
- service binding validate: `service_binding_name` + `service_definition_name`
|
|
104
|
+
- class profiling: `class_name`
|
|
105
|
+
- program profiling: `program_name`
|
|
106
|
+
|
|
107
|
+
### Quick Examples
|
|
108
|
+
|
|
109
|
+
- Run profiling for class:
|
|
110
|
+
- `HandlerProfileRun` + `{ "target_type":"CLASS", "class_name":"ZCL_FOO" }`
|
|
111
|
+
- Read one profiler trace:
|
|
112
|
+
- `HandlerProfileView` + `{ "trace_id_or_uri":"...", "view":"hitlist" }`
|
|
113
|
+
- Read one dump:
|
|
114
|
+
- `HandlerDumpView` + `{ "dump_id":"...", "view":"summary" }`
|
|
115
|
+
|
|
116
|
+
- List dumps:
|
|
117
|
+
- `HandlerDumpList` + `{ "top":20, "orderby":"CREATED_AT desc" }`
|
|
118
|
+
- List profiler traces:
|
|
119
|
+
- `HandlerProfileList` + `{}`
|
|
120
|
+
- Validate service binding:
|
|
121
|
+
- `HandlerServiceBindingValidate` + `{ "service_binding_name":"ZSB_FOO", "service_definition_name":"ZSD_FOO" }`
|
|
122
|
+
|
|
123
|
+
## Navigation
|
|
124
|
+
|
|
125
|
+
- [Compact Group](#compact-group)
|
|
126
|
+
- [HandlerActivate](#handleractivate-compact)
|
|
127
|
+
- [HandlerCdsUnitTestResult](#handlercdsunittestresult-compact)
|
|
128
|
+
- [HandlerCdsUnitTestStatus](#handlercdsunitteststatus-compact)
|
|
129
|
+
- [HandlerCheckRun](#handlercheckrun-compact)
|
|
130
|
+
- [HandlerCreate](#handlercreate-compact)
|
|
131
|
+
- [HandlerDelete](#handlerdelete-compact)
|
|
132
|
+
- [HandlerDumpList](#handlerdumplist-compact)
|
|
133
|
+
- [HandlerDumpView](#handlerdumpview-compact)
|
|
134
|
+
- [HandlerGet](#handlerget-compact)
|
|
135
|
+
- [HandlerLock](#handlerlock-compact)
|
|
136
|
+
- [HandlerProfileList](#handlerprofilelist-compact)
|
|
137
|
+
- [HandlerProfileRun](#handlerprofilerun-compact)
|
|
138
|
+
- [HandlerProfileView](#handlerprofileview-compact)
|
|
139
|
+
- [HandlerServiceBindingListTypes](#handlerservicebindinglisttypes-compact)
|
|
140
|
+
- [HandlerServiceBindingValidate](#handlerservicebindingvalidate-compact)
|
|
141
|
+
- [HandlerTransportCreate](#handlertransportcreate-compact)
|
|
142
|
+
- [HandlerUnitTestResult](#handlerunittestresult-compact)
|
|
143
|
+
- [HandlerUnitTestRun](#handlerunittestrun-compact)
|
|
144
|
+
- [HandlerUnitTestStatus](#handlerunitteststatus-compact)
|
|
145
|
+
- [HandlerUnlock](#handlerunlock-compact)
|
|
146
|
+
- [HandlerUpdate](#handlerupdate-compact)
|
|
147
|
+
- [HandlerValidate](#handlervalidate-compact)
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
<a id="compact-group"></a>
|
|
152
|
+
## Compact Group
|
|
153
|
+
|
|
154
|
+
<a id="compact"></a>
|
|
155
|
+
### Compact
|
|
156
|
+
|
|
157
|
+
<a id="handleractivate-compact"></a>
|
|
158
|
+
#### HandlerActivate (Compact)
|
|
159
|
+
**Description:** Activate operation. Single mode(object_name*, object_adt_type*). Batch mode(objects[].name*, objects[].type*).
|
|
160
|
+
|
|
161
|
+
**Source:** `src/handlers/compact/high/handleHandlerActivate.ts`
|
|
162
|
+
|
|
163
|
+
**Parameters:**
|
|
164
|
+
- `object_adt_type` (string, optional) - ADT object type code (e.g. CLAS/OC, PROG/P). Required for single-object activation form.
|
|
165
|
+
- `object_name` (string, optional) - Object name for single-object activation form.
|
|
166
|
+
- `object_type` (any, optional) -
|
|
167
|
+
- `objects` (array, optional) - Explicit objects list for batch activation.
|
|
168
|
+
- `preaudit` (boolean, optional) - Run pre-audit checks before activation.
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
<a id="handlercdsunittestresult-compact"></a>
|
|
173
|
+
#### HandlerCdsUnitTestResult (Compact)
|
|
174
|
+
**Description:** CDS unit test result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON.
|
|
175
|
+
|
|
176
|
+
**Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestResult.ts`
|
|
177
|
+
|
|
178
|
+
**Parameters:**
|
|
179
|
+
- `aggregate` (boolean, optional) - Aggregate profiling data.
|
|
180
|
+
- `all_db_events` (boolean, optional) - Trace all DB events.
|
|
181
|
+
- `all_dynpro_events` (boolean, optional) - Trace dynpro events.
|
|
182
|
+
- `all_internal_table_events` (boolean, optional) - Trace internal table events.
|
|
183
|
+
- `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements.
|
|
184
|
+
- `all_procedural_units` (boolean, optional) - Trace all procedural units.
|
|
185
|
+
- `all_system_kernel_events` (boolean, optional) - Trace system kernel events.
|
|
186
|
+
- `amdp_trace` (boolean, optional) - Enable AMDP tracing.
|
|
187
|
+
- `class_name` (string, optional) - Class name for profiling.
|
|
188
|
+
- `description` (string, optional) - Profiler run description.
|
|
189
|
+
- `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections.
|
|
190
|
+
- `max_size_for_trace_file` (number, optional) - Maximum trace file size.
|
|
191
|
+
- `max_time_for_tracing` (number, optional) - Maximum tracing time.
|
|
192
|
+
- `program_name` (string, optional) - Program name for profiling.
|
|
193
|
+
- `sql_trace` (boolean, optional) - Enable SQL trace.
|
|
194
|
+
- `target_type` (string, required) - Profile execution target kind.
|
|
195
|
+
- `with_rfc_tracing` (boolean, optional) - Enable RFC tracing.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
<a id="handlercdsunitteststatus-compact"></a>
|
|
200
|
+
#### HandlerCdsUnitTestStatus (Compact)
|
|
201
|
+
**Description:** CDS unit test status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON.
|
|
202
|
+
|
|
203
|
+
**Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestStatus.ts`
|
|
204
|
+
|
|
205
|
+
**Parameters:**
|
|
206
|
+
- `aggregate` (boolean, optional) - Aggregate profiling data.
|
|
207
|
+
- `all_db_events` (boolean, optional) - Trace all DB events.
|
|
208
|
+
- `all_dynpro_events` (boolean, optional) - Trace dynpro events.
|
|
209
|
+
- `all_internal_table_events` (boolean, optional) - Trace internal table events.
|
|
210
|
+
- `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements.
|
|
211
|
+
- `all_procedural_units` (boolean, optional) - Trace all procedural units.
|
|
212
|
+
- `all_system_kernel_events` (boolean, optional) - Trace system kernel events.
|
|
213
|
+
- `amdp_trace` (boolean, optional) - Enable AMDP tracing.
|
|
214
|
+
- `class_name` (string, optional) - Class name for profiling.
|
|
215
|
+
- `description` (string, optional) - Profiler run description.
|
|
216
|
+
- `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections.
|
|
217
|
+
- `max_size_for_trace_file` (number, optional) - Maximum trace file size.
|
|
218
|
+
- `max_time_for_tracing` (number, optional) - Maximum tracing time.
|
|
219
|
+
- `program_name` (string, optional) - Program name for profiling.
|
|
220
|
+
- `sql_trace` (boolean, optional) - Enable SQL trace.
|
|
221
|
+
- `target_type` (string, required) - Profile execution target kind.
|
|
222
|
+
- `with_rfc_tracing` (boolean, optional) - Enable RFC tracing.
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
<a id="handlercheckrun-compact"></a>
|
|
227
|
+
#### HandlerCheckRun (Compact)
|
|
228
|
+
**Description:** CheckRun operation (syntax, no activation). object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*).
|
|
229
|
+
|
|
230
|
+
**Source:** `src/handlers/compact/high/handleHandlerCheckRun.ts`
|
|
231
|
+
|
|
232
|
+
**Parameters:**
|
|
233
|
+
- `session_id` (string, optional) - Optional ADT session id for stateful check flow.
|
|
234
|
+
- `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful check flow.
|
|
235
|
+
- `version` (string, optional (default: active)) - Version to syntax-check.
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
239
|
+
<a id="handlercreate-compact"></a>
|
|
240
|
+
#### HandlerCreate (Compact)
|
|
241
|
+
**Description:** Create operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*).
|
|
242
|
+
|
|
243
|
+
**Source:** `src/handlers/compact/high/handleHandlerCreate.ts`
|
|
244
|
+
|
|
245
|
+
**Parameters:**
|
|
246
|
+
- `activate` (boolean, optional) - Activate object after create.
|
|
247
|
+
- `application` (string, optional) - Domain application area.
|
|
248
|
+
- `class_name` (string, optional) - ABAP class name.
|
|
249
|
+
- `conversion_exit` (string, optional) - Conversion exit name.
|
|
250
|
+
- `datatype` (string, optional) - ABAP data type.
|
|
251
|
+
- `decimals` (number, optional) - Decimal places.
|
|
252
|
+
- `description` (string, optional) - Human-readable object description.
|
|
253
|
+
- `domain_name` (string, optional) - ABAP domain name.
|
|
254
|
+
- `fixed_values` (array, optional) - Domain fixed values list.
|
|
255
|
+
- `function_group_name` (string, optional) - ABAP function group name.
|
|
256
|
+
- `function_module_name` (string, optional) - ABAP function module name.
|
|
257
|
+
- `length` (number, optional) - Length for typed artifacts.
|
|
258
|
+
- `lowercase` (boolean, optional) - Allow lowercase values (domain setting).
|
|
259
|
+
- `object_type` (any, required) -
|
|
260
|
+
- `package_name` (string, optional) - ABAP package name.
|
|
261
|
+
- `program_name` (string, optional) - ABAP program name.
|
|
262
|
+
- `program_type` (string, optional) - ABAP program type.
|
|
263
|
+
- `sign_exists` (boolean, optional) - Allow signed values (domain setting).
|
|
264
|
+
- `source_code` (string, optional) - ABAP source code payload.
|
|
265
|
+
- `transport_request` (string, optional) - Transport request id (if required by system).
|
|
266
|
+
- `value_table` (string, optional) - Foreign key value table.
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
<a id="handlerdelete-compact"></a>
|
|
271
|
+
#### HandlerDelete (Compact)
|
|
272
|
+
**Description:** Delete operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*).
|
|
273
|
+
|
|
274
|
+
**Source:** `src/handlers/compact/high/handleHandlerDelete.ts`
|
|
275
|
+
|
|
276
|
+
**Parameters:**
|
|
277
|
+
- `class_name` (string, optional) - ABAP class name.
|
|
278
|
+
- `domain_name` (string, optional) - ABAP domain name.
|
|
279
|
+
- `function_group_name` (string, optional) - ABAP function group name.
|
|
280
|
+
- `function_module_name` (string, optional) - ABAP function module name.
|
|
281
|
+
- `object_type` (any, required) -
|
|
282
|
+
- `program_name` (string, optional) - ABAP program name.
|
|
283
|
+
- `transport_request` (string, optional) - Transport request id (if required by system).
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
<a id="handlerdumplist-compact"></a>
|
|
288
|
+
#### HandlerDumpList (Compact)
|
|
289
|
+
**Description:** Runtime dump list. object_type: not used. Required: none. Optional: user, inlinecount, top, skip, orderby. Response: JSON.
|
|
290
|
+
|
|
291
|
+
**Source:** `src/handlers/compact/high/handleHandlerDumpList.ts`
|
|
292
|
+
|
|
293
|
+
**Parameters:**
|
|
294
|
+
- `inlinecount` (string, optional) - Include total count in response.
|
|
295
|
+
- `orderby` (string, optional) - Sort expression.
|
|
296
|
+
- `skip` (number, optional) - Offset for pagination.
|
|
297
|
+
- `top` (number, optional) - Limit number of returned dumps.
|
|
298
|
+
- `user` (string, optional) - Filter dumps by user.
|
|
299
|
+
|
|
300
|
+
---
|
|
301
|
+
|
|
302
|
+
<a id="handlerdumpview-compact"></a>
|
|
303
|
+
#### HandlerDumpView (Compact)
|
|
304
|
+
**Description:** Runtime dump view. object_type: not used. Required: dump_id*. Optional: view(default|summary|formatted). Response: JSON.
|
|
305
|
+
|
|
306
|
+
**Source:** `src/handlers/compact/high/handleHandlerDumpView.ts`
|
|
307
|
+
|
|
308
|
+
**Parameters:**
|
|
309
|
+
- `dump_id` (string, required) - Runtime dump id.
|
|
310
|
+
- `view` (string, optional (default: default)) - Dump rendering mode.
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
|
|
314
|
+
<a id="handlerget-compact"></a>
|
|
315
|
+
#### HandlerGet (Compact)
|
|
316
|
+
**Description:** Read operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*).
|
|
317
|
+
|
|
318
|
+
**Source:** `src/handlers/compact/high/handleHandlerGet.ts`
|
|
319
|
+
|
|
320
|
+
**Parameters:**
|
|
321
|
+
- `behavior_definition_name` (string, optional) - Behavior definition name.
|
|
322
|
+
- `behavior_implementation_name` (string, optional) - Behavior implementation name.
|
|
323
|
+
- `class_name` (string, optional) - Class name.
|
|
324
|
+
- `data_element_name` (string, optional) - Data element name.
|
|
325
|
+
- `domain_name` (string, optional) - Domain name.
|
|
326
|
+
- `function_group_name` (string, optional) - Function group name.
|
|
327
|
+
- `function_module_name` (string, optional) - Function module name.
|
|
328
|
+
- `interface_name` (string, optional) - Interface name.
|
|
329
|
+
- `metadata_extension_name` (string, optional) - Metadata extension name.
|
|
330
|
+
- `object_type` (any, required) -
|
|
331
|
+
- `package_name` (string, optional) - Package name.
|
|
332
|
+
- `program_name` (string, optional) - Program name.
|
|
333
|
+
- `response_format` (string, optional) - Response format for SERVICE_BINDING reads.
|
|
334
|
+
- `run_id` (string, optional) - Unit test run id.
|
|
335
|
+
- `service_binding_name` (string, optional) - Service binding name.
|
|
336
|
+
- `service_definition_name` (string, optional) - Service definition name.
|
|
337
|
+
- `structure_name` (string, optional) - Structure name.
|
|
338
|
+
- `table_name` (string, optional) - Table name.
|
|
339
|
+
- `version` (any, optional) -
|
|
340
|
+
- `view_name` (string, optional) - View name.
|
|
341
|
+
|
|
342
|
+
---
|
|
343
|
+
|
|
344
|
+
<a id="handlerlock-compact"></a>
|
|
345
|
+
#### HandlerLock (Compact)
|
|
346
|
+
**Description:** Lock operation. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*).
|
|
347
|
+
|
|
348
|
+
**Source:** `src/handlers/compact/high/handleHandlerLock.ts`
|
|
349
|
+
|
|
350
|
+
**Parameters:**
|
|
351
|
+
- `session_id` (string, optional) - Optional ADT session id for stateful lock flow.
|
|
352
|
+
- `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful lock flow.
|
|
353
|
+
- `super_package` (string, optional) - Super package context when relevant.
|
|
354
|
+
|
|
355
|
+
---
|
|
356
|
+
|
|
357
|
+
<a id="handlerprofilelist-compact"></a>
|
|
358
|
+
#### HandlerProfileList (Compact)
|
|
359
|
+
**Description:** Runtime profiling list. object_type: not used. Required: none. Response: JSON.
|
|
360
|
+
|
|
361
|
+
**Source:** `src/handlers/compact/high/handleHandlerProfileList.ts`
|
|
362
|
+
|
|
363
|
+
**Parameters:**
|
|
364
|
+
- See schema reference `compactProfileListSchema` in source file
|
|
365
|
+
|
|
366
|
+
---
|
|
367
|
+
|
|
368
|
+
<a id="handlerprofilerun-compact"></a>
|
|
369
|
+
#### HandlerProfileRun (Compact)
|
|
370
|
+
**Description:** Runtime profiling run. object_type: not used. Required: target_type*(CLASS|PROGRAM) + class_name* for CLASS or program_name* for PROGRAM. Optional profiling flags and description. Response: JSON.
|
|
371
|
+
|
|
372
|
+
**Source:** `src/handlers/compact/high/handleHandlerProfileRun.ts`
|
|
373
|
+
|
|
374
|
+
**Parameters:**
|
|
375
|
+
- `aggregate` (boolean, optional) - Aggregate profiling data.
|
|
376
|
+
- `all_db_events` (boolean, optional) - Trace all DB events.
|
|
377
|
+
- `all_dynpro_events` (boolean, optional) - Trace dynpro events.
|
|
378
|
+
- `all_internal_table_events` (boolean, optional) - Trace internal table events.
|
|
379
|
+
- `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements.
|
|
380
|
+
- `all_procedural_units` (boolean, optional) - Trace all procedural units.
|
|
381
|
+
- `all_system_kernel_events` (boolean, optional) - Trace system kernel events.
|
|
382
|
+
- `amdp_trace` (boolean, optional) - Enable AMDP tracing.
|
|
383
|
+
- `class_name` (string, optional) - Class name for profiling.
|
|
384
|
+
- `description` (string, optional) - Profiler run description.
|
|
385
|
+
- `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections.
|
|
386
|
+
- `max_size_for_trace_file` (number, optional) - Maximum trace file size.
|
|
387
|
+
- `max_time_for_tracing` (number, optional) - Maximum tracing time.
|
|
388
|
+
- `program_name` (string, optional) - Program name for profiling.
|
|
389
|
+
- `sql_trace` (boolean, optional) - Enable SQL trace.
|
|
390
|
+
- `target_type` (string, required) - Profile execution target kind.
|
|
391
|
+
- `with_rfc_tracing` (boolean, optional) - Enable RFC tracing.
|
|
392
|
+
|
|
393
|
+
---
|
|
394
|
+
|
|
395
|
+
<a id="handlerprofileview-compact"></a>
|
|
396
|
+
#### HandlerProfileView (Compact)
|
|
397
|
+
**Description:** Runtime profiling view. object_type: not used. Required: trace_id_or_uri*, view*(hitlist|statements|db_accesses). Optional: with_system_events, id, with_details, auto_drill_down_threshold. Response: JSON.
|
|
398
|
+
|
|
399
|
+
**Source:** `src/handlers/compact/high/handleHandlerProfileView.ts`
|
|
400
|
+
|
|
401
|
+
**Parameters:**
|
|
402
|
+
- `auto_drill_down_threshold` (number, optional) - Auto drill-down threshold.
|
|
403
|
+
- `id` (number, optional) - Optional statement/access id.
|
|
404
|
+
- `trace_id_or_uri` (string, required) - Profiler trace id or URI.
|
|
405
|
+
- `view` (string, required) - Profiler trace view kind.
|
|
406
|
+
- `with_details` (boolean, optional) - Include detailed payload.
|
|
407
|
+
- `with_system_events` (boolean, optional) - Include system events in analysis.
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
<a id="handlerservicebindinglisttypes-compact"></a>
|
|
412
|
+
#### HandlerServiceBindingListTypes (Compact)
|
|
413
|
+
**Description:** Service binding types list. object_type: not used. Required: none. Optional: response_format(xml|json|plain). Response: XML/JSON/plain by response_format.
|
|
414
|
+
|
|
415
|
+
**Source:** `src/handlers/compact/high/handleHandlerServiceBindingListTypes.ts`
|
|
416
|
+
|
|
417
|
+
**Parameters:**
|
|
418
|
+
- `response_format` (string, optional (default: xml)) - Response format for protocol types list.
|
|
419
|
+
|
|
420
|
+
---
|
|
421
|
+
|
|
422
|
+
<a id="handlerservicebindingvalidate-compact"></a>
|
|
423
|
+
#### HandlerServiceBindingValidate (Compact)
|
|
424
|
+
**Description:** Service binding validate before create. object_type: not used. Required: service_binding_name*, service_definition_name*. Optional: service_binding_version, package_name, description. Response: JSON.
|
|
425
|
+
|
|
426
|
+
**Source:** `src/handlers/compact/high/handleHandlerServiceBindingValidate.ts`
|
|
427
|
+
|
|
428
|
+
**Parameters:**
|
|
429
|
+
- `description` (string, optional) - Binding description.
|
|
430
|
+
- `package_name` (string, optional) - Target package name.
|
|
431
|
+
- `service_binding_name` (string, required) - Service binding name to validate.
|
|
432
|
+
- `service_binding_version` (string, optional) - Service binding version.
|
|
433
|
+
- `service_definition_name` (string, required) - Service definition name to pair with binding.
|
|
434
|
+
|
|
435
|
+
---
|
|
436
|
+
|
|
437
|
+
<a id="handlertransportcreate-compact"></a>
|
|
438
|
+
#### HandlerTransportCreate (Compact)
|
|
439
|
+
**Description:** Transport create. object_type: not used. Required: description*. Optional: transport_type(workbench|customizing), target_system, owner. Response: JSON.
|
|
440
|
+
|
|
441
|
+
**Source:** `src/handlers/compact/high/handleHandlerTransportCreate.ts`
|
|
442
|
+
|
|
443
|
+
**Parameters:**
|
|
444
|
+
- `description` (string, required) - Transport description.
|
|
445
|
+
- `owner` (string, optional) - Transport owner user.
|
|
446
|
+
- `target_system` (string, optional) - Target system id.
|
|
447
|
+
- `transport_type` (string, optional (default: workbench)) - Transport type.
|
|
448
|
+
|
|
449
|
+
---
|
|
450
|
+
|
|
451
|
+
<a id="handlerunittestresult-compact"></a>
|
|
452
|
+
#### HandlerUnitTestResult (Compact)
|
|
453
|
+
**Description:** ABAP Unit result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON.
|
|
454
|
+
|
|
455
|
+
**Source:** `src/handlers/compact/high/handleHandlerUnitTestResult.ts`
|
|
456
|
+
|
|
457
|
+
**Parameters:**
|
|
458
|
+
- `format` (string, optional) - Result format.
|
|
459
|
+
- `run_id` (string, required) - Unit test run id.
|
|
460
|
+
- `with_navigation_uris` (boolean, optional (default: false)) - Include ADT navigation URIs in the result payload.
|
|
461
|
+
|
|
462
|
+
---
|
|
463
|
+
|
|
464
|
+
<a id="handlerunittestrun-compact"></a>
|
|
465
|
+
#### HandlerUnitTestRun (Compact)
|
|
466
|
+
**Description:** ABAP Unit run. object_type: not used. Required: tests[]{container_class*, test_class*}. Optional: title, context, scope, risk_level, duration. Response: JSON.
|
|
467
|
+
|
|
468
|
+
**Source:** `src/handlers/compact/high/handleHandlerUnitTestRun.ts`
|
|
469
|
+
|
|
470
|
+
**Parameters:**
|
|
471
|
+
- `context` (string, optional) - Run context label.
|
|
472
|
+
- `duration` (object, optional) - Allowed duration classes.
|
|
473
|
+
- `risk_level` (object, optional) - Allowed risk levels.
|
|
474
|
+
- `scope` (object, optional) - ABAP Unit scope flags.
|
|
475
|
+
- `tests` (array, required) - List of test classes to run.
|
|
476
|
+
- `title` (string, optional) - Run title shown in ABAP Unit logs.
|
|
477
|
+
|
|
478
|
+
---
|
|
479
|
+
|
|
480
|
+
<a id="handlerunitteststatus-compact"></a>
|
|
481
|
+
#### HandlerUnitTestStatus (Compact)
|
|
482
|
+
**Description:** ABAP Unit status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON.
|
|
483
|
+
|
|
484
|
+
**Source:** `src/handlers/compact/high/handleHandlerUnitTestStatus.ts`
|
|
485
|
+
|
|
486
|
+
**Parameters:**
|
|
487
|
+
- `run_id` (string, required) - Unit test run id.
|
|
488
|
+
- `with_long_polling` (boolean, optional (default: true)) - Use long polling while waiting for completion.
|
|
489
|
+
|
|
490
|
+
---
|
|
491
|
+
|
|
492
|
+
<a id="handlerunlock-compact"></a>
|
|
493
|
+
#### HandlerUnlock (Compact)
|
|
494
|
+
**Description:** Unlock operation. object_type required: CLASS(object_name*, lock_handle*, session_id*), PROGRAM(object_name*, lock_handle*, session_id*), INTERFACE(object_name*, lock_handle*, session_id*), FUNCTION_GROUP(object_name*, lock_handle*, session_id*), FUNCTION_MODULE(object_name*, lock_handle*, session_id*), TABLE(object_name*, lock_handle*, session_id*), STRUCTURE(object_name*, lock_handle*, session_id*), VIEW(object_name*, lock_handle*, session_id*), DOMAIN(object_name*, lock_handle*, session_id*), DATA_ELEMENT(object_name*, lock_handle*, session_id*), PACKAGE(object_name*, lock_handle*, session_id*), BEHAVIOR_DEFINITION(object_name*, lock_handle*, session_id*), BEHAVIOR_IMPLEMENTATION(object_name*, lock_handle*, session_id*), METADATA_EXTENSION(object_name*, lock_handle*, session_id*).
|
|
495
|
+
|
|
496
|
+
**Source:** `src/handlers/compact/high/handleHandlerUnlock.ts`
|
|
497
|
+
|
|
498
|
+
**Parameters:**
|
|
499
|
+
- `lock_handle` (string, required) - Lock handle returned by lock.
|
|
500
|
+
- `session_id` (string, required) - ADT session id used during lock.
|
|
501
|
+
- `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful unlock flow.
|
|
502
|
+
|
|
503
|
+
---
|
|
504
|
+
|
|
505
|
+
<a id="handlerupdate-compact"></a>
|
|
506
|
+
#### HandlerUpdate (Compact)
|
|
507
|
+
**Description:** Update operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*).
|
|
508
|
+
|
|
509
|
+
**Source:** `src/handlers/compact/high/handleHandlerUpdate.ts`
|
|
510
|
+
|
|
511
|
+
**Parameters:**
|
|
512
|
+
- `activate` (boolean, optional) - Activate object after update.
|
|
513
|
+
- `class_name` (string, optional) - ABAP class name.
|
|
514
|
+
- `conversion_exit` (string, optional) - Conversion exit name.
|
|
515
|
+
- `datatype` (string, optional) - ABAP data type.
|
|
516
|
+
- `decimals` (number, optional) - Decimal places.
|
|
517
|
+
- `description` (string, optional) - Human-readable object description.
|
|
518
|
+
- `domain_name` (string, optional) - ABAP domain name.
|
|
519
|
+
- `fixed_values` (array, optional) - Domain fixed values list.
|
|
520
|
+
- `function_group_name` (string, optional) - ABAP function group name.
|
|
521
|
+
- `function_module_name` (string, optional) - ABAP function module name.
|
|
522
|
+
- `length` (number, optional) - Length for typed artifacts.
|
|
523
|
+
- `lowercase` (boolean, optional) - Allow lowercase values (domain setting).
|
|
524
|
+
- `object_type` (any, required) -
|
|
525
|
+
- `package_name` (string, optional) - ABAP package name.
|
|
526
|
+
- `program_name` (string, optional) - ABAP program name.
|
|
527
|
+
- `sign_exists` (boolean, optional) - Allow signed values (domain setting).
|
|
528
|
+
- `source_code` (string, optional) - ABAP source code payload.
|
|
529
|
+
- `transport_request` (string, optional) - Transport request id (if required by system).
|
|
530
|
+
- `value_table` (string, optional) - Foreign key value table.
|
|
531
|
+
|
|
532
|
+
---
|
|
533
|
+
|
|
534
|
+
<a id="handlervalidate-compact"></a>
|
|
535
|
+
#### HandlerValidate (Compact)
|
|
536
|
+
**Description:** Validate before create only. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*), SERVICE_BINDING(object_name*=service_binding_name*, service_definition_name*).
|
|
537
|
+
|
|
538
|
+
**Source:** `src/handlers/compact/high/handleHandlerValidate.ts`
|
|
539
|
+
|
|
540
|
+
**Parameters:**
|
|
541
|
+
- `behavior_definition` (string, optional) - Optional behavior definition name, used when validating behavior implementation.
|
|
542
|
+
- `description` (string, optional) - Optional object description used during validation.
|
|
543
|
+
- `implementation_type` (string, optional) - Optional implementation type, used for behavior implementation validation.
|
|
544
|
+
- `object_name` (string, required) - Required object name. For SERVICE_BINDING this is the service binding name.
|
|
545
|
+
- `object_type` (string, required) - Object type to validate before create. Supported: CLASS, PROGRAM, INTERFACE, FUNCTION_GROUP, FUNCTION_MODULE, TABLE, STRUCTURE, VIEW, DOMAIN, DATA_ELEMENT, PACKAGE, BEHAVIOR_DEFINITION, BEHAVIOR_IMPLEMENTATION, METADATA_EXTENSION, SERVICE_BINDING.
|
|
546
|
+
- `package_name` (string, optional) - Optional package context for validation (especially for create scenarios).
|
|
547
|
+
- `root_entity` (string, optional) - Optional CDS root entity name, used for behavior-related validation.
|
|
548
|
+
- `service_binding_version` (string, optional) - Optional service binding version for SERVICE_BINDING.
|
|
549
|
+
- `service_definition_name` (string, optional) - Required when object_type=SERVICE_BINDING. Service definition paired with the binding.
|
|
550
|
+
- `session_id` (string, optional) - Optional ADT session id for stateful validation flow.
|
|
551
|
+
- `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful validation flow.
|
|
552
|
+
|
|
553
|
+
---
|
|
554
|
+
|
|
555
|
+
*Last updated: 2026-02-21*
|