NAME

Kernel::GenericInterface::Operation::ConfigItem::ConfigItemGet – GenericInterface Configuration Item Get Operation backend

PUBLIC INTERFACE

OperationName()

Returns the name of the operation.

Run()

perform ConfigItemGet Operation. This function is able to return one or more ConfigItem entries in one call.

    my $Result = $OperationObject->Run(
        Data => {
            UserLogin         => 'some agent login',            # UserLogin or AccessToken is
            AccessToken       => 'eyJhbGciOiJIUzI1NiJ9[...]',   # required
            Password          => 'some password',               # if UserLogin is sent then Password is required
            ConfigItemID      => '32,33',                       # required, could be coma separated IDs or an Array
            Attachments       => 1,                             # Optional, 1 as default. If it's set with the value 1,
                                                                # attachments for articles will be included on ConfigItem data
        },
    );

    $Result = {
        Success      => 1,                                # 0 or 1
        ErrorMessage => '',                               # In case of an error
        Data         => {
            ConfigItem => [
                {

                    Number             => '20101027000001',
                    ConfigItemID       => 123,
                    Name               => 'some name',
                    Class              => 'some class',
                    VersionID          => 123,
                    LastVersionID      => 123,
                    DefinitionID       => 123,
                    InciState          => 'some incident state',
                    InciStateType      => 'some incident state type',
                    DeplState          => 'some deployment state',
                    DeplStateType      => 'some deployment state type',
                    CurInciState       => 'some incident state',
                    CurInciStateType   => 'some incident state type',
                    CurDeplState       => 'some deployment state',
                    CurDeplStateType   => 'some deployment state type',
                    CreateTime         => '2010-10-27 20:15:00'
                    CreateBy           => 123,
                    CIXMLData          => $XMLDataHashRef,

                    Attachment => [
                        {
                            Content            => "xxxx",     # actual attachment contents, base64 enconded
                            ContentType        => "application/pdf",
                            Filename           => "StdAttachment-Test1.pdf",
                            Filesize           => "4.6 KBytes",
                            Preferences        => $PreferencesHashRef,
                        },
                        {
                            # . . .
                        },
                    ],
                },
                {
                    # . . .
                },
            ],
        },
    };