Service Desk WebService - popis rozhraní

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

Seznam metod

Metody pro práci s požadavky:

IsExistingTicket
GetTicketByMessageTag
FindPerson
ResolveTicket
ReadColumn
WriteColumn
CreateTicket
CreateAct
BeginUpload
UploadDataPart
EndUpload
CancelUpload
GetLastSectionChange
GetHdSectionsList
AssignTicketToSolver
GetPersonCommunicationTickets
GetTicketStateAfterAssignToSolver
SetTicketState

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

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

Metody pro odesílání automatických upozornění:

SendCheckSettingsAlert
SendNonSummaryAlert
SendSummaryAlert

Různé další metody:

IsActivated
GetWebServiceVersion
GetServiceDeskPortalUrl

Podrobný popis metod

Práce s požadavky

bool IsExistingTicket(...)

Dotaz na existenci požadavku.

bool GetTicketByMessageTag(...)

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

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.

void ResolveTicket(...)

Vyřeší požadavek. Operace se provede pod účtem "_system". Pokud požadavek nelze vyřešit, operace skončí výjimkou.

string ReadColumn(...)

Vrátí hodnotu sloupce tabulky.

void WriteColumn(...)

Zapíše hodnotu do sloupce tabulky.

int CreateTicket(...)

Vytvoří nový požadavek. Návratová hodnota je číslo (ID) nového požadavku.

int CreateAct(...)

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

GUID BeginUpload(...)

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

void UploadDataPart(...)

Načtení části souboru na server.

void EndUpload(...)

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

void CancelUpload(...)

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

DateTime GetLastSectionChange()

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

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]

bool AssignTicketToSolver(...)

Předá požadavek řešiteli.

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.

string[] GetPersonCommunicationTickets(...)

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

void SetTicketState(...)

Změní stav 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.

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.

Oznámení

void NotifyOnHdTicketAccepted(...)

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

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 NotifyOnHdTicketRejected(...)

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

void NotifyOnHdTicketExpired(...)

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

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 NotifyOnHdTicketResolved(...)

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

void NotifySubscribersOnHdTicketResolved(...)

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

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 NotifySubscribersOnMessageSent(...)

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

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 NotifyOnHdTicketHdSectionChanged(...)

Pošle žadateli požadavku oznámení s informací, že požadavek byl přesunut do jiné služby.

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 NotifySubscribersOnHdTicketDeadlineChanged(...)

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

void NotifyOnHdTicketUserOpen(...)

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

void NotifyOnHdTicketSolverOpen(...)

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

void NotifySubscribersOnHdTicketOpen(...)

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

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.

Další metody

bool IsActivated(...)

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

string GetWebServiceVersion()

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

string GetServiceDeskPortalUrl()

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

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