# InBox KPI - API

Versão 6.0.0 Data de Criação 08/08/2019

# Instalação

bin/otrs.Console.pl Admin::Package::Install /path/to/InBox\ KPI-6.0.0.opm

# API

Criar o objeto KPI.

my $KPIObject = $Kernel::OM->Get('Kernel::System::KPI');

# KPIList()

Função que retorna os IDs dos KPIs em uma referência de array.

my $KPIs = $KPIObject->KPIList();

return
@KPIs = [ 1, 2, 3 ]

# ValidKPIList()

Função que retorna os ID dos KPI dado seu nome.

my $KPIs = $KPIObject->KPILookup(
    Name => 'KPI Name'
);

# KPIDelete()

Função que deleta um KPI.

my $KPIs = $KPIObject->KPIDelete(
    ID => 1 # KPI ID
);

# KPIGet()

Função que fornece informações de um dado KPI.

my $KPIs = $KPIObject->KPIGet(
    ID => 1 # KPI ID
);

Return
%KPI = {
    ID            => 1,
    Name          => 'KPI Name',
    ObjectType    => 'Ticket',
    Groups        => ['admin', 'users'],
    Search        => JSON string for search
    ValidID       => 1
    ReturnFormat  => 'normal' # options ('normal' | 'excel')
    MinValue      => '0'
    MaxValue      => '50'
    Rules         => JSON string for rules
    SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
}

# KPIUpdate()

Função que atualiza um dado KPI.

my $KPIs = $KPIObject->KPIUpdate(
    ID            => 1, # KPI iD
    Name          => 'KPI Name',
    ObjectType    => 'Ticket',
    Groups        => ['admin', 'users'],
    Search        => JSON string for search
    ValidID       => 1
    ReturnFormat  => 'normal' # options ('normal' | 'excel')
    MinValue      => '0'
    MaxValue      => '50'
    Rules         => JSON string for rules
    SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
);

# KPIAdd()

Função que adiciona um novo KPI

my $KPIs = $KPIObject->KPIAdd(
    Name          => 'KPI Name',
    ObjectType    => 'Ticket',
    Groups        => ['admin', 'users'],
    Search        => JSON string for search
    ValidID       => 1
    ReturnFormat  => 'normal' # options ('normal' | 'excel')
    MinValue      => '0'
    MaxValue      => '50'
    Rules         => JSON string for rules
    SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
);

# SeriesList()

Função que retorna uma lista dos conjuntos de KPI.

my $KPIs = $KPIObject->SeriesList();

Return
@KPIs = [ 1, 2, 3 ]

# ValidSeriesList()

Função que retorna os conjuntos de KPIs válidos.

my $KPIs = $KPIObject->ValidSeriesList();

Return
@KPIs = [ 1, 2, 3 ]

# SeriesLookup()

Função que retorna o ID de um conjunto de KPI dado seu nome.

my $KPIs = $KPIObject->SeriesLookup(
    Name => 'Series'
);

# SeriesGet()

Função que retorna informações de um dado KPI.

my $Series = $KPIObject->SeriesGet(
    ID => 1 # SeriesID
);

Return
%Series = {
    ID             => 1,
    Name           => 'Series Name',
    ValidID        => 1
    AssociatedKPIs => '1,2,3,4', # KPIIDs associated
    GroupIDs       => '1,2,3,4', # GroupIDs associated
}

# SeriesAdd()

Função que adiciona um novo conjunto de KPI.

my $KPIs = $KPIObject->SeriesAdd(
    Name           => 'Series Name',
    ValidID        => 1
    AssociatedKPIs => '1,2,3,4', # KPIIDs associated
    GroupIDs       => '1,2,3,4', # GroupIDs associated
);

# SeriesUpdate()

Função que atualiza um conjunto de KPI.

my $KPIs = $KPIObject->SeriesUpdate(
    ID             => 1, # SeriesID
    Name           => 'Series Name',
    ValidID        => 1
    AssociatedKPIs => '1,2,3,4', # KPIIDs associated
    GroupIDs       => '1,2,3,4', # GroupIDs associated
);

---