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
Metody pro odesílání notifikací 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í na neřešení / termínu
požadavků:
SendAllNonSummaryAlerts
SendAllSummaryAlerts
Různé další metody:
GetWebServiceVersion
GetServiceDeskPortalUrl
Podrobný popis metod
Práce s požadavky
bool IsExistingTicket()
Dotaz na existenci požadavku.
bool GetTicketByMessageTag(...)
Dotaz na existenci požadavku.
Parametr |
Datový typ |
Popis |
značka požadavku |
string |
Značka požadavku. |
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.
Parametr |
Datový typ |
Popis |
jméno |
string |
Jméno a příjmení osoby. |
email |
string |
Email osoby. |
void ResolveTicket(...)
Vyřeší požadavek. Operace se provede pod účtem "_system". Pokud požadavek
nelze uzavřít, operace skončí výjimkou.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Identifikační číslo požadavku. |
zpráva |
string |
Zpráva žadateli požadavku. |
string ReadColumn(...)
Vrátí hodnotu sloupce tabulky.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Identifikační číslo požadavku. |
název tabulky |
string |
Název tabulky, odkud číst informace. Podporované hodnoty jsou:
tHdTicket, tHdTicketCust, TicketForeignKeyInfo. |
název sloupce |
string |
Název sloupce tabulky. V případě TicketForeignKeyInfo, jsou
podporované tyto sloupce:
- SolverName = jméno řešitele požadavku
- SolverEmail = email řešitele požadavku
- TicketPriority = priorita požadavku
- SectionName = jméno služby, ve které se požadavek nachází
- RoomName = místnost
- SLAname = název SLA
- FirstActText = původní text požadavku
|
void WriteColumn(...)
Zapíše hodnotu do sloupce tabulky.
.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Identifikační číslo požadavku. |
název tabulky |
string |
Název tabulky, odkud číst informace. Podporované hodnoty jsou:
tHdTicket, tHdTicketCust. |
název sloupce |
string |
Název sloupce tabulky. |
hodnota |
string |
Hodnota vložená do sloupce. |
int CreateTicket(...)
Vytvoří nový požadavek. Návratová hodnota je číslo (ID) nového požadavku.
.
Parametr |
Datový typ |
Popis |
ID osoby |
int |
ID osoby vytvářející požadavek. |
ID osoby |
int |
ID osoby žadatele. |
jméno |
string |
Jméno a příjmení žadatele. |
email |
string |
Email žadatele. |
služba |
string |
Úplné jméno služby, do které bude požadavek založen. |
SLA |
string |
Název SLA. |
název požadavku |
string |
Název požadavku. |
popis |
string |
Popis požadavku. |
HTML popis |
string |
Popis požadavku s HTML formátováním. |
od |
string |
Email odesílatele - pouze pro emaily. |
komu |
string |
Příjemci zprávy - pouze pro emaily. |
kopie |
string |
Příjemci zprávy v poli kopie - pouze pro emaily. |
datum vytvoření |
datetime |
Datum vytvoření záznamu v UTC - pouze pro emaily. |
ID druhu záznamu |
string |
Typ události zakládacího záznamu. |
int CreateAct(...)
Vytvoří nový záznam v deníku požadavku.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
ID požadavku, ke kterému se má záznam vytvořit. |
ID osoby |
int |
ID osoby zakládající záznam. |
předmět |
string |
Předmět záznamu. |
zpráva |
string |
Zpráva. |
HTML zpráva |
string |
Zpráva s HTML formátováním. |
jméno odesílatele |
string |
jméno odesílatele. |
email odesílatele |
string |
Email odesílatele - pouze pro emaily. |
komu |
string |
Příjemci zprávy - pouze pro emaily. |
kopie |
string |
Příjemci zprávy v poli kopie - pouze pro emaily. |
datum vytvoření |
datetime |
Datum vytvoření záznamu v UTC - pouze pro emaily. |
ID druhu záznamu |
string |
Typ události záznamu v deníku. |
ukázat žadateli |
bool |
Zobrazovat událost žadateli. |
GUID BeginUpload(...)
Zahájení nahrávání souboru na server.
.
Parametr |
Datový typ |
Popis |
soubor |
string |
Cesta k souboru. |
typ |
string |
Typ souboru. |
void UploadDataPart(...)
Načtení části souboru na server.
Parametr |
Datový typ |
Popis |
ID session |
GUID |
Iidentifikátor session, který vrátila funkce BeginUpload. |
pořadové číslo |
int |
Pořadové číslo části souboru. |
data |
byte[] |
Binární data souboru. |
velikost |
int |
Velikost načítané části souboru v bajtech. |
void EndUpload(...)
Ukončení nahrávání souboru na server a uložení do databáze k odpovídajícímu
záznamu.
Parametr |
Datový typ |
Popis |
ID session |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
počet částí |
int |
Celkový počet částí souboru. |
ID záznamu |
int |
ID záznamu v deníku ServiceDesk, ke kterému se má soubor
připojit jako příloha. |
ID přílohy |
string |
ID přílohy vložené přímo v těle emailové zprávy. Nepovinné. |
void CancelUpload(...)
Zrušení nahrávání souboru na server a smazání dočasného souboru.
Parametr |
Datový typ |
Popis |
ID session |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
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 AssignToSolver(...)
Předání požadavku řešiteli.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Identifikační číslo požadavku. |
ID osoby |
int |
Identifikační číslo osoby, která se má stát novým řešitelem
požadavku. |
Notifikace
void NotifyOnHdTicketAccepted(...)
Odešle žadateli notifikaci s informací, že požadavek byl přijat do
systému.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Číslo požadavku. |
zpráva |
string |
Zpráva žadateli. |
void NotifyOnHdTicketCreated(...)
Odešle operátorům a řešitelům (případně i žadateli) požadavku notifikaci s
informací, že požadavek byl založen.
Parametr |
Datový typ |
Popis |
ID události |
int |
První událost požadavku. |
odeslat žadateli |
bool |
Odeslat notifikaci žadateli. |
void NotifyOnHdTicketRejected(...)
Odešle žadateli notifikaci s informací, že požadavek byl zamítnut.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Číslo požadavku. |
zpráva |
string |
Zpráva žadateli. |
void NotifyOnHdTicketExpired(...)
Odešle notifikaci s informací, že schvalování požadavku vypršelo.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Číslo požadavku. |
void
NotifyOnHdTicketApprovalCanceled(...)
Odešle notifikaci s informací, že schvalování požadavku bylo zrušeno.
Parametr |
Datový typ |
Popis |
ID požadavku |
int |
Číslo požadavku. |
void NotifyOnHdTicketApprovalItem(...)
Odešle notifikaci s informací, že osoba má schválit požadavek.
Parametr |
Datový typ |
Popis |
ID schvalovací položky |
int |
Číslo schvalovací položky. |
ID osoby |
int |
Identifikátor osoby (tPerson). |
void NotifyOnHdTicketResolved(...)
Odešle žadateli požadavku notifikaci s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
ID uzavírací události |
int |
Číslo události, která vyřešila požadavek. |
zpráva |
string |
Zpráva žadateli. |
void
NotifySubscribersOnHdTicketResolved(...)
Odešle odběratelům notifikaci s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
ID uzavírací události |
int |
Číslo události, která vyřešila požadavek. |
zpráva |
string |
Zpráva žadateli. |
void NotifyOnMessageSent(...)
Odešle řešitelům / odběratelům notifikaci s informací, že byla přijata nová
zpráva k požadavku.
Parametr |
Datový typ |
Popis |
ID události |
int |
Identifikační číslo události zprávy. |
void
NotifySubscribersOnMessageSent(...)
Odešle odběratelům notifikaci s informací, že byla přijata nová zpráva k
požadavku.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události zprávy. |
void NotifyOnHdTicketPassed(...)
Odešle notifikaci s informací, že požadavek byl předán (jinému) řešiteli.
Notifikace je zaslána původnímu řešiteli a novému řešiteli (případně
operátorům).
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události předání řešiteli. |
ID původního řešitele |
int |
Identifikátor osoby původního řešitele, pokud je 0, požadavek
neměl řešitele. |
ID nového řešitele |
int |
Identifikátor osoby nového řešitele, pokud je 0, požadavek byl
vrácen operátorům. |
zpráva |
string |
Zpráva řešitelům / operátorům. |
void
NotifyOnHdTicketHdSectionChanged(...)
Odešle žadateli požadavku notifikaci s informací, že požadavek byl přesunut
do jiné služby.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události přesunu do jiné služby. |
ID původní služby |
int |
Identifikátor původní služby, služba musí existovat. |
ID nové služby |
int |
Identifikátor nové služby, služba musí existovat. |
zpráva |
string |
Zpráva řešitelům / operátorům. |
void
NotifyOnHdTicketDeadlineChanged(...)
Odešle žadateli požadavku notifikaci s informací, že u požadavku byl
nastaven / změněn / zrušen termín.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události změny termínu. |
původní termín |
datetime |
Původní termín požadavku, pokud je hodnota datumu menší než
1.1.0001, původní termín byl prázdný - jedná se tedy o nastavení
nového termínu. |
nový termín |
datetime |
Nový termín požadavku, pokud je hodnota datumu menší než
1.1.0001, termín bude zrušen. |
důvod |
string |
Zpráva - důvod změny termínu. |
void
NotifySubscribersOnHdTicketDeadlineChanged(...)
Odešle odběratelům notifikaci s informací, že u požadavku byl nastaven /
změněn / zrušen termín.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události změny termínu. |
původní termín |
datetime |
Původní termín požadavku, pokud je hodnota data menší než
1.1.0001, původní termín byl prázdný - jedná se tedy o nastavení
nového termínu. |
nový termín |
datetime |
Nový termín požadavku, pokud je hodnota data menší než 1.1.0001,
termín bude zrušen. |
důvod |
string |
Zpráva - důvod změny termínu. |
void NotifyOnHdTicketUserOpen(...)
Odešle řešiteli požadavku notifikaci s informací, že žadatel znovu otevřel
požadavek.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události otevření požadavku. |
důvod |
string |
Zpráva - důvod otevření požadavku. |
void NotifyOnHdTicketSolverOpen(...)
Odešle žadateli požadavku notifikaci s informací, že řešitel znovu otevřel
požadavek.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události otevření požadavku. |
důvod |
string |
Zpráva - důvod otevření požadavku. |
void
NotifySubscribersOnHdTicketOpen(...)
Odešle odběratelům notifikaci s informací, že požadavek byl znovu otevřen.
Parametr |
Datový typ |
Popis |
ID události |
int |
Číslo události otevření požadavku. |
zpráva |
string |
Zpráva - důvod otevření požadavku. |
void NotifyUserOnMessageRejected(...)
Odešle žadateli notifikaci s informací, že požadavek byl zamítnut, protože
nemá oprávnění používat službu.
Parametr |
Datový typ |
Popis |
ID služby |
int |
Identifikátor služby. |
jméno odesílatele |
string |
Jméno a příjmení odesílatele zprávy. |
email odesílatele |
string |
Email odesílatele zprávy. |
email příjemce |
string |
Email příjemce zprávy (původní odesílatel zprávy). |
datum |
string |
Datum původní zprávy. |
ID zprávy |
string |
Identifikátor zprávy. |
předmět |
string |
Předmět původní zprávy. |
text |
string |
Text původní zprávy. |
void NotifyUserOnOpenRejected(...)
Odešle žadateli notifikaci s informací, že znovuotevření požadavku bylo
zamítnuto.
Parametr |
Datový typ |
Popis |
ID služby |
int |
Identifikátor služby. |
jméno odesílatele |
string |
Jméno a příjmení odesílatele zprávy. |
email odesílatele |
string |
Email odesílatele zprávy. |
email příjemce |
string |
Email příjemce zprávy (původní odesílatel zprávy). |
CC příjemce |
string |
CC (CarbonCopy, kopie) původní zprávy. |
datum |
string |
Datum původní zprávy. |
ID zprávy |
string |
Identifikátor zprávy. |
předmět |
string |
Předmět původní zprávy. |
text |
string |
Text původní zprávy. |
Automatická upozornění
void SendAllNonSummaryAlerts()
Odešle ihned všechna upozornění (na neřešení, na termín) k jednotlivým
požadavkům.
Pozn.: Metoda nemá žádný parametr.
void SendAllSummaryAlerts()
Odešle souhrnná upozornění (na neřešení, na termín), ale pouze ta, která se
mají posílat v aktuální hodinu.
Pozn.: Metoda nemá žádný parametr.
Další metody
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.
|