Kernel::System::GenericInterface::Webservice
Web service configuration backend.
Don't use the constructor directly, use the ObjectManager instead:
my $WebserviceObject = $Kernel::OM->Get('Kernel::System::GenericInterface::Webservice');
add new Webservices
returns id of new web service if successful or undef otherwise
my $ID = $WebserviceObject->WebserviceAdd( Name => 'some name', Config => $ConfigHashRef, ValidID => 1, UserID => 123, );
get Webservices attributes
my $Webservice = $WebserviceObject->WebserviceGet( ID => 123, # ID or Name must be provided Name => 'MyWebservice', );
Returns:
$Webservice = { ID => 123, Name => 'some name', Config => $ConfigHashRef, ValidID => 123, CreateTime => '2011-02-08 15:08:00', ChangeTime => '2011-02-08 15:08:00', };
update web service attributes
returns 1 if successful or undef otherwise
my $Success = $WebserviceObject->WebserviceUpdate( ID => 123, Name => 'some name', Config => $ConfigHashRef, ValidID => 1, UserID => 123, );
delete a Webservice
returns 1 if successful or undef otherwise
my $Success = $WebserviceObject->WebserviceDelete( ID => 123, UserID => 123, );
get web service list
my $List = $WebserviceObject->WebserviceList(); or my $List = $WebserviceObject->WebserviceList( Valid => 0, # optional, defaults to 1 );
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.