@mcp-abap-adt/core 2.2.5 → 2.2.7
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 +18 -0
- package/README.md +27 -10
- package/dist/handlers/function/high/handleUpdateFunctionModule.d.ts.map +1 -1
- package/dist/handlers/function/high/handleUpdateFunctionModule.js +31 -1
- package/dist/handlers/function/high/handleUpdateFunctionModule.js.map +1 -1
- package/dist/handlers/function/low/handleLockFunctionModule.d.ts.map +1 -1
- package/dist/handlers/function/low/handleLockFunctionModule.js +4 -2
- package/dist/handlers/function/low/handleLockFunctionModule.js.map +1 -1
- package/dist/handlers/function/low/handleUpdateFunctionModule.d.ts +6 -1
- package/dist/handlers/function/low/handleUpdateFunctionModule.d.ts.map +1 -1
- package/dist/handlers/function/low/handleUpdateFunctionModule.js +12 -3
- package/dist/handlers/function/low/handleUpdateFunctionModule.js.map +1 -1
- package/dist/handlers/function/readonly/handleGetFunction.d.ts +1 -1
- package/dist/handlers/function/readonly/handleGetFunction.d.ts.map +1 -1
- package/dist/handlers/function/readonly/handleGetFunction.js +9 -7
- package/dist/handlers/function/readonly/handleGetFunction.js.map +1 -1
- package/dist/handlers/function_module/high/handleDeleteFunctionModule.d.ts +6 -1
- package/dist/handlers/function_module/high/handleDeleteFunctionModule.d.ts.map +1 -1
- package/dist/handlers/function_module/high/handleDeleteFunctionModule.js +12 -5
- package/dist/handlers/function_module/high/handleDeleteFunctionModule.js.map +1 -1
- package/dist/handlers/function_module/high/handleGetFunctionModule.d.ts +6 -1
- package/dist/handlers/function_module/high/handleGetFunctionModule.d.ts.map +1 -1
- package/dist/handlers/function_module/high/handleGetFunctionModule.js +12 -6
- package/dist/handlers/function_module/high/handleGetFunctionModule.js.map +1 -1
- package/dist/lib/config/ArgumentsParser.d.ts.map +1 -1
- package/dist/lib/config/ArgumentsParser.js +20 -21
- package/dist/lib/config/ArgumentsParser.js.map +1 -1
- package/dist/lib/config/ServerConfigManager.d.ts.map +1 -1
- package/dist/lib/config/ServerConfigManager.js +8 -3
- package/dist/lib/config/ServerConfigManager.js.map +1 -1
- package/dist/lib/config/envResolver.d.ts +6 -0
- package/dist/lib/config/envResolver.d.ts.map +1 -0
- package/dist/lib/config/envResolver.js +84 -0
- package/dist/lib/config/envResolver.js.map +1 -0
- package/dist/lib/config/runtimeConfig.d.ts.map +1 -1
- package/dist/lib/config/runtimeConfig.js +27 -14
- package/dist/lib/config/runtimeConfig.js.map +1 -1
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +10 -6
- package/dist/lib/utils.js.map +1 -1
- package/dist/server/launcher.js +1 -1
- package/docs/installation/INSTALLATION.md +17 -12
- package/docs/user-guide/AUTHENTICATION.md +3 -2
- package/docs/user-guide/AVAILABLE_TOOLS.md +815 -526
- package/docs/user-guide/AVAILABLE_TOOLS_HIGH.md +1417 -0
- package/docs/user-guide/AVAILABLE_TOOLS_LOW.md +1945 -0
- package/docs/user-guide/AVAILABLE_TOOLS_READONLY.md +405 -0
- package/docs/user-guide/CLIENT_CONFIGURATION.md +24 -16
- package/docs/user-guide/CLI_OPTIONS.md +28 -22
- package/docs/user-guide/HANDLERS_MANAGEMENT.md +5 -5
- package/docs/user-guide/README.md +12 -6
- package/package.json +1 -1
|
@@ -0,0 +1,1945 @@
|
|
|
1
|
+
# Low-Level Tools - MCP ABAP ADT Server
|
|
2
|
+
|
|
3
|
+
Generated from code in `src/handlers/**` (not from docs).
|
|
4
|
+
|
|
5
|
+
- Level: Low-Level
|
|
6
|
+
- Total tools: 122
|
|
7
|
+
|
|
8
|
+
## Navigation
|
|
9
|
+
|
|
10
|
+
- [Low-Level Group](#low-level-group)
|
|
11
|
+
- [Behavior Definition](#low-level-behavior-definition)
|
|
12
|
+
- [ActivateBehaviorDefinitionLow](#activatebehaviordefinitionlow-low-level-behavior-definition)
|
|
13
|
+
- [CheckBdefLow](#checkbdeflow-low-level-behavior-definition)
|
|
14
|
+
- [CreateBehaviorDefinitionLow](#createbehaviordefinitionlow-low-level-behavior-definition)
|
|
15
|
+
- [DeleteBehaviorDefinitionLow](#deletebehaviordefinitionlow-low-level-behavior-definition)
|
|
16
|
+
- [LockBehaviorDefinitionLow](#lockbehaviordefinitionlow-low-level-behavior-definition)
|
|
17
|
+
- [UnlockBehaviorDefinitionLow](#unlockbehaviordefinitionlow-low-level-behavior-definition)
|
|
18
|
+
- [UpdateBehaviorDefinitionLow](#updatebehaviordefinitionlow-low-level-behavior-definition)
|
|
19
|
+
- [ValidateBehaviorDefinitionLow](#validatebehaviordefinitionlow-low-level-behavior-definition)
|
|
20
|
+
- [Behavior Implementation](#low-level-behavior-implementation)
|
|
21
|
+
- [CreateBehaviorImplementationLow](#createbehaviorimplementationlow-low-level-behavior-implementation)
|
|
22
|
+
- [LockBehaviorImplementationLow](#lockbehaviorimplementationlow-low-level-behavior-implementation)
|
|
23
|
+
- [ValidateBehaviorImplementationLow](#validatebehaviorimplementationlow-low-level-behavior-implementation)
|
|
24
|
+
- [Class](#low-level-class)
|
|
25
|
+
- [ActivateClassLow](#activateclasslow-low-level-class)
|
|
26
|
+
- [ActivateClassTestClassesLow](#activateclasstestclasseslow-low-level-class)
|
|
27
|
+
- [CheckClassLow](#checkclasslow-low-level-class)
|
|
28
|
+
- [CreateClassLow](#createclasslow-low-level-class)
|
|
29
|
+
- [DeleteClassLow](#deleteclasslow-low-level-class)
|
|
30
|
+
- [GetClassUnitTestResultLow](#getclassunittestresultlow-low-level-class)
|
|
31
|
+
- [GetClassUnitTestStatusLow](#getclassunitteststatuslow-low-level-class)
|
|
32
|
+
- [LockClassLow](#lockclasslow-low-level-class)
|
|
33
|
+
- [LockClassTestClassesLow](#lockclasstestclasseslow-low-level-class)
|
|
34
|
+
- [RunClassUnitTestsLow](#runclassunittestslow-low-level-class)
|
|
35
|
+
- [UnlockClassLow](#unlockclasslow-low-level-class)
|
|
36
|
+
- [UnlockClassTestClassesLow](#unlockclasstestclasseslow-low-level-class)
|
|
37
|
+
- [UpdateClassLow](#updateclasslow-low-level-class)
|
|
38
|
+
- [UpdateClassTestClassesLow](#updateclasstestclasseslow-low-level-class)
|
|
39
|
+
- [ValidateClassLow](#validateclasslow-low-level-class)
|
|
40
|
+
- [Common](#low-level-common)
|
|
41
|
+
- [ActivateObjectLow](#activateobjectlow-low-level-common)
|
|
42
|
+
- [CheckObjectLow](#checkobjectlow-low-level-common)
|
|
43
|
+
- [DeleteObjectLow](#deleteobjectlow-low-level-common)
|
|
44
|
+
- [LockObjectLow](#lockobjectlow-low-level-common)
|
|
45
|
+
- [UnlockObjectLow](#unlockobjectlow-low-level-common)
|
|
46
|
+
- [ValidateObjectLow](#validateobjectlow-low-level-common)
|
|
47
|
+
- [Data Element](#low-level-data-element)
|
|
48
|
+
- [ActivateDataElementLow](#activatedataelementlow-low-level-data-element)
|
|
49
|
+
- [CheckDataElementLow](#checkdataelementlow-low-level-data-element)
|
|
50
|
+
- [CreateDataElementLow](#createdataelementlow-low-level-data-element)
|
|
51
|
+
- [DeleteDataElementLow](#deletedataelementlow-low-level-data-element)
|
|
52
|
+
- [LockDataElementLow](#lockdataelementlow-low-level-data-element)
|
|
53
|
+
- [UnlockDataElementLow](#unlockdataelementlow-low-level-data-element)
|
|
54
|
+
- [UpdateDataElementLow](#updatedataelementlow-low-level-data-element)
|
|
55
|
+
- [ValidateDataElementLow](#validatedataelementlow-low-level-data-element)
|
|
56
|
+
- [Ddlx](#low-level-ddlx)
|
|
57
|
+
- [ActivateMetadataExtensionLow](#activatemetadataextensionlow-low-level-ddlx)
|
|
58
|
+
- [CheckMetadataExtensionLow](#checkmetadataextensionlow-low-level-ddlx)
|
|
59
|
+
- [CreateMetadataExtensionLow](#createmetadataextensionlow-low-level-ddlx)
|
|
60
|
+
- [DeleteMetadataExtensionLow](#deletemetadataextensionlow-low-level-ddlx)
|
|
61
|
+
- [LockMetadataExtensionLow](#lockmetadataextensionlow-low-level-ddlx)
|
|
62
|
+
- [UnlockMetadataExtensionLow](#unlockmetadataextensionlow-low-level-ddlx)
|
|
63
|
+
- [UpdateMetadataExtensionLow](#updatemetadataextensionlow-low-level-ddlx)
|
|
64
|
+
- [ValidateMetadataExtensionLow](#validatemetadataextensionlow-low-level-ddlx)
|
|
65
|
+
- [Domain](#low-level-domain)
|
|
66
|
+
- [ActivateDomainLow](#activatedomainlow-low-level-domain)
|
|
67
|
+
- [CheckDomainLow](#checkdomainlow-low-level-domain)
|
|
68
|
+
- [CreateDomainLow](#createdomainlow-low-level-domain)
|
|
69
|
+
- [DeleteDomainLow](#deletedomainlow-low-level-domain)
|
|
70
|
+
- [LockDomainLow](#lockdomainlow-low-level-domain)
|
|
71
|
+
- [UnlockDomainLow](#unlockdomainlow-low-level-domain)
|
|
72
|
+
- [UpdateDomainLow](#updatedomainlow-low-level-domain)
|
|
73
|
+
- [ValidateDomainLow](#validatedomainlow-low-level-domain)
|
|
74
|
+
- [Function](#low-level-function)
|
|
75
|
+
- [ActivateFunctionGroupLow](#activatefunctiongrouplow-low-level-function)
|
|
76
|
+
- [ActivateFunctionModuleLow](#activatefunctionmodulelow-low-level-function)
|
|
77
|
+
- [CheckFunctionGroupLow](#checkfunctiongrouplow-low-level-function)
|
|
78
|
+
- [CheckFunctionModuleLow](#checkfunctionmodulelow-low-level-function)
|
|
79
|
+
- [CreateFunctionGroupLow](#createfunctiongrouplow-low-level-function)
|
|
80
|
+
- [CreateFunctionModuleLow](#createfunctionmodulelow-low-level-function)
|
|
81
|
+
- [DeleteFunctionGroupLow](#deletefunctiongrouplow-low-level-function)
|
|
82
|
+
- [DeleteFunctionModuleLow](#deletefunctionmodulelow-low-level-function)
|
|
83
|
+
- [LockFunctionGroupLow](#lockfunctiongrouplow-low-level-function)
|
|
84
|
+
- [LockFunctionModuleLow](#lockfunctionmodulelow-low-level-function)
|
|
85
|
+
- [UnlockFunctionGroupLow](#unlockfunctiongrouplow-low-level-function)
|
|
86
|
+
- [UnlockFunctionModuleLow](#unlockfunctionmodulelow-low-level-function)
|
|
87
|
+
- [UpdateFunctionModuleLow](#updatefunctionmodulelow-low-level-function)
|
|
88
|
+
- [ValidateFunctionGroupLow](#validatefunctiongrouplow-low-level-function)
|
|
89
|
+
- [ValidateFunctionModuleLow](#validatefunctionmodulelow-low-level-function)
|
|
90
|
+
- [Interface](#low-level-interface)
|
|
91
|
+
- [ActivateInterfaceLow](#activateinterfacelow-low-level-interface)
|
|
92
|
+
- [CheckInterfaceLow](#checkinterfacelow-low-level-interface)
|
|
93
|
+
- [CreateInterfaceLow](#createinterfacelow-low-level-interface)
|
|
94
|
+
- [DeleteInterfaceLow](#deleteinterfacelow-low-level-interface)
|
|
95
|
+
- [LockInterfaceLow](#lockinterfacelow-low-level-interface)
|
|
96
|
+
- [UnlockInterfaceLow](#unlockinterfacelow-low-level-interface)
|
|
97
|
+
- [UpdateInterfaceLow](#updateinterfacelow-low-level-interface)
|
|
98
|
+
- [ValidateInterfaceLow](#validateinterfacelow-low-level-interface)
|
|
99
|
+
- [Package](#low-level-package)
|
|
100
|
+
- [CheckPackageLow](#checkpackagelow-low-level-package)
|
|
101
|
+
- [CreatePackageLow](#createpackagelow-low-level-package)
|
|
102
|
+
- [DeletePackageLow](#deletepackagelow-low-level-package)
|
|
103
|
+
- [LockPackageLow](#lockpackagelow-low-level-package)
|
|
104
|
+
- [UnlockPackageLow](#unlockpackagelow-low-level-package)
|
|
105
|
+
- [UpdatePackageLow](#updatepackagelow-low-level-package)
|
|
106
|
+
- [ValidatePackageLow](#validatepackagelow-low-level-package)
|
|
107
|
+
- [Program](#low-level-program)
|
|
108
|
+
- [ActivateProgramLow](#activateprogramlow-low-level-program)
|
|
109
|
+
- [CheckProgramLow](#checkprogramlow-low-level-program)
|
|
110
|
+
- [CreateProgramLow](#createprogramlow-low-level-program)
|
|
111
|
+
- [DeleteProgramLow](#deleteprogramlow-low-level-program)
|
|
112
|
+
- [LockProgramLow](#lockprogramlow-low-level-program)
|
|
113
|
+
- [UnlockProgramLow](#unlockprogramlow-low-level-program)
|
|
114
|
+
- [UpdateProgramLow](#updateprogramlow-low-level-program)
|
|
115
|
+
- [ValidateProgramLow](#validateprogramlow-low-level-program)
|
|
116
|
+
- [Structure](#low-level-structure)
|
|
117
|
+
- [ActivateStructureLow](#activatestructurelow-low-level-structure)
|
|
118
|
+
- [CheckStructureLow](#checkstructurelow-low-level-structure)
|
|
119
|
+
- [CreateStructureLow](#createstructurelow-low-level-structure)
|
|
120
|
+
- [DeleteStructureLow](#deletestructurelow-low-level-structure)
|
|
121
|
+
- [LockStructureLow](#lockstructurelow-low-level-structure)
|
|
122
|
+
- [UnlockStructureLow](#unlockstructurelow-low-level-structure)
|
|
123
|
+
- [UpdateStructureLow](#updatestructurelow-low-level-structure)
|
|
124
|
+
- [ValidateStructureLow](#validatestructurelow-low-level-structure)
|
|
125
|
+
- [System](#low-level-system)
|
|
126
|
+
- [GetNodeStructureLow](#getnodestructurelow-low-level-system)
|
|
127
|
+
- [GetObjectStructureLow](#getobjectstructurelow-low-level-system)
|
|
128
|
+
- [GetVirtualFoldersLow](#getvirtualfolderslow-low-level-system)
|
|
129
|
+
- [Table](#low-level-table)
|
|
130
|
+
- [ActivateTableLow](#activatetablelow-low-level-table)
|
|
131
|
+
- [CheckTableLow](#checktablelow-low-level-table)
|
|
132
|
+
- [CreateTableLow](#createtablelow-low-level-table)
|
|
133
|
+
- [DeleteTableLow](#deletetablelow-low-level-table)
|
|
134
|
+
- [LockTableLow](#locktablelow-low-level-table)
|
|
135
|
+
- [UnlockTableLow](#unlocktablelow-low-level-table)
|
|
136
|
+
- [UpdateTableLow](#updatetablelow-low-level-table)
|
|
137
|
+
- [ValidateTableLow](#validatetablelow-low-level-table)
|
|
138
|
+
- [Transport](#low-level-transport)
|
|
139
|
+
- [CreateTransportLow](#createtransportlow-low-level-transport)
|
|
140
|
+
- [View](#low-level-view)
|
|
141
|
+
- [ActivateViewLow](#activateviewlow-low-level-view)
|
|
142
|
+
- [CheckViewLow](#checkviewlow-low-level-view)
|
|
143
|
+
- [CreateViewLow](#createviewlow-low-level-view)
|
|
144
|
+
- [DeleteViewLow](#deleteviewlow-low-level-view)
|
|
145
|
+
- [LockViewLow](#lockviewlow-low-level-view)
|
|
146
|
+
- [UnlockViewLow](#unlockviewlow-low-level-view)
|
|
147
|
+
- [UpdateViewLow](#updateviewlow-low-level-view)
|
|
148
|
+
- [ValidateViewLow](#validateviewlow-low-level-view)
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
<a id="low-level-group"></a>
|
|
153
|
+
## Low-Level Group
|
|
154
|
+
|
|
155
|
+
<a id="low-level-behavior-definition"></a>
|
|
156
|
+
### Low-Level / Behavior Definition
|
|
157
|
+
|
|
158
|
+
<a id="activatebehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
159
|
+
#### ActivateBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
160
|
+
**Description:** [low-level] Activate an ABAP behavior definition. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
161
|
+
|
|
162
|
+
**Source:** `src/handlers/behavior_definition/low/handleActivateBehaviorDefinition.ts`
|
|
163
|
+
|
|
164
|
+
**Parameters:**
|
|
165
|
+
- `name` (string, required) - Behavior definition name (root entity, e.g., ZI_MY_ENTITY).
|
|
166
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
167
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
<a id="checkbdeflow-low-level-behavior-definition"></a>
|
|
172
|
+
#### CheckBdefLow (Low-Level / Behavior Definition)
|
|
173
|
+
**Description:** [low-level] Perform syntax check on an ABAP behavior definition. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
174
|
+
|
|
175
|
+
**Source:** `src/handlers/behavior_definition/low/handleCheckBehaviorDefinition.ts`
|
|
176
|
+
|
|
177
|
+
**Parameters:**
|
|
178
|
+
- `name` (string, required) - BehaviorDefinition name (e.g., Z_MY_PROGRAM).
|
|
179
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
180
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
<a id="createbehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
185
|
+
#### CreateBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
186
|
+
**Description:** [low-level] Create a new ABAP Behavior Definition. - use CreateBehaviorDefinition (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
187
|
+
|
|
188
|
+
**Source:** `src/handlers/behavior_definition/low/handleCreateBehaviorDefinition.ts`
|
|
189
|
+
|
|
190
|
+
**Parameters:**
|
|
191
|
+
- `description` (string, required) - Behavior Definition description.
|
|
192
|
+
- `implementation_type` (string, required) - Implementation type:
|
|
193
|
+
- `name` (string, required) - Behavior Definition name (e.g., ZI_MY_BDEF).
|
|
194
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
195
|
+
- `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY).
|
|
196
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
197
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
198
|
+
- `transport_request` (string, required) - Transport request number (e.g., E19K905635). Required.
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
<a id="deletebehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
203
|
+
#### DeleteBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
204
|
+
**Description:** [low-level] Delete an ABAP behavior definition from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
205
|
+
|
|
206
|
+
**Source:** `src/handlers/behavior_definition/low/handleDeleteBehaviorDefinition.ts`
|
|
207
|
+
|
|
208
|
+
**Parameters:**
|
|
209
|
+
- `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF).
|
|
210
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
<a id="lockbehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
215
|
+
#### LockBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
216
|
+
**Description:** [low-level] Lock an ABAP behavior definition for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
217
|
+
|
|
218
|
+
**Source:** `src/handlers/behavior_definition/low/handleLockBehaviorDefinition.ts`
|
|
219
|
+
|
|
220
|
+
**Parameters:**
|
|
221
|
+
- `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF).
|
|
222
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
223
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
<a id="unlockbehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
228
|
+
#### UnlockBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
229
|
+
**Description:** [low-level] Unlock an ABAP behavior definition after modification. Must use the same session_id and lock_handle from LockBehaviorDefinition operation.
|
|
230
|
+
|
|
231
|
+
**Source:** `src/handlers/behavior_definition/low/handleUnlockBehaviorDefinition.ts`
|
|
232
|
+
|
|
233
|
+
**Parameters:**
|
|
234
|
+
- `lock_handle` (string, required) - Lock handle from LockBehaviorDefinition operation.
|
|
235
|
+
- `name` (string, required) - BehaviorDefinition name (e.g., ZI_MY_BDEF).
|
|
236
|
+
- `session_id` (string, required) - Session ID from LockBehaviorDefinition operation. Must be the same as used in LockBehaviorDefinition.
|
|
237
|
+
- `session_state` (object, optional) - Session state from LockBehaviorDefinition (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
<a id="updatebehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
242
|
+
#### UpdateBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
243
|
+
**Description:** [low-level] Update source code of an existing ABAP behavior definition. Requires lock handle from LockObject. - use UpdateBehaviorDefinition (high-level) for full workflow with lock/unlock/activate.
|
|
244
|
+
|
|
245
|
+
**Source:** `src/handlers/behavior_definition/low/handleUpdateBehaviorDefinition.ts`
|
|
246
|
+
|
|
247
|
+
**Parameters:**
|
|
248
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
249
|
+
- `name` (string, required) - Behavior definition name (e.g., ZOK_C_TEST_0001). Behavior definition must already exist.
|
|
250
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
251
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
252
|
+
- `source_code` (string, required) - Complete behavior definition source code.
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
<a id="validatebehaviordefinitionlow-low-level-behavior-definition"></a>
|
|
257
|
+
#### ValidateBehaviorDefinitionLow (Low-Level / Behavior Definition)
|
|
258
|
+
**Description:** [low-level] Validate an ABAP behavior definition name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
259
|
+
|
|
260
|
+
**Source:** `src/handlers/behavior_definition/low/handleValidateBehaviorDefinition.ts`
|
|
261
|
+
|
|
262
|
+
**Parameters:**
|
|
263
|
+
- `description` (string, required) - BehaviorDefinition description. Required for validation.
|
|
264
|
+
- `implementation_type` (string, required) - Implementation type:
|
|
265
|
+
- `name` (string, required) - BehaviorDefinition name to validate (e.g., ZI_MY_BDEF).
|
|
266
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
267
|
+
- `root_entity` (string, required) - Root entity name (e.g., ZI_MY_ENTITY). Required for validation.
|
|
268
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
269
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
<a id="low-level-behavior-implementation"></a>
|
|
274
|
+
### Low-Level / Behavior Implementation
|
|
275
|
+
|
|
276
|
+
<a id="createbehaviorimplementationlow-low-level-behavior-implementation"></a>
|
|
277
|
+
#### CreateBehaviorImplementationLow (Low-Level / Behavior Implementation)
|
|
278
|
+
**Description:** [low-level] Create a new ABAP behavior implementation class with full workflow (create, lock, update main source, update implementations, unlock, activate). - use CreateBehaviorImplementation (high-level) for additional validation.
|
|
279
|
+
|
|
280
|
+
**Source:** `src/handlers/behavior_implementation/low/handleCreateBehaviorImplementation.ts`
|
|
281
|
+
|
|
282
|
+
**Parameters:**
|
|
283
|
+
- `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Required.
|
|
284
|
+
- `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must follow SAP naming conventions.
|
|
285
|
+
- `description` (string, required) - Class description.
|
|
286
|
+
- `implementation_code` (string, optional) - Implementation code for the implementations include (optional).
|
|
287
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
288
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
289
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
290
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
<a id="lockbehaviorimplementationlow-low-level-behavior-implementation"></a>
|
|
295
|
+
#### LockBehaviorImplementationLow (Low-Level / Behavior Implementation)
|
|
296
|
+
**Description:** [low-level] Lock an ABAP behavior implementation class for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
297
|
+
|
|
298
|
+
**Source:** `src/handlers/behavior_implementation/low/handleLockBehaviorImplementation.ts`
|
|
299
|
+
|
|
300
|
+
**Parameters:**
|
|
301
|
+
- `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY).
|
|
302
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
303
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
<a id="validatebehaviorimplementationlow-low-level-behavior-implementation"></a>
|
|
308
|
+
#### ValidateBehaviorImplementationLow (Low-Level / Behavior Implementation)
|
|
309
|
+
**Description:** [low-level] Validate an ABAP behavior implementation class name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
310
|
+
|
|
311
|
+
**Source:** `src/handlers/behavior_implementation/low/handleValidateBehaviorImplementation.ts`
|
|
312
|
+
|
|
313
|
+
**Parameters:**
|
|
314
|
+
- `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Required for validation.
|
|
315
|
+
- `class_name` (string, required) - Behavior Implementation class name to validate (e.g., ZBP_MY_ENTITY).
|
|
316
|
+
- `description` (string, required) - Class description. Required for validation.
|
|
317
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
318
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
319
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
320
|
+
|
|
321
|
+
---
|
|
322
|
+
|
|
323
|
+
<a id="low-level-class"></a>
|
|
324
|
+
### Low-Level / Class
|
|
325
|
+
|
|
326
|
+
<a id="activateclasslow-low-level-class"></a>
|
|
327
|
+
#### ActivateClassLow (Low-Level / Class)
|
|
328
|
+
**Description:** [low-level] Activate an ABAP class. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
329
|
+
|
|
330
|
+
**Source:** `src/handlers/class/low/handleActivateClass.ts`
|
|
331
|
+
|
|
332
|
+
**Parameters:**
|
|
333
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
334
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
335
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
<a id="activateclasstestclasseslow-low-level-class"></a>
|
|
340
|
+
#### ActivateClassTestClassesLow (Low-Level / Class)
|
|
341
|
+
**Description:** [low-level] Activate ABAP Unit test classes include for an existing class. Should be executed after updating and unlocking test classes.
|
|
342
|
+
|
|
343
|
+
**Source:** `src/handlers/class/low/handleActivateClassTestClasses.ts`
|
|
344
|
+
|
|
345
|
+
**Parameters:**
|
|
346
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
347
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
348
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
349
|
+
- `test_class_name` (string, optional) - Optional ABAP Unit test class name (e.g., LTCL_MY_CLASS). Defaults to auto-detected value.
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
<a id="checkclasslow-low-level-class"></a>
|
|
354
|
+
#### CheckClassLow (Low-Level / Class)
|
|
355
|
+
**Description:** [low-level] Perform syntax check on an ABAP class. Can check existing class (active/inactive) or hypothetical source code. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
356
|
+
|
|
357
|
+
**Source:** `src/handlers/class/low/handleCheckClass.ts`
|
|
358
|
+
|
|
359
|
+
**Parameters:**
|
|
360
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS)
|
|
361
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
362
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
363
|
+
- `source_code` (string, optional) - Optional: source code to validate. If provided, validates hypothetical code without creating object. Must include complete CLASS DEFINITION and IMPLEMENTATION sections.
|
|
364
|
+
- `version` (string, optional) - Version to check:
|
|
365
|
+
|
|
366
|
+
---
|
|
367
|
+
|
|
368
|
+
<a id="createclasslow-low-level-class"></a>
|
|
369
|
+
#### CreateClassLow (Low-Level / Class)
|
|
370
|
+
**Description:** [low-level] Create a new ABAP class. - use CreateClass (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
371
|
+
|
|
372
|
+
**Source:** `src/handlers/class/low/handleCreateClass.ts`
|
|
373
|
+
|
|
374
|
+
**Parameters:**
|
|
375
|
+
- `abstract` (boolean, optional (default: false).)) - Mark class as abstract (optional, default: false).
|
|
376
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). Must follow SAP naming conventions.
|
|
377
|
+
- `create_protected` (boolean, optional (default: false).)) - Create protected section (optional, default: false).
|
|
378
|
+
- `description` (string, required) - Class description.
|
|
379
|
+
- `final` (boolean, optional (default: false).)) - Mark class as final (optional, default: false).
|
|
380
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
381
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
382
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
383
|
+
- `superclass` (string, optional) - Superclass name (optional).
|
|
384
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
385
|
+
|
|
386
|
+
---
|
|
387
|
+
|
|
388
|
+
<a id="deleteclasslow-low-level-class"></a>
|
|
389
|
+
#### DeleteClassLow (Low-Level / Class)
|
|
390
|
+
**Description:** [low-level] Delete an ABAP class from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
391
|
+
|
|
392
|
+
**Source:** `src/handlers/class/low/handleDeleteClass.ts`
|
|
393
|
+
|
|
394
|
+
**Parameters:**
|
|
395
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
396
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
397
|
+
|
|
398
|
+
---
|
|
399
|
+
|
|
400
|
+
<a id="getclassunittestresultlow-low-level-class"></a>
|
|
401
|
+
#### GetClassUnitTestResultLow (Low-Level / Class)
|
|
402
|
+
**Description:** [low-level] Retrieve ABAP Unit run result (ABAPUnit or JUnit XML) for a completed run_id.
|
|
403
|
+
|
|
404
|
+
**Source:** `src/handlers/class/low/handleGetClassUnitTestResult.ts`
|
|
405
|
+
|
|
406
|
+
**Parameters:**
|
|
407
|
+
- `format` (string, optional) - Preferred response format. Defaults to
|
|
408
|
+
- `run_id` (string, required) - Run identifier returned by RunClassUnitTestsLow.
|
|
409
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
410
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
411
|
+
- `with_navigation_uris` (boolean, optional) - Optional flag to request navigation URIs in SAP response (default true).
|
|
412
|
+
|
|
413
|
+
---
|
|
414
|
+
|
|
415
|
+
<a id="getclassunitteststatuslow-low-level-class"></a>
|
|
416
|
+
#### GetClassUnitTestStatusLow (Low-Level / Class)
|
|
417
|
+
**Description:** [low-level] Retrieve ABAP Unit run status XML for a previously started run_id.
|
|
418
|
+
|
|
419
|
+
**Source:** `src/handlers/class/low/handleGetClassUnitTestStatus.ts`
|
|
420
|
+
|
|
421
|
+
**Parameters:**
|
|
422
|
+
- `run_id` (string, required) - Run identifier returned by RunClassUnitTestsLow.
|
|
423
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
424
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
425
|
+
- `with_long_polling` (boolean, optional) - Optional flag to enable SAP long-polling (default true).
|
|
426
|
+
|
|
427
|
+
---
|
|
428
|
+
|
|
429
|
+
<a id="lockclasslow-low-level-class"></a>
|
|
430
|
+
#### LockClassLow (Low-Level / Class)
|
|
431
|
+
**Description:** [low-level] Lock an ABAP class for modification. Uses session from HandlerContext. Returns lock handle that must be used in subsequent update/unlock operations.
|
|
432
|
+
|
|
433
|
+
**Source:** `src/handlers/class/low/handleLockClass.ts`
|
|
434
|
+
|
|
435
|
+
**Parameters:**
|
|
436
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
437
|
+
|
|
438
|
+
---
|
|
439
|
+
|
|
440
|
+
<a id="lockclasstestclasseslow-low-level-class"></a>
|
|
441
|
+
#### LockClassTestClassesLow (Low-Level / Class)
|
|
442
|
+
**Description:** [low-level] Lock ABAP Unit test classes include (CLAS/OC testclasses) for the specified class. Returns a test_classes_lock_handle for subsequent update/unlock operations using the same session.
|
|
443
|
+
|
|
444
|
+
**Source:** `src/handlers/class/low/handleLockClassTestClasses.ts`
|
|
445
|
+
|
|
446
|
+
**Parameters:**
|
|
447
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
448
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
449
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
450
|
+
|
|
451
|
+
---
|
|
452
|
+
|
|
453
|
+
<a id="runclassunittestslow-low-level-class"></a>
|
|
454
|
+
#### RunClassUnitTestsLow (Low-Level / Class)
|
|
455
|
+
**Description:** [low-level] Start an ABAP Unit test run for provided class test definitions. Returns run_id extracted from SAP response headers.
|
|
456
|
+
|
|
457
|
+
**Source:** `src/handlers/class/low/handleRunClassUnitTests.ts`
|
|
458
|
+
|
|
459
|
+
**Parameters:**
|
|
460
|
+
- `test_class` (string, required) - Test class name inside the include (e.g., LTCL_MAIN_CLASS).
|
|
461
|
+
- `tests` (array, optional) - List of container/test class pairs to execute.
|
|
462
|
+
|
|
463
|
+
---
|
|
464
|
+
|
|
465
|
+
<a id="unlockclasslow-low-level-class"></a>
|
|
466
|
+
#### UnlockClassLow (Low-Level / Class)
|
|
467
|
+
**Description:** [low-level] Unlock an ABAP class after modification. Uses session from HandlerContext. Must use the same lock_handle from LockClass operation.
|
|
468
|
+
|
|
469
|
+
**Source:** `src/handlers/class/low/handleUnlockClass.ts`
|
|
470
|
+
|
|
471
|
+
**Parameters:**
|
|
472
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
473
|
+
- `lock_handle` (string, required) - Lock handle from LockClass operation.
|
|
474
|
+
|
|
475
|
+
---
|
|
476
|
+
|
|
477
|
+
<a id="unlockclasstestclasseslow-low-level-class"></a>
|
|
478
|
+
#### UnlockClassTestClassesLow (Low-Level / Class)
|
|
479
|
+
**Description:** [low-level] Unlock ABAP Unit test classes include for a class using the test_classes_lock_handle obtained from LockClassTestClassesLow.
|
|
480
|
+
|
|
481
|
+
**Source:** `src/handlers/class/low/handleUnlockClassTestClasses.ts`
|
|
482
|
+
|
|
483
|
+
**Parameters:**
|
|
484
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
485
|
+
- `lock_handle` (string, required) - Lock handle returned by LockClassTestClassesLow.
|
|
486
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
487
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
488
|
+
|
|
489
|
+
---
|
|
490
|
+
|
|
491
|
+
<a id="updateclasslow-low-level-class"></a>
|
|
492
|
+
#### UpdateClassLow (Low-Level / Class)
|
|
493
|
+
**Description:** [low-level] Update source code of an existing ABAP class. Uses session from HandlerContext. Requires lock handle from LockClass operation. - use UpdateClass (high-level) for full workflow with lock/unlock/activate.
|
|
494
|
+
|
|
495
|
+
**Source:** `src/handlers/class/low/handleUpdateClass.ts`
|
|
496
|
+
|
|
497
|
+
**Parameters:**
|
|
498
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). Class must already exist.
|
|
499
|
+
- `lock_handle` (string, required) - Lock handle from LockClass operation. Required for update operation.
|
|
500
|
+
- `source_code` (string, required) - Complete ABAP class source code including CLASS DEFINITION and IMPLEMENTATION sections.
|
|
501
|
+
|
|
502
|
+
---
|
|
503
|
+
|
|
504
|
+
<a id="updateclasstestclasseslow-low-level-class"></a>
|
|
505
|
+
#### UpdateClassTestClassesLow (Low-Level / Class)
|
|
506
|
+
**Description:** [low-level] Upload ABAP Unit test include source code for an existing class. Requires test_classes_lock_handle from LockClassTestClassesLow.
|
|
507
|
+
|
|
508
|
+
**Source:** `src/handlers/class/low/handleUpdateClassTestClasses.ts`
|
|
509
|
+
|
|
510
|
+
**Parameters:**
|
|
511
|
+
- `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS).
|
|
512
|
+
- `lock_handle` (string, required) - Test classes lock handle from LockClassTestClassesLow.
|
|
513
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
514
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
515
|
+
- `test_class_source` (string, required) - Complete ABAP Unit test class source code.
|
|
516
|
+
|
|
517
|
+
---
|
|
518
|
+
|
|
519
|
+
<a id="validateclasslow-low-level-class"></a>
|
|
520
|
+
#### ValidateClassLow (Low-Level / Class)
|
|
521
|
+
**Description:** [low-level] Validate an ABAP class name before creation. Checks if the name is valid, available, and validates package, description, and superclass if provided. Can use session_id and session_state from GetSession to maintain the same session.
|
|
522
|
+
|
|
523
|
+
**Source:** `src/handlers/class/low/handleValidateClass.ts`
|
|
524
|
+
|
|
525
|
+
**Parameters:**
|
|
526
|
+
- `class_name` (string, required) - Class name to validate (e.g., ZCL_MY_CLASS)
|
|
527
|
+
- `description` (string, required) - Description for validation (required).
|
|
528
|
+
- `package_name` (string, required) - Package name for validation (required).
|
|
529
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
530
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
531
|
+
- `superclass` (string, optional) - Optional superclass name for validation (e.g., CL_OBJECT)
|
|
532
|
+
|
|
533
|
+
---
|
|
534
|
+
|
|
535
|
+
<a id="low-level-common"></a>
|
|
536
|
+
### Low-Level / Common
|
|
537
|
+
|
|
538
|
+
<a id="activateobjectlow-low-level-common"></a>
|
|
539
|
+
#### ActivateObjectLow (Low-Level / Common)
|
|
540
|
+
**Description:** [low-level] Activate one or multiple ABAP repository objects. Works with any object type; URI is auto-generated from name and type.
|
|
541
|
+
|
|
542
|
+
**Source:** `src/handlers/common/low/handleActivateObject.ts`
|
|
543
|
+
|
|
544
|
+
**Parameters:**
|
|
545
|
+
- `objects` (array, optional) - Array of objects to activate. Each object must have
|
|
546
|
+
|
|
547
|
+
---
|
|
548
|
+
|
|
549
|
+
<a id="checkobjectlow-low-level-common"></a>
|
|
550
|
+
#### CheckObjectLow (Low-Level / Common)
|
|
551
|
+
**Description:** [low-level] Perform syntax check on an ABAP object without activation. Returns syntax errors, warnings, and messages.
|
|
552
|
+
|
|
553
|
+
**Source:** `src/handlers/common/low/handleCheckObject.ts`
|
|
554
|
+
|
|
555
|
+
**Parameters:**
|
|
556
|
+
- `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM)
|
|
557
|
+
- `object_type` (string, required) - Object type
|
|
558
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
559
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
560
|
+
- `version` (string, optional) - Version to check:
|
|
561
|
+
|
|
562
|
+
---
|
|
563
|
+
|
|
564
|
+
<a id="deleteobjectlow-low-level-common"></a>
|
|
565
|
+
#### DeleteObjectLow (Low-Level / Common)
|
|
566
|
+
**Description:** [low-level] Delete an ABAP object via ADT deletion API. Transport request optional for $TMP objects.
|
|
567
|
+
|
|
568
|
+
**Source:** `src/handlers/common/low/handleDeleteObject.ts`
|
|
569
|
+
|
|
570
|
+
**Parameters:**
|
|
571
|
+
- `function_group_name` (string, optional) - Required only for function_module type
|
|
572
|
+
- `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS)
|
|
573
|
+
- `object_type` (string, required) - Object type (class/program/interface/function_group/function_module/table/structure/view/domain/data_element/behavior_definition/metadata_extension)
|
|
574
|
+
- `transport_request` (string, optional) - Transport request number
|
|
575
|
+
|
|
576
|
+
---
|
|
577
|
+
|
|
578
|
+
<a id="lockobjectlow-low-level-common"></a>
|
|
579
|
+
#### LockObjectLow (Low-Level / Common)
|
|
580
|
+
**Description:** [low-level] Lock an ABAP object for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
581
|
+
|
|
582
|
+
**Source:** `src/handlers/common/low/handleLockObject.ts`
|
|
583
|
+
|
|
584
|
+
**Parameters:**
|
|
585
|
+
- `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE). For function modules, use format GROUP|FM_NAME
|
|
586
|
+
- `object_type` (string, required) - Object type
|
|
587
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
588
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
589
|
+
- `super_package` (string, optional) - Super package (required for package locking)
|
|
590
|
+
|
|
591
|
+
---
|
|
592
|
+
|
|
593
|
+
<a id="unlockobjectlow-low-level-common"></a>
|
|
594
|
+
#### UnlockObjectLow (Low-Level / Common)
|
|
595
|
+
**Description:** [low-level] Unlock an ABAP object after modification. Must use the same session_id and lock_handle from the LockObject operation.
|
|
596
|
+
|
|
597
|
+
**Source:** `src/handlers/common/low/handleUnlockObject.ts`
|
|
598
|
+
|
|
599
|
+
**Parameters:**
|
|
600
|
+
- `lock_handle` (string, required) - Lock handle from LockObject operation
|
|
601
|
+
- `object_name` (string, required) - Object name (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE). For function modules, use format GROUP|FM_NAME
|
|
602
|
+
- `object_type` (string, required) - Object type
|
|
603
|
+
- `session_id` (string, required) - Session ID from LockObject operation. Must be the same session.
|
|
604
|
+
- `session_state` (object, optional) - Session state from LockObject (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
605
|
+
|
|
606
|
+
---
|
|
607
|
+
|
|
608
|
+
<a id="validateobjectlow-low-level-common"></a>
|
|
609
|
+
#### ValidateObjectLow (Low-Level / Common)
|
|
610
|
+
**Description:** [low-level] Validate an ABAP object name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
611
|
+
|
|
612
|
+
**Source:** `src/handlers/common/low/handleValidateObject.ts`
|
|
613
|
+
|
|
614
|
+
**Parameters:**
|
|
615
|
+
- `behavior_definition` (string, optional) - Optional behavior definition name (required for behavior_implementation validation)
|
|
616
|
+
- `description` (string, optional) - Optional description for validation
|
|
617
|
+
- `implementation_type` (string, optional) - Implementation type:
|
|
618
|
+
- `object_name` (string, required) - Object name to validate (e.g., ZCL_MY_CLASS, Z_MY_PROGRAM, ZIF_MY_INTERFACE)
|
|
619
|
+
- `object_type` (string, required) - Object type:
|
|
620
|
+
- `package_name` (string, optional) - Optional package name for validation
|
|
621
|
+
- `root_entity` (string, optional) - Root entity name (required for behavior_definition validation)
|
|
622
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
623
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
624
|
+
|
|
625
|
+
---
|
|
626
|
+
|
|
627
|
+
<a id="low-level-data-element"></a>
|
|
628
|
+
### Low-Level / Data Element
|
|
629
|
+
|
|
630
|
+
<a id="activatedataelementlow-low-level-data-element"></a>
|
|
631
|
+
#### ActivateDataElementLow (Low-Level / Data Element)
|
|
632
|
+
**Description:** [low-level] Activate an ABAP data element. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
633
|
+
|
|
634
|
+
**Source:** `src/handlers/data_element/low/handleActivateDataElement.ts`
|
|
635
|
+
|
|
636
|
+
**Parameters:**
|
|
637
|
+
- `data_element_name` (string, required) - Data element name (e.g., ZDT_MY_ELEMENT).
|
|
638
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
639
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
640
|
+
|
|
641
|
+
---
|
|
642
|
+
|
|
643
|
+
<a id="checkdataelementlow-low-level-data-element"></a>
|
|
644
|
+
#### CheckDataElementLow (Low-Level / Data Element)
|
|
645
|
+
**Description:** [low-level] Perform syntax check on an ABAP data element. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
646
|
+
|
|
647
|
+
**Source:** `src/handlers/data_element/low/handleCheckDataElement.ts`
|
|
648
|
+
|
|
649
|
+
**Parameters:**
|
|
650
|
+
- `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM).
|
|
651
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
652
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
653
|
+
|
|
654
|
+
---
|
|
655
|
+
|
|
656
|
+
<a id="createdataelementlow-low-level-data-element"></a>
|
|
657
|
+
#### CreateDataElementLow (Low-Level / Data Element)
|
|
658
|
+
**Description:** [low-level] Create a new ABAP data element. - use CreateDataElement (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
659
|
+
|
|
660
|
+
**Source:** `src/handlers/data_element/low/handleCreateDataElement.ts`
|
|
661
|
+
|
|
662
|
+
**Parameters:**
|
|
663
|
+
- `data_element_name` (string, required) - DataElement name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
664
|
+
- `data_type` (string, optional) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is
|
|
665
|
+
- `decimals` (number, optional) - Decimal places (for predefinedAbapType or refToPredefinedAbapType)
|
|
666
|
+
- `description` (string, required) - DataElement description.
|
|
667
|
+
- `length` (number, optional) - Data type length (for predefinedAbapType or refToPredefinedAbapType)
|
|
668
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
669
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
670
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
671
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
672
|
+
- `type_kind` (string, optional) - Type kind:
|
|
673
|
+
- `type_name` (string, optional) - Type name: domain name (when type_kind is
|
|
674
|
+
|
|
675
|
+
---
|
|
676
|
+
|
|
677
|
+
<a id="deletedataelementlow-low-level-data-element"></a>
|
|
678
|
+
#### DeleteDataElementLow (Low-Level / Data Element)
|
|
679
|
+
**Description:** [low-level] Delete an ABAP data element from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
680
|
+
|
|
681
|
+
**Source:** `src/handlers/data_element/low/handleDeleteDataElement.ts`
|
|
682
|
+
|
|
683
|
+
**Parameters:**
|
|
684
|
+
- `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM).
|
|
685
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
686
|
+
|
|
687
|
+
---
|
|
688
|
+
|
|
689
|
+
<a id="lockdataelementlow-low-level-data-element"></a>
|
|
690
|
+
#### LockDataElementLow (Low-Level / Data Element)
|
|
691
|
+
**Description:** [low-level] Lock an ABAP data element for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
692
|
+
|
|
693
|
+
**Source:** `src/handlers/data_element/low/handleLockDataElement.ts`
|
|
694
|
+
|
|
695
|
+
**Parameters:**
|
|
696
|
+
- `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM).
|
|
697
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
698
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
699
|
+
|
|
700
|
+
---
|
|
701
|
+
|
|
702
|
+
<a id="unlockdataelementlow-low-level-data-element"></a>
|
|
703
|
+
#### UnlockDataElementLow (Low-Level / Data Element)
|
|
704
|
+
**Description:** [low-level] Unlock an ABAP data element after modification. Must use the same session_id and lock_handle from LockDataElement operation.
|
|
705
|
+
|
|
706
|
+
**Source:** `src/handlers/data_element/low/handleUnlockDataElement.ts`
|
|
707
|
+
|
|
708
|
+
**Parameters:**
|
|
709
|
+
- `data_element_name` (string, required) - DataElement name (e.g., Z_MY_PROGRAM).
|
|
710
|
+
- `lock_handle` (string, required) - Lock handle from LockDataElement operation.
|
|
711
|
+
- `session_id` (string, required) - Session ID from LockDataElement operation. Must be the same as used in LockDataElement.
|
|
712
|
+
- `session_state` (object, optional) - Session state from LockDataElement (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
713
|
+
|
|
714
|
+
---
|
|
715
|
+
|
|
716
|
+
<a id="updatedataelementlow-low-level-data-element"></a>
|
|
717
|
+
#### UpdateDataElementLow (Low-Level / Data Element)
|
|
718
|
+
**Description:** [low-level] Update properties of an existing ABAP data element. Requires lock handle from LockObject. - use UpdateDataElement (high-level) for full workflow with lock/unlock/activate.
|
|
719
|
+
|
|
720
|
+
**Source:** `src/handlers/data_element/low/handleUpdateDataElement.ts`
|
|
721
|
+
|
|
722
|
+
**Parameters:**
|
|
723
|
+
- `data_element_name` (string, required) - Data element name (e.g., ZOK_E_TEST_0001). Data element must already exist.
|
|
724
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
725
|
+
- `properties` (object, required) - Data element properties object. Can include: description, type_name, type_kind, data_type, field_label_short, field_label_medium, field_label_long, etc.
|
|
726
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
727
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
728
|
+
|
|
729
|
+
---
|
|
730
|
+
|
|
731
|
+
<a id="validatedataelementlow-low-level-data-element"></a>
|
|
732
|
+
#### ValidateDataElementLow (Low-Level / Data Element)
|
|
733
|
+
**Description:** [low-level] Validate an ABAP data element name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
734
|
+
|
|
735
|
+
**Source:** `src/handlers/data_element/low/handleValidateDataElement.ts`
|
|
736
|
+
|
|
737
|
+
**Parameters:**
|
|
738
|
+
- `data_element_name` (string, required) - DataElement name to validate (e.g., Z_MY_PROGRAM).
|
|
739
|
+
- `description` (string, required) - DataElement description. Required for validation.
|
|
740
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
741
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
742
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
743
|
+
|
|
744
|
+
---
|
|
745
|
+
|
|
746
|
+
<a id="low-level-ddlx"></a>
|
|
747
|
+
### Low-Level / Ddlx
|
|
748
|
+
|
|
749
|
+
<a id="activatemetadataextensionlow-low-level-ddlx"></a>
|
|
750
|
+
#### ActivateMetadataExtensionLow (Low-Level / Ddlx)
|
|
751
|
+
**Description:** [low-level] Activate an ABAP metadata extension. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
752
|
+
|
|
753
|
+
**Source:** `src/handlers/ddlx/low/handleActivateMetadataExtension.ts`
|
|
754
|
+
|
|
755
|
+
**Parameters:**
|
|
756
|
+
- `name` (string, required) - Metadata extension name (e.g., ZC_MY_EXTENSION).
|
|
757
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
758
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
759
|
+
|
|
760
|
+
---
|
|
761
|
+
|
|
762
|
+
<a id="checkmetadataextensionlow-low-level-ddlx"></a>
|
|
763
|
+
#### CheckMetadataExtensionLow (Low-Level / Ddlx)
|
|
764
|
+
**Description:** [low-level] Perform syntax check on an ABAP metadata extension. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
765
|
+
|
|
766
|
+
**Source:** `src/handlers/ddlx/low/handleCheckMetadataExtension.ts`
|
|
767
|
+
|
|
768
|
+
**Parameters:**
|
|
769
|
+
- `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX).
|
|
770
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
771
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
772
|
+
|
|
773
|
+
---
|
|
774
|
+
|
|
775
|
+
<a id="createmetadataextensionlow-low-level-ddlx"></a>
|
|
776
|
+
#### CreateMetadataExtensionLow (Low-Level / Ddlx)
|
|
777
|
+
**Description:** [low-level] Create a new ABAP Metadata Extension. - use CreateMetadataExtension (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
778
|
+
|
|
779
|
+
**Source:** `src/handlers/ddlx/low/handleCreateMetadataExtension.ts`
|
|
780
|
+
|
|
781
|
+
**Parameters:**
|
|
782
|
+
- `description` (string, required) - Metadata Extension description.
|
|
783
|
+
- `master_language` (string, optional) - Master language (optional, e.g.,
|
|
784
|
+
- `name` (string, required) - Metadata Extension name (e.g., ZI_MY_DDLX).
|
|
785
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
786
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
787
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
788
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional for local objects.
|
|
789
|
+
|
|
790
|
+
---
|
|
791
|
+
|
|
792
|
+
<a id="deletemetadataextensionlow-low-level-ddlx"></a>
|
|
793
|
+
#### DeleteMetadataExtensionLow (Low-Level / Ddlx)
|
|
794
|
+
**Description:** [low-level] Delete an ABAP metadata extension from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
795
|
+
|
|
796
|
+
**Source:** `src/handlers/ddlx/low/handleDeleteMetadataExtension.ts`
|
|
797
|
+
|
|
798
|
+
**Parameters:**
|
|
799
|
+
- `name` (string, required) - MetadataExtension name (e.g., ZI_MY_DDLX).
|
|
800
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
801
|
+
|
|
802
|
+
---
|
|
803
|
+
|
|
804
|
+
<a id="lockmetadataextensionlow-low-level-ddlx"></a>
|
|
805
|
+
#### LockMetadataExtensionLow (Low-Level / Ddlx)
|
|
806
|
+
**Description:** [low-level] Lock an ABAP metadata extension for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
807
|
+
|
|
808
|
+
**Source:** `src/handlers/ddlx/low/handleLockMetadataExtension.ts`
|
|
809
|
+
|
|
810
|
+
**Parameters:**
|
|
811
|
+
- `objName` (string, optional) - MetadataExtension name (e.g., Z_MY_PROGRAM).
|
|
812
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
813
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
814
|
+
|
|
815
|
+
---
|
|
816
|
+
|
|
817
|
+
<a id="unlockmetadataextensionlow-low-level-ddlx"></a>
|
|
818
|
+
#### UnlockMetadataExtensionLow (Low-Level / Ddlx)
|
|
819
|
+
**Description:** [low-level] Unlock an ABAP metadata extension after modification. Must use the same session_id and lock_handle from LockMetadataExtension operation.
|
|
820
|
+
|
|
821
|
+
**Source:** `src/handlers/ddlx/low/handleUnlockMetadataExtension.ts`
|
|
822
|
+
|
|
823
|
+
**Parameters:**
|
|
824
|
+
- `lock_handle` (string, required) - Lock handle from LockMetadataExtension operation.
|
|
825
|
+
- `objName` (string, optional) - MetadataExtension name (e.g., Z_MY_PROGRAM).
|
|
826
|
+
- `session_id` (string, required) - Session ID from LockMetadataExtension operation. Must be the same as used in LockMetadataExtension.
|
|
827
|
+
- `session_state` (object, optional) - Session state from LockMetadataExtension (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
828
|
+
|
|
829
|
+
---
|
|
830
|
+
|
|
831
|
+
<a id="updatemetadataextensionlow-low-level-ddlx"></a>
|
|
832
|
+
#### UpdateMetadataExtensionLow (Low-Level / Ddlx)
|
|
833
|
+
**Description:** [low-level] Update source code of an existing ABAP metadata extension. Requires lock handle from LockObject. - use UpdateMetadataExtension (high-level) for full workflow with lock/unlock/activate.
|
|
834
|
+
|
|
835
|
+
**Source:** `src/handlers/ddlx/low/handleUpdateMetadataExtension.ts`
|
|
836
|
+
|
|
837
|
+
**Parameters:**
|
|
838
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
839
|
+
- `name` (string, required) - Metadata extension name (e.g., ZOK_C_TEST_0001). Metadata extension must already exist.
|
|
840
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
841
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
842
|
+
- `source_code` (string, required) - Complete metadata extension source code.
|
|
843
|
+
|
|
844
|
+
---
|
|
845
|
+
|
|
846
|
+
<a id="validatemetadataextensionlow-low-level-ddlx"></a>
|
|
847
|
+
#### ValidateMetadataExtensionLow (Low-Level / Ddlx)
|
|
848
|
+
**Description:** [low-level] Validate an ABAP metadata extension name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
849
|
+
|
|
850
|
+
**Source:** `src/handlers/ddlx/low/handleValidateMetadataExtension.ts`
|
|
851
|
+
|
|
852
|
+
**Parameters:**
|
|
853
|
+
- `objName` (string, optional) - MetadataExtension name to validate (e.g., Z_MY_PROGRAM).
|
|
854
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
855
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
856
|
+
|
|
857
|
+
---
|
|
858
|
+
|
|
859
|
+
<a id="low-level-domain"></a>
|
|
860
|
+
### Low-Level / Domain
|
|
861
|
+
|
|
862
|
+
<a id="activatedomainlow-low-level-domain"></a>
|
|
863
|
+
#### ActivateDomainLow (Low-Level / Domain)
|
|
864
|
+
**Description:** [low-level] Activate an ABAP domain. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
865
|
+
|
|
866
|
+
**Source:** `src/handlers/domain/low/handleActivateDomain.ts`
|
|
867
|
+
|
|
868
|
+
**Parameters:**
|
|
869
|
+
- `domain_name` (string, required) - Domain name (e.g., ZDM_MY_DOMAIN).
|
|
870
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
871
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
872
|
+
|
|
873
|
+
---
|
|
874
|
+
|
|
875
|
+
<a id="checkdomainlow-low-level-domain"></a>
|
|
876
|
+
#### CheckDomainLow (Low-Level / Domain)
|
|
877
|
+
**Description:** [low-level] Perform syntax check on an ABAP domain. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
878
|
+
|
|
879
|
+
**Source:** `src/handlers/domain/low/handleCheckDomain.ts`
|
|
880
|
+
|
|
881
|
+
**Parameters:**
|
|
882
|
+
- `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM).
|
|
883
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
884
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
885
|
+
|
|
886
|
+
---
|
|
887
|
+
|
|
888
|
+
<a id="createdomainlow-low-level-domain"></a>
|
|
889
|
+
#### CreateDomainLow (Low-Level / Domain)
|
|
890
|
+
**Description:** [low-level] Create a new ABAP domain. - use CreateDomain (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
891
|
+
|
|
892
|
+
**Source:** `src/handlers/domain/low/handleCreateDomain.ts`
|
|
893
|
+
|
|
894
|
+
**Parameters:**
|
|
895
|
+
- `description` (string, required) - Domain description.
|
|
896
|
+
- `domain_name` (string, required) - Domain name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
897
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
898
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
899
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
900
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
901
|
+
|
|
902
|
+
---
|
|
903
|
+
|
|
904
|
+
<a id="deletedomainlow-low-level-domain"></a>
|
|
905
|
+
#### DeleteDomainLow (Low-Level / Domain)
|
|
906
|
+
**Description:** [low-level] Delete an ABAP domain from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
907
|
+
|
|
908
|
+
**Source:** `src/handlers/domain/low/handleDeleteDomain.ts`
|
|
909
|
+
|
|
910
|
+
**Parameters:**
|
|
911
|
+
- `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM).
|
|
912
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
913
|
+
|
|
914
|
+
---
|
|
915
|
+
|
|
916
|
+
<a id="lockdomainlow-low-level-domain"></a>
|
|
917
|
+
#### LockDomainLow (Low-Level / Domain)
|
|
918
|
+
**Description:** [low-level] Lock an ABAP domain for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
919
|
+
|
|
920
|
+
**Source:** `src/handlers/domain/low/handleLockDomain.ts`
|
|
921
|
+
|
|
922
|
+
**Parameters:**
|
|
923
|
+
- `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM).
|
|
924
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
925
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
926
|
+
|
|
927
|
+
---
|
|
928
|
+
|
|
929
|
+
<a id="unlockdomainlow-low-level-domain"></a>
|
|
930
|
+
#### UnlockDomainLow (Low-Level / Domain)
|
|
931
|
+
**Description:** [low-level] Unlock an ABAP domain after modification. Must use the same session_id and lock_handle from LockDomain operation.
|
|
932
|
+
|
|
933
|
+
**Source:** `src/handlers/domain/low/handleUnlockDomain.ts`
|
|
934
|
+
|
|
935
|
+
**Parameters:**
|
|
936
|
+
- `domain_name` (string, required) - Domain name (e.g., Z_MY_PROGRAM).
|
|
937
|
+
- `lock_handle` (string, required) - Lock handle from LockDomain operation.
|
|
938
|
+
- `session_id` (string, required) - Session ID from LockDomain operation. Must be the same as used in LockDomain.
|
|
939
|
+
- `session_state` (object, optional) - Session state from LockDomain (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
940
|
+
|
|
941
|
+
---
|
|
942
|
+
|
|
943
|
+
<a id="updatedomainlow-low-level-domain"></a>
|
|
944
|
+
#### UpdateDomainLow (Low-Level / Domain)
|
|
945
|
+
**Description:** [low-level] Update properties of an existing ABAP domain. Requires lock handle from LockObject. - use UpdateDomain (high-level) for full workflow with lock/unlock/activate.
|
|
946
|
+
|
|
947
|
+
**Source:** `src/handlers/domain/low/handleUpdateDomain.ts`
|
|
948
|
+
|
|
949
|
+
**Parameters:**
|
|
950
|
+
- `domain_name` (string, required) - Domain name (e.g., ZOK_D_TEST_0001). Domain must already exist.
|
|
951
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
952
|
+
- `properties` (object, required) - Domain properties object. Can include: description, datatype, length, decimals, conversion_exit, lowercase, sign_exists, value_table, fixed_values, etc.
|
|
953
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
954
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
955
|
+
|
|
956
|
+
---
|
|
957
|
+
|
|
958
|
+
<a id="validatedomainlow-low-level-domain"></a>
|
|
959
|
+
#### ValidateDomainLow (Low-Level / Domain)
|
|
960
|
+
**Description:** [low-level] Validate an ABAP domain name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
961
|
+
|
|
962
|
+
**Source:** `src/handlers/domain/low/handleValidateDomain.ts`
|
|
963
|
+
|
|
964
|
+
**Parameters:**
|
|
965
|
+
- `description` (string, required) - Domain description (required for validation).
|
|
966
|
+
- `domain_name` (string, required) - Domain name to validate (e.g., Z_MY_PROGRAM).
|
|
967
|
+
- `package_name` (string, required) - Package name (required for validation).
|
|
968
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
969
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
970
|
+
|
|
971
|
+
---
|
|
972
|
+
|
|
973
|
+
<a id="low-level-function"></a>
|
|
974
|
+
### Low-Level / Function
|
|
975
|
+
|
|
976
|
+
<a id="activatefunctiongrouplow-low-level-function"></a>
|
|
977
|
+
#### ActivateFunctionGroupLow (Low-Level / Function)
|
|
978
|
+
**Description:** [low-level] Activate an ABAP function group. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
979
|
+
|
|
980
|
+
**Source:** `src/handlers/function/low/handleActivateFunctionGroup.ts`
|
|
981
|
+
|
|
982
|
+
**Parameters:**
|
|
983
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_FG_TEST).
|
|
984
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
985
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
986
|
+
|
|
987
|
+
---
|
|
988
|
+
|
|
989
|
+
<a id="activatefunctionmodulelow-low-level-function"></a>
|
|
990
|
+
#### ActivateFunctionModuleLow (Low-Level / Function)
|
|
991
|
+
**Description:** [low-level] Activate an ABAP function module. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
992
|
+
|
|
993
|
+
**Source:** `src/handlers/function/low/handleActivateFunctionModule.ts`
|
|
994
|
+
|
|
995
|
+
**Parameters:**
|
|
996
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_FG_TEST).
|
|
997
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_FM_TEST).
|
|
998
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
999
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1000
|
+
|
|
1001
|
+
---
|
|
1002
|
+
|
|
1003
|
+
<a id="checkfunctiongrouplow-low-level-function"></a>
|
|
1004
|
+
#### CheckFunctionGroupLow (Low-Level / Function)
|
|
1005
|
+
**Description:** [low-level] Perform syntax check on an ABAP function group. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1006
|
+
|
|
1007
|
+
**Source:** `src/handlers/function/low/handleCheckFunctionGroup.ts`
|
|
1008
|
+
|
|
1009
|
+
**Parameters:**
|
|
1010
|
+
- `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM).
|
|
1011
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1012
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1013
|
+
|
|
1014
|
+
---
|
|
1015
|
+
|
|
1016
|
+
<a id="checkfunctionmodulelow-low-level-function"></a>
|
|
1017
|
+
#### CheckFunctionModuleLow (Low-Level / Function)
|
|
1018
|
+
**Description:** [low-level] Perform syntax check on an ABAP function module. Returns syntax errors, warnings, and messages. Requires function group name. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1019
|
+
|
|
1020
|
+
**Source:** `src/handlers/function/low/handleCheckFunctionModule.ts`
|
|
1021
|
+
|
|
1022
|
+
**Parameters:**
|
|
1023
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_FUGR_TEST_0001)
|
|
1024
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM)
|
|
1025
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1026
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1027
|
+
- `version` (string, optional) - Version to check:
|
|
1028
|
+
|
|
1029
|
+
---
|
|
1030
|
+
|
|
1031
|
+
<a id="createfunctiongrouplow-low-level-function"></a>
|
|
1032
|
+
#### CreateFunctionGroupLow (Low-Level / Function)
|
|
1033
|
+
**Description:** [low-level] Create a new ABAP function group. - use CreateFunctionGroup (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1034
|
+
|
|
1035
|
+
**Source:** `src/handlers/function/low/handleCreateFunctionGroup.ts`
|
|
1036
|
+
|
|
1037
|
+
**Parameters:**
|
|
1038
|
+
- `description` (string, required) - Function group description.
|
|
1039
|
+
- `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP). Must follow SAP naming conventions.
|
|
1040
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1041
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1042
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1043
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1044
|
+
|
|
1045
|
+
---
|
|
1046
|
+
|
|
1047
|
+
<a id="createfunctionmodulelow-low-level-function"></a>
|
|
1048
|
+
#### CreateFunctionModuleLow (Low-Level / Function)
|
|
1049
|
+
**Description:** [low-level] Create a new ABAP function module. - use CreateFunctionModule (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1050
|
+
|
|
1051
|
+
**Source:** `src/handlers/function/low/handleCreateFunctionModule.ts`
|
|
1052
|
+
|
|
1053
|
+
**Parameters:**
|
|
1054
|
+
- `description` (string, required) - Function module description.
|
|
1055
|
+
- `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP).
|
|
1056
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION).
|
|
1057
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1058
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1059
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1060
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1061
|
+
|
|
1062
|
+
---
|
|
1063
|
+
|
|
1064
|
+
<a id="deletefunctiongrouplow-low-level-function"></a>
|
|
1065
|
+
#### DeleteFunctionGroupLow (Low-Level / Function)
|
|
1066
|
+
**Description:** [low-level] Delete an ABAP function group from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1067
|
+
|
|
1068
|
+
**Source:** `src/handlers/function/low/handleDeleteFunctionGroup.ts`
|
|
1069
|
+
|
|
1070
|
+
**Parameters:**
|
|
1071
|
+
- `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM).
|
|
1072
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1073
|
+
|
|
1074
|
+
---
|
|
1075
|
+
|
|
1076
|
+
<a id="deletefunctionmodulelow-low-level-function"></a>
|
|
1077
|
+
#### DeleteFunctionModuleLow (Low-Level / Function)
|
|
1078
|
+
**Description:** [low-level] Delete an ABAP function module from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1079
|
+
|
|
1080
|
+
**Source:** `src/handlers/function/low/handleDeleteFunctionModule.ts`
|
|
1081
|
+
|
|
1082
|
+
**Parameters:**
|
|
1083
|
+
- `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP).
|
|
1084
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION).
|
|
1085
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1086
|
+
|
|
1087
|
+
---
|
|
1088
|
+
|
|
1089
|
+
<a id="lockfunctiongrouplow-low-level-function"></a>
|
|
1090
|
+
#### LockFunctionGroupLow (Low-Level / Function)
|
|
1091
|
+
**Description:** [low-level] Lock an ABAP function group for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1092
|
+
|
|
1093
|
+
**Source:** `src/handlers/function/low/handleLockFunctionGroup.ts`
|
|
1094
|
+
|
|
1095
|
+
**Parameters:**
|
|
1096
|
+
- `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM).
|
|
1097
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1098
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1099
|
+
|
|
1100
|
+
---
|
|
1101
|
+
|
|
1102
|
+
<a id="lockfunctionmodulelow-low-level-function"></a>
|
|
1103
|
+
#### LockFunctionModuleLow (Low-Level / Function)
|
|
1104
|
+
**Description:** [low-level] Lock an ABAP function module for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1105
|
+
|
|
1106
|
+
**Source:** `src/handlers/function/low/handleLockFunctionModule.ts`
|
|
1107
|
+
|
|
1108
|
+
**Parameters:**
|
|
1109
|
+
- `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP).
|
|
1110
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION).
|
|
1111
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1112
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1113
|
+
|
|
1114
|
+
---
|
|
1115
|
+
|
|
1116
|
+
<a id="unlockfunctiongrouplow-low-level-function"></a>
|
|
1117
|
+
#### UnlockFunctionGroupLow (Low-Level / Function)
|
|
1118
|
+
**Description:** [low-level] Unlock an ABAP function group after modification. Must use the same session_id and lock_handle from LockFunctionGroup operation.
|
|
1119
|
+
|
|
1120
|
+
**Source:** `src/handlers/function/low/handleUnlockFunctionGroup.ts`
|
|
1121
|
+
|
|
1122
|
+
**Parameters:**
|
|
1123
|
+
- `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_PROGRAM).
|
|
1124
|
+
- `lock_handle` (string, required) - Lock handle from LockFunctionGroup operation.
|
|
1125
|
+
- `session_id` (string, required) - Session ID from LockFunctionGroup operation. Must be the same as used in LockFunctionGroup.
|
|
1126
|
+
- `session_state` (object, optional) - Session state from LockFunctionGroup (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1127
|
+
|
|
1128
|
+
---
|
|
1129
|
+
|
|
1130
|
+
<a id="unlockfunctionmodulelow-low-level-function"></a>
|
|
1131
|
+
#### UnlockFunctionModuleLow (Low-Level / Function)
|
|
1132
|
+
**Description:** [low-level] Unlock an ABAP function module after modification. Must use the same session_id and lock_handle from LockFunctionModule operation.
|
|
1133
|
+
|
|
1134
|
+
**Source:** `src/handlers/function/low/handleUnlockFunctionModule.ts`
|
|
1135
|
+
|
|
1136
|
+
**Parameters:**
|
|
1137
|
+
- `function_group_name` (string, required) - Function group name (e.g., ZFG_MY_GROUP).
|
|
1138
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_MY_FUNCTION).
|
|
1139
|
+
- `lock_handle` (string, required) - Lock handle from LockFunctionModule operation.
|
|
1140
|
+
- `session_id` (string, required) - Session ID from LockFunctionModule operation. Must be the same as used in LockFunctionModule.
|
|
1141
|
+
- `session_state` (object, optional) - Session state from LockFunctionModule (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1142
|
+
|
|
1143
|
+
---
|
|
1144
|
+
|
|
1145
|
+
<a id="updatefunctionmodulelow-low-level-function"></a>
|
|
1146
|
+
#### UpdateFunctionModuleLow (Low-Level / Function)
|
|
1147
|
+
**Description:** [low-level] Update source code of an existing ABAP function module. Requires lock handle from LockObject and function group name. - use UpdateFunctionModule (high-level) for full workflow with lock/unlock/activate.
|
|
1148
|
+
|
|
1149
|
+
**Source:** `src/handlers/function/low/handleUpdateFunctionModule.ts`
|
|
1150
|
+
|
|
1151
|
+
**Parameters:**
|
|
1152
|
+
- `function_group_name` (string, required) - Function group name containing the function module (e.g., Z_TEST_FG).
|
|
1153
|
+
- `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM). Function module must already exist.
|
|
1154
|
+
- `lock_handle` (string, required) - Lock handle from LockFunctionModule. Required for update operation.
|
|
1155
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1156
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1157
|
+
- `source_code` (string, required) - Complete ABAP function module source code.
|
|
1158
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects locked in a request.
|
|
1159
|
+
|
|
1160
|
+
---
|
|
1161
|
+
|
|
1162
|
+
<a id="validatefunctiongrouplow-low-level-function"></a>
|
|
1163
|
+
#### ValidateFunctionGroupLow (Low-Level / Function)
|
|
1164
|
+
**Description:** [low-level] Validate an ABAP function group name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1165
|
+
|
|
1166
|
+
**Source:** `src/handlers/function/low/handleValidateFunctionGroup.ts`
|
|
1167
|
+
|
|
1168
|
+
**Parameters:**
|
|
1169
|
+
- `description` (string, optional) - Optional description for validation
|
|
1170
|
+
- `function_group_name` (string, required) - FunctionGroup name to validate (e.g., Z_MY_PROGRAM).
|
|
1171
|
+
- `package_name` (string, optional) - Package name for validation (optional but recommended).
|
|
1172
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1173
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1174
|
+
|
|
1175
|
+
---
|
|
1176
|
+
|
|
1177
|
+
<a id="validatefunctionmodulelow-low-level-function"></a>
|
|
1178
|
+
#### ValidateFunctionModuleLow (Low-Level / Function)
|
|
1179
|
+
**Description:** [low-level] Validate an ABAP function module name before creation. Checks if the name is valid and available. Requires function group name. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1180
|
+
|
|
1181
|
+
**Source:** `src/handlers/function/low/handleValidateFunctionModule.ts`
|
|
1182
|
+
|
|
1183
|
+
**Parameters:**
|
|
1184
|
+
- `description` (string, optional) - Optional description for validation
|
|
1185
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_FUGR_TEST_0001)
|
|
1186
|
+
- `function_module_name` (string, required) - Function module name to validate (e.g., Z_TEST_FM)
|
|
1187
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1188
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1189
|
+
|
|
1190
|
+
---
|
|
1191
|
+
|
|
1192
|
+
<a id="low-level-interface"></a>
|
|
1193
|
+
### Low-Level / Interface
|
|
1194
|
+
|
|
1195
|
+
<a id="activateinterfacelow-low-level-interface"></a>
|
|
1196
|
+
#### ActivateInterfaceLow (Low-Level / Interface)
|
|
1197
|
+
**Description:** [low-level] Activate an ABAP interface. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1198
|
+
|
|
1199
|
+
**Source:** `src/handlers/interface/low/handleActivateInterface.ts`
|
|
1200
|
+
|
|
1201
|
+
**Parameters:**
|
|
1202
|
+
- `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE).
|
|
1203
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1204
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1205
|
+
|
|
1206
|
+
---
|
|
1207
|
+
|
|
1208
|
+
<a id="checkinterfacelow-low-level-interface"></a>
|
|
1209
|
+
#### CheckInterfaceLow (Low-Level / Interface)
|
|
1210
|
+
**Description:** [low-level] Perform syntax check on an ABAP interface. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1211
|
+
|
|
1212
|
+
**Source:** `src/handlers/interface/low/handleCheckInterface.ts`
|
|
1213
|
+
|
|
1214
|
+
**Parameters:**
|
|
1215
|
+
- `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM).
|
|
1216
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1217
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1218
|
+
|
|
1219
|
+
---
|
|
1220
|
+
|
|
1221
|
+
<a id="createinterfacelow-low-level-interface"></a>
|
|
1222
|
+
#### CreateInterfaceLow (Low-Level / Interface)
|
|
1223
|
+
**Description:** [low-level] Create a new ABAP interface. - use CreateInterface (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1224
|
+
|
|
1225
|
+
**Source:** `src/handlers/interface/low/handleCreateInterface.ts`
|
|
1226
|
+
|
|
1227
|
+
**Parameters:**
|
|
1228
|
+
- `description` (string, required) - Interface description.
|
|
1229
|
+
- `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE). Must follow SAP naming conventions.
|
|
1230
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1231
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1232
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1233
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1234
|
+
|
|
1235
|
+
---
|
|
1236
|
+
|
|
1237
|
+
<a id="deleteinterfacelow-low-level-interface"></a>
|
|
1238
|
+
#### DeleteInterfaceLow (Low-Level / Interface)
|
|
1239
|
+
**Description:** [low-level] Delete an ABAP interface from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1240
|
+
|
|
1241
|
+
**Source:** `src/handlers/interface/low/handleDeleteInterface.ts`
|
|
1242
|
+
|
|
1243
|
+
**Parameters:**
|
|
1244
|
+
- `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM).
|
|
1245
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1246
|
+
|
|
1247
|
+
---
|
|
1248
|
+
|
|
1249
|
+
<a id="lockinterfacelow-low-level-interface"></a>
|
|
1250
|
+
#### LockInterfaceLow (Low-Level / Interface)
|
|
1251
|
+
**Description:** [low-level] Lock an ABAP interface for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1252
|
+
|
|
1253
|
+
**Source:** `src/handlers/interface/low/handleLockInterface.ts`
|
|
1254
|
+
|
|
1255
|
+
**Parameters:**
|
|
1256
|
+
- `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE).
|
|
1257
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1258
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1259
|
+
|
|
1260
|
+
---
|
|
1261
|
+
|
|
1262
|
+
<a id="unlockinterfacelow-low-level-interface"></a>
|
|
1263
|
+
#### UnlockInterfaceLow (Low-Level / Interface)
|
|
1264
|
+
**Description:** [low-level] Unlock an ABAP interface after modification. Must use the same session_id and lock_handle from LockInterface operation.
|
|
1265
|
+
|
|
1266
|
+
**Source:** `src/handlers/interface/low/handleUnlockInterface.ts`
|
|
1267
|
+
|
|
1268
|
+
**Parameters:**
|
|
1269
|
+
- `interface_name` (string, required) - Interface name (e.g., Z_MY_PROGRAM).
|
|
1270
|
+
- `lock_handle` (string, required) - Lock handle from LockInterface operation.
|
|
1271
|
+
- `session_id` (string, required) - Session ID from LockInterface operation. Must be the same as used in LockInterface.
|
|
1272
|
+
- `session_state` (object, optional) - Session state from LockInterface (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1273
|
+
|
|
1274
|
+
---
|
|
1275
|
+
|
|
1276
|
+
<a id="updateinterfacelow-low-level-interface"></a>
|
|
1277
|
+
#### UpdateInterfaceLow (Low-Level / Interface)
|
|
1278
|
+
**Description:** [low-level] Update source code of an existing ABAP interface. Requires lock handle from LockObject. - use UpdateInterface (high-level) for full workflow with lock/unlock/activate.
|
|
1279
|
+
|
|
1280
|
+
**Source:** `src/handlers/interface/low/handleUpdateInterface.ts`
|
|
1281
|
+
|
|
1282
|
+
**Parameters:**
|
|
1283
|
+
- `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE). Interface must already exist.
|
|
1284
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1285
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1286
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1287
|
+
- `source_code` (string, required) - Complete ABAP interface source code.
|
|
1288
|
+
|
|
1289
|
+
---
|
|
1290
|
+
|
|
1291
|
+
<a id="validateinterfacelow-low-level-interface"></a>
|
|
1292
|
+
#### ValidateInterfaceLow (Low-Level / Interface)
|
|
1293
|
+
**Description:** [low-level] Validate an ABAP interface name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1294
|
+
|
|
1295
|
+
**Source:** `src/handlers/interface/low/handleValidateInterface.ts`
|
|
1296
|
+
|
|
1297
|
+
**Parameters:**
|
|
1298
|
+
- `description` (string, required) - Interface description. Required for validation.
|
|
1299
|
+
- `interface_name` (string, required) - Interface name to validate (e.g., Z_MY_PROGRAM).
|
|
1300
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
1301
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1302
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1303
|
+
|
|
1304
|
+
---
|
|
1305
|
+
|
|
1306
|
+
<a id="low-level-package"></a>
|
|
1307
|
+
### Low-Level / Package
|
|
1308
|
+
|
|
1309
|
+
<a id="checkpackagelow-low-level-package"></a>
|
|
1310
|
+
#### CheckPackageLow (Low-Level / Package)
|
|
1311
|
+
**Description:** [low-level] Perform syntax check on an ABAP package. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1312
|
+
|
|
1313
|
+
**Source:** `src/handlers/package/low/handleCheckPackage.ts`
|
|
1314
|
+
|
|
1315
|
+
**Parameters:**
|
|
1316
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002).
|
|
1317
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1318
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1319
|
+
- `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required.
|
|
1320
|
+
|
|
1321
|
+
---
|
|
1322
|
+
|
|
1323
|
+
<a id="createpackagelow-low-level-package"></a>
|
|
1324
|
+
#### CreatePackageLow (Low-Level / Package)
|
|
1325
|
+
**Description:** [low-level] Create a new ABAP package. - use CreatePackage (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1326
|
+
|
|
1327
|
+
**Source:** `src/handlers/package/low/handleCreatePackage.ts`
|
|
1328
|
+
|
|
1329
|
+
**Parameters:**
|
|
1330
|
+
- `application_component` (string, optional) - Application component (e.g., BC-ABA).
|
|
1331
|
+
- `description` (string, required) - Package description.
|
|
1332
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Must follow SAP naming conventions.
|
|
1333
|
+
- `package_type` (string, optional) - Package type (development/structure). Defaults to development.
|
|
1334
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1335
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1336
|
+
- `software_component` (string, optional) - Software component (e.g., HOME, ZLOCAL). If not provided, SAP will set a default (typically ZLOCAL for local packages).
|
|
1337
|
+
- `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required.
|
|
1338
|
+
- `transport_layer` (string, optional) - Transport layer (e.g., ZDEV). Required for transportable packages.
|
|
1339
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1340
|
+
|
|
1341
|
+
---
|
|
1342
|
+
|
|
1343
|
+
<a id="deletepackagelow-low-level-package"></a>
|
|
1344
|
+
#### DeletePackageLow (Low-Level / Package)
|
|
1345
|
+
**Description:** [low-level] Delete an ABAP package from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1346
|
+
|
|
1347
|
+
**Source:** `src/handlers/package/low/handleDeletePackage.ts`
|
|
1348
|
+
|
|
1349
|
+
**Parameters:**
|
|
1350
|
+
- `connection_config` (object, optional) - Optional SAP connection config to create a fresh connection for deletion. Useful when the existing connection config is unavailable.
|
|
1351
|
+
- `force_new_connection` (boolean, optional) - Force creation of a new connection (bypass cache). Useful when package was locked/unlocked and needs to be deleted in a fresh session. Default: false.
|
|
1352
|
+
- `package_name` (string, required) - Package name (e.g., Z_MY_PROGRAM).
|
|
1353
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1354
|
+
|
|
1355
|
+
---
|
|
1356
|
+
|
|
1357
|
+
<a id="lockpackagelow-low-level-package"></a>
|
|
1358
|
+
#### LockPackageLow (Low-Level / Package)
|
|
1359
|
+
**Description:** [low-level] Lock an ABAP package for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id. Requires super_package.
|
|
1360
|
+
|
|
1361
|
+
**Source:** `src/handlers/package/low/handleLockPackage.ts`
|
|
1362
|
+
|
|
1363
|
+
**Parameters:**
|
|
1364
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002).
|
|
1365
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1366
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1367
|
+
- `super_package` (string, required) - Super package (parent package) name (e.g., ZOK_PACKAGE). Required.
|
|
1368
|
+
|
|
1369
|
+
---
|
|
1370
|
+
|
|
1371
|
+
<a id="unlockpackagelow-low-level-package"></a>
|
|
1372
|
+
#### UnlockPackageLow (Low-Level / Package)
|
|
1373
|
+
**Description:** [low-level] Unlock an ABAP package after modification. Requires lock handle from LockObject and superPackage. - must use the same session_id and lock_handle from LockObject.
|
|
1374
|
+
|
|
1375
|
+
**Source:** `src/handlers/package/low/handleUnlockPackage.ts`
|
|
1376
|
+
|
|
1377
|
+
**Parameters:**
|
|
1378
|
+
- `lock_handle` (string, required) - Lock handle from LockObject operation
|
|
1379
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Package must already exist.
|
|
1380
|
+
- `session_id` (string, required) - Session ID from LockObject operation. Must be the same as used in LockObject.
|
|
1381
|
+
- `session_state` (object, optional) - Session state from LockObject (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1382
|
+
- `super_package` (string, required) - Super package (parent package) name. Required for package operations.
|
|
1383
|
+
|
|
1384
|
+
---
|
|
1385
|
+
|
|
1386
|
+
<a id="updatepackagelow-low-level-package"></a>
|
|
1387
|
+
#### UpdatePackageLow (Low-Level / Package)
|
|
1388
|
+
**Description:** [low-level] Update description of an existing ABAP package. Requires lock handle from LockObject and superPackage. - use UpdatePackageSource for full workflow with lock/unlock.
|
|
1389
|
+
|
|
1390
|
+
**Source:** `src/handlers/package/low/handleUpdatePackage.ts`
|
|
1391
|
+
|
|
1392
|
+
**Parameters:**
|
|
1393
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1394
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_TEST_0002). Package must already exist.
|
|
1395
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1396
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1397
|
+
- `super_package` (string, required) - Super package (parent package) name. Required for package operations.
|
|
1398
|
+
- `updated_description` (string, required) - New description for the package.
|
|
1399
|
+
|
|
1400
|
+
---
|
|
1401
|
+
|
|
1402
|
+
<a id="validatepackagelow-low-level-package"></a>
|
|
1403
|
+
#### ValidatePackageLow (Low-Level / Package)
|
|
1404
|
+
**Description:** [low-level] Validate an ABAP package name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1405
|
+
|
|
1406
|
+
**Source:** `src/handlers/package/low/handleValidatePackage.ts`
|
|
1407
|
+
|
|
1408
|
+
**Parameters:**
|
|
1409
|
+
- `package_name` (string, required) - Package name to validate (e.g., Z_MY_PROGRAM).
|
|
1410
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1411
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1412
|
+
|
|
1413
|
+
---
|
|
1414
|
+
|
|
1415
|
+
<a id="low-level-program"></a>
|
|
1416
|
+
### Low-Level / Program
|
|
1417
|
+
|
|
1418
|
+
<a id="activateprogramlow-low-level-program"></a>
|
|
1419
|
+
#### ActivateProgramLow (Low-Level / Program)
|
|
1420
|
+
**Description:** [low-level] Activate an ABAP program. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1421
|
+
|
|
1422
|
+
**Source:** `src/handlers/program/low/handleActivateProgram.ts`
|
|
1423
|
+
|
|
1424
|
+
**Parameters:**
|
|
1425
|
+
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
1426
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1427
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1428
|
+
|
|
1429
|
+
---
|
|
1430
|
+
|
|
1431
|
+
<a id="checkprogramlow-low-level-program"></a>
|
|
1432
|
+
#### CheckProgramLow (Low-Level / Program)
|
|
1433
|
+
**Description:** [low-level] Perform syntax check on an ABAP program. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1434
|
+
|
|
1435
|
+
**Source:** `src/handlers/program/low/handleCheckProgram.ts`
|
|
1436
|
+
|
|
1437
|
+
**Parameters:**
|
|
1438
|
+
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
1439
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1440
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1441
|
+
|
|
1442
|
+
---
|
|
1443
|
+
|
|
1444
|
+
<a id="createprogramlow-low-level-program"></a>
|
|
1445
|
+
#### CreateProgramLow (Low-Level / Program)
|
|
1446
|
+
**Description:** [low-level] Create a new ABAP program. - use CreateProgram (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1447
|
+
|
|
1448
|
+
**Source:** `src/handlers/program/low/handleCreateProgram.ts`
|
|
1449
|
+
|
|
1450
|
+
**Parameters:**
|
|
1451
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1452
|
+
- `description` (string, required) - Program description.
|
|
1453
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1454
|
+
- `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1455
|
+
- `program_type` (string, optional) - Program type:
|
|
1456
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1457
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1458
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1459
|
+
|
|
1460
|
+
---
|
|
1461
|
+
|
|
1462
|
+
<a id="deleteprogramlow-low-level-program"></a>
|
|
1463
|
+
#### DeleteProgramLow (Low-Level / Program)
|
|
1464
|
+
**Description:** [low-level] Delete an ABAP program from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1465
|
+
|
|
1466
|
+
**Source:** `src/handlers/program/low/handleDeleteProgram.ts`
|
|
1467
|
+
|
|
1468
|
+
**Parameters:**
|
|
1469
|
+
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
1470
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1471
|
+
|
|
1472
|
+
---
|
|
1473
|
+
|
|
1474
|
+
<a id="lockprogramlow-low-level-program"></a>
|
|
1475
|
+
#### LockProgramLow (Low-Level / Program)
|
|
1476
|
+
**Description:** [low-level] Lock an ABAP program for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1477
|
+
|
|
1478
|
+
**Source:** `src/handlers/program/low/handleLockProgram.ts`
|
|
1479
|
+
|
|
1480
|
+
**Parameters:**
|
|
1481
|
+
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
1482
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1483
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1484
|
+
|
|
1485
|
+
---
|
|
1486
|
+
|
|
1487
|
+
<a id="unlockprogramlow-low-level-program"></a>
|
|
1488
|
+
#### UnlockProgramLow (Low-Level / Program)
|
|
1489
|
+
**Description:** [low-level] Unlock an ABAP program after modification. Must use the same session_id and lock_handle from LockProgram operation.
|
|
1490
|
+
|
|
1491
|
+
**Source:** `src/handlers/program/low/handleUnlockProgram.ts`
|
|
1492
|
+
|
|
1493
|
+
**Parameters:**
|
|
1494
|
+
- `lock_handle` (string, required) - Lock handle from LockProgram operation.
|
|
1495
|
+
- `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM).
|
|
1496
|
+
- `session_id` (string, required) - Session ID from LockProgram operation. Must be the same as used in LockProgram.
|
|
1497
|
+
- `session_state` (object, optional) - Session state from LockProgram (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1498
|
+
|
|
1499
|
+
---
|
|
1500
|
+
|
|
1501
|
+
<a id="updateprogramlow-low-level-program"></a>
|
|
1502
|
+
#### UpdateProgramLow (Low-Level / Program)
|
|
1503
|
+
**Description:** [low-level] Update source code of an existing ABAP program. Requires lock handle from LockObject. - use UpdateProgram (high-level) for full workflow with lock/unlock/activate.
|
|
1504
|
+
|
|
1505
|
+
**Source:** `src/handlers/program/low/handleUpdateProgram.ts`
|
|
1506
|
+
|
|
1507
|
+
**Parameters:**
|
|
1508
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1509
|
+
- `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM). Program must already exist.
|
|
1510
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1511
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1512
|
+
- `source_code` (string, required) - Complete ABAP program source code.
|
|
1513
|
+
|
|
1514
|
+
---
|
|
1515
|
+
|
|
1516
|
+
<a id="validateprogramlow-low-level-program"></a>
|
|
1517
|
+
#### ValidateProgramLow (Low-Level / Program)
|
|
1518
|
+
**Description:** [low-level] Validate an ABAP program name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1519
|
+
|
|
1520
|
+
**Source:** `src/handlers/program/low/handleValidateProgram.ts`
|
|
1521
|
+
|
|
1522
|
+
**Parameters:**
|
|
1523
|
+
- `description` (string, required) - Program description. Required for validation.
|
|
1524
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
1525
|
+
- `program_name` (string, required) - Program name to validate (e.g., Z_MY_PROGRAM).
|
|
1526
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1527
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1528
|
+
|
|
1529
|
+
---
|
|
1530
|
+
|
|
1531
|
+
<a id="low-level-structure"></a>
|
|
1532
|
+
### Low-Level / Structure
|
|
1533
|
+
|
|
1534
|
+
<a id="activatestructurelow-low-level-structure"></a>
|
|
1535
|
+
#### ActivateStructureLow (Low-Level / Structure)
|
|
1536
|
+
**Description:** [low-level] Activate an ABAP structure. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1537
|
+
|
|
1538
|
+
**Source:** `src/handlers/structure/low/handleActivateStructure.ts`
|
|
1539
|
+
|
|
1540
|
+
**Parameters:**
|
|
1541
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1542
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1543
|
+
- `structure_name` (string, required) - Structure name (e.g., ZST_MY_STRUCTURE).
|
|
1544
|
+
|
|
1545
|
+
---
|
|
1546
|
+
|
|
1547
|
+
<a id="checkstructurelow-low-level-structure"></a>
|
|
1548
|
+
#### CheckStructureLow (Low-Level / Structure)
|
|
1549
|
+
**Description:** [low-level] Perform syntax check on an ABAP structure. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. If ddl_code is provided, validates new/unsaved code (will be base64 encoded in request).
|
|
1550
|
+
|
|
1551
|
+
**Source:** `src/handlers/structure/low/handleCheckStructure.ts`
|
|
1552
|
+
|
|
1553
|
+
**Parameters:**
|
|
1554
|
+
- `ddl_code` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body.
|
|
1555
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1556
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1557
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM).
|
|
1558
|
+
- `version` (string, optional) - Version to check:
|
|
1559
|
+
|
|
1560
|
+
---
|
|
1561
|
+
|
|
1562
|
+
<a id="createstructurelow-low-level-structure"></a>
|
|
1563
|
+
#### CreateStructureLow (Low-Level / Structure)
|
|
1564
|
+
**Description:** [low-level] Create a new ABAP structure. - use CreateStructure (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1565
|
+
|
|
1566
|
+
**Source:** `src/handlers/structure/low/handleCreateStructure.ts`
|
|
1567
|
+
|
|
1568
|
+
**Parameters:**
|
|
1569
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1570
|
+
- `description` (string, required) - Structure description.
|
|
1571
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1572
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1573
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1574
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1575
|
+
- `structure_type` (string, optional) - Structure type:
|
|
1576
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1577
|
+
|
|
1578
|
+
---
|
|
1579
|
+
|
|
1580
|
+
<a id="deletestructurelow-low-level-structure"></a>
|
|
1581
|
+
#### DeleteStructureLow (Low-Level / Structure)
|
|
1582
|
+
**Description:** [low-level] Delete an ABAP structure from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1583
|
+
|
|
1584
|
+
**Source:** `src/handlers/structure/low/handleDeleteStructure.ts`
|
|
1585
|
+
|
|
1586
|
+
**Parameters:**
|
|
1587
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM).
|
|
1588
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1589
|
+
|
|
1590
|
+
---
|
|
1591
|
+
|
|
1592
|
+
<a id="lockstructurelow-low-level-structure"></a>
|
|
1593
|
+
#### LockStructureLow (Low-Level / Structure)
|
|
1594
|
+
**Description:** [low-level] Lock an ABAP structure for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1595
|
+
|
|
1596
|
+
**Source:** `src/handlers/structure/low/handleLockStructure.ts`
|
|
1597
|
+
|
|
1598
|
+
**Parameters:**
|
|
1599
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1600
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1601
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM).
|
|
1602
|
+
|
|
1603
|
+
---
|
|
1604
|
+
|
|
1605
|
+
<a id="unlockstructurelow-low-level-structure"></a>
|
|
1606
|
+
#### UnlockStructureLow (Low-Level / Structure)
|
|
1607
|
+
**Description:** [low-level] Unlock an ABAP structure after modification. Must use the same session_id and lock_handle from LockStructure operation.
|
|
1608
|
+
|
|
1609
|
+
**Source:** `src/handlers/structure/low/handleUnlockStructure.ts`
|
|
1610
|
+
|
|
1611
|
+
**Parameters:**
|
|
1612
|
+
- `lock_handle` (string, required) - Lock handle from LockStructure operation.
|
|
1613
|
+
- `session_id` (string, required) - Session ID from LockStructure operation. Must be the same as used in LockStructure.
|
|
1614
|
+
- `session_state` (object, optional) - Session state from LockStructure (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1615
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_PROGRAM).
|
|
1616
|
+
|
|
1617
|
+
---
|
|
1618
|
+
|
|
1619
|
+
<a id="updatestructurelow-low-level-structure"></a>
|
|
1620
|
+
#### UpdateStructureLow (Low-Level / Structure)
|
|
1621
|
+
**Description:** [low-level] Update DDL source code of an existing ABAP structure. Requires lock handle from LockObject. - use UpdateStructureSource for full workflow with lock/unlock.
|
|
1622
|
+
|
|
1623
|
+
**Source:** `src/handlers/structure/low/handleUpdateStructure.ts`
|
|
1624
|
+
|
|
1625
|
+
**Parameters:**
|
|
1626
|
+
- `ddl_code` (string, required) - Complete DDL source code for the structure definition.
|
|
1627
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1628
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1629
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1630
|
+
- `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Structure must already exist.
|
|
1631
|
+
|
|
1632
|
+
---
|
|
1633
|
+
|
|
1634
|
+
<a id="validatestructurelow-low-level-structure"></a>
|
|
1635
|
+
#### ValidateStructureLow (Low-Level / Structure)
|
|
1636
|
+
**Description:** [low-level] Validate an ABAP structure name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1637
|
+
|
|
1638
|
+
**Source:** `src/handlers/structure/low/handleValidateStructure.ts`
|
|
1639
|
+
|
|
1640
|
+
**Parameters:**
|
|
1641
|
+
- `description` (string, required) - Structure description. Required for validation.
|
|
1642
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
1643
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1644
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1645
|
+
- `structure_name` (string, required) - Structure name to validate (e.g., Z_MY_PROGRAM).
|
|
1646
|
+
|
|
1647
|
+
---
|
|
1648
|
+
|
|
1649
|
+
<a id="low-level-system"></a>
|
|
1650
|
+
### Low-Level / System
|
|
1651
|
+
|
|
1652
|
+
<a id="getnodestructurelow-low-level-system"></a>
|
|
1653
|
+
#### GetNodeStructureLow (Low-Level / System)
|
|
1654
|
+
**Description:** [low-level] Fetch node structure from ADT repository. Used for object tree navigation and structure discovery. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1655
|
+
|
|
1656
|
+
**Source:** `src/handlers/system/low/handleGetNodeStructure.ts`
|
|
1657
|
+
|
|
1658
|
+
**Parameters:**
|
|
1659
|
+
- `node_id` (string, optional (default: 0000" for root). Use to fetch child nodes.)) - Optional node ID (default:
|
|
1660
|
+
- `parent_name` (string, required) - Parent object name
|
|
1661
|
+
- `parent_type` (string, required) - Parent object type (e.g.,
|
|
1662
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1663
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1664
|
+
- `with_short_descriptions` (boolean, optional (default: true)) - Include short descriptions in response
|
|
1665
|
+
|
|
1666
|
+
---
|
|
1667
|
+
|
|
1668
|
+
<a id="getobjectstructurelow-low-level-system"></a>
|
|
1669
|
+
#### GetObjectStructureLow (Low-Level / System)
|
|
1670
|
+
**Description:** [low-level] Retrieve ADT object structure as compact JSON tree. Returns XML response with object structure tree. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1671
|
+
|
|
1672
|
+
**Source:** `src/handlers/system/low/handleGetObjectStructure.ts`
|
|
1673
|
+
|
|
1674
|
+
**Parameters:**
|
|
1675
|
+
- `object_name` (string, required) - Object name (e.g.,
|
|
1676
|
+
- `object_type` (string, required) - Object type (e.g.,
|
|
1677
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1678
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1679
|
+
|
|
1680
|
+
---
|
|
1681
|
+
|
|
1682
|
+
<a id="getvirtualfolderslow-low-level-system"></a>
|
|
1683
|
+
#### GetVirtualFoldersLow (Low-Level / System)
|
|
1684
|
+
**Description:** [low-level] Retrieve hierarchical virtual folder contents from ADT information system. Used for browsing ABAP objects by package, group, type, etc.
|
|
1685
|
+
|
|
1686
|
+
**Source:** `src/handlers/system/low/handleGetVirtualFolders.ts`
|
|
1687
|
+
|
|
1688
|
+
**Parameters:**
|
|
1689
|
+
- `object_search_pattern` (string, optional (default: *)) - Object search pattern (e.g.,
|
|
1690
|
+
- `preselection` (array, optional) - Optional preselection filters (facet-value pairs for filtering)
|
|
1691
|
+
- `values` (array, required) - Array of facet values to filter by
|
|
1692
|
+
|
|
1693
|
+
---
|
|
1694
|
+
|
|
1695
|
+
<a id="low-level-table"></a>
|
|
1696
|
+
### Low-Level / Table
|
|
1697
|
+
|
|
1698
|
+
<a id="activatetablelow-low-level-table"></a>
|
|
1699
|
+
#### ActivateTableLow (Low-Level / Table)
|
|
1700
|
+
**Description:** [low-level] Activate an ABAP table. Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1701
|
+
|
|
1702
|
+
**Source:** `src/handlers/table/low/handleActivateTable.ts`
|
|
1703
|
+
|
|
1704
|
+
**Parameters:**
|
|
1705
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1706
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1707
|
+
- `table_name` (string, required) - Table name (e.g., ZTB_MY_TABLE).
|
|
1708
|
+
|
|
1709
|
+
---
|
|
1710
|
+
|
|
1711
|
+
<a id="checktablelow-low-level-table"></a>
|
|
1712
|
+
#### CheckTableLow (Low-Level / Table)
|
|
1713
|
+
**Description:** [low-level] Perform syntax check on an ABAP table. Returns syntax errors, warnings, and messages. Requires session_id for stateful operations. Can use session_id and session_state from GetSession to maintain the same session. If ddl_code is provided, validates new/unsaved code (will be base64 encoded in request).
|
|
1714
|
+
|
|
1715
|
+
**Source:** `src/handlers/table/low/handleCheckTable.ts`
|
|
1716
|
+
|
|
1717
|
+
**Parameters:**
|
|
1718
|
+
- `ddl_code` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body.
|
|
1719
|
+
- `reporter` (string, optional) - Check reporter:
|
|
1720
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1721
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1722
|
+
- `table_name` (string, required) - Table name (e.g., Z_MY_TABLE)
|
|
1723
|
+
- `version` (string, optional) - Version to check:
|
|
1724
|
+
|
|
1725
|
+
---
|
|
1726
|
+
|
|
1727
|
+
<a id="createtablelow-low-level-table"></a>
|
|
1728
|
+
#### CreateTableLow (Low-Level / Table)
|
|
1729
|
+
**Description:** [low-level] Create a new ABAP table. - use CreateTable (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1730
|
+
|
|
1731
|
+
**Source:** `src/handlers/table/low/handleCreateTable.ts`
|
|
1732
|
+
|
|
1733
|
+
**Parameters:**
|
|
1734
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1735
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1736
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1737
|
+
- `table_name` (string, required) - Table name (e.g., ZT_TEST_001). Must follow SAP naming conventions.
|
|
1738
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1739
|
+
|
|
1740
|
+
---
|
|
1741
|
+
|
|
1742
|
+
<a id="deletetablelow-low-level-table"></a>
|
|
1743
|
+
#### DeleteTableLow (Low-Level / Table)
|
|
1744
|
+
**Description:** [low-level] Delete an ABAP table from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1745
|
+
|
|
1746
|
+
**Source:** `src/handlers/table/low/handleDeleteTable.ts`
|
|
1747
|
+
|
|
1748
|
+
**Parameters:**
|
|
1749
|
+
- `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM).
|
|
1750
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1751
|
+
|
|
1752
|
+
---
|
|
1753
|
+
|
|
1754
|
+
<a id="locktablelow-low-level-table"></a>
|
|
1755
|
+
#### LockTableLow (Low-Level / Table)
|
|
1756
|
+
**Description:** [low-level] Lock an ABAP table for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1757
|
+
|
|
1758
|
+
**Source:** `src/handlers/table/low/handleLockTable.ts`
|
|
1759
|
+
|
|
1760
|
+
**Parameters:**
|
|
1761
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1762
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1763
|
+
- `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM).
|
|
1764
|
+
|
|
1765
|
+
---
|
|
1766
|
+
|
|
1767
|
+
<a id="unlocktablelow-low-level-table"></a>
|
|
1768
|
+
#### UnlockTableLow (Low-Level / Table)
|
|
1769
|
+
**Description:** [low-level] Unlock an ABAP table after modification. Must use the same session_id and lock_handle from LockTable operation.
|
|
1770
|
+
|
|
1771
|
+
**Source:** `src/handlers/table/low/handleUnlockTable.ts`
|
|
1772
|
+
|
|
1773
|
+
**Parameters:**
|
|
1774
|
+
- `lock_handle` (string, required) - Lock handle from LockTable operation.
|
|
1775
|
+
- `session_id` (string, required) - Session ID from LockTable operation. Must be the same as used in LockTable.
|
|
1776
|
+
- `session_state` (object, optional) - Session state from LockTable (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1777
|
+
- `table_name` (string, required) - Table name (e.g., Z_MY_PROGRAM).
|
|
1778
|
+
|
|
1779
|
+
---
|
|
1780
|
+
|
|
1781
|
+
<a id="updatetablelow-low-level-table"></a>
|
|
1782
|
+
#### UpdateTableLow (Low-Level / Table)
|
|
1783
|
+
**Description:** [low-level] Update DDL source code of an existing ABAP table. Requires lock handle from LockObject. - use CreateTable for full workflow with lock/unlock.
|
|
1784
|
+
|
|
1785
|
+
**Source:** `src/handlers/table/low/handleUpdateTable.ts`
|
|
1786
|
+
|
|
1787
|
+
**Parameters:**
|
|
1788
|
+
- `ddl_code` (string, required) - Complete DDL source code for the table definition.
|
|
1789
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1790
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1791
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1792
|
+
- `table_name` (string, required) - Table name (e.g., ZOK_T_TEST_0001). Table must already exist.
|
|
1793
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport.
|
|
1794
|
+
|
|
1795
|
+
---
|
|
1796
|
+
|
|
1797
|
+
<a id="validatetablelow-low-level-table"></a>
|
|
1798
|
+
#### ValidateTableLow (Low-Level / Table)
|
|
1799
|
+
**Description:** [low-level] Validate an ABAP table name before creation. Checks if the name is valid and available. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1800
|
+
|
|
1801
|
+
**Source:** `src/handlers/table/low/handleValidateTable.ts`
|
|
1802
|
+
|
|
1803
|
+
**Parameters:**
|
|
1804
|
+
- `description` (string, required) - Table description. Required for validation.
|
|
1805
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
1806
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1807
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1808
|
+
- `table_name` (string, required) - Table name to validate (e.g., Z_MY_TABLE)
|
|
1809
|
+
|
|
1810
|
+
---
|
|
1811
|
+
|
|
1812
|
+
<a id="low-level-transport"></a>
|
|
1813
|
+
### Low-Level / Transport
|
|
1814
|
+
|
|
1815
|
+
<a id="createtransportlow-low-level-transport"></a>
|
|
1816
|
+
#### CreateTransportLow (Low-Level / Transport)
|
|
1817
|
+
**Description:** [low-level] Create a new ABAP transport request.
|
|
1818
|
+
|
|
1819
|
+
**Source:** `src/handlers/transport/low/handleCreateTransport.ts`
|
|
1820
|
+
|
|
1821
|
+
**Parameters:**
|
|
1822
|
+
- `description` (string, required) - Transport request description.
|
|
1823
|
+
- `transport_type` (string, optional (default: workbench').)) - Transport type:
|
|
1824
|
+
|
|
1825
|
+
---
|
|
1826
|
+
|
|
1827
|
+
<a id="low-level-view"></a>
|
|
1828
|
+
### Low-Level / View
|
|
1829
|
+
|
|
1830
|
+
<a id="activateviewlow-low-level-view"></a>
|
|
1831
|
+
#### ActivateViewLow (Low-Level / View)
|
|
1832
|
+
**Description:** [low-level] Activate an ABAP view (CDS view). Returns activation status and any warnings/errors. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1833
|
+
|
|
1834
|
+
**Source:** `src/handlers/view/low/handleActivateView.ts`
|
|
1835
|
+
|
|
1836
|
+
**Parameters:**
|
|
1837
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1838
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1839
|
+
- `view_name` (string, required) - View name (e.g., ZVW_MY_VIEW).
|
|
1840
|
+
|
|
1841
|
+
---
|
|
1842
|
+
|
|
1843
|
+
<a id="checkviewlow-low-level-view"></a>
|
|
1844
|
+
#### CheckViewLow (Low-Level / View)
|
|
1845
|
+
**Description:** [low-level] Perform syntax check on an ABAP view. Returns syntax errors, warnings, and messages. Can use session_id and session_state from GetSession to maintain the same session. If ddl_source is provided, validates new/unsaved code (will be base64 encoded in request).
|
|
1846
|
+
|
|
1847
|
+
**Source:** `src/handlers/view/low/handleCheckView.ts`
|
|
1848
|
+
|
|
1849
|
+
**Parameters:**
|
|
1850
|
+
- `ddl_source` (string, optional) - Optional DDL source code to validate (for checking new/unsaved code). If provided, code will be base64 encoded and sent in check request body.
|
|
1851
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1852
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1853
|
+
- `version` (string, optional) - Version to check:
|
|
1854
|
+
- `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM).
|
|
1855
|
+
|
|
1856
|
+
---
|
|
1857
|
+
|
|
1858
|
+
<a id="createviewlow-low-level-view"></a>
|
|
1859
|
+
#### CreateViewLow (Low-Level / View)
|
|
1860
|
+
**Description:** [low-level] Create a new ABAP view. - use CreateView (high-level) for full workflow with validation, lock, update, check, unlock, and activate.
|
|
1861
|
+
|
|
1862
|
+
**Source:** `src/handlers/view/low/handleCreateView.ts`
|
|
1863
|
+
|
|
1864
|
+
**Parameters:**
|
|
1865
|
+
- `application` (string, optional (default: *').)) - Application area (optional, default:
|
|
1866
|
+
- `description` (string, required) - View description.
|
|
1867
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects).
|
|
1868
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1869
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1870
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1871
|
+
- `view_name` (string, required) - View name (e.g., Z_TEST_PROGRAM). Must follow SAP naming conventions.
|
|
1872
|
+
- `view_type` (string, optional) - View type:
|
|
1873
|
+
|
|
1874
|
+
---
|
|
1875
|
+
|
|
1876
|
+
<a id="deleteviewlow-low-level-view"></a>
|
|
1877
|
+
#### DeleteViewLow (Low-Level / View)
|
|
1878
|
+
**Description:** [low-level] Delete an ABAP view from the SAP system via ADT deletion API. Transport request optional for $TMP objects.
|
|
1879
|
+
|
|
1880
|
+
**Source:** `src/handlers/view/low/handleDeleteView.ts`
|
|
1881
|
+
|
|
1882
|
+
**Parameters:**
|
|
1883
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1884
|
+
- `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM).
|
|
1885
|
+
|
|
1886
|
+
---
|
|
1887
|
+
|
|
1888
|
+
<a id="lockviewlow-low-level-view"></a>
|
|
1889
|
+
#### LockViewLow (Low-Level / View)
|
|
1890
|
+
**Description:** [low-level] Lock an ABAP view for modification. Returns lock handle that must be used in subsequent update/unlock operations with the same session_id.
|
|
1891
|
+
|
|
1892
|
+
**Source:** `src/handlers/view/low/handleLockView.ts`
|
|
1893
|
+
|
|
1894
|
+
**Parameters:**
|
|
1895
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1896
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1897
|
+
- `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM).
|
|
1898
|
+
|
|
1899
|
+
---
|
|
1900
|
+
|
|
1901
|
+
<a id="unlockviewlow-low-level-view"></a>
|
|
1902
|
+
#### UnlockViewLow (Low-Level / View)
|
|
1903
|
+
**Description:** [low-level] Unlock an ABAP view after modification. Must use the same session_id and lock_handle from LockView operation.
|
|
1904
|
+
|
|
1905
|
+
**Source:** `src/handlers/view/low/handleUnlockView.ts`
|
|
1906
|
+
|
|
1907
|
+
**Parameters:**
|
|
1908
|
+
- `lock_handle` (string, required) - Lock handle from LockView operation.
|
|
1909
|
+
- `session_id` (string, required) - Session ID from LockView operation. Must be the same as used in LockView.
|
|
1910
|
+
- `session_state` (object, optional) - Session state from LockView (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1911
|
+
- `view_name` (string, required) - View name (e.g., Z_MY_PROGRAM).
|
|
1912
|
+
|
|
1913
|
+
---
|
|
1914
|
+
|
|
1915
|
+
<a id="updateviewlow-low-level-view"></a>
|
|
1916
|
+
#### UpdateViewLow (Low-Level / View)
|
|
1917
|
+
**Description:** [low-level] Update DDL source code of an existing CDS View or Classic View. Requires lock handle from LockObject. - use UpdateView (high-level) for full workflow with lock/unlock/activate.
|
|
1918
|
+
|
|
1919
|
+
**Source:** `src/handlers/view/low/handleUpdateView.ts`
|
|
1920
|
+
|
|
1921
|
+
**Parameters:**
|
|
1922
|
+
- `ddl_source` (string, required) - Complete DDL source code. CDS: include @AbapCatalog.sqlViewName and other annotations. Classic: plain
|
|
1923
|
+
- `lock_handle` (string, required) - Lock handle from LockObject. Required for update operation.
|
|
1924
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1925
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1926
|
+
- `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002). View must already exist.
|
|
1927
|
+
|
|
1928
|
+
---
|
|
1929
|
+
|
|
1930
|
+
<a id="validateviewlow-low-level-view"></a>
|
|
1931
|
+
#### ValidateViewLow (Low-Level / View)
|
|
1932
|
+
**Description:** [low-level] Validate an ABAP view name before creation. Checks if the name is valid and available. Returns validation result with success status and message. Can use session_id and session_state from GetSession to maintain the same session.
|
|
1933
|
+
|
|
1934
|
+
**Source:** `src/handlers/view/low/handleValidateView.ts`
|
|
1935
|
+
|
|
1936
|
+
**Parameters:**
|
|
1937
|
+
- `description` (string, required) - View description. Required for validation.
|
|
1938
|
+
- `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects). Required for validation.
|
|
1939
|
+
- `session_id` (string, optional) - Session ID from GetSession. If not provided, a new session will be created.
|
|
1940
|
+
- `session_state` (object, optional) - Session state from GetSession (cookies, csrf_token, cookie_store). Required if session_id is provided.
|
|
1941
|
+
- `view_name` (string, required) - View name to validate (e.g., Z_MY_PROGRAM).
|
|
1942
|
+
|
|
1943
|
+
---
|
|
1944
|
+
|
|
1945
|
+
*Last updated: 2026-02-12*
|