LigeroSmart 6.1 Perl Objects Reference

Description manuals and libraries
LigeroSmart 6.1 Perl Objects Reference > Perl Modules > GenericInterface::Operation::Admin::Generic
Source

NAME

Kernel::GenericInterface::Operation::Admin::Generic - GenericInterface Admin Commun Tasks

SYNOPSIS

PUBLIC INTERFACE

new()

usually, you want to create an instance of this by using Kernel::GenericInterface::Operation->new();

@apiExample Example usage: { "SessionID": "BJtrQ23c0uMWVINuXEOk7FuVCq2xFhkN", "Object": "LinkObject", "Method": "LinkDelete", "ReturnType": "HASH", "Params": { "Object1": "Ticket", "Key1": "70", "Object2": "Ticket", "Key2": "69", "Type": "ParentChild", "UserID": "1" } }

@apiParam (Request body) {String} [UserLogin] User login to create sesssion. @apiParam (Request body) {String} [Password] Password to create session. @apiParam (Request body) {String} SessionID session id generated by session create method. @apiParam (Request body) {String} Object Class Object from LigeroSmart Framework @apiParam (Request body) {String} Method Object Method from LigeroSmart Framework. See methods here: https://docs.ligerosmart.org/6.1/perl-reference/ @apiParam (Request body) {String="HASH","ARRAY","SCALAR"} RetunType Object Method from LigeroSmart Framework @apiParam (Request body) {Object} [Params] Depends on the Method that are invocating

@apiErrorExample {json} Error example: HTTP/1.1 200 Success { "Error": { "ErrorMessage": "TicketCreate: User could not be authenticated!", "ErrorCode": "TicketCreate.AuthFail" } }

@apiSuccessExample {json} Success example: HTTP/1.1 200 Success { "Result": { "ITSMChange": 1, "Appointment": 1, "ITSMWorkOrder": 1, "FAQ": 1, "ITSMConfigItem": 1, "Ticket": 1 } }

@apiSuccess {Object} [Result] Depends on the method invocated.

Run()

perform LanguageList Operation. This will return the current FAQ Languages.

    my $Result = $OperationObject->Run(
        Data => {},
    );

    $Result = {
        Success      => 1,                                # 0 or 1
        ErrorMessage => '',                               # In case of an error
        Data         => {                                 # result data payload after Operation
            Language => [
                {
                    ID => 1,
                    Name> 'en',
                },
                {
                    ID => 2,
                    Name> 'OneMoreLanguage',
                },
                # ...
            ],
        },
    };

TERMS AND CONDITIONS

This software is part of the OTRS project (http://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (AGPL). If you did not receive this file, see http://www.gnu.org/licenses/agpl.txt.