mcp-abap-adt

# High-Level Tools - MCP ABAP ADT Server Generated from code in `src/handlers/**` (not from docs). - Level: High-Level - Total tools: 117 ## Navigation - [High-Level Group](#high-level-group) - [Behavior Definition](#high-level-behavior-definition) - [CreateBehaviorDefinition](#createbehaviordefinition-high-level-behavior-definition) - [DeleteBehaviorDefinition](#deletebehaviordefinition-high-level-behavior-definition) - [GetBehaviorDefinition](#getbehaviordefinition-high-level-behavior-definition) - [UpdateBehaviorDefinition](#updatebehaviordefinition-high-level-behavior-definition) - [Behavior Implementation](#high-level-behavior-implementation) - [CreateBehaviorImplementation](#createbehaviorimplementation-high-level-behavior-implementation) - [DeleteBehaviorImplementation](#deletebehaviorimplementation-high-level-behavior-implementation) - [GetBehaviorImplementation](#getbehaviorimplementation-high-level-behavior-implementation) - [UpdateBehaviorImplementation](#updatebehaviorimplementation-high-level-behavior-implementation) - [Class](#high-level-class) - [CreateClass](#createclass-high-level-class) - [CreateLocalDefinitions](#createlocaldefinitions-high-level-class) - [CreateLocalMacros](#createlocalmacros-high-level-class) - [CreateLocalTestClass](#createlocaltestclass-high-level-class) - [CreateLocalTypes](#createlocaltypes-high-level-class) - [DeleteClass](#deleteclass-high-level-class) - [DeleteLocalDefinitions](#deletelocaldefinitions-high-level-class) - [DeleteLocalMacros](#deletelocalmacros-high-level-class) - [DeleteLocalTestClass](#deletelocaltestclass-high-level-class) - [DeleteLocalTypes](#deletelocaltypes-high-level-class) - [GetClass](#getclass-high-level-class) - [GetLocalDefinitions](#getlocaldefinitions-high-level-class) - [GetLocalMacros](#getlocalmacros-high-level-class) - [GetLocalTestClass](#getlocaltestclass-high-level-class) - [GetLocalTypes](#getlocaltypes-high-level-class) - [UpdateClass](#updateclass-high-level-class) - [UpdateLocalDefinitions](#updatelocaldefinitions-high-level-class) - [UpdateLocalMacros](#updatelocalmacros-high-level-class) - [UpdateLocalTestClass](#updatelocaltestclass-high-level-class) - [UpdateLocalTypes](#updatelocaltypes-high-level-class) - [Compact](#high-level-compact) - [HandlerActivate](#handleractivate-high-level-compact) - [HandlerCdsUnitTestResult](#handlercdsunittestresult-high-level-compact) - [HandlerCdsUnitTestStatus](#handlercdsunitteststatus-high-level-compact) - [HandlerCheckRun](#handlercheckrun-high-level-compact) - [HandlerCreate](#handlercreate-high-level-compact) - [HandlerDelete](#handlerdelete-high-level-compact) - [HandlerDumpList](#handlerdumplist-high-level-compact) - [HandlerDumpView](#handlerdumpview-high-level-compact) - [HandlerGet](#handlerget-high-level-compact) - [HandlerLock](#handlerlock-high-level-compact) - [HandlerProfileList](#handlerprofilelist-high-level-compact) - [HandlerProfileRun](#handlerprofilerun-high-level-compact) - [HandlerProfileView](#handlerprofileview-high-level-compact) - [HandlerServiceBindingListTypes](#handlerservicebindinglisttypes-high-level-compact) - [HandlerServiceBindingValidate](#handlerservicebindingvalidate-high-level-compact) - [HandlerTransportCreate](#handlertransportcreate-high-level-compact) - [HandlerUnitTestResult](#handlerunittestresult-high-level-compact) - [HandlerUnitTestRun](#handlerunittestrun-high-level-compact) - [HandlerUnitTestStatus](#handlerunitteststatus-high-level-compact) - [HandlerUnlock](#handlerunlock-high-level-compact) - [HandlerUpdate](#handlerupdate-high-level-compact) - [HandlerValidate](#handlervalidate-high-level-compact) - [Data Element](#high-level-data-element) - [CreateDataElement](#createdataelement-high-level-data-element) - [DeleteDataElement](#deletedataelement-high-level-data-element) - [GetDataElement](#getdataelement-high-level-data-element) - [UpdateDataElement](#updatedataelement-high-level-data-element) - [Ddlx](#high-level-ddlx) - [CreateMetadataExtension](#createmetadataextension-high-level-ddlx) - [UpdateMetadataExtension](#updatemetadataextension-high-level-ddlx) - [Domain](#high-level-domain) - [CreateDomain](#createdomain-high-level-domain) - [DeleteDomain](#deletedomain-high-level-domain) - [GetDomain](#getdomain-high-level-domain) - [UpdateDomain](#updatedomain-high-level-domain) - [Function](#high-level-function) - [CreateFunctionGroup](#createfunctiongroup-high-level-function) - [CreateFunctionModule](#createfunctionmodule-high-level-function) - [UpdateFunctionGroup](#updatefunctiongroup-high-level-function) - [UpdateFunctionModule](#updatefunctionmodule-high-level-function) - [Function Group](#high-level-function-group) - [DeleteFunctionGroup](#deletefunctiongroup-high-level-function-group) - [GetFunctionGroup](#getfunctiongroup-high-level-function-group) - [Function Module](#high-level-function-module) - [DeleteFunctionModule](#deletefunctionmodule-high-level-function-module) - [GetFunctionModule](#getfunctionmodule-high-level-function-module) - [Interface](#high-level-interface) - [CreateInterface](#createinterface-high-level-interface) - [DeleteInterface](#deleteinterface-high-level-interface) - [GetInterface](#getinterface-high-level-interface) - [UpdateInterface](#updateinterface-high-level-interface) - [Metadata Extension](#high-level-metadata-extension) - [DeleteMetadataExtension](#deletemetadataextension-high-level-metadata-extension) - [GetMetadataExtension](#getmetadataextension-high-level-metadata-extension) - [Package](#high-level-package) - [CreatePackage](#createpackage-high-level-package) - [GetPackage](#getpackage-high-level-package) - [Program](#high-level-program) - [CreateProgram](#createprogram-high-level-program) - [DeleteProgram](#deleteprogram-high-level-program) - [GetProgram](#getprogram-high-level-program) - [UpdateProgram](#updateprogram-high-level-program) - [Service Binding](#high-level-service-binding) - [CreateServiceBinding](#createservicebinding-high-level-service-binding) - [DeleteServiceBinding](#deleteservicebinding-high-level-service-binding) - [GetServiceBinding](#getservicebinding-high-level-service-binding) - [ListServiceBindingTypes](#listservicebindingtypes-high-level-service-binding) - [UpdateServiceBinding](#updateservicebinding-high-level-service-binding) - [ValidateServiceBinding](#validateservicebinding-high-level-service-binding) - [Service Definition](#high-level-service-definition) - [CreateServiceDefinition](#createservicedefinition-high-level-service-definition) - [DeleteServiceDefinition](#deleteservicedefinition-high-level-service-definition) - [GetServiceDefinition](#getservicedefinition-high-level-service-definition) - [UpdateServiceDefinition](#updateservicedefinition-high-level-service-definition) - [Structure](#high-level-structure) - [CreateStructure](#createstructure-high-level-structure) - [DeleteStructure](#deletestructure-high-level-structure) - [GetStructure](#getstructure-high-level-structure) - [UpdateStructure](#updatestructure-high-level-structure) - [System](#high-level-system) - [GetPackageTree](#getpackagetree-high-level-system) - [Table](#high-level-table) - [CreateTable](#createtable-high-level-table) - [DeleteTable](#deletetable-high-level-table) - [GetTable](#gettable-high-level-table) - [UpdateTable](#updatetable-high-level-table) - [Transport](#high-level-transport) - [CreateTransport](#createtransport-high-level-transport) - [Unit Test](#high-level-unit-test) - [CreateCdsUnitTest](#createcdsunittest-high-level-unit-test) - [CreateUnitTest](#createunittest-high-level-unit-test) - [DeleteCdsUnitTest](#deletecdsunittest-high-level-unit-test) - [DeleteUnitTest](#deleteunittest-high-level-unit-test) - [GetCdsUnitTest](#getcdsunittest-high-level-unit-test) - [GetCdsUnitTestResult](#getcdsunittestresult-high-level-unit-test) - [GetCdsUnitTestStatus](#getcdsunitteststatus-high-level-unit-test) - [GetUnitTest](#getunittest-high-level-unit-test) - [GetUnitTestResult](#getunittestresult-high-level-unit-test) - [GetUnitTestStatus](#getunitteststatus-high-level-unit-test) - [RunUnitTest](#rununittest-high-level-unit-test) - [UpdateCdsUnitTest](#updatecdsunittest-high-level-unit-test) - [UpdateUnitTest](#updateunittest-high-level-unit-test) - [View](#high-level-view) - [CreateView](#createview-high-level-view) - [DeleteView](#deleteview-high-level-view) - [GetView](#getview-high-level-view) - [UpdateView](#updateview-high-level-view) --- <a id="high-level-group"></a> ## High-Level Group <a id="high-level-behavior-definition"></a> ### High-Level / Behavior Definition <a id="createbehaviordefinition-high-level-behavior-definition"></a> #### CreateBehaviorDefinition (High-Level / Behavior Definition) **Description:** Create a new ABAP Behavior Definition (BDEF) in SAP system. **Source:** `src/handlers/behavior_definition/high/handleCreateBehaviorDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: true - `description` (string, optional) - Description - `implementation_type` (string, required) - Implementation type: - `name` (string, required) - Behavior Definition name (usually same as Root Entity name) - `package_name` (string, required) - Package name - `root_entity` (string, required) - Root Entity name (CDS View name) - `transport_request` (string, optional) - Transport request number --- <a id="deletebehaviordefinition-high-level-behavior-definition"></a> #### DeleteBehaviorDefinition (High-Level / Behavior Definition) **Description:** Delete an ABAP behavior definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/behavior_definition/high/handleDeleteBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getbehaviordefinition-high-level-behavior-definition"></a> #### GetBehaviorDefinition (High-Level / Behavior Definition) **Description:** Retrieve ABAP behavior definition definition. Supports reading active or inactive version. **Source:** `src/handlers/behavior_definition/high/handleGetBehaviorDefinition.ts` **Parameters:** - `behavior_definition_name` (string, required) - BehaviorDefinition name (e.g., Z_MY_BEHAVIORDEFINITION). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatebehaviordefinition-high-level-behavior-definition"></a> #### UpdateBehaviorDefinition (High-Level / Behavior Definition) **Description:** Update source code of an ABAP Behavior Definition. **Source:** `src/handlers/behavior_definition/high/handleUpdateBehaviorDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: true - `lock_handle` (string, optional) - Lock handle from LockObject. If not provided, will attempt to lock internally (not recommended for stateful flows). - `name` (string, required) - Behavior Definition name - `source_code` (string, required) - New source code - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="high-level-behavior-implementation"></a> ### High-Level / Behavior Implementation <a id="createbehaviorimplementation-high-level-behavior-implementation"></a> #### CreateBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Create a new ABAP behavior implementation class for a behavior definition. Behavior implementations contain the business logic for RAP entities. Uses stateful session for proper lock management. **Source:** `src/handlers/behavior_implementation/high/handleCreateBehaviorImplementation.ts` **Parameters:** - `activate` (boolean, optional) - Activate behavior implementation after creation. Default: true. - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). The behavior definition must exist. - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must follow SAP naming conventions (typically starts with ZBP_ for behavior implementations). - `description` (string, optional) - Class description. If not provided, class_name will be used. - `implementation_code` (string, optional) - Implementation code for the implementations include (optional). Contains the actual behavior implementation methods. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deletebehaviorimplementation-high-level-behavior-implementation"></a> #### DeleteBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Delete an ABAP behavior implementation from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/behavior_implementation/high/handleDeleteBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getbehaviorimplementation-high-level-behavior-implementation"></a> #### GetBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Retrieve ABAP behavior implementation definition. Supports reading active or inactive version. **Source:** `src/handlers/behavior_implementation/high/handleGetBehaviorImplementation.ts` **Parameters:** - `behavior_implementation_name` (string, required) - BehaviorImplementation name (e.g., Z_MY_BEHAVIORIMPLEMENTATION). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatebehaviorimplementation-high-level-behavior-implementation"></a> #### UpdateBehaviorImplementation (High-Level / Behavior Implementation) **Description:** Update source code of an existing ABAP behavior implementation class. Updates both main source (with FOR BEHAVIOR OF clause) and implementations include. Uses stateful session with proper lock/unlock mechanism. **Source:** `src/handlers/behavior_implementation/high/handleUpdateBehaviorImplementation.ts` **Parameters:** - `activate` (boolean, optional) - Activate behavior implementation after update. Default: true. - `behavior_definition` (string, required) - Behavior Definition name (e.g., ZI_MY_ENTITY). Must match the behavior definition used when creating the class. - `class_name` (string, required) - Behavior Implementation class name (e.g., ZBP_MY_ENTITY). Must exist in the system. - `implementation_code` (string, required) - Implementation code for the implementations include. Contains the actual behavior implementation methods. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="high-level-class"></a> ### High-Level / Class <a id="createclass-high-level-class"></a> #### CreateClass (High-Level / Class) **Description:** Create a new ABAP class with optional activation. Manages validation, lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleCreateClass.ts` **Parameters:** - `abstract` (boolean, optional) - Mark class as abstract. Default: false - `activate` (boolean, optional) - Activate after creation. Default: true. - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). - `create_protected` (boolean, optional) - Protected constructor. Default: false - `description` (string, optional) - Class description (defaults to class_name). - `final` (boolean, optional) - Mark class as final. Default: false - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP). - `source_code` (string, optional) - Full ABAP class source code. If omitted, a minimal template is generated. - `superclass` (string, optional) - Optional superclass name. - `transport_request` (string, optional) - Transport request number (required for transportable packages). --- <a id="createlocaldefinitions-high-level-class"></a> #### CreateLocalDefinitions (High-Level / Class) **Description:** Create local definitions in an ABAP class (definitions include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleCreateLocalDefinitions.ts` **Parameters:** - `activate_on_create` (boolean, optional (default: false)) - Activate parent class after creating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `definitions_code` (string, required) - Source code for local definitions. - `transport_request` (string, optional) - Transport request number. --- <a id="createlocalmacros-high-level-class"></a> #### CreateLocalMacros (High-Level / Class) **Description:** Create local macros in an ABAP class (macros include). Manages lock, check, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleCreateLocalMacros.ts` **Parameters:** - `activate_on_create` (boolean, optional (default: false)) - Activate parent class after creating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `macros_code` (string, required) - Source code for local macros. - `transport_request` (string, optional) - Transport request number. --- <a id="createlocaltestclass-high-level-class"></a> #### CreateLocalTestClass (High-Level / Class) **Description:** Create a local test class in an ABAP class. Manages lock, check, update, unlock, and optional activation of parent class. **Source:** `src/handlers/class/high/handleCreateLocalTestClass.ts` **Parameters:** - `activate_on_create` (boolean, optional (default: false)) - Activate parent class after creating test class. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `test_class_code` (string, required) - Source code for the local test class. - `test_class_name` (string, optional) - Optional test class name (e.g., lcl_test). - `transport_request` (string, optional) - Transport request number (required for transportable objects). --- <a id="createlocaltypes-high-level-class"></a> #### CreateLocalTypes (High-Level / Class) **Description:** Create local types in an ABAP class (implementations include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleCreateLocalTypes.ts` **Parameters:** - `activate_on_create` (boolean, optional (default: false)) - Activate parent class after creating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `local_types_code` (string, required) - Source code for local types. - `transport_request` (string, optional) - Transport request number. --- <a id="deleteclass-high-level-class"></a> #### DeleteClass (High-Level / Class) **Description:** Delete an ABAP class from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/class/high/handleDeleteClass.ts` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="deletelocaldefinitions-high-level-class"></a> #### DeleteLocalDefinitions (High-Level / Class) **Description:** Delete local definitions from an ABAP class by clearing the definitions include. Manages lock, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleDeleteLocalDefinitions.ts` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- <a id="deletelocalmacros-high-level-class"></a> #### DeleteLocalMacros (High-Level / Class) **Description:** Delete local macros from an ABAP class by clearing the macros include. Manages lock, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleDeleteLocalMacros.ts` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- <a id="deletelocaltestclass-high-level-class"></a> #### DeleteLocalTestClass (High-Level / Class) **Description:** Delete a local test class from an ABAP class by clearing the testclasses include. Manages lock, update, unlock, and optional activation of parent class. **Source:** `src/handlers/class/high/handleDeleteLocalTestClass.ts` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting test class. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number (required for transportable objects). --- <a id="deletelocaltypes-high-level-class"></a> #### DeleteLocalTypes (High-Level / Class) **Description:** Delete local types from an ABAP class by clearing the implementations include. Manages lock, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleDeleteLocalTypes.ts` **Parameters:** - `activate_on_delete` (boolean, optional (default: false)) - Activate parent class after deleting. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `transport_request` (string, optional) - Transport request number. --- <a id="getclass-high-level-class"></a> #### GetClass (High-Level / Class) **Description:** Retrieve ABAP class source code. Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetClass.ts` **Parameters:** - `class_name` (string, required) - Class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: --- <a id="getlocaldefinitions-high-level-class"></a> #### GetLocalDefinitions (High-Level / Class) **Description:** Retrieve local definitions source code from a class (definitions include). Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalDefinitions.ts` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: --- <a id="getlocalmacros-high-level-class"></a> #### GetLocalMacros (High-Level / Class) **Description:** Retrieve local macros source code from a class (macros include). Supports reading active or inactive version. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleGetLocalMacros.ts` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: --- <a id="getlocaltestclass-high-level-class"></a> #### GetLocalTestClass (High-Level / Class) **Description:** Retrieve local test class source code from a class. Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalTestClass.ts` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: --- <a id="getlocaltypes-high-level-class"></a> #### GetLocalTypes (High-Level / Class) **Description:** Retrieve local types source code from a class (implementations include). Supports reading active or inactive version. **Source:** `src/handlers/class/high/handleGetLocalTypes.ts` **Parameters:** - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `version` (string, optional (default: active)) - Version to read: --- <a id="updateclass-high-level-class"></a> #### UpdateClass (High-Level / Class) **Description:** Update source code of an existing ABAP class. Locks, checks, updates, unlocks, and optionally activates. **Source:** `src/handlers/class/high/handleUpdateClass.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `class_name` (string, required) - Class name (e.g., ZCL_TEST_CLASS_001). - `source_code` (string, required) - Complete ABAP class source code. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="updatelocaldefinitions-high-level-class"></a> #### UpdateLocalDefinitions (High-Level / Class) **Description:** Update local definitions in an ABAP class (definitions include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleUpdateLocalDefinitions.ts` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `definitions_code` (string, required) - Updated source code for local definitions. - `transport_request` (string, optional) - Transport request number. --- <a id="updatelocalmacros-high-level-class"></a> #### UpdateLocalMacros (High-Level / Class) **Description:** Update local macros in an ABAP class (macros include). Manages lock, check, update, unlock, and optional activation. Note: Macros are supported in older ABAP versions but not in newer ones. **Source:** `src/handlers/class/high/handleUpdateLocalMacros.ts` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `macros_code` (string, required) - Updated source code for local macros. - `transport_request` (string, optional) - Transport request number. --- <a id="updatelocaltestclass-high-level-class"></a> #### UpdateLocalTestClass (High-Level / Class) **Description:** Update a local test class in an ABAP class. Manages lock, check, update, unlock, and optional activation of parent class. **Source:** `src/handlers/class/high/handleUpdateLocalTestClass.ts` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating test class. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `test_class_code` (string, required) - Updated source code for the local test class. - `transport_request` (string, optional) - Transport request number (required for transportable objects). --- <a id="updatelocaltypes-high-level-class"></a> #### UpdateLocalTypes (High-Level / Class) **Description:** Update local types in an ABAP class (implementations include). Manages lock, check, update, unlock, and optional activation. **Source:** `src/handlers/class/high/handleUpdateLocalTypes.ts` **Parameters:** - `activate_on_update` (boolean, optional (default: false)) - Activate parent class after updating. Default: false - `class_name` (string, required) - Parent class name (e.g., ZCL_MY_CLASS). - `local_types_code` (string, required) - Updated source code for local types. - `transport_request` (string, optional) - Transport request number. --- <a id="high-level-compact"></a> ### High-Level / Compact <a id="handleractivate-high-level-compact"></a> #### HandlerActivate (High-Level / Compact) **Description:** Activate operation. Single mode(object_name*, object_adt_type*). Batch mode(objects[].name*, objects[].type*). **Source:** `src/handlers/compact/high/handleHandlerActivate.ts` **Parameters:** - `object_adt_type` (string, optional) - ADT object type code (e.g. CLAS/OC, PROG/P). Required for single-object activation form. - `object_name` (string, optional) - Object name for single-object activation form. - `object_type` (any, optional) - - `objects` (array, optional) - Explicit objects list for batch activation. - `preaudit` (boolean, optional) - Run pre-audit checks before activation. --- <a id="handlercdsunittestresult-high-level-compact"></a> #### HandlerCdsUnitTestResult (High-Level / Compact) **Description:** CDS unit test result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestResult.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- <a id="handlercdsunitteststatus-high-level-compact"></a> #### HandlerCdsUnitTestStatus (High-Level / Compact) **Description:** CDS unit test status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerCdsUnitTestStatus.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- <a id="handlercheckrun-high-level-compact"></a> #### HandlerCheckRun (High-Level / Compact) **Description:** CheckRun operation (syntax, no activation). object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*). **Source:** `src/handlers/compact/high/handleHandlerCheckRun.ts` **Parameters:** - `session_id` (string, optional) - Optional ADT session id for stateful check flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful check flow. - `version` (string, optional (default: active)) - Version to syntax-check. --- <a id="handlercreate-high-level-compact"></a> #### HandlerCreate (High-Level / Compact) **Description:** Create operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerCreate.ts` **Parameters:** - `activate` (boolean, optional) - Activate object after create. - `application` (string, optional) - Domain application area. - `class_name` (string, optional) - ABAP class name. - `conversion_exit` (string, optional) - Conversion exit name. - `datatype` (string, optional) - ABAP data type. - `decimals` (number, optional) - Decimal places. - `description` (string, optional) - Human-readable object description. - `domain_name` (string, optional) - ABAP domain name. - `fixed_values` (array, optional) - Domain fixed values list. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `length` (number, optional) - Length for typed artifacts. - `lowercase` (boolean, optional) - Allow lowercase values (domain setting). - `object_type` (any, required) - - `package_name` (string, optional) - ABAP package name. - `program_name` (string, optional) - ABAP program name. - `program_type` (string, optional) - ABAP program type. - `sign_exists` (boolean, optional) - Allow signed values (domain setting). - `source_code` (string, optional) - ABAP source code payload. - `transport_request` (string, optional) - Transport request id (if required by system). - `value_table` (string, optional) - Foreign key value table. --- <a id="handlerdelete-high-level-compact"></a> #### HandlerDelete (High-Level / Compact) **Description:** Delete operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerDelete.ts` **Parameters:** - `class_name` (string, optional) - ABAP class name. - `domain_name` (string, optional) - ABAP domain name. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `object_type` (any, required) - - `program_name` (string, optional) - ABAP program name. - `transport_request` (string, optional) - Transport request id (if required by system). --- <a id="handlerdumplist-high-level-compact"></a> #### HandlerDumpList (High-Level / Compact) **Description:** Runtime dump list. object_type: not used. Required: none. Optional: user, inlinecount, top, skip, orderby. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerDumpList.ts` **Parameters:** - `inlinecount` (string, optional) - Include total count in response. - `orderby` (string, optional) - Sort expression. - `skip` (number, optional) - Offset for pagination. - `top` (number, optional) - Limit number of returned dumps. - `user` (string, optional) - Filter dumps by user. --- <a id="handlerdumpview-high-level-compact"></a> #### HandlerDumpView (High-Level / Compact) **Description:** Runtime dump view. object_type: not used. Required: dump_id*. Optional: view(default|summary|formatted). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerDumpView.ts` **Parameters:** - `dump_id` (string, required) - Runtime dump id. - `view` (string, optional (default: default)) - Dump rendering mode. --- <a id="handlerget-high-level-compact"></a> #### HandlerGet (High-Level / Compact) **Description:** Read operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerGet.ts` **Parameters:** - `behavior_definition_name` (string, optional) - Behavior definition name. - `behavior_implementation_name` (string, optional) - Behavior implementation name. - `class_name` (string, optional) - Class name. - `data_element_name` (string, optional) - Data element name. - `domain_name` (string, optional) - Domain name. - `function_group_name` (string, optional) - Function group name. - `function_module_name` (string, optional) - Function module name. - `interface_name` (string, optional) - Interface name. - `metadata_extension_name` (string, optional) - Metadata extension name. - `object_type` (any, required) - - `package_name` (string, optional) - Package name. - `program_name` (string, optional) - Program name. - `response_format` (string, optional) - Response format for SERVICE_BINDING reads. - `run_id` (string, optional) - Unit test run id. - `service_binding_name` (string, optional) - Service binding name. - `service_definition_name` (string, optional) - Service definition name. - `structure_name` (string, optional) - Structure name. - `table_name` (string, optional) - Table name. - `version` (any, optional) - - `view_name` (string, optional) - View name. --- <a id="handlerlock-high-level-compact"></a> #### HandlerLock (High-Level / Compact) **Description:** Lock operation. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*). **Source:** `src/handlers/compact/high/handleHandlerLock.ts` **Parameters:** - `session_id` (string, optional) - Optional ADT session id for stateful lock flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful lock flow. - `super_package` (string, optional) - Super package context when relevant. --- <a id="handlerprofilelist-high-level-compact"></a> #### HandlerProfileList (High-Level / Compact) **Description:** Runtime profiling list. object_type: not used. Required: none. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileList.ts` **Parameters:** - See schema reference `compactProfileListSchema` in source file --- <a id="handlerprofilerun-high-level-compact"></a> #### HandlerProfileRun (High-Level / Compact) **Description:** Runtime profiling run. object_type: not used. Required: target_type*(CLASS|PROGRAM) + class_name* for CLASS or program_name* for PROGRAM. Optional profiling flags and description. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileRun.ts` **Parameters:** - `aggregate` (boolean, optional) - Aggregate profiling data. - `all_db_events` (boolean, optional) - Trace all DB events. - `all_dynpro_events` (boolean, optional) - Trace dynpro events. - `all_internal_table_events` (boolean, optional) - Trace internal table events. - `all_misc_abap_statements` (boolean, optional) - Trace miscellaneous ABAP statements. - `all_procedural_units` (boolean, optional) - Trace all procedural units. - `all_system_kernel_events` (boolean, optional) - Trace system kernel events. - `amdp_trace` (boolean, optional) - Enable AMDP tracing. - `class_name` (string, optional) - Class name for profiling. - `description` (string, optional) - Profiler run description. - `explicit_on_off` (boolean, optional) - Use explicit on/off trace sections. - `max_size_for_trace_file` (number, optional) - Maximum trace file size. - `max_time_for_tracing` (number, optional) - Maximum tracing time. - `program_name` (string, optional) - Program name for profiling. - `sql_trace` (boolean, optional) - Enable SQL trace. - `target_type` (string, required) - Profile execution target kind. - `with_rfc_tracing` (boolean, optional) - Enable RFC tracing. --- <a id="handlerprofileview-high-level-compact"></a> #### HandlerProfileView (High-Level / Compact) **Description:** Runtime profiling view. object_type: not used. Required: trace_id_or_uri*, view*(hitlist|statements|db_accesses). Optional: with_system_events, id, with_details, auto_drill_down_threshold. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerProfileView.ts` **Parameters:** - `auto_drill_down_threshold` (number, optional) - Auto drill-down threshold. - `id` (number, optional) - Optional statement/access id. - `trace_id_or_uri` (string, required) - Profiler trace id or URI. - `view` (string, required) - Profiler trace view kind. - `with_details` (boolean, optional) - Include detailed payload. - `with_system_events` (boolean, optional) - Include system events in analysis. --- <a id="handlerservicebindinglisttypes-high-level-compact"></a> #### HandlerServiceBindingListTypes (High-Level / Compact) **Description:** Service binding types list. object_type: not used. Required: none. Optional: response_format(xml|json|plain). Response: XML/JSON/plain by response_format. **Source:** `src/handlers/compact/high/handleHandlerServiceBindingListTypes.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - Response format for protocol types list. --- <a id="handlerservicebindingvalidate-high-level-compact"></a> #### HandlerServiceBindingValidate (High-Level / Compact) **Description:** Service binding validate before create. object_type: not used. Required: service_binding_name*, service_definition_name*. Optional: service_binding_version, package_name, description. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerServiceBindingValidate.ts` **Parameters:** - `description` (string, optional) - Binding description. - `package_name` (string, optional) - Target package name. - `service_binding_name` (string, required) - Service binding name to validate. - `service_binding_version` (string, optional) - Service binding version. - `service_definition_name` (string, required) - Service definition name to pair with binding. --- <a id="handlertransportcreate-high-level-compact"></a> #### HandlerTransportCreate (High-Level / Compact) **Description:** Transport create. object_type: not used. Required: description*. Optional: transport_type(workbench|customizing), target_system, owner. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerTransportCreate.ts` **Parameters:** - `description` (string, required) - Transport description. - `owner` (string, optional) - Transport owner user. - `target_system` (string, optional) - Target system id. - `transport_type` (string, optional (default: workbench)) - Transport type. --- <a id="handlerunittestresult-high-level-compact"></a> #### HandlerUnitTestResult (High-Level / Compact) **Description:** ABAP Unit result. object_type: not used. Required: run_id*. Optional: with_navigation_uris, format(abapunit|junit). Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestResult.ts` **Parameters:** - `format` (string, optional) - Result format. - `run_id` (string, required) - Unit test run id. - `with_navigation_uris` (boolean, optional (default: false)) - Include ADT navigation URIs in the result payload. --- <a id="handlerunittestrun-high-level-compact"></a> #### HandlerUnitTestRun (High-Level / Compact) **Description:** ABAP Unit run. object_type: not used. Required: tests[]{container_class*, test_class*}. Optional: title, context, scope, risk_level, duration. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestRun.ts` **Parameters:** - `context` (string, optional) - Run context label. - `duration` (object, optional) - Allowed duration classes. - `risk_level` (object, optional) - Allowed risk levels. - `scope` (object, optional) - ABAP Unit scope flags. - `tests` (array, required) - List of test classes to run. - `title` (string, optional) - Run title shown in ABAP Unit logs. --- <a id="handlerunitteststatus-high-level-compact"></a> #### HandlerUnitTestStatus (High-Level / Compact) **Description:** ABAP Unit status. object_type: not used. Required: run_id*. Optional: with_long_polling. Response: JSON. **Source:** `src/handlers/compact/high/handleHandlerUnitTestStatus.ts` **Parameters:** - `run_id` (string, required) - Unit test run id. - `with_long_polling` (boolean, optional (default: true)) - Use long polling while waiting for completion. --- <a id="handlerunlock-high-level-compact"></a> #### HandlerUnlock (High-Level / Compact) **Description:** Unlock operation. object_type required: CLASS(object_name*, lock_handle*, session_id*), PROGRAM(object_name*, lock_handle*, session_id*), INTERFACE(object_name*, lock_handle*, session_id*), FUNCTION_GROUP(object_name*, lock_handle*, session_id*), FUNCTION_MODULE(object_name*, lock_handle*, session_id*), TABLE(object_name*, lock_handle*, session_id*), STRUCTURE(object_name*, lock_handle*, session_id*), VIEW(object_name*, lock_handle*, session_id*), DOMAIN(object_name*, lock_handle*, session_id*), DATA_ELEMENT(object_name*, lock_handle*, session_id*), PACKAGE(object_name*, lock_handle*, session_id*), BEHAVIOR_DEFINITION(object_name*, lock_handle*, session_id*), BEHAVIOR_IMPLEMENTATION(object_name*, lock_handle*, session_id*), METADATA_EXTENSION(object_name*, lock_handle*, session_id*). **Source:** `src/handlers/compact/high/handleHandlerUnlock.ts` **Parameters:** - `lock_handle` (string, required) - Lock handle returned by lock. - `session_id` (string, required) - ADT session id used during lock. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful unlock flow. --- <a id="handlerupdate-high-level-compact"></a> #### HandlerUpdate (High-Level / Compact) **Description:** Update operation. object_type required: PACKAGE(package_name*), DOMAIN(domain_name*), DATA_ELEMENT(data_element_name*), TABLE(table_name*), STRUCTURE(structure_name*), VIEW(view_name*), SERVICE_DEFINITION(service_definition_name*), SERVICE_BINDING(service_binding_name*), CLASS(class_name*), LOCAL_TEST_CLASS(class_name*), LOCAL_TYPES(class_name*), LOCAL_DEFINITIONS(class_name*), LOCAL_MACROS(class_name*), PROGRAM(program_name*), INTERFACE(interface_name*), FUNCTION_GROUP(function_group_name*), FUNCTION_MODULE(function_module_name*, function_group_name*), BEHAVIOR_DEFINITION(behavior_definition_name*), BEHAVIOR_IMPLEMENTATION(behavior_implementation_name*), METADATA_EXTENSION(metadata_extension_name*), UNIT_TEST(run_id*), CDS_UNIT_TEST(run_id*). **Source:** `src/handlers/compact/high/handleHandlerUpdate.ts` **Parameters:** - `activate` (boolean, optional) - Activate object after update. - `class_name` (string, optional) - ABAP class name. - `conversion_exit` (string, optional) - Conversion exit name. - `datatype` (string, optional) - ABAP data type. - `decimals` (number, optional) - Decimal places. - `description` (string, optional) - Human-readable object description. - `domain_name` (string, optional) - ABAP domain name. - `fixed_values` (array, optional) - Domain fixed values list. - `function_group_name` (string, optional) - ABAP function group name. - `function_module_name` (string, optional) - ABAP function module name. - `length` (number, optional) - Length for typed artifacts. - `lowercase` (boolean, optional) - Allow lowercase values (domain setting). - `object_type` (any, required) - - `package_name` (string, optional) - ABAP package name. - `program_name` (string, optional) - ABAP program name. - `sign_exists` (boolean, optional) - Allow signed values (domain setting). - `source_code` (string, optional) - ABAP source code payload. - `transport_request` (string, optional) - Transport request id (if required by system). - `value_table` (string, optional) - Foreign key value table. --- <a id="handlervalidate-high-level-compact"></a> #### HandlerValidate (High-Level / Compact) **Description:** Validate before create only. object_type required: CLASS(object_name*), PROGRAM(object_name*), INTERFACE(object_name*), FUNCTION_GROUP(object_name*), FUNCTION_MODULE(object_name*), TABLE(object_name*), STRUCTURE(object_name*), VIEW(object_name*), DOMAIN(object_name*), DATA_ELEMENT(object_name*), PACKAGE(object_name*), BEHAVIOR_DEFINITION(object_name*), BEHAVIOR_IMPLEMENTATION(object_name*), METADATA_EXTENSION(object_name*), SERVICE_BINDING(object_name*=service_binding_name*, service_definition_name*). **Source:** `src/handlers/compact/high/handleHandlerValidate.ts` **Parameters:** - `behavior_definition` (string, optional) - Optional behavior definition name, used when validating behavior implementation. - `description` (string, optional) - Optional object description used during validation. - `implementation_type` (string, optional) - Optional implementation type, used for behavior implementation validation. - `object_name` (string, required) - Required object name. For SERVICE_BINDING this is the service binding name. - `object_type` (string, required) - Object type to validate before create. Supported: CLASS, PROGRAM, INTERFACE, FUNCTION_GROUP, FUNCTION_MODULE, TABLE, STRUCTURE, VIEW, DOMAIN, DATA_ELEMENT, PACKAGE, BEHAVIOR_DEFINITION, BEHAVIOR_IMPLEMENTATION, METADATA_EXTENSION, SERVICE_BINDING. - `package_name` (string, optional) - Optional package context for validation (especially for create scenarios). - `root_entity` (string, optional) - Optional CDS root entity name, used for behavior-related validation. - `service_binding_version` (string, optional) - Optional service binding version for SERVICE_BINDING. - `service_definition_name` (string, optional) - Required when object_type=SERVICE_BINDING. Service definition paired with the binding. - `session_id` (string, optional) - Optional ADT session id for stateful validation flow. - `session_state` (object, optional) - Optional ADT session state container (cookies/CSRF) for stateful validation flow. --- <a id="high-level-data-element"></a> ### High-Level / Data Element <a id="createdataelement-high-level-data-element"></a> #### CreateDataElement (High-Level / Data Element) **Description:** Create a new ABAP data element in SAP system with all required steps: create, activate, and verify. **Source:** `src/handlers/data_element/high/handleCreateDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., ZZ_E_TEST_001). Must follow SAP naming conventions. - `data_type` (string, optional (default: CHAR)) - Data type (e.g., CHAR, NUMC) or domain name when type_kind is - `decimals` (number, optional (default: 0)) - Decimal places. Usually inherited from domain. - `description` (string, optional) - Data element description. If not provided, data_element_name will be used. - `heading_label` (string, optional) - Heading field label (max 55 chars). Applied during update step after creation. - `length` (number, optional (default: 100)) - Data type length. Usually inherited from domain. - `long_label` (string, optional) - Long field label (max 40 chars). Applied during update step after creation. - `medium_label` (string, optional) - Medium field label (max 20 chars). Applied during update step after creation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `search_help` (string, optional) - Search help name. Applied during update step after creation. - `search_help_parameter` (string, optional) - Search help parameter. Applied during update step after creation. - `set_get_parameter` (string, optional) - Set/Get parameter ID. Applied during update step after creation. - `short_label` (string, optional) - Short field label (max 10 chars). Applied during update step after creation. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. - `type_kind` (string, optional (default: domain)) - Type kind: - `type_name` (string, optional) - Type name: domain name (when type_kind is --- <a id="deletedataelement-high-level-data-element"></a> #### DeleteDataElement (High-Level / Data Element) **Description:** Delete an ABAP data element from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/data_element/high/handleDeleteDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getdataelement-high-level-data-element"></a> #### GetDataElement (High-Level / Data Element) **Description:** Retrieve ABAP data element definition. Supports reading active or inactive version. **Source:** `src/handlers/data_element/high/handleGetDataElement.ts` **Parameters:** - `data_element_name` (string, required) - Data element name (e.g., Z_MY_DATA_ELEMENT). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatedataelement-high-level-data-element"></a> #### UpdateDataElement (High-Level / Data Element) **Description:** Data element name to update (e.g., ZZ_TEST_DTEL_01) **Source:** `src/handlers/data_element/high/handleUpdateDataElement.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - Activate data element after update (default: true) - `data_element_name` (string, required) - Data element name to update (e.g., ZZ_TEST_DTEL_01) - `data_type` (string, optional) - Data type (CHAR, NUMC, etc.) - for predefinedAbapType or refToPredefinedAbapType - `decimals` (number, optional) - Decimals - for predefinedAbapType or refToPredefinedAbapType - `description` (string, optional) - New data element description - `field_label_heading` (string, optional) - Heading field label (max 55 chars) - `field_label_long` (string, optional) - Long field label (max 40 chars) - `field_label_medium` (string, optional) - Medium field label (max 20 chars) - `field_label_short` (string, optional) - Short field label (max 10 chars) - `length` (number, optional) - Length - for predefinedAbapType or refToPredefinedAbapType - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `search_help` (string, optional) - Search help name - `search_help_parameter` (string, optional) - Search help parameter - `set_get_parameter` (string, optional) - Set/Get parameter ID - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. - `type_kind` (string, optional (default: domain)) - Type kind: domain, predefinedAbapType, refToPredefinedAbapType, refToDictionaryType, refToClifType - `type_name` (string, optional) - Type name: domain name, data element name, or class name (depending on type_kind) --- <a id="high-level-ddlx"></a> ### High-Level / Ddlx <a id="createmetadataextension-high-level-ddlx"></a> #### CreateMetadataExtension (High-Level / Ddlx) **Description:** Create a new ABAP Metadata Extension (DDLX) in SAP system. **Source:** `src/handlers/ddlx/high/handleCreateMetadataExtension.ts` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: true - `description` (string, optional) - Description - `name` (string, required) - Metadata Extension name - `package_name` (string, required) - Package name - `transport_request` (string, optional) - Transport request number --- <a id="updatemetadataextension-high-level-ddlx"></a> #### UpdateMetadataExtension (High-Level / Ddlx) **Description:** Update source code of an ABAP Metadata Extension. **Source:** `src/handlers/ddlx/high/handleUpdateMetadataExtension.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: true - `lock_handle` (string, optional) - Lock handle from LockObject. If not provided, will attempt to lock internally. - `name` (string, required) - Metadata Extension name - `source_code` (string, required) - New source code --- <a id="high-level-domain"></a> ### High-Level / Domain <a id="createdomain-high-level-domain"></a> #### CreateDomain (High-Level / Domain) **Description:** Create a new ABAP domain in SAP system with all required steps: lock, create, check, unlock, activate, and verify. **Source:** `src/handlers/domain/high/handleCreateDomain.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - (optional) Activate domain after creation (default: true) - `conversion_exit` (string, optional) - (optional) Conversion exit routine name (without CONVERSION_EXIT_ prefix) - `datatype` (string, optional (default: CHAR)) - (optional) Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc. - `decimals` (number, optional (default: 0)) - (optional) Decimal places (for DEC, CURR, QUAN types) - `description` (string, optional) - (optional) Domain description. If not provided, domain_name will be used. - `domain_name` (string, required) - Domain name (e.g., ZZ_TEST_0001). Must follow SAP naming conventions. - `fixed_values` (array, optional) - (optional) Array of fixed values for domain value range - `length` (number, optional (default: 100)) - (optional) Field length (max depends on datatype) - `lowercase` (boolean, optional (default: false)) - (optional) Allow lowercase input - `package_name` (string, optional) - (optional) Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `sign_exists` (boolean, optional (default: false)) - (optional) Field has sign (+/-) - `transport_request` (string, optional) - (optional) Transport request number (e.g., E19K905635). Required for transportable packages. - `value_table` (string, optional) - (optional) Value table name for foreign key relationship --- <a id="deletedomain-high-level-domain"></a> #### DeleteDomain (High-Level / Domain) **Description:** Delete an ABAP domain from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/domain/high/handleDeleteDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getdomain-high-level-domain"></a> #### GetDomain (High-Level / Domain) **Description:** Retrieve ABAP domain definition. Supports reading active or inactive version. **Source:** `src/handlers/domain/high/handleGetDomain.ts` **Parameters:** - `domain_name` (string, required) - Domain name (e.g., Z_MY_DOMAIN). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatedomain-high-level-domain"></a> #### UpdateDomain (High-Level / Domain) **Description:** Domain name to update (e.g., ZZ_TEST_0001) **Source:** `src/handlers/domain/high/handleUpdateDomain.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - Activate domain after update (default: true) - `conversion_exit` (string, optional) - Conversion exit routine name (without CONVERSION_EXIT_ prefix) - `datatype` (string, optional) - Data type: CHAR, NUMC, DATS, TIMS, DEC, INT1, INT2, INT4, INT8, CURR, QUAN, etc. - `decimals` (number, optional) - Decimal places (for DEC, CURR, QUAN types) - `description` (string, optional) - New domain description (optional) - `domain_name` (string, required) - Domain name to update (e.g., ZZ_TEST_0001) - `fixed_values` (array, optional) - Array of fixed values for domain value range - `length` (number, optional) - Field length (max depends on datatype) - `lowercase` (boolean, optional) - Allow lowercase input - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `sign_exists` (boolean, optional) - Field has sign (+/-) - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. - `value_table` (string, optional) - Value table name for foreign key relationship --- <a id="high-level-function"></a> ### High-Level / Function <a id="createfunctiongroup-high-level-function"></a> #### CreateFunctionGroup (High-Level / Function) **Description:** Create a new ABAP function group in SAP system. Function groups serve as containers for function modules. Uses stateful session for proper lock management. **Source:** `src/handlers/function/high/handleCreateFunctionGroup.ts` **Parameters:** - `activate` (boolean, optional) - Activate function group after creation. Default: true. Set to false for batch operations. - `description` (string, optional) - Function group description. If not provided, function_group_name will be used. - `function_group_name` (string, required) - Function group name (e.g., ZTEST_FG_001). Must follow SAP naming conventions (start with Z or Y, max 26 chars). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="createfunctionmodule-high-level-function"></a> #### CreateFunctionModule (High-Level / Function) **Description:** Create a new ABAP function module within an existing function group. Uses stateful session with LOCK/UNLOCK workflow for source code upload. **Source:** `src/handlers/function/high/handleCreateFunctionModule.ts` **Parameters:** - `activate` (boolean, optional (default: true))) - Whether to activate the function module after creation (default: true) - `description` (string, optional) - Optional description for the function module - `function_group_name` (string, required) - Parent function group name (e.g., ZTEST_FG_001) - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FUNCTION_001). Must follow SAP naming conventions (start with Z or Y, max 30 chars). - `source_code` (string, required) - ABAP source code for the function module including signature (FUNCTION name IMPORTING/EXPORTING ... ENDFUNCTION). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="updatefunctiongroup-high-level-function"></a> #### UpdateFunctionGroup (High-Level / Function) **Description:** Update metadata (description) of an existing ABAP function group. Function groups are containers for function modules and don **Source:** `src/handlers/function/high/handleUpdateFunctionGroup.ts` **Parameters:** - `description` (string, required) - New description for the function group. - `function_group_name` (string, required) - Function group name (e.g., ZTEST_FG_001). Must exist in the system. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="updatefunctionmodule-high-level-function"></a> #### UpdateFunctionModule (High-Level / Function) **Description:** Update source code of an existing ABAP function module. Locks the function module, uploads new source code, and unlocks. Optionally activates after update. Use this to modify existing function modules without re-creating metadata. **Source:** `src/handlers/function/high/handleUpdateFunctionModule.ts` **Parameters:** - `activate` (boolean, optional) - Activate function module after source update. Default: false. Set to true to activate immediately. - `function_group_name` (string, required) - Function group name containing the function module (e.g., ZOK_FG_MCP01). - `function_module_name` (string, required) - Function module name (e.g., Z_TEST_FM_MCP01). Function module must already exist. - `source_code` (string, required) - Complete ABAP function module source code. Must include FUNCTION statement with parameters and ENDFUNCTION. Example:\n\nFUNCTION Z_TEST_FM\n IMPORTING\n VALUE(iv_input) TYPE string\n EXPORTING\n VALUE(ev_output) TYPE string.\n \n ev_output = iv_input.\nENDFUNCTION. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable function modules. --- <a id="high-level-function-group"></a> ### High-Level / Function Group <a id="deletefunctiongroup-high-level-function-group"></a> #### DeleteFunctionGroup (High-Level / Function Group) **Description:** Delete an ABAP function group from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/function_group/high/handleDeleteFunctionGroup.ts` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getfunctiongroup-high-level-function-group"></a> #### GetFunctionGroup (High-Level / Function Group) **Description:** Retrieve ABAP function group definition. Supports reading active or inactive version. **Source:** `src/handlers/function_group/high/handleGetFunctionGroup.ts` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name (e.g., Z_MY_FUNCTIONGROUP). - `version` (string, optional (default: active)) - Version to read: --- <a id="high-level-function-module"></a> ### High-Level / Function Module <a id="deletefunctionmodule-high-level-function-module"></a> #### DeleteFunctionModule (High-Level / Function Module) **Description:** Delete an ABAP function module from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/function_module/high/handleDeleteFunctionModule.ts` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP). - `function_module_name` (string, required) - FunctionModule name (e.g., Z_MY_FUNCTIONMODULE). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getfunctionmodule-high-level-function-module"></a> #### GetFunctionModule (High-Level / Function Module) **Description:** Retrieve ABAP function module definition. Supports reading active or inactive version. **Source:** `src/handlers/function_module/high/handleGetFunctionModule.ts` **Parameters:** - `function_group_name` (string, required) - FunctionGroup name containing the function module (e.g., Z_MY_FUNCTIONGROUP). - `function_module_name` (string, required) - FunctionModule name (e.g., Z_MY_FUNCTIONMODULE). - `version` (string, optional (default: active)) - Version to read: --- <a id="high-level-interface"></a> ### High-Level / Interface <a id="createinterface-high-level-interface"></a> #### CreateInterface (High-Level / Interface) **Description:** Create a new ABAP interface in SAP system with source code. Interfaces define method signatures, events, and types for implementation by classes. Uses stateful session for proper lock management. **Source:** `src/handlers/interface/high/handleCreateInterface.ts` **Parameters:** - `activate` (boolean, optional) - Activate interface after creation. Default: true. Set to false for batch operations (activate multiple objects later). - `description` (string, optional) - Interface description. If not provided, interface_name will be used. - `interface_name` (string, required) - Interface name (e.g., ZIF_TEST_INTERFACE_001). Must follow SAP naming conventions (start with Z or Y). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `source_code` (string, optional) - Complete ABAP interface source code with INTERFACE...ENDINTERFACE section. If not provided, generates minimal template. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deleteinterface-high-level-interface"></a> #### DeleteInterface (High-Level / Interface) **Description:** Delete an ABAP interface from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/interface/high/handleDeleteInterface.ts` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_INTERFACE). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getinterface-high-level-interface"></a> #### GetInterface (High-Level / Interface) **Description:** Retrieve ABAP interface definition. Supports reading active or inactive version. **Source:** `src/handlers/interface/high/handleGetInterface.ts` **Parameters:** - `interface_name` (string, required) - Interface name (e.g., Z_MY_INTERFACE). - `version` (string, optional (default: active)) - Version to read: --- <a id="updateinterface-high-level-interface"></a> #### UpdateInterface (High-Level / Interface) **Description:** Update source code of an existing ABAP interface. Uses stateful session with proper lock/unlock mechanism. Lock handle and transport number are passed in URL parameters. **Source:** `src/handlers/interface/high/handleUpdateInterface.ts` **Parameters:** - `activate` (boolean, optional) - Activate interface after update. Default: true. - `interface_name` (string, required) - Interface name (e.g., ZIF_MY_INTERFACE). Must exist in the system. - `source_code` (string, required) - Complete ABAP interface source code with INTERFACE...ENDINTERFACE section. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="high-level-metadata-extension"></a> ### High-Level / Metadata Extension <a id="deletemetadataextension-high-level-metadata-extension"></a> #### DeleteMetadataExtension (High-Level / Metadata Extension) **Description:** Delete an ABAP metadata extension from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/metadata_extension/high/handleDeleteMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - MetadataExtension name (e.g., Z_MY_METADATAEXTENSION). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getmetadataextension-high-level-metadata-extension"></a> #### GetMetadataExtension (High-Level / Metadata Extension) **Description:** Retrieve ABAP metadata extension definition. Supports reading active or inactive version. **Source:** `src/handlers/metadata_extension/high/handleGetMetadataExtension.ts` **Parameters:** - `metadata_extension_name` (string, required) - MetadataExtension name (e.g., Z_MY_METADATAEXTENSION). - `version` (string, optional (default: active)) - Version to read: --- <a id="high-level-package"></a> ### High-Level / Package <a id="createpackage-high-level-package"></a> #### CreatePackage (High-Level / Package) **Description:** Create a new ABAP package in SAP system. Packages are containers for development objects and are essential for organizing code. **Source:** `src/handlers/package/high/handleCreatePackage.ts` **Parameters:** - None --- <a id="getpackage-high-level-package"></a> #### GetPackage (High-Level / Package) **Description:** Retrieve ABAP package metadata (description, super-package, etc.). Supports reading active or inactive version. **Source:** `src/handlers/package/high/handleGetPackage.ts` **Parameters:** - `package_name` (string, required) - Package name (e.g., Z_MY_PACKAGE). - `version` (string, optional (default: active)) - Version to read: --- <a id="high-level-program"></a> ### High-Level / Program <a id="createprogram-high-level-program"></a> #### CreateProgram (High-Level / Program) **Description:** Create a new ABAP program (report) in SAP system with source code. Supports executable programs, includes, module pools. Uses stateful session for proper lock management. **Source:** `src/handlers/program/high/handleCreateProgram.ts` **Parameters:** - `activate` (boolean, optional) - Activate program after creation. Default: true. Set to false for batch operations (activate multiple objects later). - `application` (string, optional) - Application area (e.g., - `description` (string, optional) - Program description. If not provided, program_name will be used. - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM_001). Must follow SAP naming conventions (start with Z or Y). - `program_type` (string, optional) - Program type: - `source_code` (string, optional) - Complete ABAP program source code. If not provided, generates minimal template based on program_type. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deleteprogram-high-level-program"></a> #### DeleteProgram (High-Level / Program) **Description:** Delete an ABAP program from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/program/high/handleDeleteProgram.ts` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getprogram-high-level-program"></a> #### GetProgram (High-Level / Program) **Description:** Retrieve ABAP program definition. Supports reading active or inactive version. **Source:** `src/handlers/program/high/handleGetProgram.ts` **Parameters:** - `program_name` (string, required) - Program name (e.g., Z_MY_PROGRAM). - `version` (string, optional (default: active)) - Version to read: --- <a id="updateprogram-high-level-program"></a> #### UpdateProgram (High-Level / Program) **Description:** Update source code of an existing ABAP program. Locks the program, checks new code, uploads new source code, and unlocks. Optionally activates after update. Use this to modify existing programs without re-creating metadata. **Source:** `src/handlers/program/high/handleUpdateProgram.ts` **Parameters:** - `activate` (boolean, optional) - Activate program after source update. Default: false. Set to true to activate immediately, or use ActivateObject for batch activation. - `program_name` (string, required) - Program name (e.g., Z_TEST_PROGRAM_001). Program must already exist. - `source_code` (string, required) - Complete ABAP program source code. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="high-level-service-binding"></a> ### High-Level / Service Binding <a id="createservicebinding-high-level-service-binding"></a> #### CreateServiceBinding (High-Level / Service Binding) **Description:** Create ABAP service binding via ADT Business Services endpoint. XML is generated from high-level parameters. **Source:** `src/handlers/service_binding/high/handleCreateServiceBinding.ts` **Parameters:** - `activate` (boolean, optional (default: true)) - Activate service binding after create. Default: true. - `binding_type` (string, optional (default: ODataV4)) - OData binding type. - `description` (string, optional) - Optional description. Defaults to service_binding_name when omitted. - `package_name` (string, required) - ABAP package name. - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name. - `service_binding_version` (string, optional) - Service binding ADT version. Default inferred from type. - `service_definition_name` (string, required) - Referenced service definition name. - `service_name` (string, optional) - Published service name. Default: service_binding_name if omitted. - `service_version` (string, optional) - Published service version. Default: 0001. - `transport_request` (string, optional) - Optional transport request for transport checks. --- <a id="deleteservicebinding-high-level-service-binding"></a> #### DeleteServiceBinding (High-Level / Service Binding) **Description:** Delete ABAP service binding via ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleDeleteServiceBinding.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name to delete. - `transport_request` (string, optional) - Optional transport request for deletion transport flow. --- <a id="getservicebinding-high-level-service-binding"></a> #### GetServiceBinding (High-Level / Service Binding) **Description:** Retrieve ABAP service binding source/metadata by name via ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleGetServiceBinding.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - Preferred response format. - `service_binding_name` (string, required) - Service binding name (for example: ZUI_MY_BINDING). Case-insensitive. --- <a id="listservicebindingtypes-high-level-service-binding"></a> #### ListServiceBindingTypes (High-Level / Service Binding) **Description:** List available service binding types (for example ODataV2/ODataV4) from ADT Business Services endpoint. **Source:** `src/handlers/service_binding/high/handleListServiceBindingTypes.ts` **Parameters:** - `response_format` (string, optional (default: xml)) - --- <a id="updateservicebinding-high-level-service-binding"></a> #### UpdateServiceBinding (High-Level / Service Binding) **Description:** Update publication state for ABAP service binding via AdtServiceBinding workflow. **Source:** `src/handlers/service_binding/high/handleUpdateServiceBinding.ts` **Parameters:** - `desired_publication_state` (string, required) - Target publication state. - `response_format` (string, optional (default: xml)) - - `service_binding_name` (string, required) - Service binding name to update. - `service_name` (string, required) - Published service name. - `service_type` (string, required (default: ODataV4)) - OData service type for publish/unpublish action routing. - `service_version` (string, optional) - Published service version. Optional. --- <a id="validateservicebinding-high-level-service-binding"></a> #### ValidateServiceBinding (High-Level / Service Binding) **Description:** Validate service binding parameters (name, service definition, package, version) via ADT validation endpoint. **Source:** `src/handlers/service_binding/high/handleValidateServiceBinding.ts` **Parameters:** - `description` (string, optional) - Optional description used during validation. - `package_name` (string, optional) - ABAP package for the binding. - `service_binding_name` (string, required) - Service binding name to validate. - `service_binding_version` (string, optional) - Service binding version (for example: 1.0). - `service_definition_name` (string, required) - Service definition linked to binding. --- <a id="high-level-service-definition"></a> ### High-Level / Service Definition <a id="createservicedefinition-high-level-service-definition"></a> #### CreateServiceDefinition (High-Level / Service Definition) **Description:** Create a new ABAP service definition for OData services. Service definitions define the structure and behavior of OData services. Uses stateful session for proper lock management. **Source:** `src/handlers/service_definition/high/handleCreateServiceDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate service definition after creation. Default: true. - `description` (string, optional) - Service definition description. If not provided, service_definition_name will be used. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `service_definition_name` (string, required) - Service definition name (e.g., ZSD_MY_SERVICE). Must follow SAP naming conventions (start with Z or Y). - `source_code` (string, optional) - Service definition source code (optional). If not provided, a minimal template will be created. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deleteservicedefinition-high-level-service-definition"></a> #### DeleteServiceDefinition (High-Level / Service Definition) **Description:** Delete an ABAP service definition from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/service_definition/high/handleDeleteServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getservicedefinition-high-level-service-definition"></a> #### GetServiceDefinition (High-Level / Service Definition) **Description:** Retrieve ABAP service definition definition. Supports reading active or inactive version. **Source:** `src/handlers/service_definition/high/handleGetServiceDefinition.ts` **Parameters:** - `service_definition_name` (string, required) - ServiceDefinition name (e.g., Z_MY_SERVICEDEFINITION). - `version` (string, optional (default: active)) - Version to read: --- <a id="updateservicedefinition-high-level-service-definition"></a> #### UpdateServiceDefinition (High-Level / Service Definition) **Description:** Update source code of an existing ABAP service definition. Uses stateful session with proper lock/unlock mechanism. **Source:** `src/handlers/service_definition/high/handleUpdateServiceDefinition.ts` **Parameters:** - `activate` (boolean, optional) - Activate service definition after update. Default: true. - `service_definition_name` (string, required) - Service definition name (e.g., ZSD_MY_SERVICE). Must exist in the system. - `source_code` (string, required) - Complete service definition source code. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="high-level-structure"></a> ### High-Level / Structure <a id="createstructure-high-level-structure"></a> #### CreateStructure (High-Level / Structure) **Description:** Create a new ABAP structure in SAP system with fields and type references. Includes create, activate, and verify steps. **Source:** `src/handlers/structure/high/handleCreateStructure.ts` **Parameters:** - `activate` (boolean, optional) - Activate structure after creation. Default: true. Set to false for batch operations (activate multiple objects later). - `description` (string, optional) - Structure description. If not provided, structure_name will be used. - `fields` (array, required (default: 0)) - Array of structure fields - `includes` (array, optional) - Include other structures in this structure - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Must follow SAP naming conventions. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deletestructure-high-level-structure"></a> #### DeleteStructure (High-Level / Structure) **Description:** Delete an ABAP structure from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/structure/high/handleDeleteStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="getstructure-high-level-structure"></a> #### GetStructure (High-Level / Structure) **Description:** Retrieve ABAP structure definition. Supports reading active or inactive version. **Source:** `src/handlers/structure/high/handleGetStructure.ts` **Parameters:** - `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatestructure-high-level-structure"></a> #### UpdateStructure (High-Level / Structure) **Description:** Update DDL source code of an existing ABAP structure. Locks the structure, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing structures without re-creating metadata. **Source:** `src/handlers/structure/high/handleUpdateStructure.ts` **Parameters:** - `activate` (boolean, optional) - Activate structure after source update. Default: true. - `ddl_code` (string, required) - Complete DDL source code for structure. Example: - `structure_name` (string, required) - Structure name (e.g., ZZ_S_TEST_001). Structure must already exist. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="high-level-system"></a> ### High-Level / System <a id="getpackagetree-high-level-system"></a> #### GetPackageTree (High-Level / System) **Description:** [high-level] Retrieve complete package tree structure including subpackages and objects. Returns hierarchical tree with object names, types, and descriptions. **Source:** `src/handlers/system/high/handleGetPackageTree.ts` **Parameters:** - `debug` (boolean, optional (default: false)) - Include diagnostic metadata in response (counts, types, hierarchy info). Default: false - `include_descriptions` (boolean, optional (default: true)) - Include object descriptions in response. Default: true - `include_subpackages` (boolean, optional (default: true)) - Include subpackages recursively in the tree. If false, subpackages are shown as first-level objects but not recursively expanded. Default: true - `max_depth` (integer, optional (default: 5)) - Maximum depth for recursive package traversal. Default: 5 - `package_name` (string, required) - Package name (e.g., --- <a id="high-level-table"></a> ### High-Level / Table <a id="createtable-high-level-table"></a> #### CreateTable (High-Level / Table) **Description:** Create a new ABAP table via the ADT API using provided DDL. Mirrors Eclipse ADT behaviour with status/check runs, lock handling, activation and verification. **Source:** `src/handlers/table/high/handleCreateTable.ts` **Parameters:** - `activate` (boolean, optional) - Activate table after creation. Default: true. Set to false for batch operations (activate multiple objects later). - `ddl_code` (string, required) - Complete DDL code for table creation. Example: - `description` (string, optional) - Table description for validation and creation. - `package_name` (string, required) - Package name (e.g., ZOK_LOCAL, $TMP for local objects) - `table_name` (string, required) - Table name (e.g., ZZ_TEST_TABLE_001). Must follow SAP naming conventions. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. --- <a id="deletetable-high-level-table"></a> #### DeleteTable (High-Level / Table) **Description:** Delete an ABAP table from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/table/high/handleDeleteTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). --- <a id="gettable-high-level-table"></a> #### GetTable (High-Level / Table) **Description:** Retrieve ABAP table definition. Supports reading active or inactive version. **Source:** `src/handlers/table/high/handleGetTable.ts` **Parameters:** - `table_name` (string, required) - Table name (e.g., Z_MY_TABLE). - `version` (string, optional (default: active)) - Version to read: --- <a id="updatetable-high-level-table"></a> #### UpdateTable (High-Level / Table) **Description:** Update DDL source code of an existing ABAP table. Locks the table, uploads new DDL source, and unlocks. Optionally activates after update. Use this to modify existing tables without re-creating metadata. **Source:** `src/handlers/table/high/handleUpdateTable.ts` **Parameters:** - `activate` (boolean, optional) - Activate table after source update. Default: true. - `ddl_code` (string, required) - Complete DDL source code for table. Example: - `table_name` (string, required) - Table name (e.g., ZZ_TEST_TABLE_001). Table must already exist. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Optional if object is local or already in transport. --- <a id="high-level-transport"></a> ### High-Level / Transport <a id="createtransport-high-level-transport"></a> #### CreateTransport (High-Level / Transport) **Description:** Create a new ABAP transport request in SAP system for development objects. **Source:** `src/handlers/transport/high/handleCreateTransport.ts` **Parameters:** - `description` (string, required) - Transport request description (mandatory) - `owner` (string, optional) - Transport owner (optional, defaults to current user) - `target_system` (string, optional) - Target system for transport (optional, e.g., - `transport_type` (string, optional (default: workbench)) - Transport type: --- <a id="high-level-unit-test"></a> ### High-Level / Unit Test <a id="createcdsunittest-high-level-unit-test"></a> #### CreateCdsUnitTest (High-Level / Unit Test) **Description:** Create a CDS unit test class with CDS validation, class template, and local test class source. **Source:** `src/handlers/unit_test/high/handleCreateCdsUnitTest.ts` **Parameters:** - `cds_view_name` (string, required) - CDS view name to validate for unit test doubles. - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `class_template` (string, required) - ABAP class template used for CDS unit tests. - `description` (string, optional) - Optional description for the global test class. - `package_name` (string, required) - Package name (e.g., ZOK_TEST_PKG_01, $TMP). - `test_class_source` (string, required) - Local test class ABAP source code. - `transport_request` (string, optional) - Transport request number (required for transportable packages). --- <a id="createunittest-high-level-unit-test"></a> #### CreateUnitTest (High-Level / Unit Test) **Description:** Start an ABAP Unit test run for provided class test definitions. Returns run_id for status/result queries. **Source:** `src/handlers/unit_test/high/handleCreateUnitTest.ts` **Parameters:** - `context` (string, optional) - Optional context string shown in SAP tools. - `duration` (object, optional) - - `risk_level` (object, optional) - - `scope` (object, optional) - - `tests` (array, required) - List of container/test class pairs to execute. - `title` (string, optional) - Optional title for the ABAP Unit run. --- <a id="deletecdsunittest-high-level-unit-test"></a> #### DeleteCdsUnitTest (High-Level / Unit Test) **Description:** Delete a CDS unit test class (global class). **Source:** `src/handlers/unit_test/high/handleDeleteCdsUnitTest.ts` **Parameters:** - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `transport_request` (string, optional) - Transport request number (required for transportable packages). --- <a id="deleteunittest-high-level-unit-test"></a> #### DeleteUnitTest (High-Level / Unit Test) **Description:** Delete an ABAP Unit test run. Note: ADT does not support deleting unit test runs and will return an error. **Source:** `src/handlers/unit_test/high/handleDeleteUnitTest.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by CreateUnitTest/RunUnitTest. --- <a id="getcdsunittest-high-level-unit-test"></a> #### GetCdsUnitTest (High-Level / Unit Test) **Description:** Retrieve CDS unit test run status and result for a previously started run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTest.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. --- <a id="getcdsunittestresult-high-level-unit-test"></a> #### GetCdsUnitTestResult (High-Level / Unit Test) **Description:** Retrieve CDS unit test run result for a run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTestResult.ts` **Parameters:** - `format` (string, optional) - Result format: abapunit or junit. - `run_id` (string, required) - Run identifier returned by unit test run. - `with_navigation_uris` (boolean, optional (default: false)) - Include navigation URIs in result if supported. --- <a id="getcdsunitteststatus-high-level-unit-test"></a> #### GetCdsUnitTestStatus (High-Level / Unit Test) **Description:** Retrieve CDS unit test run status for a run_id. **Source:** `src/handlers/unit_test/high/handleGetCdsUnitTestStatus.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. - `with_long_polling` (boolean, optional (default: true)) - Enable long polling while waiting for status. --- <a id="getunittest-high-level-unit-test"></a> #### GetUnitTest (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run status and result for a previously started run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTest.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by RunUnitTest. --- <a id="getunittestresult-high-level-unit-test"></a> #### GetUnitTestResult (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run result for a run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTestResult.ts` **Parameters:** - `format` (string, optional) - Result format: abapunit or junit. - `run_id` (string, required) - Run identifier returned by unit test run. - `with_navigation_uris` (boolean, optional (default: false)) - Include navigation URIs in result if supported. --- <a id="getunitteststatus-high-level-unit-test"></a> #### GetUnitTestStatus (High-Level / Unit Test) **Description:** Retrieve ABAP Unit test run status for a run_id. **Source:** `src/handlers/unit_test/high/handleGetUnitTestStatus.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by unit test run. - `with_long_polling` (boolean, optional (default: true)) - Enable long polling while waiting for status. --- <a id="rununittest-high-level-unit-test"></a> #### RunUnitTest (High-Level / Unit Test) **Description:** Start an ABAP Unit test run for provided class test definitions. Returns run_id for status/result queries. **Source:** `src/handlers/unit_test/high/handleRunUnitTest.ts` **Parameters:** - `context` (string, optional) - Optional context string shown in SAP tools. - `duration` (object, optional) - - `risk_level` (object, optional) - - `scope` (object, optional) - - `tests` (array, required) - List of container/test class pairs to execute. - `title` (string, optional) - Optional title for the ABAP Unit run. --- <a id="updatecdsunittest-high-level-unit-test"></a> #### UpdateCdsUnitTest (High-Level / Unit Test) **Description:** Update a CDS unit test class local test class source code. **Source:** `src/handlers/unit_test/high/handleUpdateCdsUnitTest.ts` **Parameters:** - `class_name` (string, required) - Global test class name (e.g., ZCL_CDS_TEST). - `test_class_source` (string, required) - Updated local test class ABAP source code. - `transport_request` (string, optional) - Transport request number (required for transportable packages). --- <a id="updateunittest-high-level-unit-test"></a> #### UpdateUnitTest (High-Level / Unit Test) **Description:** Update an ABAP Unit test run. Note: ADT does not support updating unit test runs and will return an error. **Source:** `src/handlers/unit_test/high/handleUpdateUnitTest.ts` **Parameters:** - `run_id` (string, required) - Run identifier returned by CreateUnitTest/RunUnitTest. --- <a id="high-level-view"></a> ### High-Level / View <a id="createview-high-level-view"></a> #### CreateView (High-Level / View) **Description:** Create CDS View or Classic View in SAP using DDL syntax. Both types use the same API workflow, differing only in DDL content (CDS has @AbapCatalog.sqlViewName and other annotations). **Source:** `src/handlers/view/high/handleCreateView.ts` **Parameters:** - `activate` (boolean, optional) - Activate after creation. Default: true. - `ddl_source` (string, required) - Complete DDL source code. - `description` (string, optional) - Optional description (defaults to view_name). - `package_name` (string, required) - Package name (e.g., ZOK_LAB, $TMP for local objects) - `transport_request` (string, optional) - Transport request number (required for transportable packages). - `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002, Z_I_MY_VIEW). --- <a id="deleteview-high-level-view"></a> #### DeleteView (High-Level / View) **Description:** Delete an ABAP view from the SAP system. Includes deletion check before actual deletion. Transport request optional for $TMP objects. **Source:** `src/handlers/view/high/handleDeleteView.ts` **Parameters:** - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP). - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- <a id="getview-high-level-view"></a> #### GetView (High-Level / View) **Description:** Retrieve ABAP view definition. Supports reading active or inactive version. **Source:** `src/handlers/view/high/handleGetView.ts` **Parameters:** - `version` (string, optional (default: active)) - Version to read: - `view_name` (string, required) - View name (e.g., Z_MY_VIEW). --- <a id="updateview-high-level-view"></a> #### UpdateView (High-Level / View) **Description:** Update DDL source code of an existing CDS View or Classic View. Locks the view, checks new code, uploads new DDL source, unlocks, and optionally activates. **Source:** `src/handlers/view/high/handleUpdateView.ts` **Parameters:** - `activate` (boolean, optional) - Activate after update. Default: false. - `ddl_source` (string, required) - Complete DDL source code. - `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages. - `view_name` (string, required) - View name (e.g., ZOK_R_TEST_0002). --- *Last updated: 2026-02-27*