FAQ -> rel-5_0 API documentation

NAME

Kernel::GenericInterface::Operation::FAQ::PublicFAQSearch - GenericInterface FAQ PublicFAQSearch Operation backend

SYNOPSIS

PUBLIC INTERFACE

• new()

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

• Run()

  perform PublicFAQSearch Operation. This will return a list of public FAQ entries.

  my @IDs = $OperationObject->Run(
      Data => {
  
          Number    => '*134*',                                         # (optional)
          Title     => '*some title*',                                  # (optional)
  
          # is searching in Number, Title, Keyword and Field1-6
          What      => '*some text*',                                   # (optional)
  
          Keyword   => '*webserver*',                                   # (optional)
          LanguageIDs => [ 4, 5, 6 ],                                   # (optional)
          CategoryIDs => [ 7, 8, 9 ],                                   # (optional)
  
          OrderBy => [ 'FAQID', 'Title' ],                              # (optional)
  
          # Additional information for OrderBy:
          # The OrderByDirection can be specified for each OrderBy attribute.
          # The pairing is made by the array indexes.
  
          OrderByDirection => 'Down', # (Down | Up)                         # (optional)
          # default: 'Down'
      },
  );
  
  $Result = {
      Success      => 1,                                # 0 or 1
      ErrorMessage => '',                               # In case of an error
      Data         => {                                 # result data payload after Operation
          ID => [
              32,
              13,
              12,
              9,
              6,
              5,
              4,
              1,
          ],
      },
  };
  

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.