Kaseya 2. Gebruikershandleiding. Versie 6,0

Kaseya 2

VSA API Web Service Gebruikershandleiding Versie 6,0

June 11, 2010

About Kaseya Kaseya is a global provider of IT automation software for IT Solution Providers and Public and Private Sector IT organizations. Kaseya's IT Automation Framework allows IT Professionals to proactively monitor, manage and maintain distributed IT infrastructure remotely, easily and efficiently with one integrated Web based platform. Kaseya's technology is licensed on over three million machines worldwide.

Copyright © 2000-2009 Kaseya International Limited. All Rights Reserved.

Contents VSA API Web Service

5

VSA API Web Service - overzicht ................................................................................................................. 7 De VSA API Web Service activeren .................................................................................................... 8 Speciale velden ................................................................................................................................... 8 VSA API Web Service Sample Client - C# GUI applicatie .................................................................. 9 VSA API Web Service voorbeeldclient - ASP-pagina ....................................................................... 10 VSA API-webservice beveiliging ....................................................................................................... 13 Webkoppelingen - inkomend en uitgaand ......................................................................................... 15 VSA API Web Service - handelingen .......................................................................................................... 17 AddMachGrouptoScope .................................................................................................................... 17 AddOrg .............................................................................................................................................. 17 AddOrgDeptStaff ............................................................................................................................... 17 AddOrgToScope................................................................................................................................ 17 AddScope .......................................................................................................................................... 18 AddScopeOrg .................................................................................................................................... 18 AddTicRequest .................................................................................................................................. 18 AddUserToRole ................................................................................................................................. 18 AddUserToScope .............................................................................................................................. 19 AdminGroupAccess........................................................................................................................... 19 AssignRole ........................................................................................................................................ 19 AssignScope ..................................................................................................................................... 19 Authenticate ...................................................................................................................................... 20 CloseAlarm ........................................................................................................................................ 20 CreateAdmin ..................................................................................................................................... 20 CreateAgentInstallPackage ............................................................................................................... 21 CreateMachineGroup ........................................................................................................................ 21 CreateRole ........................................................................................................................................ 21 DeleteAdmin ...................................................................................................................................... 21 DeleteAgent ....................................................................................................................................... 21 DeleteAgentInstallPackage ............................................................................................................... 22 DeleteMachineGroup ........................................................................................................................ 22 DeleteOrg .......................................................................................................................................... 22 DeleteRole ......................................................................................................................................... 22 DeleteScope ...................................................................................................................................... 23 DisableAdmin .................................................................................................................................... 23 Echo .................................................................................................................................................. 23 EchoMt .............................................................................................................................................. 23 EnableAdmin ..................................................................................................................................... 23 GetAlarm ........................................................................................................................................... 24 GetAlarmList...................................................................................................................................... 25 GetGroupLicenseInfo ........................................................................................................................ 25 GetLogEntry ...................................................................................................................................... 26 GetMachine ....................................................................................................................................... 26 GetMachineCollectionList ................................................................................................................. 29 GetMachineGroupList ....................................................................................................................... 29 GetMachineList ................................................................................................................................. 30 GetMachineUptime............................................................................................................................ 30 GetNotesList ...................................................................................................................................... 31 GetOrgLocation ................................................................................................................................. 31 GetOrgs ............................................................................................................................................. 31 i

GetOrgsByScopeID ........................................................................................................................... 32 GetOrgTypes ..................................................................................................................................... 32 GetPackageURLs .............................................................................................................................. 32 GetPartnerUserLocation ................................................................................................................... 33 GetPublishedViewColumns ............................................................................................................... 33 GetPublishedViewRows .................................................................................................................... 33 GetPublishedViews ........................................................................................................................... 34 GetRoles ........................................................................................................................................... 34 GetScopes ......................................................................................................................................... 34 GetTicket ........................................................................................................................................... 35 GetTicketList ..................................................................................................................................... 35 GetTicketNotes .................................................................................................................................. 36 GetTicRequestTicket ......................................................................................................................... 36 GetVerboseMachineGroupList .......................................................................................................... 36 LockFunctionAccess ......................................................................................................................... 37 Primitieven ......................................................................................................................................... 37 RemoveUserFromRole...................................................................................................................... 38 ResetPassword ................................................................................................................................. 38 RoleMembership ............................................................................................................................... 39 SendAdminMessage ......................................................................................................................... 39 SetAdminPassword ........................................................................................................................... 39 SetGroupLicenseInfo......................................................................................................................... 39 SetPartnerUserLocation .................................................................................................................... 40 UpdateOrg ......................................................................................................................................... 40 UpdateTicket ..................................................................................................................................... 40 UpdateUser ....................................................................................................................................... 42

KSD API Web Service

43

KSD API Web Service inschakelen ............................................................................................................. 43 KSD API Webservice gegevenstypes ......................................................................................................... 43 RefItem .............................................................................................................................................. 44 CustomField ...................................................................................................................................... 44 Note ................................................................................................................................................... 44 Attachment ........................................................................................................................................ 44 RelatedIncident ................................................................................................................................. 45 ServiceDeskDefinition ....................................................................................................................... 45 Incidentenoverzicht ........................................................................................................................... 47 Incident .............................................................................................................................................. 48 KSD API Web Service - handelingen .......................................................................................................... 50 AddIncident ....................................................................................................................................... 50 AddServDeskToScope ...................................................................................................................... 50 GetIncident ........................................................................................................................................ 50 GetIncidentList .................................................................................................................................. 51 GetServiceDesk ................................................................................................................................ 52 GetServiceDesks............................................................................................................................... 52 Primitieven ......................................................................................................................................... 52 UpdateIncident .................................................................................................................................. 53 Voorbeeldberichten ..................................................................................................................................... 53 GetServiceDesks Request ................................................................................................................ 53 GetServiceDesks Response ............................................................................................................. 53 GetServiceDesk Request .................................................................................................................. 54 GetServiceDesk Response ............................................................................................................... 54 GetIncidentList Request .................................................................................................................... 61 GetIncidentList Response ................................................................................................................. 61 GetIncident Request.......................................................................................................................... 61 ii

GetIncident Response ....................................................................................................................... 61 AddIncident Request ......................................................................................................................... 63 AddIncident Response ...................................................................................................................... 63 UpdateIncident Request .................................................................................................................... 64 UpdateIncident Response ................................................................................................................. 65

iii

Hoofdstuk 1

VSA API Web Service In dit hoofdstuk VSA API Web Service - overzicht VSA API Web Service - handelingen

7 17

5

VSA API Web Service

VSA API Web Service - overzicht De VSA API Web Service biedt een client een algemene interface voor een programmatische interface met de VSA. Door deze API kan een client contact maken met een pakket van derden. De API is gericht op de volgende diensten:  Verbinden: Deze dienst stelt de gebruiker van de API in staat om zich te authenticeren en een GUID te ontvangen die tijdens de communicatie gebruikt wordt. Deze GUID veroudert op dezelfde manier als gebruikers.  Tickets: deze dienst levert basisfaciliteiten zodat de gebruiker op de hoogte blijft van nieuwe tickets. Hierdoor kunnen gebruikers velden in een ticket bijwerken.  Alarms: deze dienst biedt basismogelijkheden waamee de gebruiker op de hoogte blijft van nieuwe alarms en om een alarm als gesloten te markeren.  Computers: deze dienst zorgt voor een aanvraag om een reeks gegevens over een of meer computers te verzamelen. De VSA API Web Service is gebaseerd op de Web Services Description Language (WSDL). De WSDL wordt weergegeven in een browser en zorgt voor een abstracte beschrijving van de gegevens die worden uitgewisseld met een web service. Een client-programma dat verbinding maakt met een web service kan de WSDL lezen om te bepalen welke functies beschikbaar zijn op de server. Alle gebruikte speciale gegevenstypen zijn ingesloten in het WSDL-bestand in de vorm van een XML Schema. Daarna kan de client SOAP gebruiken om een van de in de WSDL genoemde functies aan te roepen. Dit is een voorbeeld van de uitvoer van vsaWS:

7

VSA API Web Service

De VSA API Web Service activeren Zo activeert u de VSA API Web Service:  De pagina Systeem > Configureren in de VSA weergeven.  Klik in het keuzevakje VSA API Web Service activeren.  Neem toegang tot de VSA API webservice met http:///vsaWS/KaseyaWS.asmx Opmerking: De KSD API Webservice beschrijft bijkomende Servicedesk API-handelingen.

Speciale velden De volgende velden worden opgenomen in het antwoord op elke aanvraag. Method

string

De handeling die dit antwoord heeft aangevraagd.

TransactionID

decimal

Het unieke bericht-ID voor dit bericht.

ErrorMessage

string

Als dit leeg is, is geen fout teruggegeven.

ErrorLocation

string


Een Sessie-ID is door de webservice gemaakt en aan de client teruggegeven de eerste keer dat de client een methode aanroept. Hetzelfde sessie-ID moet door de client worden teruggegeven met elke methode die tijdens de sessie wordt aangeroepen. Het sessie-ID is alleen geldig als het is ontvangen van hetzelfde IP-adres waarvan de authenticatie afkomstig is.

8

VSA API Web Service

VSA API Web Service Sample Client - C# GUI applicatie Een GUI-testclient en een reeks test-XML's worden meegeleverd met de VSA API Web Service om u bekend te maken met de verschillende API-handelingen. De broncode in C# voor de VSA API Web Service Voorbeeldclient wordt u zonder verdere beperkingen aangeboden. U kunt deze gebruiken om te zien hoe de client is opgebouwd en u kunt elk deel van de code in uw eigen toepassing opnemen. Opmerking: Ook een ASP-pagina tekstclient (pagina 10) wordt meegeleverd.

Zo voert u de voorbeeldclient uit: 1. Voer de voorbeeldclient uit die op de KServer staat: \vsaWs\TestClient\KaseyaWStestClient.exe 2. Typ de Gebruikersnaam en het Wachtwoord voor een gebruiker die gerechtigd is om verbinding te maken met de KServer. Opmerking: Dit is dezelfde gebruikersnaam en wachtwoord die een beheerder gebruikt om zich bij de KServer aan te melden.

3. Klik op de knop Aanmelden om een waarde n het veld Sessie-ID weer te geven. 4. Klik op de knop Bladeren om een test-XML-bestand te kiezen. Dit vult het tekstvak SendXML met de tekst van het XML-bestand. Opmerking: U hoeft geen waarde in te voeren tussen de tags <SessionID> van het test-XML-bestand. De Voorbeeldclient plaatst automatisch het getoonde Sessie-ID in een XML-bericht als u op de knop Verzenden klikt.

5. Klik op de knop Verzenden om het XML-bericht naar de doel-URL te verzenden. Een antwoord-XML-bericht verschijnt in het tekstvak ResponseXML.

9

VSA API Web Service

VSA API Web Service voorbeeldclient ASP-pagina Een testclient ASP-pagina wordt eveneens meegeleverd met de VSA API Web Service om u bekend te maken met de verschillende API-handelingen. U kunt deze gebruiken om te zien hoe de ASP-client is opgebouwd en u kunt elk deel van de code in uw eigen toepassing opnemen. Gebruikers kunnen naar de eigenlijke /vsaWS/KaseyaWS.asmx -pagina van een willekeurig Kserver gaan, een webmethode selecteren de juiste XML SOAP aanvraagstructuur kopiëren en plakken die in de WSDL wordt aangegeven. Authenticatie wordt in een eigen frame bovenaan de pagina uitgevoerd. Het sessie-ID van een geslaagde authenticatie wordt getoond; u kunt deze kopiëren en in volgende XML-aanvragen plakken. Opmerking: Deze pagina bevat niet automatisch de getoonde sessie-ID in volgende aanvraagopdrachten zoals de C# GUI Testclient (pagina 9) dat doet.

Voorbeeld 1: Authenticatie 1. Neem toegang tot de VSA API webservice asp-testclient met http:///vsaWS/TestClient/TestClient.asp 2. Typ een geldige Gebruikersnaam en Wachtwoord in van een VSA beheerder en klik op Aanmelden.

Het tekstvak Sessie-ID wordt gevuld met het sessie-ID dat door uw aanmelden is gegenereerd. U moet dit sessie-ID te kopiëren en in volgende XML-aanvragen plakken.

10

VSA API Web Service

Voorbeeld 2 - een Verzoek krijgen maken 1. Gebruik in een tweede browservenster de pagina /vsaWS/KaseyaWS.asmx om een methode te selecteren, zoals GetLogEntry.

2. Elke methode laat de XML SOAP-structuur voor de aanvraag van die methode zien. Kopieer alle het deel van de verzoekstructuur van de methode die met <req> begint en met eindigt.

11

VSA API Web Service

1. Plak de verzoekstructuur in het venster Verzoeken van de pagina TestClient.asp. Voer de naam van de methode in het veld Naam webmethode in. Vervang de plaatsvervanger decimaal met de tekenreeks sessie-ID die u tijdens de authenticatie hebt verkregen. Vervang de inhoud van andere plaatsvervangers naar vereiste met geldige gegevens. Klik vervolgens op de knop Verzenden. Opmerking: Het element in een methode kunt u negeren. Het element helpt bij de coördinatie van eenmaal aanmelden bij de VSA en mag in een testomgeving waarin eenmalig aanmelden niet het doel is, worden genegeerd.

Het resultaat wordt in het venster Antwoord weergegeven.

12

VSA API Web Service

VSA API-webservice beveiliging Algemeen De VSA API Web Service is standaard bereikbaar vanaf elk IP-adres ter wereld met elke geldige VSA-referentie. In deze standaardconfiguratie worden geldige combinaties van gebruikersnaam en wachtwoord vanaf elke computer voor verificatie beoordeeld. In elke configuratie moet de hash.dll die door de VSA is geleverd, worden gebruikt om het wachtwoord voor aanbieding te versleutelen. Implementatiegegevens voor de hash.dll zijn te vinden in het meegeleverde voorbeeld van het bronbestand. Nadat een geslaagde aanvraag voor verificatie een sessie-ID heeft afgegeven, moet dit sessie-ID worden aangeboden bij elke aanroep van de service en is deze alleen geldig als hij is ontvangen vanaf het IP-adres waarvoor het is afgegeven. Na een periode van inactiviteit verloopt het afgegeven sessie-ID. U kunt de beveiliging verbeteren door een AccesRules.xml-bestand te maken en gebruiken. Dit bestand wordt gebruikt door de VSA API Web Service om toegangsregels te definiëren aan de hand van de IP-adressen die aanvragen indienen. IP-filteren is een mechanisme dat gewoonlijk wordt gebruikt tussen zakelijke systemen om te garanderen dat alleen aanvragen worden gehonoreerd die afkomstig zijn van de servers van partners. Het bestand AccesRules.xml is in drie secties verdeeld:  Standaard toegangsregels  IP-bereiken  Gebruikerstoewijzing Opmerking: 127.0.0.1 (localhost) is altijd toegankelijk voor elke account, ongeacht de configuratie.

XML-structuur <UserMapping> <User UserName="" RangeID="" GrantAllRanges="" GrantAnyIP="" DenyAccess=""/> <User UserName="" RangeID="" GrantAllRanges="" GrantAnyIP="" DenyAccess=""/>

Standaard toegangsregels De elementen in deze sectie bepalen de toegangsregels voor de accounts die niet specifiek zijn genoemd in het deel Gebruikerstoewijzing. waar/onwaar

waar: Iedere gebruiker die niet is opgenomen in UserMapping krijgt toegang vanaf elk IP-adres. waar/onwaar

waar: Iedere gebruiker die niet is opgenomen in UserMapping krijgt toegang vanaf elk IP-adres dat is opgenomen in IPRanges. waar/onwaar

waar: Iedere gebruiker die niet is opgenomen in UserMapping wordt de toegang geweigerd.

13

VSA API Web Service

IP-bereiken Deze sectie wordt gebruikt voor het definiëren van specifieke computers, of reeksen computers, op IP-adres, die gebruikt worden om gebruikers toegang te verlenen. RangeID="integer"

Een willekeurig door de gebruiker ingesteld geheel getal, gebruikt ter verwijzing naar het bereik in UserMapping. FromIPAddress="string"

Het eerste IP-adres. De eerste drie posities van de vier getallen moeten overeenkomen met ToIPAddress. ToIPAddress=" string"

Het laatste IP-adres. De eerste drie posities van de vier getallen moeten overeenkomen met FromIPAddress. RangeDescription=" string"

Beschrijving van het IP-bereik. Bijvoorbeeld: "Productieservers"

Gebruikerstoewijzing UserName="string"

De naam van de VSA Admin. De VSA API Web Service gebruikt dezelfde referenties en wachtwoordversleuteling als VSA. Als u uw wachtwoord dus in VSA wijzigt, moet u het ook wijzigen in uw implementatie van de VSA API Web Service client. RangeID="integer"

Verwijst naar een gedefinieerd IP-bereik in de sectie IP Ranges. Een gebruiker kan meerdere UserMapping-elementen hebben voor alle IP-bereiken vanwaar hij toegang heeft. Niet gebruikt als een van de onderstaande attributen Toekennen/Weigeren worden gebruikt. GrantAllRanges="waar/onwaar"

waar: Gebruiker heeft toegang vanaf elk bereik gedefinieerd in de sectie IP Ranges. GrantAnyIP=" waar/onwaar"

waar: Gebruiker heeft toegang vanaf elk IP-adres. DenyAccess=" waar/onwaar"

waar: Gebruiker heeft geen toegang.

XML-bestand voorbeeld toegangsconfiguratie onwaar onwaar waar <UserMapping> <User UserName="B2BMasterAdmin" RangeID="1" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="false"/> <User UserName="DevTestAccount" RangeID="2" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="false"/> <User UserName="SalesTestAccount" RangeID="3" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="false"/>

14

VSA API Web Service <User UserName="SalesTestAccount2" RangeID="3" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="false"/> <User UserName="QAMasterAdmin" RangeID="4" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="false"/> <User UserName="SalesTravellingTestAccount" RangeID="" GrantAllRanges="false" GrantAnyIP="true" DenyAccess="false"/> <User UserName="Bob" RangeID="" GrantAllRanges="true" GrantAnyIP="false" DenyAccess="false"/> <User UserName="Sally" RangeID="" GrantAllRanges="false" GrantAnyIP="false" DenyAccess="true"/>

Webkoppelingen - inkomend en uitgaand Naast de API-handelingen die verderop in dit document worden beschreven, ondersteunt de KServer ook de volgende inkomende en uitgaande koppelingen:

Inkomen De volgende URL geeft de webpagina Computeroverzicht voor een specifieke computer-ID weer: http//....?machName=<MachineID> Bijvoorbeeld: http://demo.kaseya.com?machName=jconners.acme

15

VSA API Web Service De volgende URL geeft de webpagina Ticket voor een specifiek ticket-ID weer: http://...?ticid=<TicketID> Bijvoorbeeld: http://demo.kaseya.com?ticid=1234

Uitgaand Om de koppeling Nieuwe ticket op de pagina Computeroverzicht aan te passen, vult u het bestand externalLink.xml in als beschreven in de het gedeelte opmerkingen van onderstaande XML. Plaats om de nieuwe koppeling te actieveren het bestand externalLink.xml in de map \WebPages\install\ van uw KServer. <externalLinks>

16

VSA API Web Service

VSA API Web Service handelingen De volgende handelingen kunnen met de VSA API Web Service worden verricht:

AddMachGrouptoScope Voegt een computer op GroepsNaam toe aan BereikNaam. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddOrg Voegt een organisatie toe. Een enkel record wordt teruggeven van de volgende velden. orgOutId

decimal

Het organisatie-ID van de nieuw toegevoegde organisatie.

orgOutRef

string

De fully qualified name van de organisatie. Gebruik de puntnotatie als een hoger- of lagerliggende organisatie bestaat. Voorbeelden:

 nieuworgnaam  hogerorgnaam.nieuworgnaam  hogerorgnaam.lagerorgnaam.nieuworgnaam Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddOrgDeptStaff Voegt een personeelslid toe aan de afdeling van een organisatie. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddOrgToScope Voegt een organisatie toe aan een bereik. 17

VSA API Web Service Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddScope Voegt een scope toe. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddScopeOrg Voegt in één keer een organisatie en een bereik toe en koppelt de organisatie aan het bereik. Een enkel record wordt teruggeven van de volgende velden. orgOutRef

string

De fully qualified name van de organisatie. Gebruik de puntnotatie als een hoger- of lagerliggende organisatie bestaat. Voorbeelden:

 nieuworgnaam  hogerorgnaam.nieuworgnaam  hogerorgnaam.lagerorgnaam.nieuworgnaam Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddTicRequest Voegt een voorlopige ticketaanvraag toe. Een enkel record wordt teruggeven van de volgende velden. newId

string

Unieke aanduiding.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddUserToRole Voeg een gebruiker toe aan een gebruikersrol. 18


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AddUserToScope Voeg een gebruiker toe aan een bereik. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AdminGroupAccess Wijst een computergroep toe aan een gebruikersrol. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AssignRole Voegt een gebruiker toe aan een gebruikersrol of verwijdert deze. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


AssignScope Voegt een gebruiker toe aan een bereik of verwijdert deze. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


19

VSA API Web Service

Authenticate Vereist om de VSA API Web Service sessie te starten. Het teruggegeven sessie-ID moet worden aangeboden met elke methode die tijdens de sessie wordt aangeroepen. Het sessie-ID is alleen geldig als het is ontvangen van dezelfde computer waarvan de verificatie afkomstig is. Een enkel record wordt teruggeven van de volgende velden. SessionID

decimal

Het unieke sessie-ID toegewezen aan de verbinding van een gebruiker met de doel-URL.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Automatische aanmelding tijdens verificatie Als u via de API verifieert, wordt u automatisch ook bij VSA aangemeld. Als u tijdens de verificatie al bij VSA bent aangemeld, worden de twee sessies gesynchroniseerd. Het resultaat is in beide gevallen hetzelfde: u krijgt in beide omgevingen een geldige sessie. De VSA zoekt naar het 26-cijferige sessie-ID van de API in de zoekstring van elke VSA-pagina. Als de ontwikkelaar van de toepassing dus een omleiding nodig heeft naar een VSA-pagina, kan hij nu rechtsreeks naar een pagina gaan zonder de gebruiker te dwingen zich opnieuw aan te melden. De syntaxis is: URL?apiLogonGuid=12345678901234567890123456

Bijvoorbeeld: http://someServer:123/Systemtab/SomePage?apiLogonGuid=12345678901234567890123456&SomeVar=Some Value

Activiteit van de API houdt de VSA-sessie levend. Maar omdat VSA er niet van uitgaat dat er altijd behoefte is aan een API-sessie, houdt VSA-activiteit de API-sessie niet levend. De API gebruikt dezelfde timeout-waarde alsde VSA, die wordt bijgehouden met de pagina Systeem > Aanmeldingsbeleid van de VSA en waarvan de standaardwaarde 30 minuten is.

CloseAlarm Sluit het alarm voor het aangeboden MonitorAlarmID. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


CreateAdmin Maakt een VSA-gebruiker. Het wachtwoord moet gehashed zijn. Een enkel record wordt teruggeven van de volgende velden.

20

Method

string


TransactionID

decimal


ErrorMessage

string


VSA API Web Service ErrorLocation

string


CreateAgentInstallPackage Maakt een agent-installatiepakket. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


CreateMachineGroup Maakt een computergroep. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


CreateRole Maakt een gebruikersrol. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteAdmin Verwijdert de opgegeven gebruiker. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteAgent Verwijdert de agent op de doelcomputer en het bijbehorende computer-ID account op de VSA. 21


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteAgentInstallPackage Verwijdert een agent-installatiepakket. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteMachineGroup Verwijdert de opgegeven computergroep. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteOrg Verwijdert de opgegeven organisatie. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DeleteRole Verwijdert de opgegeven rol. Een enkel record wordt teruggeven van de volgende velden.

22

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


VSA API Web Service

DeleteScope Verwijdert het opgegeven bereik. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


DisableAdmin Schakelt een opgegeven gebruiker uit. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Echo Testmethode voor verbindingstests en benchmarking. Hiervoor is verificatie niet vereist. Geeft de aangeboden tekenreeks terug. Een enkel record wordt teruggeven van het volgende veld. EchoResult

string

Deze waarde moet overeenkomen met de invoer die in de aanvraag is opgenomen.

EchoMt Testmethode voor verbindingstest en benchmarking in de middenlaag. Verificatie vereist. Geeft de aangeboden tekenreeks terug. Geeft de aangeboden belastingreeks terug (echo). Een enkel record wordt teruggeven van de volgende velden. Payload

string

De tekenreeks die met de aanvraag wordt meegezonden.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


EnableAdmin Schakelt een opgegeven gebruiker in. Een enkel record wordt teruggeven van de volgende velden.

23

VSA API Web Service Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetAlarm Geeft alarmgegevens terug voor het aangeboden MonitorAlarmID. Een enkel record wordt teruggeven van de volgende velden. Machine_GroupID

string

Een samengevoegde representatie van computer-ID en de bijbehorende groeps-ID.

agentGuid

decimal

Een globaal unieke aanduiding voor een computer-ID groeps-ID account en de bijbehorende agent.

MachineName

string

Computernaam die voor elke agent wordt gebruikt

GroupName

string

Groepsnaam die voor elke agent wordt gebruikt

MonitorAlarmID

int

uniek nummer voor controlealarm

MonitorType

int

0 - Teller 1 - Dienst 2 - Proces 3 - SNMP 4 - Waarschuwing - Waarschuwingen zijn verder onderverdeeld in waarschuwingstypes. 5 - Systeemcontroles 6 - EPS 7 - Logboekcontrole

AlarmType

string

0 -> Alarm 1 -> Trending

Message

string

Bericht gemaakt van alarm, hoofdtekst e-mail

AlarmSubject

string

Onderwerp van alarm en e-mail

AlarmEmail

string

E-mail adres(sen) waarheen alarm wordt gezonden

EventTime

string

Datum en tijd van alarm

TicketID

int

Ticket-ID dat van alarm is gemaakt

AdminName

string

Gebruiker die controleteller aan computer heeft toegewezen

MonitorName

string

Naam van controle SNMP Get-object

LogType

24

1 -> Toepassingenlogboek 2 -> Beveiligingslogboek 3 -> Systeemlogboek

EventType

int

1 -> Fout 2 -> Waarschuwing 4 -> Informatief 8 -> Audit geslaagd 16 -> Audit mislukt

LogValue

decimal

Waarde die alarm heeft veroorzaakt, als de teruggegeven waarde van de SNMP Object Get-opdracht een tekenreeks is, is de waarde het bericht.

SNMPName

string

Naam bij scan teruggegeven uit SNMP Device

SNMPCustomerName

string

Aangepaste naam voor SNMP-apparaat

SystemCheckParam1

string

Eerste parameter gebruikt in systeemcheck

VSA API Web Service SystemCheckParam2

string

(Optioneel) tweede parameter gebruikt door systeemcheck

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetAlarmList Geeft standaard een array terug met nieuwe alarms die sinds de laatste aanvraag zijn toegevoegd. Geeft alle alarms terug als ReturnAllRecords is ingesteld op waar. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. Machine_GroupID

string


agentGuid

decimal


MonitorAlarmID

int

uniek nummer voor controlealarm

AlertType

int

Waarschuwingen zijn een van een reeks controletypes. 1 - Beheerderaccount uitgeschakeld 2 - Waarschuwing Bestandswijziging ophalen 3 - Nieuwe agent is voor de eerste keer ingecheckt 4 - Toepassing is geïnstalleerd of verwijderd 5 - Mislukken agentprocedure gedetecteerd 6 - Fout in NT Gebeurtenissenlogboek gedetecteerd 7 - KServer gestopt 8 - Beschermingsovertreding gedetecteerd 9 - PCI-configuratie is gewijzigd 10 - Configuratie schijfstation gewijzigd 11 - Grootte RAM gewijzigd 12 - Test e-mail verzonden door serverInfo.asp 13 - Gepland rapport voltooid 14 - LAN Watch waarschuwingstype 15 - agent offline 16 - weinig schijfruimte 17 - beheer op afstand uitgeschakeld 18 - agent online 19 - nieuwe patch gevonden 20 - patch-pad ontbreekt 21 - installatie patch mislukt 23 - Back-up waarschuwing

AlarmSubject

string

Onderwerp van alarm en e-mail

EventTime

dateTime

Datum en tijd van alarm

Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetGroupLicenseInfo Haalt het toegestane aantal licenties voor de opgegeven groep op. 25

VSA API Web Service Een enkel record wordt teruggeven van de volgende velden. MaxAgents

int

Het maximale aantal agenten dat voor deze computergroep geïnstalleerd kan worden.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetLogEntry Geeft details terug over het transactielogboek voor het aangeboden TransactionID. Een enkel record wordt teruggeven van de volgende velden. LogTransactionId

decimal

Het transactie-ID van het logboek.

LogErrorLocation

string

De locatie van de logboekfout.

LogErrorMessage

string

Het foutbericht voor het logboek.

LogMethod

string

De logboekhandeling die dit antwoord heeft aangevraagd.

ExecutionTimeInSeconds

decimal

De logboektijd die nodig is om op de aanvraag te antwoorden.

SessionId

decimal

Het sessie-ID van het logboek.

UserName

string

De gebruikersnaam van het logboek.

ClientIP

string

Het IP-adres van de logboekclient.

DateSubmitted

dateTime

De logboekdatum en tijd waarop de aanvraag is aangeboden.

DateUpdated

dateTime

De logboekdatum en tijd waarop het antwoord is teruggegeven..

TransactionXML

string

Het XML-bericht dat gebruikt is om de aanvraag in te dienen.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetMachine Geeft details terug over computers voor het aangeboden computergroeps-ID. Een enkel record wordt teruggeven van de volgende velden.

26

Machine_GroupID

string


agentGuid

decimal


machName

string

volledige computernaam. Alles links van de linker decimale punt is de computernaam.

groupName

string

volledige groepsnaam voor deze account. Alles rechts van de linker decimale punt is de groepsnaam.

Manufacturer

string

Tekenreeks fabrikant (type 1)

ProductName

string

Tekenreeks productnaam (type 1)

MachineVersion

string

Tekenreeks versie (type 1)

VSA API Web Service SysSerialNumber

string

Tekenreeks serienummer (type 1)

ChassisSerialNumber

string

Serienummer behuizing (type 3)

ChassisAssetTag

string

Nummer asset-label behuizing (type 3)

BusSpeed

string

Externe bussnelheid (in MHz) (type 4)

MaxMemorySize

string

Maximale grootte geheugenmodule (in MB) (type 16 - maximale capaciteit of als type 16 niet beschikbaar, maximale grootte geheugenmodule type 5)

MaxMemorySlots

string

Aantal bijbehorende geheugensleuven (aantal geheugenapparaten in type 16 of als type 16 niet beschikbaar is, aantal bijbehorende geheugensleuven in type 5)

ChassisManufacturer

string

Fabrikant behuizing (type 3)

ChassisType

string

Type behuizing (type 3)

ChassisVersion

string

Versie behuizing (type 3)

MotherboardManufacturer

string

Fabrikant moederbord (type 2)

MotherboardProductCode

string

Productcode moederbord (type 2)

MotherboardVersion

string

Versie moederbord (type 2)

MotherboardSerialNumber

string

Serienummer moederbord (type 2)

ComputerName

string

Naam van de computer

IpAddress

string

IP-adres van de computer in de notatie a.b.c.d

SubnetMask

string

Subnetmasker in notatie a.b.c.d. Reeks is leeg als gegevens niet beschikbaar zijn

DefaultGateway

string

IP-adres van standaard gateway in de notatie a.b.c.d. Reeks is leeg als gegevens niet beschikbaar zijn

DnsServer1

string

DNS server #1 IP-adres in de notatie a.b.c.d. Reeks is leeg als gegevens niet beschikbaar zijn

DnsServer2

string


DnsServer3

string


DnsServer4

string


DhcpEnabled

int

0 -> Geen gegevens beschikbaar, 1 -> DHCP op clientcomputer is ingeschakeld, 2 -> uitgeschakeld

DhcpServer

string

IP-adres van DHCP-server in de notatie a.b.c.d. Reeks is leeg als gegevens niet beschikbaar zijn

WinsEnabled

string

0 -> Geen gegevens beschikbaar, 1 -> WINS-resolutie op clientcomputer is ingeschakeld, 2 -> uitgeschakeld

PrimaryWinsServer

string

IP-adres van primaire WINS-server in de notatie a.b.c.d. Reeks is leeg indien niet beschikbaar.

SecondaryWinsServer

int

IP-adres van secundaire WINS-server in de notatie a.b.c.d. Reeks is leeg indien niet beschikbaar.

ConnectionGatewayIp

int

IP-adres in de notatie a.b.c.d verkregen door de KServer als bronadres van de agent. Dit IP-adres is de netwerk-gateway van de agent en verschilt van IpAddress als de computer zich bijvoorbeeld achter NAT bevindt. Reeks is leeg indien niet beschikbaar.

OsType

string

Reeks bevat type besturingssysteem, zoals 95, 98, NT4, 2000, NT3.51 of WIN32s. Afgeleid van delen van MajorVersion, MinorVersion en PlatformId.

27

VSA API Web Service OsInfo

string

Reeks bevat aanvullende info over besturingssysteem, zoals Build 1381 Service Pack 3. Afgeleid van delen van BuildNumber en CsdVersion.

MajorVersion

decimal

Nummer hoofdversie van de Windows functieaanroep GetVersionEx().

MinorVersion

string

Nummer subversie uit Windows functieaanroep GetVersionEx(). Als PlatformId Win32 for Windows is, dan geeft een 0 MinorVersion Windows 95 aan. Als PlatformId Win32 for Windows is, geeft MinorVersion > 0 Windows 98 aan.

MacAddr

string

Reeks met fysiek adres, het Media Access Control adres, van de verbinding. Een MAC-adres heeft de vorm 00-03- 47-12-65-77

LoginName

string

Aanmeldnaam van de op dit moment aangemelde gebruiker. Deze waarde wordt bij elke snelle incheck bijgewerkt. Het foutlogbestand van de agent wordt met elke verandering bijgewerkt.

firstCheckin

dateTime

tijdstempel dat de eerste keer aangeeft waarop deze agent zich op het systeem heeft aangemeld

lastCheckin

dateTime

tijdstempel dat de laatste keer aangeeft waarop deze agent zich op het systeem heeft aangemeld

currentUser

string

aanmeldnaam van de op dit moment aangemelde gebruiker. Leeg als op dit moment niemand is aangemeld

lastLoginName

string

aanmeldnaam van de laatste gebruiker die zich op dit systeem heeft aangemeld

lastReboot

dateTime

tijdstempel wanneer dit systeem voor het laatst is herstart

agentVersion

int

versienummer van de op dit systeem geïnstalleerde agent

contactName

string

Naam van contactpersoon die aan deze agent is toegewezen

contactEmail

string

E-mailadres van contactpersoon die aan deze agent is toegewezen

contactPhone

string

E-mailadres van contactpersoon die aan deze agent is toegewezen

contactNotes

string

Notities gekoppeld aan de contactpersoon voor deze agent

enableTickets

int

0 als deze gebruiker geen toegang heeft tot ticketing via de gebruikersinterface

enableRemoteControl

int

0 als deze gebruiker geen toegang heeft tot beheer op afstand via de gebruikersinterface

enableChat

int

0 als deze gebruiker geen toegang heeft tot chat via de gebruikersinterface

credentialName

string

De gebruikersnaam van de aanmeldgegevens die voor deze agent zijn ingesteld (indien van toepassing)

primaryKServer

string

het adres van de poort waarmee de agent verbinding maakt voor voor verbinding met zijn primaire kserver

secondaryKServer

string

het adres van de poort waarmee de agent verbinding maakt voor verbinding met zijn secundaire kserver

quickCheckinSecs

int

de wachttijd, in seconden, voordat een agent een volgende snelle check-in uitvoert

agentTempDir

string

De werkmap die de agent op dit systeem gebruikt

Indien van toepassing worden meerdere records terugggegeven van de volgende velden. CpuDesc

string

Beschrijving cpu (bijvoorbeeld Pentium III Model 8)

CpuSpeed

int

Snelheid cpu in MHz (bijvoorbeeld 601)

CpuCount

int

Aantal processoren (bijvoorbeeld 1)

TotalRam

int

Hoeveelheid RAM in MBytes (bijvoorbeeld 250)

Indien van toepassing worden meerdere records terugggegeven van de volgende velden. 28

VSA API Web Service DriveLetter

string

Stationsletter van logische schijf (bijvoorbeeld C)

TotalSpace

int

Totaal MBytes op de schijf (bijvoorbeeld 28609 voor 28.609 GB) Mag nul zijn indien niet beschikbaar.

UsedSpace

int

Aantal MBytes in gebruik (bijvoorbeeld 21406 voor 21.406 GB). Mag nul zijn indien niet beschikbaar.

FreeSpace

int

Aantal MBytes vrij (bijvoorbeeld 21406 voor 21.406 GB). Mag nul zijn indien niet beschikbaar.

DriveType

string

Vast = harde schijf Verwisselbaar = diskette of andere verwisselbare media CDROM Netwerk = toegewezen netwerkstation

VolumeName

string

Aan volume toegewezen naam

FormatType

string

NTFS, FAT32, CDFS, enz.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetMachineCollectionList Geeft een array terug van alle computerverzamelingen. Teruggegeven items zijn bruikbaar als argumenten voor GetMachineList om de uitvoer te filteren. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. collectionName

string

De naam van de verzameling.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetMachineGroupList Geeft een array terug van alle computergroepen waarvoor de geverifieerde account rechten heeft om ze te zien. Teruggegeven items zijn bruikbaar als argumenten voor GetMachineList om de uitvoer te filteren. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. groupName

string

Het computergroep-ID.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


29

VSA API Web Service

GetMachineList Geeft een array terug van alle computes waarvoor de geverifieerde gebruiker toegangsrechten heeft. Ondersteunt optioneel filteren van de teruggegeven computergroep of computerverzameling. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. MachineGroupID

string

Een actueel bestaande computergroep. Als dit veld leeg blijft, worden alle computers teruggegeven.

IpAddress

string

het IP-adres van de agentcomputer

MacAddr

string

het MAC-adres van de agentcomputer

groupName

string


firstCheckin

datetime

de eerste keer dat een agent incheckt bij de VSA

agentGuid

decimal



string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetMachineUptime Geeft een array terug met statistische gegevens over de actieve tijd van computer voor een aangeboden AgentGuid of computergroep of voor alle computers al ReturnAllRecords is ingesteld op waar. rptDate stelt de begindatum voor de uit te voeren berekening in op de huidige datum. Alle uitvoer is onderworpen aan beveiligingsfiltering, waaronder de agentGuid en computergroep subgroepen. Als u dus een agentGuid of computergroep aanbiedt waarvoor u geen rechten hebt om ze te bekijken, krijgt u niets terug. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. agentGuid

decimal


machineName

string

Volledige computernaam. Alles links van de linker decimale punt is de computernaam.

totalOnline

int

Het totale aantal seconden dat de computer online was gedurende de meettijd.

measureTime

int

Het totale aantal seconden het systeem is gemeten (laatste - oudste uitgesteld alarm tijden).

latestStatDate

dateTime

De laatste keer dat het systeem is gemeten, gewoonlijk het laatste record in het agentlogboek voor een offline-systeem.

olderStatDate

dateTime

Het vroegste tijdstip waarop het systeem is gemeten.

Een enkel record wordt teruggeven van de volgende velden.

30

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


VSA API Web Service

GetNotesList Geeft een array terug van nieuwe ticketnotities toegevoegd sinds de laatste aanvraag. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. TicketID

int

Het ticket ID.

Author

string

De auteur van de notitie.

DateEntered

dateTime

De datum waarop de notitie is gemaakt of voor het laatst gewijzigd.

NoteText

string

De tekst van de notitie.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetOrgLocation Geeft het adres van een organisatie terug, inclusief lengte- en breedtegraad. Een enkel record wordt teruggeven van de volgende velden. orgId

string

Unieke aanduiding.

orgRef

string

Unieke naam.

partitionId

string

Identificatie partner.

orgName

string

De naam van de organisatie.

street

string

Het adres.

city

string

De plaats

usState

string

De staat (VS).

postalCode

string

De postcode.

country

string

Het land.

countryCode

string

De landcode.

longitude

string

De lengtegraad voor de locatie van de organisatie.

latitude

string

De breedtegraad voor de locatie van de organisatie.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetOrgs Geeft de organisaties terug die de aangemelde VSA-gebruiker kan bereiken. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. orgName

string


orgRef

string

Unieke naam.

31

VSA API Web Service orgID

string

Unieke aanduiding.

CustomerID

string

Unieke aanduiding voor de klant.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetOrgsByScopeID Geeft de organisaties terug die een opgegeven bereik kan benaderen. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. orgName

string


orgRef

string

Unieke naam.

orgID

string

Unieke aanduiding.

CustomerID

string

Unieke aanduiding voor de klant.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetOrgTypes Geeft details terug over computers voor het aangeboden computergroeps-ID. Meerdere records worden terugggegeven van de volgende velden. orgTypeID

decimal

Unieke aanduiding.

orgTypeRef

string

De unieke naam van het organisatietype.

status

int

1=Actief

description

string

Een beschrijving van het organisatietype.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetPackageURLs Haalt een lijst op van de URL's van alle agentpakketten die beschikbaar zijn voor de aangemelde gebruiker. Indien van toepassing worden meerdere records terugggegeven van de volgende velden.

32

VSA API Web Service URL

string

De URL.

PackageName

string

De naam van het agentpakket.

Description

string

De beschrijving van het agentpakket.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetPartnerUserLocation Geeft de locatie terug van een VSA-gebruiker die specifiek is voor de partner, inclusief de lengte- en breedtegraad van de VSA-gebruiker. Een enkel record wordt teruggeven van de volgende velden. adminId

string

De unieke aanduiding van de VSA.

adminName

string

De gebruikersnaam van de VSA.

partitionId

string

De aanduiding voor de partner.

longitude

string

De lengtegraad voor de locatie van de VSA-gebruiker.

latitude

string

De breedtegraad voor de locatie van de VSA-gebruiker.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetPublishedViewColumns Geeft een array terug met alle kolommen voor een gepubliceerde databaseweergave. Meerdere records worden terugggegeven van de volgende velden. name

string

Naam van de kolom in de databaseweergave.

dataType

string

Gegevenstype van de kolom in de databaseweergave.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetPublishedViewRows Geeft een array terug met alle rijen voor een gepubliceerde databaseweergave met een WHERE-claus. Een enkel record wordt teruggeven van de volgende velden.

33

VSA API Web Service PublishedViewRows

string

Array met rijgegevens.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetPublishedViews Geeft een array terug met alle gepubliceerde databaseweergaven. Meerdere records worden terugggegeven van de volgende velden. PublishedView

string

Naam van de databaseweergave.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetRoles Geeft de rollen terug die de aangemelde VSA-gebruiker kan bereiken. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. roleID

string

Unieke aanduiding.

isActive

boolean

Rol is actief of inactief.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetScopes Geeft de bereiken terug die de aangemelde VSA-gebruiker kan bereiken. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. scopeID

string

Unieke aanduiding.


34

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


VSA API Web Service

GetTicket Geeft ticketgegevens terug voor het aangeboden MonitorTicketID. TicketID

int

uniek ID-nummer voor probleemticket

Machine_GroupID

string


agentGuid

decimal


machName

string

Computernaam die voor elke agent wordt gebruikt

groupName

string


TicketSummary

string

korte beschrijving van het ticket

Assignee

string

Naam beheerder aan wie het ticket is toegewezen

CreatedBy

string

naam beheerder (of computer-ID indien ingevoerd door gebruiker) van degene die dit ticket heeft gemaakt

CreationDate

string

tijdstempel wanneer het ticket is gemaakt

DueDate

string

datum waarop ticket verwerkt moet zijn

LastModifiedDate

string

Datum van de laatste notitie die voor dit ticket is ingevoerd

ResolutionDate

string

tijdstempel wanneer het ticket is gesloten

UserName

string

De naam van de aanbieder

UserEmail

string

Het e-mailadres van de aanbieder

UserPhone

string

Het telefoonnummer van de aanbieder

Indien van toepassing worden meerdere records terugggegeven van de volgende velden. TicketLabel

string

Het label van het veld

IntegerValue

int

De waarde van een integerveld

NumberValue

decimal

De waarde van een numeriek veld

StringValue

string

De waarde van een tekenreeksveld

ListValue

string

De waarde van een lijstveld


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetTicketList Geeft standaard een array terug met nieuwe tickets die sinds de laatste aanvraag zijn toegevoegd. Geeft alle tickets terug als ReturnAllRecords is ingesteld op waar. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. TicketID

int

uniek ID-nummer voor probleemticket

Machine_GroupID

string


agentGuid

decimal


TicketSummary

string

korte beschrijving van het ticket

35


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetTicketNotes Geeft een array terug met notities die bij het aangeboden ticket behoren. Indien van toepassing worden meerdere records terugggegeven van de volgende velden. TicketID

int

Het ticket ID.

Author

string

De auteur van de notitie.

DateEntered

dateTime

De datum waarop de notitie is gemaakt of voor het laatst gewijzigd.

NoteText

string

De tekst van de notitie.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetTicRequestTicket Geeft het ticket-ID terug dat is gekoppeld aan een ticket aanvraag-ID. Een enkel record wordt teruggeven van de volgende velden. ticketId

string

unieke aanduiding voor ticket

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetVerboseMachineGroupList Indien van toepassing worden meerdere records terugggegeven van de volgende velden. groupName

string

Het computergroep-ID.

machGroupGuid

string

GUID van de computergroep.

parentGroupGuid

string

GUID van de hogerliggende computergroep als deze bestaat.

orgFK

string

Vreemde sleutel (foreign key) voor de organisatie die de computergroep bevat.


36

Method

string


TransactionID

decimal


VSA API Web Service ErrorMessage

string


ErrorLocation

string


LockFunctionAccess Vergrendelt toegang tot functies van de aangeboden gebruikersrol voor de aangeboden basisgebruikersrol. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Primitieven De volgende primitieve handelingen op gegevenstypen worden eveneens geboden. Elke primitieve handeling gebruikt hetzelfde xml-contract als de overeenkomstige handelingen op meerdere kolommen. Elke primitief geeft een tekenreekswaarde terug die verder verwerkt moet worden. Primitief

Resultaat

Gegevensty pe

PrimitiveAddMachGroupToScope

PrimitiveAddMachGroupToScopeResult

string

PrimitiveAddOrg

PrimitiveAddOrgResult

string

PrimitiveAddOrgDeptStaff

PrimitiveAddOrgDeptStaffResult

string

PrimitiveAddOrgToScope

PrimitiveAddOrgToScopeResult

string

PrimitiveAddScope

PrimitiveAddScopeResult

string

PrimitiveAddScopeOrg

PrimitiveAddScopeOrgResult

string

PrimitiveAddTicRequest

PrimitiveAddTicRequestResult

string

PrimitiveAddUserToRole

PrimitiveAddUserToRoleResult

string

PrimitiveAddUserToScope

PrimitiveAddUserToScopeResult

string

PrimitiveAssignRole

PrimitiveAssignRoleResult

string

PrimitiveAssignScope

PrimitiveAssignScopeResult

string

PrimitiveAuthenticate

PrimitiveAuthenticateResult

string

PrimitiveCloseAlarm

PrimitiveCloseAlarmResult

string

PrimitiveCreateMachineGroup

PrimitiveCreateMachineGroupResult

string

PrimitiveCreateRole

PrimitiveCreateRoleResult

string

PrimitiveDeleteMachineGroup

PrimitiveDeleteMachineGroupResult

string

PrimitiveDeleteOrg

PrimitiveDeleteOrgResult

string

PrimitiveDeleteScope

PrimitiveDeleteScopeResult

string

PrimitiveEchoMt

PrimitiveEchoMtResult

string

PrimitiveGetAlarm

PrimitiveGetAlarmResult

string

PrimitiveGetAlarmList

PrimitiveGetAlarmResult

string

PrimitiveGetLogEntry

PrimitiveGetLogEntryResult

string

37

VSA API Web Service PrimitiveGetMachine

PrimitiveGetMachineResult

string

PrimitiveGetMachineCollectionList

PrimitiveGetMachineCollectionListResult

string

PrimitiveGetMachineGroupList

PrimitiveGetMachineGroupListResult

string

PrimitiveGetMachineGroups

PrimitiveGetMachineGroupsResult

string

PrimitiveGetMachineList

PrimitiveGetMachineListResult

string

PrimitiveGetMachineUptime

PrimitiveGetMachineUptimeResult

string

PrimitiveGetNotesList

PrimitiveGetNotesListResult

string

PrimitiveGetOrgLocation

PrimitiveGetOrgLocationResult

string

PrimitiveGetOrgs

PrimitiveGetOrgsResult

string

PrimitiveGetOrgsByScopeID

PrimitiveGetOrgsByScopeIDResult

string

PrimitiveGetOrgTypes

PrimitiveGetOrgTypesResult

string

PrimitiveGetPartnerUserLocation

PrimitiveGetPartnerUserLocationResult

string

PrimitiveGetPublishedViewColumns PrimitiveGetPublishedViewColumnsResult

string

PrimitiveGetPublishedViewRows

PrimitiveGetPublishedViewRowsResult

string

PrimitiveGetPublishedViews

PrimitiveGetPublishedViewsResult

string

PrimitiveGetRoles

PrimitiveGetRolesResult

string

PrimitiveGetScopes

PrimitiveGetScopesResult

string

PrimitiveGetTicRequestTicket

PrimitiveGetTicRequestTicketResult

string

PrimitiveGetTicket

PrimitiveGetTicketResult

string

PrimitiveGetTicketList

PrimitiveGetTicketListResult

string

PrimitiveGetTicketNotes

PrimitiveGetTicketNotesResult

string

PrimitiveGetVerboseMachineGroup List

PrimitiveGetVerboseMachineGroupListResult

string

PrimitiveRemoveUserFromRole

PrimitiveRemoveUserFromRoleResult

string

PrimitiveResetPassword

PrimitiveResetPasswordResult

string

PrimitiveSetPartnerUserLocation

PrimitiveSetPartnerUserLocationResult

string

PrimitiveUpdateOrg

PrimitiveUpdateOrgResult

string

PrimitiveUpdateTicket

PrimitiveUpdateTicketResult

string

PrimitiveUpdateUser

PrimitiveUpdateUserResult

string

RemoveUserFromRole Verwijdert een VSA-gebruiker uit een rol. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


ResetPassword Stelt het gebruikerswachtwoord opnieuw in.

38


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


RoleMembership Wijst een gebruiker toe aan een gebruikersrol. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


SendAdminMessage Stuurt een bericht naar een gebruiker. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


SetAdminPassword Stelt het wachtwoord voor een opgegeven gebruiker opnieuw in. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


SetGroupLicenseInfo Stelt het maximale aantal agenten in dat voor een opgegeven groep is toegestaan. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


39

VSA API Web Service

SetPartnerUserLocation Stelt de huidige lengte- en breedtegraad in voor de VSA-gebruiker. Een enkel record wordt teruggeven van de volgende velden. AdminId

decimal

Unieke aanduiding voor de VSA-gebruiker.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


UpdateOrg Werkt de informatie voor een organisatie bij. Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


UpdateTicket Werkt een of meer velden voor een ticket bij. Alleen velden opgesomd op de pagina Ticketing > E-mail lezer kunnen worden bijgewerkt.

Lijstvelden bijwerken In het onderstaande voorbeeld is het veld Origin een veld van het type List (lijst) met vier mogelijke waarden. Een aanvraag geeft de naam door van het veld, Origin, en een getal dat de positie van de waarde in de lijst weergeeft, te beginnen met 1. Zo staat de waarde Phone op de tweede positie in de lijst, zodat de waarde die wordt doorgegeven om het veld Origin te veranderen in Phone 2 is.

40

VSA API Web Service Waarschuwing: De waarden in de keuzelijsten wijzigen door de volgorde te veranderen of door een nieuwe waarde in de lijst in te voegen, verandert de waarde die wordt geselecteerd door de handeling UpdateTicket. Zorg er voor dat gebruikers zich bewust zijn van deze beperking voordat ze wijzigingen aanbrengen in de veldwaarden van E-mail lezer.

Een ticket afsluiten Het bijwerken van een ticket kan omvatten het sluiten van een aangeboden MonitorTicketID door het veld Status bij te werken met de waarde 3, doe de derde waarde weergeeft in de keuzelijst van het veld Status. Hieronder staat een voorbeeld. Extra <TicketField> u kunt naam/waarde-elementen toevoegen aan onderstaand voorbeeld om meerdere velden bij te werken. <TicketID>1 <TicketFields> <TicketField> Status 3 <SessionID>13642146236194247244181221

Andere soorten velden bijwerken De volgende andere soorten ticketvelden kunnen eveneens worden bijgewerkt:  String: kan elke tekst bevatten tot maximaal 500 tekens. Vooral geschikt voor zaken zoals probleemlocaties of andere variabelen die niet op de samenvattingsregel thuishoren.  Integer: kan elke positieve of negatieve gehele waarde bevatten.  Number (nn.d): een getal dat altijd een cijfer rechts van de komma bevat.  Number (nn.dd): een getal dat altijd twee cijfers rechts van de komma bevat.  Number (nn.ddd): een getal dat altijd drie cijfers rechts van de komma bevat.  Number (nn.dddd): een getal dat altijd vier cijfers rechts van de komma bevat.

Teruggegeven velden Een enkel record wordt teruggeven van de volgende velden. Method

string


TransactionID

decimal


ErrorMessage

string


41

VSA API Web Service ErrorLocation

string


Ticket-bijlagen U kunt de API Web Service niet gebruiken om bijlagen bij ticket-bestanden te bewerken of op te halen. Bijlagen bij ticket-bestanden staan gewoonlijk in de map C:\Kaseya\WebPages\ManagedFiles van de KServer. API-ontwikkelaars zijn verantwoordelijk voor het schrijven van code om bijlagebestanden in deze map te plaatsen voor het uitvoeren van Web Service API-aanroepen die naar deze bijlagen verwijzen.

UpdateUser Werkt gebruikersinformatie bij. Een enkel record wordt teruggeven van de volgende velden.

42

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Hoofdstuk 2

KSD API Web Service In dit hoofdstuk KSD API Web Service inschakelen KSD API Webservice gegevenstypes KSD API Web Service - handelingen Voorbeeldberichten

43 43 50 53

KSD API Web Service inschakelen Zie de VSA API Web Service online help of gebruikershandleiding voor een algemene inleiding tot de Kaseya API. Zo schakelt u de KSD API Web Service in:  De pagina Systeem > Configureren in de VSA weergeven.  Klik in het keuzevakje VSA API Web Service activeren.  Neem toegang tot de KSD API webservice met http:///vsaWS/vsaServiceDeskWS.asmx

KSD API Webservice gegevenstypes De volgende zijn de belangrijkste gegevenstypes die in de KSD API Webservice worden gebruikt. Deze gegevenstypes worden in het XML-schemadocument in het bestand XML\Schemas\ServiceDesk\ServiceDeskDefinition.xsd gedefinieerd die zich in de map bevindt waar de Kaseya-software wordt geïnstalleerd.

43

KSD API Web Service Opmerking: In de volgende beschrijvingen betekent dat waar de naam (content) zegt, de waarde van de inhoud van het element is.

Legenda    

A - AddIncident G - GetIncident L - ListIncidents U - UpdateIncident

RefItem De RefItem beschrijft een item die in het servicedesk een referentie-item is. Deze hebben een interne waarde van het database-ID, een interne naam, een optionele beschrijving en de weergavewaarde. G

ref

string

De interne naam van het item. Deze heeft meestal een voorvoegsel van de servicedesk-naam en ||, zoals Standaard||Open.

G

id

string

De interne database-sleutel voor het item.

G

description

string

De optionele beschrijving voor het item.

G

(content)

string

De voor de gebruiker leesbare vorm van het item.

CustomField De CustomField beschrijft de waarde van een aangepast veld in een incident. AGU

fieldName

string

De naam van het veld in de servicedeks.

AGU

(content)

string

De waarde van het aangepaste veld.

Note De Notitie beschrijft een enkele notitie die aan een ticket is bevestigd. G

User

string

De naam van de gebruiker die de notitie heeft gemaakt.

G

Timestamp

dateTime

De tijd dat de notitie werd gemaakt.

AG

Text

string

De inhoud van de notitie. Dit kan HTML-indeling zijn en het kan verwijzingen naar bijlagen bevatten.

AG

Hidden

boolean

Waar als de notitie verborgen zou zijn.

AG

HoursWorked

Decimal

Het aantal uren die in deze update van het ticket zijn gewerkt.

AG

SuppressNotify

Boolean

Waar als notificaties voor deze update zouden zijn onderdrukt.

Attachment De Bijlage beschrijft een enkele bijlage voor het ticket.

44

A

Name

string

Een unieke identificerende tekenreeks voor deze bijlage.

A

DisplayName

string

De naam van de bijlage die door de gebruiker wordt gezien.

A

FileName

string

De originele naam van het bestand of de URL.

A

DocumentType

string

De MIME-opmaak van de bijlage.

KSD API Web Service A

Content

Base64Binary

De basis 64 gecodeerde inhoud voor de bijlage.

RelatedIncident De RelatedIncident is een ander incident die aan dit huidige incident is verwant. AGU

IncidentNumb string er

Het unieke ID voor het incident.

G

Overzicht

string

Het overzicht van het verwante incident.

G

Status

string

De voor de gebruiker leesbare status van het verwante incident.

G

Beschrijving

string

Het beschrijvende veld van het incident.

ServiceDeskDefinition De volgende elementen van ServiceDeskDefinition die worden geretourneerd, beschrijven de servicedesk-definitie die wordt gebruikt om het ticket te bewerken. Dit geeft voor elk veld in het ticket elk van de mogelijke waarden. Een enkel record wordt teruggeven van de volgende elementen. ServiceDeskDefinition

id="decimal"

Een uniek ID.

Name

string

De naam van de servicedesk-definitie.

Beschrijving

string

Een korte beschrijving van de servicedesk-definitie.

RequireTime

boolean

Wanneer waar, wordt het vereist dat gewerkte uren worden ingevoerd.

DisplayMachineInfo

boolean

Wanneer waar, wordt het computer-zoekveld weergegeven.

RequireMachineInfo

boolean

Wanneer waar, wordt de computer-zoekassociatie vereist.

DisplayOrgInfo

boolean

Wanneer waar, wordt het organisatie-zoekveld weergegeven.

RequireOrgInfo

boolean

Wanneer waar, wordt de organisatie-zoekassociatie vereist.

DisplayCI

boolean

verouderd

RequireCI

boolean

verouderd

AllAdmins

boolean

verouderd

AutoStartClock

boolean

Wanneer waar, wordt een klok automatisch gestart als de gebruiker het ticket begint te bewerken.

AutoSaveClock

boolean

Wanneer waar, wordt het verschil tussen de huidige tijd en de starttijd als Gewerkte uren ingevoerd zodra het ticket wordt opgeslagen.

AutoInsertNote

boolean

Wanneer waar worden notities automatisch aan elk ticket toegevoegd voor de veranderingen die aan het ticket zijn gemaakt.

AutoInsertNoteHidden

boolean

Wanneer waar, worden automatisch gegenereerde notities verborgen.

NeedStatusNote

boolean

verouderd

SDPrefix

string

De code van het voorvoegsel die aan het begin van het ticket-ID wordt toegevoegd.

DefaultStatus

decimal

Standaard statuswaarde. Verwijst naar één van de elementen met het overeenkomende ID-attribuut in de sectie Status.

DefaultStage

decimal

Standaard fasewaarde. Verwijst naar één van de elementen met het overeenkomende ID-attribuut in de sectie Fase.

DefaultPriority

decimal

Standaard prioriteitswaarde. Verwijst naar één van de elementen met het overeenkomende ID-attribuut in de sectie Prioriteit.

DefaultSeverity

decimal

Standaard ernstwaarde. Verwijst naar één van de elementen met het

45

KSD API Web Service overeenkomende ID-attribuut in de sectie Ernst. DefaultResolution

decimal

Standaard oplossingswaarde. Verwijst naar één van de elementen met het overeenkomende ID-attribuut in de sectie Oplossing.

DefaultCategory

decimal

Standaard categoriewaarde. Verwijst naar één van de elementen met het overeenkomende ID-attribuut in de sectie Categorie.

DefaultSubCategory

decimal

Verouderd

DefaultServiceDesk

boolean

Wanneer waar is dit de standaard servicedesk, de eerste die tijdens het maken van nieuwe tickets werd geselecteerd.

TemplateName

string

Het sjabloonbestand dat wordt gebruikt om aanvankelijk de servicedesk te maken. Anders niet gebruikt.

TemplateType

int

Het type servicedesk: 1=ticket, 3=kennisbasis.

SequenceName

string

Alleen voor gebruik voor interne ontwikkeling.

EditingTemplate

string

De naam van het formulier dat wordt gebruikt om voor de servicedesk tickets te bewerken.

EmailReader

string

De e-maillezer die met de servicedesk is verwant.

Administrator

string

De gebruiker die de "desk-beheerder" van de servicedesk is. De desk-beheerder wordt over bepaalde fouten in de servicedesk ingelicht.

DefaultPolicy

string

Het standaard beleid dat aan de desk is toegewezen.

Status

RefItem

Retourneert een lijst onderliggende elementen van elke Statuswaarde in de servicedesk.

Priority

RefItem

Retourneert een lijst onderliggende elementen van elke Prioriteitswaarde in de servicedesk.

Severity

RefItem

Retourneert een lijst onderliggende elementen van elke Ernstwaarde in de servicedesk.

Resolution

RefItem

Retourneert een lijst onderliggende elementen van elke Oplossingswaarde in de servicedesk.

Categories

RefItem

Retourneert een lijst onderliggende elementen van elke Categoriewaarde in de servicedesk. Elke Categorie kan, als zij bestaan, onderliggende SubCategory-elementen bevatten.

Stages

Retourneert een lijst onderliggende elementen van elke Fasewaarde in de servicedesk. Elke Fase wordt door een attribut van het fasetype Begin-, Midden- of Eind geïdentificeerd. Elke fase heeft de volgende onderliggende elementen:

 Item - De naam van de fase.  Initialisatie - De procedure voor Fase-invoer die aan de fase is gekoppeld.  Escalatie - De Escalatie-procedure die aan de fase is gekoppeld. Tijd en Eenheden worden als attributen aangegeven.  Doel - Het doel dat aan de fase is gekoppeld. De doelprocedure die aan de fase is gekoppeld. Tijd en Eenheden worden als attributen aangegeven.  NextStage - Eén van de volgende fasen waar deze fase naar kan overgaan. Participants

46

RefItem

De lijst van gebruikers zoals pools die toegewezen gebruikers of eigenaren voor de servicedesk kunnen zijn.

KSD API Web Service CurrentContact

Contactinformatie over de gebruiker die zich tijdens deze transactie heeft aangemeld. Als de gebruiker met een personeelsrecord is verwant, dan wordt de informatie van CurrentContact van het personeelsrecord gehaald. Als de huidig aangemelde gebruiker een computergebruiker is die Portaaltoegang gebruikt, dan wordt de informatie voor CurrentContact van het tabblad Home > Profiel wijzigen van Portaaltoegang gehaald.

    SubmitterTypes

string

ContactName PhoneNumber Organization EmailAddress

Type persoon die het ticket indient:

 ONBEKENDE  DEELNEMER - Een deelnemer is een VSA-gebruiker.  GEBRUIKER - Een onbekend iemand voor VSA. CustomFields

Retourneert nul of meer Veldelementen, elk met de volgende hiërarchie:

    

Bijschrift - Bijschrift scherm. Titel - Rapporttitel. Fieldname - Naam van het veld. FieldFormat - Gegevenstype. DefaultValue - Standaardwaarde, als een Lijst gegevenstype.  Values - verzamelelement, als een Lijst gegevenstype. Item - Lijst itemwaarde.

Retourneert een hiërarchie van onderliggende elementen:

AccessRights

 ViewHiddenNotes - waar of niet-waar  ChangeHiddenNotes - waar of niet-waar  Veldrechten>Veldrecht - verzamelelementen FieldName - Naam van het ticketveld AccessType - Vereist, Bewerken, Alleen weergeven, Verborgen

Retourneert een lijst van notitiesjablonen waarvan elk standaardtekst vertegenwoordigt die aan ticketnotities kan worden toegevoegd.

NoteTemplates ChangeProcedure

string

De procedure Ticket wijzigen die verwant is met de servicedesk.

GoalProcedure

decimal

De Doelprocedure die verwant is met de servicedesk.

 tijd - de hoeveelheid tijd voor doel  eenheid - De tijdseenheden  (content) - de naam van de doelprocedure.

Incidentenoverzicht De IncidentSummary bevat de basisbeschrijving van een ticket. AGLU

ServiceDeskName

string

De naam van de servicedesk-definitie.

GLU

IncidentNumber

string

Het ticket-ID.

AGLU

Overzicht

string

De tekst van het ticketoverzicht.

AGLU

Beschrijving

string

De tekst van de ticketbeschrijving.

AGLU

Status

string

De ref.status van het ticket.

AGLU

Priority

string

De ref.prioriteit van het ticket.

AGLU

Resolution

string

Het ref.oplossingstype van het ticket.

AGLU

Stage

string

De ref.fase van het ticket.

47

KSD API Web Service AGLU

Severity

string

De ref.ernst van het ticket.

AGLU

Category

string

De ref.categorie van het ticket.

AGLU

SubCategory

string

De ref.subcategorie van het ticket.

GL

Policy

string

Het beleid van het ticket.

GL

CreateDateTime

dateTime

De datum/tijd dat het ticket werd gemaakt.

GL

LastEditDateTime

dateTime

De datum/tijd dat het ticket het laatst werd bewerkt.

GL

CloseDateTime

dateTime

De datum/tijd dat het ticket werd gesloten.

AGLU

OrgID

decimal

Uniek ID van de organisatie die met het ticket is verwant.

AGLU

OrganizationName

string

De organisatienaam die met het ticket is verwant.

AGLU

Organization

string

Het organisatie-ID die met het ticket is verwant.

AGLU

OrganizationStaffName

string

De naam van het personeelslid van de organisatie die met het ticket is verwant.

AGLU

OrganizationStaff

string

Het unieke ID van het personeelslid van de organisatie die met het ticket is verwant.

AGLU

OrganizationStaffEmail

string

Het email van het personeelslid van de organisatie die met het ticket is verwant.

AGLU

Machine

string

De computer die aan een ticket is verwant.

AGLU

MachineGuid

decimal

De GUID van de computer die aan een ticket is verwant.

AGLU

MachineGroup

string

De computergroep van de computer die aan een ticket is verwant.

AGLU

MachineGroupGuid

decimal

De GUID van de computergroep die aan een ticket is verwant.

AGLU

Submitter

string

De naam van de indiener die het ticket heeft ingediend.

AGLU

SubmitterEmail

string

De e-mail van de indiener van het ticket.

AGLU

SubmitterPhone

string

De telefoon van de indiener van het ticket.

AGLU

SubmitterType

string

Type persoon die het ticket indient:

 ONBEKENDE  DEELNEMER - Een deelnemer is een VSA-gebruiker.  GEBRUIKER - Een onbekend iemand voor VSA. GL

IsUnread

boolean

Wanneer waar wordt het ticket niet door de huidig aangemelde gebruiker bekeken.

Incident Het Incident wordt van de IncidentSummary gehaald en bevat, naast al deze velden, alle velden van de IncidentSummary. G

IsParticipant

boolean

verouderd

G

IsClosed

boolean

Waar wanneer gesloten.

G

CurrentStageEscalation dateTime DateTime

Fase escalatie datum en tijd.

G

CurrentGoalDateTime

dateTime

Fase doel datum en tijd.

AGU

Owner

string

Eigenaar van het ticket.

Participant

string

verouderd

AssigneeType

string

Type van de toegewezen gebruiker:

AGU

 ONBEKENDE  DEELNEMER - individuele toegewezen gebruiker  POOL - een pool van gebruikers

48

KSD API Web Service AGU

Assignee

string

Naam toegewezen gebruiker.

AGU

AssigneeEmail

string

E-mail toegewezen gebruiker.

G

ActualCompletionDate

dateTime

verouderd

G

ExpectedCompletion Date

dateTime

Datum/tijd dat het ticket wordt of werd verwacht te worden gesloten (vervaldatum van het ticketdoel).

G

ActualResolutionDate

dateTime

Datum/tijd een oplossingstype voor het ticket werd ingesteld.

AGU

PromisedDate

dateTime

Datum/tijd van beloofde datum voor oplossing van het ticket dat doro de klantvertegenwoordiger is ingevoerd.

G

IsArchived

boolean

Waar als ticket wordt gearchiveerd

G

IsError

boolean

verouderd

G

IsPoolAssignee

boolean

verouderd

ErrorMessage

string

verouderd

Notify

boolean

verouderd

G

CurrentStage

string

De huidige fase.

AGU

ResolutionNote

string

Beschrijvende tekst die met het oplossingstype is ingevoerd.

G

LockTime

dateTime

Datum/tijd dat het ticket werd vergrendeld door het ticket voor bewerking te openen.

G

LockUser

string

Gebruiker die het ticket vergrendelt door het ticket voor bewerking te openen.

G

StageGoalTime Remaining

int

De resterende tijd voor dat de timer van het fasedoel de doelprocedure uitvoert. Relevant als het fasedoel wordt gepauseerd.

AGU

SourceType

string

Het brontype, of een systeemgebeurtenis of e-mail die een ticketverzoek heeft gegenereerd.

        

Email BUDR KES Patch Controleren Alarm Portaal ServiceDesk Overige

AGLU

Field

CustomField Nul of meer aangepaste veldwaarden

AGU

Notes

Note

Nul of meer notities.

AGU

Attachments

Attachment

Nul of meer bijlagen

AGU

RelatedIncidents

Related Incident

Nul of meer verwante incidenten

GU

ServiceDeskDefinition

ServiceDesk Definition

49

KSD API Web Service

KSD API Web Service handelingen De volgende handelingen kunnen met de KSD API Web Service worden verricht:

AddIncident Het verzoek is: AddSDIncident

Incident

De inhoud van het nieuw te maken incident. Alleen velden die in de eerste kolom met een A zijn gemarkeerd, kunnen worden ingesteld.

SessionId

Decimal

Het ID van de webservice-sessie.

Een enkel record wordt teruggeven van de volgende velden. IncidentNumber

string

Het unieke ID voor het ticket.

IncidentID

decimal

Het ID van het ticket.

Method

string


TransactionID

decimal


ErrorMessage

string

Als dit leeg is, wordt geen fout teruggegeven.

ErrorLocation

string


AddServDeskToScope Het verzoek is: servDeskName

string

De naam van de servicedesk.

scopeName

string

De naam van het bereik.

SessionId

decimal



string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetIncident Haalt van de database een enkelvoudig incident. Het verzoek is: IncidentRequest

Het af te halen incident. Dit heeft de volgende velden:

 IncidentNumber – Het ticket-ID zoals de gebruiker ziet, zoals STD000001  IncidentId – Het database-ID van het af te halen ticket.  IncludeNotes – waar om notities aan het afgehaalde ticket toe te voegen.  IncludeDefinition – waar om de servicedesk-definitie in de respons op te nemen SessionId

50

Decimal


KSD API Web Service Een enkel record wordt teruggeven van de volgende velden. IncidentResponse

Incident

Het afgehaalde incident.

Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetIncidentList Haalt een lijst van incidenten af die met de verzochte criteria overeenkomt. Het verzoek is: IncidentRequest

Het af te halen incident. Dit heeft de volgende velden:

 ServiceDeskName - De naam van de servicedesk-query.  Status - Eén of meer statuswaarden om aan te passen. Als geen statuswaarden worden geleverd, worden tickets ongeacht de status afgehaald.  Priority - Eén of meer prioriteitswaarden om aan te passen. Als geen prioriteitswaarden worden geleverd, worden tickets ongeacht de prioriteit afgehaald.  Stage - Eén of meer fasewaarden om aan te passen. Als geen fasewaarden worden geleverd, worden tickets ongeacht buiten de fase afgehaald.  Summary - een tekenreeks of expressie om het overzicht van tickets te zoeken.  Organization - De naam of gedeeltelijke naam van organisaties die overeenkomen. Wanneer niet gegeven, worden tickets voor alle organisaties binnen het bereik afgehaald.  OrganizationStaff – De naam van een organisatorisch personeelslid. verwant met tickets. Wanneer niet gegeven, worden tickets voor alle organisaties binnen het bereik afgehaald.  Machine - De naam van een computer om aan te passen. Wanneer niet gegeven, worden tickets voor alle computers binnen het bereik afgehaald.  MachineGroup - De naam van een computergroep om aan te passen. Wanneer niet gegeven, worden tickets voor alle computergroepen binnen het bereik afgehaald.  Assignee - De naam of gedeeltelijke naam van toegewezen gebruikers om aan te passen. Wanneer niet gegeven, worden tickets voor alle toegewezen gebruikers binnen het bereik afgehaald.  StartingIncident – Tijdens paginering is dit het volgende incidentnummer om af te halen. Deze waarde komt van de waarde nextStartingIncident van een eerder GetIncidentList-verzoek.  IncidentCount - Wanneer aanwezig, geeft het het aantal incidenten aan om af te halen.  SortField – Wanneer aanwezig, worden de resultaten op de veldnaam gesorteerd. SessionId

Decimal


De respons is als volgt: 51

KSD API Web Service IncidentList

De lijst overeenkomende incidenten. Dit heeft de volgende attributen en elementen:

 totalIncidents – Het totaal aantal incidenten die met het verzoek overeenkomen.  nextStartingIncident – Het ID van het volgende af te halen incident.  Incident – Nul of meer incidenten die met de vereiste criteria overeenkomen. SessionId

Decimal


GetServiceDesk Haalt de definitite van een servicedesk op. Dit moet worden opgeroepen voordat een gebruikersinterface wordt gemaakt zodat de gebruiker een ticket kan invoeren. Het verzoek is: ServiceDeskDefinitionReq uest

SessionId

Het af te halen servicedesk. Dit heeft de volgende elementen:

 ServiceDeskName - De naam van de af te halen servicedesk.  ServiceDeskID - De database van de af te halen servicedesk. Kon niet worden gebruikt. Decimal


Een enkel record wordt teruggeven van de volgende elementen. ServiceDeskDefinitionRes ServiceDeskDe De afgehaalde servicedesk-definitie. ponse finition Method

string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


GetServiceDesks Indien van toepassing worden meerdere records terugggegeven van de volgende velden. Het verzoek is: IsDefault

boolean

Wanneer waar, is de servicedesk de standaard servicedesk.

ServiceDeskID

decimal

Een uniek ID.

ServiceDeskName

string

De naam van de servicedesk.


string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Primitieven De volgende primitieve handelingen op gegevenstypen worden eveneens geboden. Elke primitieve handeling gebruikt hetzelfde xml-contract als de overeenkomstige handelingen op meerdere 52

KSD API Web Service kolommen. Elke primitief geeft een tekenreekswaarde terug die verder verwerkt moet worden. U wordt ten zeerste afgeraden om deze methoden te gebruiken. Primitief

Resultaat

Gegevenstyp e

PrimitiveAddIncident

PrimitiveAddIncidentResult

string

PrimitiveAddServDeskToScope

PrimitiveAddServDeskToScopeResult

string

PrimitiveGetIncident

PrimitiveGetIncidentResult

string

PrimitiveGetIncidentList

PrimitiveGetIncidentListResult

string

PrimitiveGetServiceDesk

PrimitiveGetServiceDeskResult

string

PrimitiveGetServiceDesks

PrimitiveGetServiceDesksResult

string

PrimitiveUpdateIncident

PrimitiveUpdateIncidentResult

string

UpdateIncident Werkt in de database een enkelvoudig incident bij. Het verzoek is: UpdateSDIncident

Incident

Het bij te werken incident. Zie de eerste kolom van het gegevenstype van Incidenten voor de velden die geldig zijn voor update.

SessionId

Decimal



string


TransactionID

decimal


ErrorMessage

string


ErrorLocation

string


Voorbeeldberichten Voorbeeldgegevens worden in de volgende XML-s opgenomen.

GetServiceDesks Request <req> <SessionID>62648424383576321292545755

GetServiceDesks Response <ServiceDesks> <ServiceDesk> false <ServiceDeskID>291273277175176 <ServiceDeskName>KnowledgeBase

53

KSD API Web Service <ServiceDesk> false <ServiceDeskID>696191121914314 <ServiceDeskName>Standard <Method>GetServiceDesks 144 <ErrorMessage/> <ErrorLocation/>

GetServiceDesk Request <req> <ServiceDeskDefinitionRequest> <ServiceDeskName xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard <ServiceDeskID xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">696191121914314 <SessionID>62648424383576321292545755

GetServiceDesk Response <ServiceDeskDefinitionResponse id="696191121914314"> Standard Standard SD true true false true true false false false false true false true false <SDPrefix xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">STD 218924116119912
54

KSD API Web Service tatus> 831768438118427 693719171716599 0 0 0 0 false 1 <SequenceName xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">SEQ129 <EditingTemplate xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Fixed_Width_Tabbed.xml <Status xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd"> Awaiting Hardware Awaiting User Feedback Closed Escalated Hold In Progress New Critical High High Low Medium Planning <Severity xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd"> Whole Company (High) Multiple users (Medium) Single User (Low) Advice Given Cannot Duplicate Closed by Customer Request Hardware Replaced Hot Fix Released Installation Completed New Software Installed No response from user OS Reinstalled Other Passed to Sales Pending script cleared Reapply Schema Reboot Resolved by Customer

55

KSD API Web Service Resolved Solved with KB article Training Given Advice & Guidance <SubCategory ref="Standard||Advice&Guidance||General" id="561699795215782">General Kaseya <SubCategory ref="Standard||Kaseya||AgentIcon" id="821781865922435">Agent Icon <SubCategory ref="Standard||Kaseya||Alarm" id="481422361723261">Alarm <SubCategory ref="Standard||Kaseya||ApplicationChanges" id="525187874623717">Application Changes <SubCategory ref="Standard||Kaseya||Disk" id="919621482151882">Disk <SubCategory ref="Standard||Kaseya||Eventlog" id="814714713317798">Eventlog <SubCategory ref="Standard||Kaseya||GetFile" id="322618792314914">Get File <SubCategory ref="Standard||Kaseya||Hardware" id="176166136238942">Hardware <SubCategory ref="Standard||Kaseya||Lanwatch" id="214791394922624">Lanwatch <SubCategory ref="Standard||Kaseya||Logon_Admin" id="943315515116292">Logon_Admin <SubCategory ref="Standard||Kaseya||Logon_User" id="636613429245187">Logon_User <SubCategory ref="Standard||Kaseya||NewAgent" id="557214511134217">New Agent <SubCategory ref="Standard||Kaseya||Other" id="631281678197153">Other <SubCategory ref="Standard||Kaseya||PatchManagement" id="462824113621914">Patch Management <SubCategory ref="Standard||Kaseya||Procedure" id="274262311559714">Procedure <SubCategory ref="Standard||Kaseya||RCDisabled" id="641624812335116">RC Disabled <SubCategory ref="Standard||Kaseya||Script" id="471482131991414">Script <SubCategory ref="Standard||Kaseya||SystemOffline" id="113411182222324">System Offline <SubCategory ref="Standard||Kaseya||SystemOnline" id="251814418923368">System Online <SubCategory ref="Standard||Kaseya||Unidentified" id="617313577253122">Unidentified Network <SubCategory ref="Standard||Network||Connectivity" id="122145211361321">Connectivity <SubCategory ref="Standard||Network||Design" id="495611529142242">Design <SubCategory ref="Standard||Network||Firewall" id="812515316323522">Firewall <SubCategory ref="Standard||Network||Other" id="946227769167531">Other <SubCategory ref="Standard||Network||Performance" id="941891772111717">Performance Printer <SubCategory ref="Standard||Printer||Other" id="341431321188813">Other <SubCategory ref="Standard||Printer||PrinterProblem" id="851831547314111">Printer Problem <SubCategory ref="Standard||Printer||PrinterSetup" id="619395216749723">Printer Setup <SubCategory ref="Standard||Printer||Toner" id="161984536861723">Toner

56

KSD API Web Service Service Request <SubCategory ref="Standard||ServiceRequest||EquipmentMove" id="862712311517672">Equipment Move <SubCategory ref="Standard||ServiceRequest||NewLaptop" id="266812518245792">New Laptop <SubCategory ref="Standard||ServiceRequest||NewServer" id="322872913227349">New Server <SubCategory ref="Standard||ServiceRequest||NewWorkstation" id="224115236352441">New Workstation <Stages xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd"> <Stage stageType="End"> Closed Standard Enters Closed <Stage stageType="Begin"> Identified Standard Enters Identified <Escalation time="15" unit="MINUTE">Incident is Escalated Identified Goal Tier1 <Stage stageType="Middle"> Tier1 Standard Enters Tier1 <Escalation time="3" unit="HOUR">Incident is Escalated Tier1 Goal Closed Tier2 <Stage stageType="Middle"> Tier2 Standard Enters Tier2 <Escalation time="3" unit="HOUR">Incident is Escalated Tier2 Goal Closed <Participants xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd"> <Participant ref="garyw" id="67511883639135112891416313" isPool="false">garyw <Participant ref="jschenck" id="72381729521421633172123416" isPool="false">jschenck <Participant ref="NickT" id="96171921315349923924634249" isPool="false">NickT <Participant ref="Standard||SupportManager" id="654222596258293" isPool="true">SupportManager (Pool) <Participant ref="Standard||Tier1Support" id="352161952139188" isPool="true">Tier1Support (Pool) <Participant ref="Standard||Tier2Support" id="921522231318131" isPool="true">Tier2Support (Pool) Source <Title>Source Source List Call Call

57

KSD API Web Service EMail Text Urgency <Title>Urgency Urgency List Medium High Low Medium KB Article created <Title>KB Article Created KB_Article List No No Yes Dept <Title>Department Dept List IT Accounting Accounts Payable Facilities HR IT Other Payroll Sales Telecom true true ID Required Summary Required Description Edit CreationDtTm ViewOnly SubmitterName Edit

58

KSD API Web Service SubmitterEmailAddr Edit ContactPhone Edit OrgName Edit OrgID Edit StaffID Edit ContactEmail Edit MachineID Edit Note Edit ClosedDtTm ViewOnly PromiseDtTm Edit DueDtTm ViewOnly ActualCompletedDate ViewOnly HiddenNote Edit Owner Edit LockUser Edit EditDtTm Edit current_esc_datetime Edit current_goal_datetime Edit

59

KSD API Web Service lockTime Edit sourceType Edit Status Edit Priority Edit Severity Edit Category Edit SubCategory Edit Stage Edit Resolution Edit Assignee Edit Source Edit Urgency Edit KB_Article Edit Dept Edit My Note Second note Standard is Changed Standard Goal - All Stages <Method>GetServiceDesk 146

60

KSD API Web Service <ErrorMessage/> <ErrorLocation/>

GetIncidentList Request <req> <ServiceDeskName xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard 30 <SessionID>62648424383576321292545755

GetIncidentList Response <ServiceDeskName>Standard STD000001 <Summary>Getting Started with Service Desk – PLEASE READ! <Status>Closed Low <Stage>Closed Advice & Guidance 2010-02-05T17:07:21.55-08:00 2010-02-05T22:59:22.64-08:00 <Submitter>Kaseya Support <SubmitterEmail>[email protected] <Method>GetIncidentList 147 <ErrorMessage/> <ErrorLocation/>

GetIncident Request <req> STD000001 true true <SessionID>67223225114316912673490269

GetIncident Response

61

KSD API Web Service STD000001 <Summary xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Getting Started with Service Desk – PLEASE READ!
<strong><span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:blue'>WELCOME TO SERVICE DESK
Your Service Desk module has been pre-configured with a template-driven Standard service desk, and a Knowledge Base desk. Only a few short customization steps are required to use these desks immediately. See Getting Started to quickstart your implementation of Service Desk.
<Status xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||Closed Standard||Low <Stage xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||Closed Standard||Advice&Guid ance 2010-02-05T17:07:21.55-08 :00 2010-02-05T22:59:22.64-08 :00 <Submitter xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Kaseya Support <SubmitterEmail xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">[email protected] <SubmitterType xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">UNKNOWN true false garyw POOL Tier1Support 2010-02-05T22:59:29.28-08 :00 <ExpectedCompletionDate xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">2010-02-06T17:07:22.283-0 8:00 false false false <SourceType xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">ServiceDesk Text Low No Sales <Timestamp>2010-02-05T22:59:25.127-08:00

62

KSD API Web Service Auto Generated Note:
Ticket Changed
'currentStageGoalDateTime' cleared
true <User>garyw <Timestamp>2010-02-05T17:07:21.55-08:00 Auto Generated Note:
Ticket Added
true <Method>GetIncident 200 <ErrorMessage/> <ErrorLocation/>

AddIncident Request <req> <ServiceDeskName xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard <Summary xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Test Ticket From Web Service This ticket was created with the web service. <Status xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||New Standard||Medium Standard||Network <SubCategory xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||Network||Connec tivity <SessionID>67223225114316912673490269

AddIncident Response STD000002 249259141859248 <Method>AddIncident 203 <ErrorMessage/> <ErrorLocation/>

63

KSD API Web Service

UpdateIncident Request <req> <ServiceDeskName xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard STD000002 <Summary xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Test Ticket From Web Service This ticket was created with the web service. <Status xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||InProgress Standard||Low <Stage xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||Identified Standard||Printer <SubCategory xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">Standard||Printer||Printe rProblem 2010-03-10T21:07:31.923-0 8:00 2010-03-10T21:07:31.923-0 8:00 <Submitter xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">garyw <SubmitterType xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">UNKNOWN true false 2010-03-10T21:22:43.063-0 8:00 2010-03-10T22:07:43.077-0 8:00 garyw POOL Tier1Support <ExpectedCompletionDate xmlns="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd">2010-03-11T21:07:43.077-0 8:00 false false false <User>garyw <Timestamp>2010-03-10T21:07:31.923-08:00 Auto Generated Note:
Ticket Added
true

64

KSD API Web Service

UpdateIncident Response <Method>UpdateIncident 205 <ErrorMessage/> <ErrorLocation/>

65

Kaseya 2. Gebruikershandleiding. Versie 6,0

Recommend Documents