Service Desk WebService API

Tato stránka popisuje rozhraní webové služby Service Desk a její metody.

Seznam metod

Obecné metody:

AddPersonToGroup
AssignTicketToSolver
BeginUpload
CancelUpload
CreateAct
CreateGroup
CreatePerson
CreateTicket
CreateTicketRelation
DeleteGroup
EndUpload
FindPerson
GetAzureApplicationOptions
GetGroupList
GetHdSectionsList
GetLastSectionChange
GetPersonCommunicationTickets
GetPersonGroupList
GetPersonList
GetServiceDeskPortalUrl
GetTicketActList
GetTicketByMessageTag
GetTicketList
GetTicketStateAfterAssignToSolver
GetWebServiceVersion
HasPersonSlaInSection
IsActivated
IsConnectedToDb
IsExistingTicket
IsPersonMemberOfGroup
LogAuditRecord
ReadColumn
RemovePersonFromGroup
ResolveTicket
SendNews
SetTicketState
UploadDataPart
WriteColumn

Metody pro odesílání oznámení k požadavkům:

NotifyOnHdTicketAccepted
NotifyOnHdTicketApprovalCanceled
NotifyOnHdTicketApprovalItem
NotifyOnHdTicketApprovalItemFinished
NotifyOnHdTicketCreated
NotifyOnHdTicketDeadlineChanged
NotifyOnHdTicketExpired
NotifyOnHdTicketHdSectionChanged
NotifyOnHdTicketPassed
NotifyOnHdTicketRejected
NotifyOnHdTicketResolved
NotifyOnHdTicketSolverOpen
NotifyOnHdTicketUserOpen
NotifyOnMessageSent
NotifyOnReplyReceived
NotifySubscribersOnHdTicketDeadlineChanged
NotifySubscribersOnHdTicketOpen
NotifySubscribersOnHdTicketResolved
NotifySubscribersOnMessageSent
NotifyUserOnMessageRejected
NotifyUserOnOpenRejected

Metody pro odesílání automatických upozornění na neřešení/termín požadavků:

SendCheckSettingsAlert
SendNonSummaryAlert
SendSummaryAlert

Podrobný popis metod

Obecné metody

bool AddPersonToGroup(...)

Přidá uživatele do skupiny.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

bool AssignTicketToSolver(...)

Předá požadavek řešiteli.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen řešitelského týmu služby požadavku.

1. Změna řešitele požadavku
   • Zápis do deníku požadavku
   • Oznámení o změně řešitele
   • Případná vlastní akce
2. Pokud na procesu existuje stav se zapnutou volbou „Při prvním předání řešiteli automaticky přejít do tohoto stavu“ a požadavek původně splňoval podmínky pro automatický přechod do tohoto stavu (viz metoda GetTicketStateAfterAssignToSolver), změní se stav požadavku (viz SetTicketState).

Metoda generuje události do deníku v jazyce služby. Pokud není nastaveno odeslání oznámení řešiteli, zpráva pro řešitele se pouze zapíše do deníku.

GUID BeginUpload(...)

Zahájení nahrávání souboru na server.

void CancelUpload(...)

Zrušení nahrávání souboru na server a smazání dočasného souboru.

int CreateAct(...)

Vytvoří nový záznam v deníku požadavku.

int CreateGroup(...)

Vytvoří novou prázdnou skupinu uživatelů. Návratová hodnota je identifikační číslo (tRole.iRoleId) nové skupiny.

Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.

Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

int CreatePerson(...)

Vytvoří nového uživatele. Návratová hodnota je identifikační číslo (tPerson.iPersonId) nového uživatele.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

int CreateTicket(...)

Vytvoří nový požadavek. Návratová hodnota je číslo (ID) nového požadavku.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen řešitelského týmu alespoň jedné služby.

int CreateTicketRelation(...)

Vytvoří vazbu mezi požadavky. Návratová hodnota je číslo (ID) vazby mezi požadavky.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze uživatel, který je členem řešitelského týmu služby alespoň jednoho z požadavků beginTicketId a endTicketId a zároveň má oprávnění číst oba požadavky.

void DeleteGroup(...)

Trvale odstraní skupinu.

Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.

Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

void EndUpload(...)

Ukončení nahrávání souboru na server a uložení do databáze k odpovídajícímu záznamu.

int FindPerson(...)

Vrátí ID první nalezené osoby (nebo 0, pokud nebyl nikdo nalezen) dle zadaných parametrů. Musí být zadán alespoň jeden z parametrů. Z vyhledávání jsou vyřazeni odstranění uživatelé a uživatelé s vlastností skrýt v nabídkách.

AzureApplicationOptions GetAzureApplicationOptions()

Vrátí konfiguraci aplikace pro ověřování Azure Active Directory. Pokud tento způsob ověřování není povolen, jednotlivé položky návratové hodnoty obsahují prázdný řetězec.

Návratový typ AzureApplicationOptions obsahuje položky:

• string ApplicationId
• string TenantId

GroupInfo[] GetGroupList()

Vrátí seznam skupin registrovaných uživatelů.

Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.

Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

Návratový typ GroupInfo obsahuje položky:

• int Id
• string Name
• string Description

string[] GetHdSectionsList()

Vrátí seznam aktivních (nesmazaných) služeb (i složek). Údaje jsou v seznamu zakódovány v uspořádaných pěticích:
1. ID služby
2. Název služby
3. Umístění ve stromu služeb
4. Popis služby - je zakódován jako Uri.EscapeDataString
5. Jedná se o složku [0|1]

DateTime GetLastSectionChange()

Zjištění data a času poslední úpravy služeb.

string[] GetPersonCommunicationTickets(...)

Zobrazí přehled požadavků, v jejichž denících osoba naposled prováděla změny (Poslední komunikace osoby).

int[] GetPersonGroupList(...)

Vrátí seznam id skupin (tRole.iRoleId), kterých je daná osoba personId členem.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

object[][] GetPersonList(...)

Vrátí informace v požadovaných sloupcích columns o všech osobách splňujících podmínku v parametru filterCondition. Metoda nevrací odstraněné osoby.
První index v návratovém typu určuje záznam (osobu), druhý index určuje datový sloupec (index sloupce odpovídá pořadí sloupce v parametru columns).
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

string GetServiceDeskPortalUrl()

Vrátí URL adresu Service Desk webové aplikace.

bool GetTicketByMessageTag(...)

Dotaz na existenci požadavku se zadanou značkou.

ActInfo[] GetTicketActList(...)

Vrátí seznam událostí z deníku požadavku ticketId.

Návratový typ ActInfo obsahuje položky:

• string ActKind – druh události
• datetime Created – datum vytvoření události ve formátu UTC
• string Subject – předmět události
• string PlainText – obsah události v plaintextu
• string HtmlText – obsah události v HTML textu
• string From – jméno a email odesílatele události
• string To – jména a emaily příjemců události oddělené středníkem
• string Cc – jména a emaily příjemců v kopii oddělené středníkem
• double WorkHours – vykázaný pracovní čas v hodinách
• double TravelHours – vykázaný čas na cestě v hodinách
• double TravelKm – vykázaná cesta v kilometrech

Ve výsledném poli jsou záznamy seřazeny chronologicky (index 0 obsahuje nejstarší záznam).

Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze uživatel, který má oprávnění číst požadavek.

object[][] GetTicketList(...)

Vrátí dvourozměrné pole, kde první rozměr představuje jednotlivé požadavky a druhý rozměr představuje definované sloupce požadavku podle parametru columns.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, zobrazí se pouze požadavky, které má uživatel právo číst.

int GetTicketStateAfterAssignToSolver(...)

Pokud má po předání požadavku nastat změna stavu, vrátí ID nového stavu. Pokud ne, vrátí 0.

Při zavolání metody se provedou následující kroky:

1. 1. Kontrola, zda se jedná o první předání řešiteli a zda na procesu existuje stav se zapnutou volbou „Při prvním předání řešiteli automaticky přejít do tohoto stavu“.
   • Pokud ano, vrátí se ID nového stavu.
   • Pokud ne, vrátí 0.

string GetWebServiceVersion()

Vrátí aktuální verzi webové služby.

bool HasPersonSlaInSection(...)

Kontroluje, zdali má uživatel ve službě nějaké SLA.

bool IsActivated(...)

Vrátí informaci o tom, zda je zadaný modul aktivovaný.

bool IsConnectedToDb(...)

Vrátí informaci o tom, zda je webová služba připojena k zadané databázi.

bool IsExistingTicket(...)

Dotaz na existenci požadavku.

Metoda vrací true, pokud požadavek ticketId existuje a volající uživatel ho má právo číst. Jinak metoda vrací false.
Při volání v rámci vlastních programových rozšíření se oprávnění volajícího uživatele nekontrolují.

bool IsPersonMemberOfGroup(...)

Vrací informaci, zda je uživatel členem určité skupiny. Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

void LogAuditRecord(...)

Zaloguje auditní zprávu.

WS na konec seznamu Properties vždy doplní dvojici:
WS client address: <IP adresa>.

string ReadColumn(...)

Vrátí hodnotu sloupce tabulky.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, údaje o požadavku může číst pouze uživatel, který má právo zobrazit požadavek, údaje o službě pouze uživatel, který má libovolnou roli ve službě a údaje o uživateli či skupině pouze člen systémové skupiny „Administrátoři“.

bool RemovePersonFromGroup(...)

Odebere uživatele z určité skupiny.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen systémové skupiny „Administrátoři“.

void ResolveTicket(...)

Vyřeší požadavek. Pokud požadavek nelze vyřešit, operace skončí výjimkou.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, provede se pod uživatelem "_system" bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, provede se pod uživatelem, který je do webové služby integrovaně přihlášen. Metodu může spouštět pouze uživatel, který má práva operátora nebo manažera služby požadavku, nebo je aktuálním řešitelem požadavku.

void SendNews(...)

Odešle aktuální zprávu nastaveným příjemcům.

void SetTicketState(...)

Změní stav požadavku.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, metodu může spouštět pouze člen řešitelského týmu služby požadavku.

Při zavolání metody se provedou následující kroky:

1. Kontrola povinných položek pro stav.
   • Změna stavu požadavku
   • Případné vyřešení/uzavření požadavku.
   • Zápis do deníku požadavku
   • Případná vlastní akce
   • Případné zahájení schvalování
   • Zápis do deníku požadavku
   • Oznámení schvalovateli

Metoda generuje události do deníku v jazyce služby.

void UploadDataPart(...)

Načtení části souboru na server.

void WriteColumn(...)

Zapíše hodnotu do sloupce tabulky.
Pokud je operace spuštěna v rámci vlastních programových rozšíření, proběhne bez kontroly oprávnění.
Pokud je operace spuštěna z externí aplikace, provede se pod uživatelem, který je do webové služby integrovaně přihlášen. Nad požadavky může metodu spouštět pouze uživatel, který je členem řešitelského týmu služby požadavku. Nad uživateli a skupinami může metodu spouštět pouze uživatel, který je členem systémové skupiny „Administrátoři“.

Oznámení

void NotifyOnHdTicketAccepted(...)

Pošle oznámení s informací, že požadavek byl schválen.

void NotifyOnHdTicketApprovalCanceled(...)

Pošle oznámení s informací, že schvalování požadavku bylo zrušeno.

void NotifyOnHdTicketApprovalItem(...)

Pošle oznámení s informací, že osoba má schválit požadavek.

void NotifyOnHdTicketApprovalItemFinished(...)

Pošle schvalovatelům oznámení o ukončení daného schvalovacího kroku.

void NotifyOnHdTicketCreated(...)

Pošle operátorům a řešitelům (případně i žadateli) požadavku oznámení s informací, že požadavek byl založen.

void NotifyOnHdTicketDeadlineChanged(...)

Pošle žadateli požadavku oznámení s informací, že u požadavku byl nastaven / změněn / zrušen termín.

void NotifyOnHdTicketExpired(...)

Pošle oznámení s informací, že schvalování požadavku vypršelo.

void NotifyOnHdTicketHdSectionChanged(...)

Pošle žadateli požadavku řešiteli/operátorům s informací, že požadavek byl přesunut do jiné služby.

void NotifyOnHdTicketPassed(...)

Pošle oznámení s informací, že požadavek byl předán (jinému) řešiteli. Oznámení je zasláno původnímu řešiteli a novému řešiteli (případně operátorům).

void NotifyOnHdTicketRejected(...)

Pošle oznámení s informací, že požadavek byl zamítnut.

void NotifyOnHdTicketResolved(...)

Pošle žadateli požadavku oznámení s informací, že požadavek byl vyřešen.

void NotifyOnHdTicketSolverOpen(...)

Pošle žadateli požadavku oznámení s informací, že řešitel znovu otevřel požadavek.

void NotifyOnHdTicketUserOpen(...)

Pošle řešiteli požadavku oznámení s informací, že žadatel znovu otevřel požadavek.

void NotifyOnMessageSent(...)

Pošle řešitelům / odběratelům oznámení s informací, že byla přijata nová zpráva k požadavku.

void NotifyOnReplyReceived(...)

Pošle uživateli oznámení o přijetí odpovědi na zprávu, kterou uživatel dříve odeslal z SD.

void NotifySubscribersOnHdTicketDeadlineChanged(...)

Pošle odběratelům oznámení s informací, že u požadavku byl nastaven / změněn / zrušen termín.

void NotifySubscribersOnHdTicketOpen(...)

Pošle odběratelům oznámení s informací, že požadavek byl znovu otevřen.

void NotifySubscribersOnHdTicketResolved(...)

Pošle odběratelům oznámení s informací, že požadavek byl vyřešen.

void NotifySubscribersOnMessageSent(...)

Pošle odběratelům oznámení s informací, že byla přijata nová zpráva k požadavku.

void NotifyUserOnMessageRejected(...)

Pošle žadateli oznámení s informací, že požadavek byl zamítnut, protože nemá oprávnění používat službu.

void NotifyUserOnOpenRejected(...)

Pošle žadateli oznámení s informací, že znovu otevření požadavku bylo zamítnuto.

Automatická upozornění

void SendCheckSettingsAlert(...)

Odešle administrátorům systému emailové upozornění, že byly zjištěny nedostatky v nastavení systému.

void SendNonSummaryAlert(...)

Odešle ihned všechna upozornění (na neřešení, na termín) k zadanému požadavku.

void SendSummaryAlert(...)

Odešle souhrnné upozornění (na neřešení, na termín) k zadanému požadavku, ale pouze pokud se mají posílat v aktuální hodinu.

Nenašli jste co jste hledali? Zeptejte se našeho týmu technické podpory.