InBox Kanban - API
Versão 6.0.0
Data de Criação 14/11/2018
Instalação
bin/otrs.Console.pl Admin::Package::Install /path/to/InBox Kanban-6.0.0.opm
API Kanban
Criar o objeto Kanban.
my $KanbanObject= $Kernel::OM->Get('Kernel::System::Kanban');
KanbanList
Retornar uma lista KanbanID como array
my $Kanbans = $KanbanObject->KanbanList();
Retorno
@Kanbans = [ 1, 2, 3 ]
ValidKanbanList
Retornar uma lista KanbanID válido como array
my $Kanbans = $KanbanObject->ValidKanbanList();
Retorno
@Kanbans = [ 1, 2, 3 ]
KanbanLookup
Retorno o KanbanID
my $Kanbans = $KanbanObject->KanbanLookup(
Name => 'Kanban Name'
);
Retorno
$KanbanID = 1
KanbanLookupByID
Retorno o nome do Kanban
Retorno
$KanbanID = 1
my $Kanbans = $KanbanObject->KanbanLookupByID(
ID => 'Kanban '
);
KanbanDelete
Deleta o Kanban
Retorno
$Success = 1 | 0
my $Kanbans = $KanbanObject->KanbanDelete(
ID => 1 # Kanban ID
);
KanbanGet
Obtém dados do Kanban
Retorno
%Kanban = {
ID => 1,
Name => 'Kanban Name',
Groups => ['admin', 'users'],
Search => JSON string for search
ValidID => 1
LimitValue => 1
StateToMove => '0'
QueueToMove => '50'
Rules => JSON string for rules
SeverityOrder => 'Ascending' # opções ('Ascending' | 'Descendant')
CreateBy => 'Ascending' # opções ('Ascending' | 'Descendant')
ManualSorting => 1
Ordination => "Ordinaton"
}
my $Kanbans = $KanbanObject->KanbanGet(
ID => 1 # Kanban ID
);
KanbanGetNewQueueAndState
Obtém a fila de colunas e estado para mover o cartão
Retorno
%ColumnData = {
QueueToMove => 'Postmaster',
StateToMove => 'open',
}
my $ColumnData = $KanbanObject->KanbanGetNewQueueAndState( ID => 1 # Kanban ID );
KanbanGetByName
Obtém o nome do Kanban
Retorno
%Kanban = {
ID => 1,
Name => 'Kanban Name',
ObjectType => 'Ticket',
Groups => ['admin', 'users'],
Search => JSON string for search
ValidID => 1
RetornoFormat => 'normal' # options ('normal' | 'excel')
MinValue => '0'
MaxValue => '50'
Rules => JSON string for rules
SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
}
my $Kanbans = $KanbanObject->KanbanGetByName(
Name => 1
);
KanbanUpdate
Atualizar o Kanban
Retorno
$Success = 1 | 0
my $Kanbans = $KanbanObject->KanbanUpdate(
ID => 1, # Kanban iD
Name => 'Kanban Name',
ObjectType => 'Ticket',
Groups => ['admin', 'users'],
Search => JSON string for search
ValidID => 1
SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
);
KanbanAdd
Adicionar coluna de Kanban
Retorno
$Success = 1 | 0
my $Kanbans = $KanbanObject->KanbanAdd(
Name => 'Kanban Name',
Groups => ['admin', 'users'],
Search => JSON string for search
ValidID => 1
Limit => 1
SeverityOrder => 'Ascending' # options ('Ascending' | 'Descendant')
Ordination => 'SLA' # options ('SLA' | 'Priority' | 'Age')
ManualSorting => 0
UserID => 0
);
BoardsList
Retorna uma lista de quadros
Retorno
@Kanbans = ( 1, 2, 3 )
my $Kanbans = $KanbanObject->BoardsList(
ValidID = 0; # not required
);
BoardsListNames
Retorna uma lista de nomes
Retorno
@Kanbans = ( name )
my $Kanbans = $KanbanObject->BoardsListNames(
Valid = 0; # not required
);
ValidBoardsList
Retorna uma lista de quadros válidos
Retorno
@Kanbans = ( 1, 2, 3 )
my $Kanbans = $KanbanObject->ValidBoardsList();
BoardsLookup
Retorna o BoardsID
Retorno
$BoardsID = 1
my $Kanbans = $KanbanObject->BoardsLookup(
Name => 'Boards'
);
BoardsGet
Obtém Boards/Quadros
Retorno
%Boards = {
ID => 1,
Name => 'Series Name',
ValidID => 1
AssociatedKanbans => '1,2,3,4', # KanbanIDs associated
GroupIDs => '1,2,3,4', # GroupIDs associated
}
my $Boards = $KanbanObject->BoardsGet(
ID => 1 # BoardsID
);
BoardsGetAssociatedKanbans
Obtém colunas associadas ao kanban
Retorno
@Boards = [
'1,2,3,4',
]
my $Boards = $KanbanObject->BoardsGetAssociatedKanbans(
ID => 1 # BoardsID
);
BoardsAdd
Adiciona Boards/Quadros
Retorno
$Success = 1 | 0
my $Kanbans = $KanbanObject->BoardsAdd(
Name => 'Boards Name',
ValidID => 1
AssociatedColumn => '1,2,3,4', # KanbanIDs associated
GroupIDs => '1,2,3,4', # GroupIDs associated
Resource_ColorName => 'color',
Resource_ColorNameLabel => 'color',
);
BoardsUpdate
Atualiza colunas
Retorno
$Success = 1 | 0
my $Kanbans = $KanbanObject->BoardsUpdate(
ID => 1, # SeriesID
Name => 'Series Name',
ValidID => 1
AssociatedCollumn => '1,2,3,4', # associated
Resource_ColorName => 'color'
Resource_ColorNameLabel => 'color'
GroupIDs => '1,2,3,4', # GroupIDs associated
);
ColumnOrdinanceAdd
Adiciona na coluna de kanban sua ordenação
Retorno
$Success = 1 | 0
my $ColumnOrdinance = $KanbanObject->ColumnOrdinanceAdd(
BoardID => 1,
ColumnID => 1,
OrderOfTickets => ['1,2,3,4'], #Order of tickets associates in the column
);
ColumnOrdinanceUpdate
Atualiza colunas
Retorno
$Success = 1 | 0
my $ColumnOrdinance = $KanbanObject->ColumnOrdinanceUpdate(
BoardID => 1,
ColumnID => 1,
OrderOfTickets => ['1,2,3,4'], #Order of tickets associates in the column
);
ColumnOrdinanceGet
Obtém o ordenação de coluna
Retorno
@Boards = [
'1,2,3,4',
]
my $Boards = $KanbanObject->ColumnOrdinanceGet(
BoardID => 1 # BoardsID
ColumnID => 1 # BoardsID
);
ColumnOrdinanceDelete
Deleta a coluna
Retorno
$Sucess= 0|1;
my $Boards = $KanbanObject->ColumnOrdinanceDelete(
BoardID => 1 # BoardsID
ColumnID => 1 # BoardsID
);
TicketGetOfKanban
Obtém dados do chamado importantes para o kanban
my %Ticket = $KanbanObject->TicketGetOfKanban(
TicketID => 123,
);
Retorno:
%Ticket = (
TicketID => '123',
Title => 'some title',
PriorityID => 123,
LockID => 123,
OwnerID => 123,
ResponsibleID => 1,
Created => 1,
TicketNumber => '20101027000001',
);