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
AssignToSolver
GetPersonCommunicationTickets
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ů:
SendNonSummaryAlert
SendSummaryAlert
Různé další metody:
IsActivated
GetWebServiceVersion
GetServiceDeskPortalUrl
Podrobný popis metod
Práce s požadavky
bool IsExistingTicket(...)
Dotaz na existenci požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
bool GetTicketByMessageTag(...)
Dotaz na existenci požadavku se zadanou značkou.
Parametr |
Datový typ |
Popis |
Povinný |
značka požadavku |
string |
Značka požadavku. |
Ne |
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 |
Povinný |
jjméno |
string |
Jméno a příjmení osoby. |
Ano (pokud není vyplněn e-mail) |
email |
string |
Email osoby. |
Ano (pokud není vyplněno jméno) |
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 |
Povinný |
ID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
zpráva |
string |
Zpráva žadateli požadavku./td>
| NNe |
string ReadColumn(...)
Vrátí hodnotu sloupce tabulky.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
název tabulky |
string |
Název tabulky, odkud číst informace. Podporované hodnoty jsou:
tHdTicket, tHdTicketCust, TicketForeignKeyInfo. |
Ano |
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
|
Ano |
void WriteColumn(...)
Zapíše hodnotu do sloupce tabulky.
Poznámka:
Lze zapisovat do všech sloupců z tabulky
tHdTicketCust, a do následujících sloupců z tabulky
tHdTicket:
mHdTicketNotice, sHdTicketCategory, sHdTicketGroup,
sHdTicketHdBranch, sHdTicketDeviceCode, sHdTicketUserPhon,
mHdTicketUserContact, sHdTicketUserMobile, sHdTicketUserOffice,
sHdTicketUserDepartment, sHdTicketUserWorkPosition a sHdTicketUserCompany
Parametr |
Datový typ |
Popis |
Povinný |
IID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
název tabulky |
string |
Název tabulky, odkud číst informace. Podporované hodnoty jsou:
tHdTicket, tHdTicketCust. |
Ano |
název sloupce |
string |
Název sloupce tabulky. |
Ano |
hodnota |
string |
Hodnota vložená do sloupce./td>
| Ano |
int CreateTicket(...)
Vytvoří nový požadavek. Návratová hodnota je číslo (ID) nového požadavku.
.
Parametr |
Datový typ |
Popis |
Povinný |
ID osoby |
int |
ID osoby vytvářející požadavek. |
Ano |
ID osoby |
int |
ID osoby žadatele. |
Ano |
jméno |
string |
Jméno a příjmení žadatele. |
Ne |
email |
string |
Email žadatele. |
Ne |
služba |
string |
Úplné jméno služby, do které bude požadavek založen. |
Ne |
SLA |
string |
Název SLA. |
Ne |
název požadavku |
string |
Název požadavku. |
Ne |
popis |
string |
Popis požadavku. |
Ne |
HTML popis |
string |
Popis požadavku s HTML formátováním. |
Ne |
od |
string |
Email odesílatele - pouze pro emaily. |
Ne |
komu |
string |
Příjemci zprávy - pouze pro emaily. |
Ne |
kopie |
string |
Příjemci zprávy v poli kopie - pouze pro emaily. |
Ne |
datum vytvoření |
datetime |
Datum vytvoření záznamu v UTC - pouze pro emaily. |
Ano |
ID druhu záznamu |
string |
Typ události zakládacího záznamu. |
Ano |
int CreateAct(...)
Vytvoří nový záznam v deníku požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
ID požadavku, ke kterému se má záznam vytvořit. |
Ano |
ID osoby |
int |
ID osoby zakládající záznam. |
Ano |
předmět |
string |
Předmět záznamu. |
Ne |
zpráva |
string |
Zpráva. |
Ne |
HTML zpráva |
string |
Zpráva s HTML formátováním. |
Ne |
jméno odesílatele |
string |
jméno odesílatele. |
Ne |
email odesílatele |
string |
Email odesílatele - pouze pro emaily. |
Ne |
komu |
string |
Příjemci zprávy - pouze pro emaily. |
Ne |
kopie |
string |
Příjemci zprávy v poli kopie - pouze pro emaily. |
Ne |
datum vytvoření |
datetime |
Datum vytvoření záznamu v UTC - pouze pro emaily. |
Ano |
ID druhu záznamu |
int |
Typ události záznamu v deníku. |
Ano |
ukázat žadateli |
bool |
Zobrazovat událost žadateli. |
Ano |
GUID BeginUpload(...)
Zahájení nahrávání souboru na server.
.
Parametr |
Datový typ |
Popis |
Povinný |
soubor |
string |
Cesta k souboru. |
Ne |
typ |
string |
Typ souboru. |
Ne |
void UploadDataPart(...)
Načtení části souboru na server.
Parametr |
Datový typ |
Popis |
Povinný |
ID session |
GUID |
Iidentifikátor session, který vrátila funkce BeginUpload. |
Ano |
pořadové číslo |
int |
Pořadové číslo části souboru. |
Ano |
data |
byte[] |
Binární data souboru. |
Ano |
velikost |
int |
Velikost načítané části souboru v bajtech. |
Ano |
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 |
Povinný |
ID session |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
Ano |
počet částí |
int |
Celkový počet částí souboru. |
Ano |
ID záznamu |
int |
ID záznamu v deníku ServiceDesk, ke kterému se má soubor
připojit jako příloha. |
Ano |
ID přílohy |
string |
ID přílohy vložené přímo v těle emailové zprávy. Nepovinné. |
Ne |
void CancelUpload(...)
Zrušení nahrávání souboru na server a smazání dočasného souboru.
Parametr |
Datový typ |
Popis |
Povinný |
ID session |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
Ano |
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 |
Povinný |
ID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
ID osoby |
int |
Identifikační číslo osoby, která se má stát novým řešitelem
požadavku. |
Ano |
string[]
GetPersonCommunicationTickets(...)
Zobrazí přehled požadavků, v jejichž denících osoba naposled prováděla změny
(Poslední komunikace osoby).
Parametr |
Datový typ |
Popis |
Povinný |
ID uživatele |
int |
Identifikační číslo uživatele, jehož komunikaci chcete zobrazit. |
Ano |
Počet požadavků |
int |
Počet požadavků (ve kterých uživatel naposled komunikoval),
které chcete zobrazit. |
Ano |
Notifikace
void NotifyOnHdTicketAccepted(...)
Odešle žadateli notifikaci s informací, že požadavek byl schválen.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Číslo požadavku. |
Ano |
zpráva |
string |
Zpráva žadateli. |
Ne |
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 |
Povinný |
ID události |
int |
První událost požadavku. |
Ano |
odeslat žadateli |
bool |
Odeslat notifikaci žadateli. |
Ano |
void NotifyOnHdTicketRejected(...)
Odešle žadateli notifikaci s informací, že požadavek byl zamítnut.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Číslo požadavku. |
Ano |
zpráva |
string |
Zpráva žadateli. |
Ne |
void NotifyOnHdTicketExpired(...)
Odešle notifikaci s informací, že schvalování požadavku vypršelo.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Číslo požadavku. |
Ano |
void
NotifyOnHdTicketApprovalCanceled(...)
Odešle notifikaci s informací, že schvalování požadavku bylo zrušeno.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Číslo požadavku. |
Ano |
void NotifyOnHdTicketApprovalItem(...)
Odešle notifikaci s informací, že osoba má schválit požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
ID schvalovací položky |
int |
Číslo schvalovací položky. |
Ano |
ID osoby |
int |
Identifikátor osoby (tPerson). |
Ano |
void NotifyOnHdTicketResolved(...)
Odešle žadateli požadavku notifikaci s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
Povinný |
ID uzavírací události |
int |
Číslo události, která vyřešila požadavek. |
Ano |
zpráva |
string |
Zpráva žadateli. |
Ne |
void
NotifySubscribersOnHdTicketResolved(...)
Odešle odběratelům notifikaci s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
Povinný |
ID uzavírací události |
int |
Číslo události, která vyřešila požadavek. |
Ano |
zpráva |
string |
Zpráva žadateli. |
Ne |
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 |
Povinný |
ID události |
int |
Identifikační číslo události zprávy. |
Ano |
zpráva |
int |
Hodnota určuje, komu se zpráva odešle:
-1 - notifikace se odešle pouze žadateli.
-2 - vynutí se odeslání notifikace řešitelům
(operátorům).
0 - odešle se standardní notifikace o nové zprávě. |
Ano |
void
NotifySubscribersOnMessageSent(...)
Odešle odběratelům notifikaci s informací, že byla přijata nová zpráva k
požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ID události |
int |
Číslo události zprávy. |
Ano |
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 |
Povinný |
ID události |
int |
Číslo události předání řešiteli. |
Ano |
ID původního řešitele |
int |
Identifikátor osoby původního řešitele, pokud je 0, požadavek
neměl řešitele. |
Ano |
ID nového řešitele |
int |
Identifikátor osoby nového řešitele, pokud je 0, požadavek byl
vrácen operátorům. |
Ano |
zpráva |
string |
Zpráva řešitelům / operátorům. |
Ne |
void
NotifyOnHdTicketHdSectionChanged(...)
Odešle žadateli požadavku notifikaci s informací, že požadavek byl přesunut
do jiné služby.
Parametr |
Datový typ |
Popis |
Povinný |
ID události |
int |
Číslo události přesunu do jiné služby. |
Ano |
ID původní služby |
int |
Identifikátor původní služby, služba musí existovat. |
Ano |
ID nové služby |
int |
Identifikátor nové služby, služba musí existovat. |
Ano |
zpráva |
string |
Zpráva řešitelům / operátorům. |
Ne |
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 |
Povinný |
ID události |
int |
Číslo události změny termínu. |
Ano |
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. |
Ano |
nový termín |
datetime |
Nový termín požadavku, pokud je hodnota datumu menší než
1.1.0001, termín bude zrušen. |
Ano |
důvod |
string |
Zpráva - důvod změny termínu. |
Ne |
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 |
Povinný |
ID události |
int |
Číslo události změny termínu. |
Ano |
nový termín |
datetime |
Nový termín požadavku, pokud je hodnota data menší než 1.1.0001,
termín bude zrušen. |
Ano |
důvod |
string |
Zpráva - důvod změny termínu. |
Ne |
void NotifyOnHdTicketUserOpen(...)
Odešle řešiteli požadavku notifikaci s informací, že
žadatel znovu otevřel požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
ID události |
int |
Číslo události otevření požadavku. |
Ano |
důvod |
string |
Zpráva - důvod otevření požadavku. |
Ne |
void NotifyOnHdTicketSolverOpen(...)
Odešle žadateli požadavku notifikaci s informací, že řešitel znovu otevřel
požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
ID události |
int |
Číslo události otevření požadavku. |
Ano |
důvod |
string |
Zpráva - důvod otevření požadavku. |
Ne |
void
NotifySubscribersOnHdTicketOpen(...)
Odešle odběratelům notifikaci s informací, že požadavek byl znovu otevřen.
Parametr |
Datový typ |
Popis |
Povinný |
ID události |
int |
Číslo události otevření požadavku. |
Ano |
zpráva |
string |
Zpráva - důvod otevření požadavku. |
Ne |
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 |
Povinný |
ID služby |
int |
Identifikátor služby. |
Ano |
jméno odesílatele |
string |
Jméno a příjmení odesílatele zprávy. |
Ne |
email odesílatele |
string |
Email odesílatele zprávy. |
Ne |
email příjemce |
string |
Email příjemce zprávy (původní odesílatel zprávy). |
Ne |
datum |
string |
Datum původní zprávy. |
Ne |
ID zprávy |
string |
Identifikátor zprávy. |
Ne |
předmět |
string |
Předmět původní zprávy. |
Ne |
text |
string |
Text původní zprávy. |
Ne |
void NotifyUserOnOpenRejected(...)
Odešle žadateli notifikaci s informací, že znovu otevření požadavku bylo
zamítnuto.
Parametr |
Datový typ |
Popis |
Povinný |
ID požadavku |
int |
Identifikační číslo požadavku. |
Ano |
ID služby |
int |
Identifikátor služby. |
Ano |
jméno odesílatele |
string |
Jméno a příjmení odesílatele zprávy. |
Ne |
email odesílatele |
string |
Email odesílatele zprávy. |
Ano |
email příjemce |
string |
Email příjemce zprávy (původní odesílatel zprávy). |
Ne |
CC příjemce |
string |
CC (CarbonCopy, kopie) původní zprávy. |
Ne |
datum |
string |
Datum původní zprávy. |
Ne |
ID zprávy |
string |
Identifikátor zprávy. |
Ne |
předmět |
string |
Předmět původní zprávy. |
Ne |
text |
string |
Text původní zprávy. |
Ne |
Značka požadavku |
string |
Značka požadavku, který byl vytvořen, pokud se žadatel pokusil
znovu otevřít požadavek po vypršení lhůty. |
Ne |
Automatická upozornění
void SendNonSummaryAlert(...)
Odešle ihned všechna upozornění (na neřešení, na termín) k zadanému
požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ID pravidla |
int |
Číslo pravidla pro odeslání notifikace, které je nastaveno na
SLA. |
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
ID pravidla |
int |
Číslo pravidla pro odeslání notifikace, které je nastaveno na
SLA. |
Ano |
Další metody
bool IsActivated(...)
Vrátí informaci o tom, zda je zadaný modul aktivovaný.
Parametr |
Datový typ |
Popis |
Povinný |
ID modulu |
int |
Identifikační číslo modulu, který chcete ověřit. |
Ano |
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.
|