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:
NotifyOnChildOrBlocksResolvedTicket
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
WSDL
Service Desk WebService ve výchozím nastavení neposkytuje soubor WSDL, takže ve webovém prohlížeči se na adrese WS nezobrazuje kompletní seznam všech metod webové služby. Pro povolení souboru WSDL v souboru web.config zakomentujte část: <remove name="Documentation"/>. Z důvodů bezpečnosti doporučujeme v produkčním prostředí ponechat WSDL vypnuté.
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“.
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo uživatele (tPerson.iPersonId) |
Ano |
roleId |
int |
Identifikační číslo skupiny (tRole.iRoleId) |
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
newPersonId |
int |
Identifikační číslo osoby, která se má stát novým řešitelem
požadavku. Nelze zadat prázdnou hodnotu, nelze tedy provést vrácení
hlavnímu řešiteli. |
Ano |
personId |
int |
Identifikační číslo osoby, která požadavek předá řešiteli. Pokud
je operace spuštěna z externí aplikace, tento parametr je ignorován
a požadavek je předán pod uživatelem, který je do webové služby
integrovaně přihlášen. |
Ano |
message |
string |
Zpráva pro řešitele požadavku v prostém textu |
Ne |
htmlMessage |
string |
Zpráva pro řešitele požadavku v HTML formátu |
Ne |
sendNotification |
bool |
Odesílat oznámení řešiteli o předání požadavku |
Ano |
Při zavolání metody se provedou následující
kroky:
- Změna řešitele požadavku
- Zápis do deníku požadavku
- Oznámení o změně řešitele
- Případná vlastní akce
- 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).
Poznámka:
Pokud stav požadavku nelze změnit (např. nejsou
vyplněny povinné položky), stav požadavku se
nezmění, ale řešitel ano.
Poznámka:
V metodě se neprovádí kontrola, zda nový řešitel
může být řešitelem požadavku.
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.
Parametr |
Datový typ |
Popis |
Povinný |
filename |
string |
Cesta k souboru |
Ne |
fileType |
string |
Typ souboru |
Ne |
void CancelUpload(...)
Zrušení nahrávání souboru na server a smazání dočasného souboru.
Parametr |
Datový typ |
Popis |
Povinný |
sessionId |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
Ano |
int CreateAct(...)
Vytvoří nový záznam v deníku požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
ID požadavku, ke kterému se má záznam vytvořit. |
Ano |
creatorId |
int |
ID osoby zakládající záznam |
Ano |
subject |
string |
Předmět záznamu |
Ne |
message |
string |
Zpráva |
Ne |
htmlMessage |
string |
Zpráva s HTML formátováním |
Ne |
senderName |
string |
Jméno odesílatele |
Ne |
fromEmail |
string |
Email odesílatele - pouze pro emaily |
Ne |
toEmails |
string |
Příjemci zprávy - pouze pro emaily |
Ne |
ccEmails |
string |
Příjemci zprávy v poli kopie - pouze pro emaily |
Ne |
created |
datetime |
Datum vytvoření záznamu v UTC - pouze pro emaily |
Ano |
actKindId |
int |
Typ události záznamu v deníku, viz
tActKind. Nelze použít typ události proces (9) a upozornění
(11). |
Ano |
showApplicant |
bool |
Zobrazovat událost žadateli |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
name |
string |
Název skupiny |
Ano |
description |
string |
Popis skupiny |
Ne |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
fullName |
string |
Jméno a příjmení |
Ano |
login |
string |
Uživatelské jméno |
Ne |
email |
string |
E-mail |
Ne |
phone |
string |
Telefon do zaměstnání |
Ne |
personalNumber |
string |
Osobní číslo |
Ne |
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.
Parametr |
Datový typ |
Popis |
Povinný |
creatorId |
int |
ID osoby zapisující požadavek. Pokud je operace spuštěna z
externí aplikace, tento parametr je ignorován a požadavek je zapsán
pod uživatelem, který je do webové služby integrovaně přihlášen. |
Ano |
requesterId |
int |
ID osoby žadatele |
Ano |
requesterName |
string |
Jméno a příjmení žadatele |
Ne |
requesterEmail |
string |
Email žadatele |
Ne |
serviceName |
string |
Úplné jméno služby, do které bude požadavek založen. |
Ano |
slaName |
string |
Název SLA |
Ne |
subject |
string |
Název požadavku |
Ne |
message |
string |
Popis požadavku |
Ne |
htmlMessage |
string |
Popis požadavku s HTML formátováním |
Ne |
fromEmail |
string |
Email odesílatele - pouze pro emaily |
Ne |
toEmails |
string |
Příjemci zprávy - pouze pro emaily |
Ne |
ccEmails |
string |
Příjemci zprávy v poli kopie - pouze pro emaily |
Ne |
messageCreated |
datetime |
Datum vytvoření zakládací události požadavku v UTC |
Ano |
ticketCreated |
datetime |
Jakékoliv datum - parametr se nepoužívá. Požadavky jsou vytvářeny vždy v aktuálním čase aplikačního serveru.
| Ano |
actKindId |
int |
Typ události zakládacího záznamu, viz
tActKind. Nelze použít typ události proces (9) a upozornění
(11). |
Ano |
requestedForPersonId |
int? |
ID osoby, pro kterou je požadavek zakládán. Při hodnotě 0 nebo null se dosadí hodnota žadatele. |
Ne |
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.
Parametr |
Datový typ |
Popis |
Povinný |
beginTicketId |
int |
Identifikační číslo výchozího požadavku (z hlediska vazby) |
Ano |
endTicketId |
int |
Identifikační číslo koncového požadavku (z hlediska vazby) |
Ano |
ticketRelationTypeId |
int |
Typ vazby:
1 – Souvisí s
2 – Je podřazený pod
3 – Následuje po
4 – Je blokován
5 – Duplikuje
Případně ID vlastního typu vazby.
|
Ano |
personId |
int |
Identifikační číslo osoby, která vazbu přidává. Pokud je zadána
hodnota 0, akci provádí -system. Pokud je operace spuštěna z externí
aplikace, tento parametr je ignorován a vazba je vytvořena
uživatelem, který je do webové služby integrovaně přihlášen. |
Ne |
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.
Parametr |
Datový typ |
Popis |
Povinný |
sessionId |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
Ano |
partsCount |
int |
Celkový počet částí souboru |
Ano |
actId |
int |
ID záznamu v deníku ServiceDesk, ke kterému se má soubor
připojit jako příloha. |
Ano |
contentId |
string |
ID přílohy vložené přímo v těle emailové zprávy |
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ý |
name |
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) |
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]
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo osoby |
Ano |
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).
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo uživatele, jehož komunikaci chcete zobrazit. |
Ano |
ticketsCount |
int |
Počet požadavků (ve kterých uživatel naposled komunikoval),
které chcete zobrazit. |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo osoby (tPerson.iPersonId) |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
columns |
string |
Názvy požadovaných sloupců oddělené čárkami. Lze vrátit všechny sloupce z tabulek tPerson a tPersonCust, které lze číst metodou ReadColumn.
Příklad: „iPersonId, sPersonLogin“
|
Ano |
filterCondition |
string |
Where klauzule pro SQL dotaz.
Příklad: „sPersonEmail is not null and sPerson is not null“
|
Ne |
sorting |
string |
Order by klauzule pro Sql dotaz.
Příklad: „sPerson ASC“
|
Ne |
string GetServiceDeskPortalUrl()
Vrátí URL adresu Service Desk webové aplikace.
bool GetTicketByMessageTag(...)
Dotaz na existenci požadavku se zadanou značkou.
Parametr |
Datový typ |
Popis |
Povinný |
text |
string |
Značka požadavku |
Ne |
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.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
Int |
Číslo požadavku (tHdTicket.iHdTicketId) |
Ano |
displayMode |
Int |
Způsob zobrazení deníku požadavku.
- 0 – Podrobný deník
- 1 – Komunikace
|
Ano |
localeId |
Int |
Metodu volejte s hodnotou 0 v tomto parametru. Parametr je rezervován pro budoucí použití.
Metoda vždy vrací hodnoty v jazyce systému Alvao.
|
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
columns |
string |
Názvy sloupců z tabulek tHdTicket a tHdTicketCust, jejichž hodnoty má metoda vrátit. Názvy jednotlivých sloupců oddělte čárkou.
Kromě sloupců z databázových tabulek jsou k dispozici následující virtuální sloupce představující hodnoty cizích klíčů v tabulce tHdTicket:
- 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
Příklad: „sHdTicket, SolverName“
|
Ano |
filterCondition |
string |
Where klauzule pro SQL dotaz.
Příklad: „SolverName is not null“
|
Ne |
sorting |
string |
Order by klauzule pro Sql dotaz.
Příklad: „dHdTicket ASC“
|
Ne |
localeId |
int |
Metodu volejte s hodnotou 0 v tomto parametru. Parametr je rezervován pro budoucí použití.
Metoda vždy vrací hodnoty v jazyce systému Alvao.
|
Ano |
maxRecords |
int |
Maximální počet vrácených záznamů. Počet vrácených záznamů doporučujeme omezit rozumnou hodnotou podle použití v aplikaci. |
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
Při zavolání metody se provedou následující kroky:
- 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.
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo osoby |
Ano |
sectionId |
int |
Identifikační číslo služby |
Ano |
bool IsActivated(...)
Vrátí informaci o tom, zda je zadaný modul aktivovaný.
Parametr |
Datový typ |
Popis |
Povinný |
moduleId |
int |
Identifikační číslo modulu, který chcete ověřit. |
Ano |
bool IsConnectedToDb(...)
Vrátí informaci o tom, zda je webová služba připojena k zadané databázi.
Parametr |
Datový typ |
Popis |
Povinný |
serverName |
string |
Název serveru |
Ano |
dbName |
string |
Název databáze |
Ano |
bool IsExistingTicket(...)
Dotaz na existenci požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo uživatele (tPerson.iPersonId) |
Ano |
roleId |
int |
Identifikační číslo skupiny (tRole.iRoleId) |
Ano |
void LogAuditRecord(...)
Zaloguje auditní zprávu.
Parametr |
Datový typ |
Popis |
Povinný |
MessageType |
int |
Typ zalogované události. Povolené hodnoty:
1 – Vytvoření uživatele
2 – Odstranění uživatele
3 – Úprava vlastností uživatele
4 – Přihlášení uživatele
5 – Odhlášení uživatele
6 – Neúspěšný pokus o přihlášení uživatele
7 - Přidání oprávnění ke službě
8 - Změna oprávnění služby
9 - Odebrání oprávnění službě
10 - Přidání SLA ke službě
11 - Změna SLA služby
12 - Odebrání SLA službě
13 - Vytvoření nového oprávnění v zabezpečení objektů
14 - Úprava existujícího oprávnění v zabezpečení objektů
15 - Odstranění existujícího oprávnění v zabezpečení objektů
16 - Změna zabezpečení vlastností objektů
17 - Vytvoření oprávnění v zabezpečení vlastností objektů
18 - Odstranění oprávnění v zabezpečení vlastností objektů
19 - Přidání nového člena do skupiny
20 - Odebrání stávajícího člena ze skupiny
21 - Import služeb ze souboru
22 - Vytvoření nového oprávnění k softwarovým licencím
23 - Úprava existujícího oprávnění k softwarovým licencím
24 - Odstranění existujícího oprávnění k softwarovým licencím
25 - Uživatel zadal nesprávné heslo při podepisování dokumentu
26 - Vytvoření nového oprávnění ke složce dokumentů
27 - Úprava existujícího oprávnění ke složce dokumentů
28 - Odstranění existujícího oprávnění ke složce dokumentů
|
Ano |
Properties |
NameValuePair[] |
Seznam dvojic název – hodnota. Jedná se o položky logované společně se zprávou |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
recordId |
int |
Identifikační číslo záznamu v tabulkách
tHdTicket,
tHdSection,
tPerson nebo
tRole. |
Ano |
table |
string |
Název tabulky, odkud číst informace. Podporované hodnoty jsou:
tHdTicket,
tHdTicketCust, TicketForeignKeyInfo,
tHdSection,
tPerson,
tPersonCust,
tRole a PersonForeignKeyInfo. |
Ano |
column |
string |
Název sloupce tabulky.
Lze číst hodnoty ze všech sloupců tabulek
tHdTicket,
tHdTicketCust,
tPersonCust a
tRole.
Z tabulky
tHdSection
lze číst hodnoty všech sloupců kromě těch, které se týkají nastavení
načítaných schránek.
Z tabulky
tPerson
lze číst hodnoty všech sloupců kromě sPersonPswd, PersonPortrait, PersonPortraitHash, WebAppLoginGUID.
V případě čtení údajů z TicketForeignKeyInfo je umožněno číst
hodnoty následujících sloupců:
- 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
- StateName - název stavu
V případě čtení údajů z PersonForeignKeyInfo je umožněno číst
hodnoty následujících sloupců:
- AccountName – název organizace
uživatele
- ManagerName – jméno a příjmení
nadřízeného uživatele
- DelegateName – jméno a příjmení
zástupce uživatele
Více informací o sloupcích (včetně datových typů) najdete v
dokumentaci databáze Alvao.
|
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
personId |
int |
Identifikační číslo uživatele (tPerson.iPersonId) |
Ano |
roleId |
int |
Identifikační číslo skupiny (tRole.iRoleId) |
Ano |
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 hlavního řešitele nebo manažera služby požadavku, nebo
je aktuálním řešitelem požadavku.
Parametr | ;
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
message |
string |
Zpráva žadateli požadavku |
Ne |
void SendNews(...)
Odešle aktuální zprávu nastaveným příjemcům.
Parametr |
Datový typ |
Popis |
Povinný |
newsId |
int |
Identifikační číslo zprávy, která se má odeslat. |
Ano |
sendToRequesters |
bool |
Odeslat zprávu žadatelům přiřazených služeb |
Ano |
sendToSectionTeam |
bool |
Odeslat zprávu členům řešitelského týmu přiřazených služeb |
Ano |
specificRecipients |
string |
Specifičtí příjemci zprávy. Pokud zpráva žádné specifické
příjemce nemá, zadejte prázdný řetězec nebo hodnotu null. |
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
personId |
int |
Identifikační číslo osoby, měnící stav požadavku. Pokud je
zadána hodnota 0, akci provádí -system. Pokud je operace spuštěna z
externí aplikace, tento parametr je ignorován a stav požadavku je
změněn pod uživatelem, který je do webové služby integrovaně
přihlášen. |
Ne |
newStateId |
int |
Identifikační číslo nového stavu požadavku |
Ano |
Při zavolání metody se provedou následující kroky:
- 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.
Parametr |
Datový typ |
Popis |
Povinný |
sessionId |
GUID |
Identifikátor session, který vrátila funkce BeginUpload. |
Ano |
partSequenceNumber |
int |
Pořadové číslo části souboru |
Ano |
data |
byte[] |
Binární data souboru |
Ano |
dataLen |
int |
Velikost načítané části souboru v bajtech |
Ano |
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“.
Parametr |
Datový typ |
Popis |
Povinný |
recordId |
int |
Identifikační číslo záznamu (tHdTicket
nebo
tPerson) |
Ano |
table |
string |
Název tabulky pro zápis. Podporované hodnoty jsou:
tHdTicket,
tHdTicketCust,
tPerson,
tPersonCust a
tRole. |
Ano |
column |
string |
Název sloupce tabulky.
Lze zapisovat do všech sloupců z tabulky
tHdTicketCust a
tPersonCust.
V tabulce
tHdTicket lze zapisovat hodnoty do těchto sloupců:
- mHdTicketNotice
- sHdTicketGroup
- sHdTicketDeviceCode
- sHdTicketUserPhone
- mHdTicketUserContact
- sHdTicketUserMobile
- sHdTicketUserOffice
- sHdTicketUserDepartment
- sHdTicketUserWorkPosition
- sHdTicketUserCompany
V tabulce
tPerson lze zapisovat hodnoty do těchto sloupců:
- sPerson
- sPersonLogin
- sPersonAdGuid
- sPersonEmail
- sPersonPhone
- sPersonMobile
- sPersonOffice
- sPersonDepartment
- sPersonWorkPosition
- bHidden
- sPersonPswd
- bPersonShared
- bPersonAccountDisabled
- mPersonContact
- sPersonCalendarWebDAVUri
- sPersonUrgentEmail
- dPersonRemoved
- sPersonCountry
- sPersonCountryAbbr
- iPersonCountryCode
- sPersonCity
- sPersonAdPath
- dPersonAdCreated
- sPersonSID
- liPersonManagerPersonId
- sPersonPersonalNumber
- liPersonDelegatePersonId
- OutOfOfficeSince
- iPersonLocaleId
- sPersonAdName
- liAccountId
- sFirstName
- sLastName
- sAdDisplayName
- TimeZone
- Email2
- Phone2
- OutOfOfficeUntil
- ImportAdLastFound
- SamAccountName
V tabulce
tRole lze zapisovat hodnoty do těchto sloupců:
- sRole
- sRoleAdGuid
- dRoleCreated
- sDesc
- AdDistributionGroup
- AdPath
- DistributionEmail
- LastImport
- AdCreated
Více informací o sloupcích (včetně datových typů) najdete v
dokumentaci databáze Alvao.
|
Ano |
value |
string |
Hodnota vložená do sloupce | Ano |
Oznámení
void NotifyOnChildOrBlocksResolvedTicket(...)
Pošle oznámení řešiteli (případně hlavním řešitelům služby, pokud požadavek nemá přiděleného řešitele) a také sledujícím z nadřazeného/blokovaného požadavku o vyřešení podřazeného/blokujícího požadavku.
V těle zprávy je uveden tag a název požadavku podřazeného/blokujícího požadavku a informace o zbývajícím počtu podřazených/blokujících požadavků, které brání ve vyřešení nadřezeného/blokonaného požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
resolvedTicketId |
int |
Číslo vyřešeného požadavku. |
Ano |
void NotifyOnHdTicketAccepted(...)
Pošle oznámení s informací, že požadavek byl schválen.
Parametr |
Datový typ |
Popis |
Povinný |
ticketApprovalItemId |
int |
Číslo schvalovacího kroku, který byl schválen (tHdTicketApprovalItem.iHdTicketApprovalItemId). |
Ano |
void
NotifyOnHdTicketApprovalCanceled(...)
Pošle oznámení s informací, že schvalování požadavku bylo zrušeno.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Číslo požadavku |
Ano |
void NotifyOnHdTicketApprovalItem(...)
Pošle oznámení s informací, že osoba má schválit požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
ticketApprovalItemId |
int |
Číslo schvalovacího kroku (tHdTicketApprovalItem.iHdTicketApprovalItemId) |
Ano |
personId |
int |
Identifikátor osoby (tPerson) |
Ano |
void
NotifyOnHdTicketApprovalItemFinished(...)
Pošle schvalovatelům oznámení o ukončení daného schvalovacího kroku.
Parametr |
Datový typ |
Popis |
Povinný |
ticketApprovalItemId |
int |
Číslo schvalovacího kroku (tHdTicketApprovalItem.iHdTicketApprovalItemId) |
Ano |
void NotifyOnHdTicketCreated(...)
Pošle řešitelům (případně i žadateli) požadavku oznámení s
informací, že požadavek byl založen.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
První událost požadavku |
Ano |
notifyUser |
bool |
Odeslat oznámení žadateli |
Ano |
void
NotifyOnHdTicketDeadlineChanged(...)
Pošle žadateli požadavku oznámení s informací, že u požadavku byl nastaven /
změněn / zrušen termín.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události změny termínu |
Ano |
oldDeadline |
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 |
newDeadline |
datetime |
Nový termín požadavku, pokud je hodnota datumu menší než
1.1.0001, termín bude zrušen. |
Ano |
message |
string |
Zpráva - důvod změny termínu |
Ne |
htmlMessage |
string |
Zpráva v HTML - důvod změny termínu |
Ne |
void NotifyOnHdTicketExpired(...)
Pošle oznámení s informací, že schvalování požadavku vypršelo.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Číslo požadavku |
Ano |
void
NotifyOnHdTicketHdSectionChanged(...)
Pošle žadateli požadavku řešiteli s informací, že požadavek byl přesunut do
jiné služby.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události přesunu do jiné služby |
Ano |
oldHdSectionId |
int |
Identifikátor původní služby, služba musí existovat. |
Ano |
newHdSectionId |
int |
Identifikátor nové služby, služba musí existovat. |
Ano |
message |
string |
Zpráva řešitelům |
Ne |
htmlMessage |
string |
Zpráva řešitelům v HTML |
Ne |
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.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události předání řešiteli |
Ano |
oldSolverPersonId |
int |
Identifikátor osoby původního řešitele, pokud je 0, požadavek
neměl řešitele. |
Ano |
newSolverPersonId |
int |
Identifikátor osoby nového řešitele, pokud je 0, požadavek byl
vrácen hlavním řešitelům. |
Ano |
message |
string |
Zpráva řešitelům |
Ne |
htmlMessage |
string |
Zpráva řešitelům v HTML |
Ne |
void NotifyOnHdTicketRejected(...)
Pošle oznámení s informací, že požadavek byl zamítnut.
Parametr |
Datový typ |
Popis |
Povinný |
ticketApprovalItemId |
int |
Číslo schvalovacího kroku, který byl zamítnut (tHdTicketApprovalItem.iHdTicketApprovalItemId). |
Ano |
void NotifyOnHdTicketResolved(...)
Pošle žadateli požadavku oznámení s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události, která vyřešila požadavek. |
Ano |
message |
string |
Zpráva žadateli |
Ne |
htmlMessage |
string |
Zpráva žadateli v HTML |
Ne |
void NotifyOnHdTicketSolverOpen(...)
Pošle žadateli požadavku oznámení s informací, že řešitel znovu otevřel
požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události otevření požadavku |
Ano |
message |
string |
Zpráva - důvod otevření požadavku |
Ne |
htmlMessage |
string |
Zpráva v HTML - důvod otevření požadavku |
Ne |
void NotifyOnHdTicketUserOpen(...)
Pošle řešiteli požadavku oznámení s informací, že
žadatel znovu otevřel požadavek.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události otevření požadavku |
Ano |
message |
string |
Zpráva - důvod otevření požadavku |
Ne |
htmlMessage |
string |
Zpráva v HTML - důvod otevření požadavku |
Ne |
sendToSubscribers |
bool |
Odeslat zprávu odběratelům požadavku |
Ne |
void NotifyOnMessageSent(...)
Pošle řešitelům / odběratelům oznámení s informací, že byla přijata nová
zpráva k požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Identifikační číslo události zprávy |
Ano |
sendNewMessageNotification |
int |
Hodnota určuje, komu se zpráva odešle:
-1 - oznámení se odešle pouze žadateli.
-2 - vynutí se odeslání oznámení řešitelům
(hlavním řešitelům).
-0 - odešle se standardní oznámení o nové zprávě. |
Ano |
void NotifyOnReplyReceived(...)
Pošle uživateli oznámení o přijetí odpovědi na zprávu, kterou uživatel dříve odeslal z SD.
Parametr |
Datový typ |
Popis |
Povinný |
originalActId |
int |
Původní zpráva odeslaná z SD (tAct.iActId) |
Ano |
replyActId |
int |
Odpověď na původní zprávu (tAct.iActId) |
Ano |
void
NotifySubscribersOnHdTicketDeadlineChanged(...)
Pošle odběratelům oznámení s informací, že u požadavku byl nastaven / změněn
/ zrušen termín.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události změny termínu |
Ano |
newDeadline |
datetime |
Nový termín požadavku, pokud je hodnota data menší než 1.1.0001,
termín bude zrušen. |
Ano |
message |
string |
Zpráva - důvod změny termínu |
Ne |
htmlMessage |
string |
Zpráva v HTML - důvod změny termínu |
Ne |
void
NotifySubscribersOnHdTicketOpen(...)
Pošle odběratelům oznámení s informací, že požadavek byl znovu otevřen.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události otevření požadavku |
Ano |
message |
string |
Zpráva - důvod otevření požadavku |
Ne |
htmlMessage |
string |
Zpráva v HTML - důvod otevření požadavku |
Ne |
void
NotifySubscribersOnHdTicketResolved(...)
Pošle odběratelům oznámení s informací, že požadavek byl vyřešen.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události, která vyřešila požadavek. |
Ano |
message |
string |
Zpráva žadateli |
Ne |
htmlMessage |
string |
Zpráva žadateli v HTML |
Ne |
void
NotifySubscribersOnMessageSent(...)
Pošle odběratelům oznámení s informací, že byla přijata nová zpráva k
požadavku.
Parametr |
Datový typ |
Popis |
Povinný |
actId |
int |
Číslo události zprávy |
Ano |
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.
Parametr |
Datový typ |
Popis |
Povinný |
hdSectionId |
int |
Identifikátor služby |
Ano |
fromName |
string |
Jméno a příjmení odesílatele zprávy |
Ne |
fromEmail |
string |
Email odesílatele zprávy |
Ne |
mailTo |
string |
Email příjemce zprávy (původní odesílatel zprávy) |
Ne |
mailSent |
string |
Datum původní zprávy |
Ne |
mailMessageId |
string |
Identifikátor zprávy |
Ne |
mailSubject |
string |
Předmět původní zprávy |
Ne |
mailBody |
string |
Text původní zprávy |
Ne |
void NotifyUserOnOpenRejected(...)
Pošle žadateli oznámení s informací, že znovu otevření požadavku bylo
zamítnuto.
Parametr |
Datový typ |
Popis |
Povinný |
ticketId |
int |
Identifikační číslo požadavku |
Ano |
hdSectionId |
int |
Identifikátor služby |
Ano |
fromName |
string |
Jméno a příjmení odesílatele zprávy |
Ne |
fromEmail |
string |
Email odesílatele zprávy |
Ano |
mailTo |
string |
Email příjemce zprávy (původní odesílatel zprávy) |
Ne |
mailCc |
string |
CC (CarbonCopy, kopie) původní zprávy |
Ne |
mailSent |
string |
Datum původní zprávy |
Ne |
mailMessageId |
string |
Identifikátor zprávy |
Ne |
mailSubject |
string |
Předmět původní zprávy |
Ne |
mailBody |
string |
Text původní zprávy |
Ne |
ticketMark |
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 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.
Parametr |
Datový typ |
Popis |
Povinný |
nAlertId |
int |
Číslo pravidla pro odeslání oznámení, 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ý |
nAlertId |
int |
Číslo pravidla pro odeslání oznámení, které je nastaveno na
SLA. |
Ano |
Nenašli jste co jste hledali? Zeptejte se našeho týmu technické podpory.