ITSMConfigurationManagement -> rel-5_0 API documentation

NAME

Kernel::GenericInterface::Operation::ConfigItem::ConfigItemUpdate - GenericInterface ConfigItem ConfigItemUpdate Operation backend

SYNOPSIS

PUBLIC INTERFACE

• new()

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

• Run()

  perform ConfigItemUpdate Operation. This will return the updated config item number.

  my $Result = $OperationObject->Run(
      Data => {
          UserLogin => 'some agent login',                # UserLogin or SessionID is
          SessionID => 123,                               #   required
  
          Password  => 'some password',                   # if UserLogin is sent then Password is required
  
          ReplaceExistingData => 0,                       # optional, 0 or 1, default 0
                                                          # this will replace the existing XML data and attachments
          ConfigItemID => 123,
  
          ConfigItem   => {
              Class     => 'Config Item Class',
              Name      => 'The Name',
              DeplState => 'deployment state',
              InciState => 'incident state',
              CIXMLData => $ArrayHashRef,                 # it depends on the Configuration Item class and definition
  
              Attachment => [
                  {
                      Content     => 'content'            # base64 encoded
                      ContentType => 'some content type'
                      Filename    => 'some fine name'
                  },
                  # ...
              ],
              # or
              #Attachment => {
              #   Content     => 'content'
              #   ContentType => 'some content type'
              #   Filename    => 'some fine name'
              #},
          },
      },
  );
  
  $Result = {
      Success         => 1,                       # 0 or 1
      ErrorMessage    => '',                      # in case of error
      Data            => {                        # result data payload after Operation
          ConfigItemID => 123,                    # Configuration Item  ID number in OTRS::ITSM (Service desk system)
          Number       => 2324454323322           # Configuration Item  Number in OTRS::ITSM (Service desk system)
          Error => {                              # should not return errors
                  ErrorCode    => 'ConfigItemUpdate.ErrorCode'
                  ErrorMessage => 'Error Description'
          },
      },
  };
  

TERMS AND CONDITIONS

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

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