Servicios web API. Kaseya R8 Virtual System Administrator

C a p í t u l o 1 2

Servicios web API

En este capítulo

Servicio web API para el VSA ........................................................................................ 524

Servicio web API para el procedimiento de agente ....................................................... 573

Servicio web API para supervisión ................................................................................. 574

Servicio web API para KSD ............................................................................................ 580

523

Servicios web API

Servicio web API para el VSA

En esta sección

Introducción al servicio web API para el VSA ................................................................ 524

Servicio web API para el VSA: Operaciones ................................................................. 536

...................................................................................................................................... 571

Introducción al servicio web API para el VSA

El servicio web API

para el VSA proporciona una interfaz generalizada para que el cliente se relacione con el VSA en forma programática. Este API facilita la interconexión del cliente con un paquete de terceros. El API se concentra en los siguientes servicios:

 Conectar : este servicio permite que el consumidor del API autentique y reciba una GUID para usar a lo largo de la comunicación. Esta GUID caduca de manera similar a la que caducan los usuarios.

 Tickets

: este servicio ofrece las funciones básicas para que el usuario sea notificado acerca de nuevos tickets. Esta función permite a los usuarios actualizar los campos en un ticket.

 Alarmas : este servicio ofrece las funciones básicas para que el usuario sea notificado acerca de nuevas alarmas y marca alarmas como cerradas.

 Máquinas

: este servicio provee una solicitud para recopilar un conjunto de datos sobre una o más máquinas.

El servicio web API

para el VSA se basa en el lenguaje de descripción de servicios web (WSDL)

. El WSDL aparece en un navegador y provee una descripción abstracta de los datos que se intercambian hacia y desde un servicio Web. Un programa del cliente que se conecta a un servicio Web puede leer el

WSDL para determinar qué funciones están disponibles en el servidor. Cualquier tipo de datos especial se incluye en el archivo WSDL en la forma de un esquema XML. El cliente puede usar SOAP para llamar a una de estas funciones listadas en el WSDL.

524

El siguiente es un ejemplo de salida de vsaWS:

Servicios web API

Habilitación del servicio web API para el VSA

Para habilitar el servicio web API para el VSA, realice lo siguiente:

 Abra la página Sistema > Configurar

(página 423)

en el VSA.

 Active la casilla de verificación Habilitar servicio web API para el VSA

.

 Acceda al servicio web API para el VSA en http://<your-KServer>/vsaWS/KaseyaWS.asmx.

Nota: El servicio web API para KSD (http://help.kaseya.com/webhelp/ES/KSD/R8/index.asp#5761.htm) describe operaciones de la API adicionales para

Service Desk

.

Campos especiales

Los siguientes campos se incluyen en respuesta a cada solicitud:

Method

TransactionID string decimal

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

ErrorMessage

ErrorLocation string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

El servicio Web crea una ID de sesión y se devuelve al cliente la primera vez que el cliente invoca un método. Esa misma ID de sesión debe devolverse al cliente con cada método invocado durante la

525

Servicios web API sesión. La SessionID sólo es válida cuando se recibe desde la misma dirección IP de la que se origina la autenticación.

Aplicación API C# de muestra

Con el servicio web API del VSA, se distribuyen un cliente de prueba de GUI y un conjunto de XML de prueba para ayudarlo a familiarizarse con las diferentes operaciones de la API. El código fuente C# para la aplicación API C# de muestra se proporciona sin restricciones. Puede usarlo para ver cómo se construyó el cliente e incorporar cualquier parte de su código a su propia aplicación.

Nota:

También se proporciona una página ASP de API de muestra (página 528).

526

Para ejecutar el cliente de muestra:

1. Ejecute el cliente de muestra ubicado en su Kaseya Server:

<Install Dir>\vsaWs\TestClient\KaseyaWStestClient.exe.

2. Introduzca el nombre de usuario y la contraseña de un usuario autorizado para conectarse al Kaseya

Server.

3. Seleccione la opción de algoritmo hash que se debe utilizar. Consulte Autenticar

(página 539)

para obtener más detalles.

Nota: Este es el mismo nombre de usuario y contraseña que usa un administrador para iniciar sesión en Kaseya Server.

4. Haga clic en el botón Conectarse para mostrar un valor en el campo SessionID .

5. Haga clic en el botón Navegar para seleccionar un archivo XML de prueba. Esto completa el cuadro de texto SendXML con el texto del archivo XML.

Nota: No es necesario que introduzca un valor entre las etiquetas de elemento <SessionID> del mensaje XML de prueba. El Cliente de muestra inserta automáticamente la SessionID que se muestra en cualquier mensaje XML cuando hace clic en el botón Enviar.

Servicios web API

6. Haga clic en el botón Enviar para enviar un mensaje XML al URL de destino. Se muestra un mensaje XML de respuesta en el cuadro de texto

ResponseXML

.

527

Servicios web API

Página ASP de API de muestra

Con el servicio web API del VSA, también se distribuye una página ASP de cliente de prueba para ayudarlo a familiarizarse con las diferentes operaciones de la API. Puede usarlo para ver cómo se construyó el cliente ASP e incorporar cualquier parte de su código a su propia aplicación. Los usuarios pueden navegar a la página /vsaWS/KaseyaWS.asmx propiamente dicha de cualquier Kaseya Server, seleccionar un método web y copiar y pegar la estructura exacta de la solicitud SOAP en XML especificada en el WSDL.

La autenticación está en su propio marco en la parte superior de la página. La sessionID de una autenticación exitosa queda expuesta y puede copiarse y pegarse en solicitudes XML posteriores.

Nota: Esta página no incorpora en forma automática el sessionID que se muestra en instrucciones de

solicitud subsiguientes como lo hace la aplicación API C# de muestra (página 526).

Ejemplo 1: Autenticación

1. Acceda al cliente de prueba ASP del servicio web API del VSA en http://<your-KServer>/vsaWS/TestClient/TestClient.asp.

2. Introduzca un nombre de usuario y contraseña de administrador del VSA válidos y haga clic en

Iniciar sesión.

3. Seleccione la opción de algoritmo hash

que se debe utilizar. Consulte

Autenticar

(página 539)

para obtener más detalles.

Se completa el cuadro de texto de la ID de sesión con la ID de sesión generada por su conexión.

Deberá copiar y pegar esta ID de sesión en solicitudes XML posteriores.

528

Servicios web API

Ejemplo 2: creación de Obtener solicitud

1. En una segunda ventana del navegador, use la página /vsaWS/KaseyaWS.asmx para seleccionar un método, por ejemplo GetLogEntry.

2. Cada método muestra la estructura SOAP en XML para la solicitud de ese método. Copie sólo la porción de la estructura de la solicitud del método que comienza con <req> y termina con </req>.

529

Servicios web API

3. Pegue la estructura de la solicitud en el panel Solicitud de la página TestClient.asp. Ingrese el nombre del método en el campo Nombre de método Web. Reemplace el decimal del marcador de posición con la cadena sessionID que obtuvo durante la autenticación. Reemplace el contenido de los demás marcadores de posición con datos válidos según sea necesario. Luego haga clic en el botón Enviar.

Nota: El elemento <BrowserIP></BrowserIP> en cualquier método se puede ignorar. Consulte

Limitación de solicitudes por dirección IP y usuario

(página 535) para obtener más información.

El resultado se muestra en el panel Respuesta.

530

Servicios web API

Seguridad del servicio web API para el VSA

General

De manera predeterminada, puede accederse al servicio web API para el VSA desde cualquier dirección IP del mundo mediante cualquier credencial de usuario del VSA válida. En esta configuración predeterminada, para la autenticación desde cualquier máquina se consideran combinaciones de nombre de usuario / contraseña válidas.

En cualquier configuración, se debe usar el hash.dll suministrado por el VSA para cifrar la contraseña para su envío. Los detalles de implementación del hash.dll se encuentran en el código fuente de muestra proporcionado.

Una vez que la solicitud de autenticación emite una SessionID, esta SessionID debe enviarse con cada invocación de servicio y sólo es válida cuando se recibe desde la dirección IP desde la que fue emitida. La SessionID emitida caduca después de un período de inactividad.

Para aumentar la seguridad, se puede preparar e implementar un archivo AccesRules.xml. El servicio web API para el VSA usa este archivo para definir reglas de acceso basadas en las direcciones IP desde las que se reciben las solicitudes. El filtrado de IP es un mecanismo que se usa comúnmente en los sistemas inter empresariales para asegurar que las solicitudes se cumplan sólo desde los servidores del socio.

El archivo AccessRules.xml se divide en tres secciones:

 Reglas de acceso predeterminadas

 Rangos de IP

 Mapeo de usuario

Nota: 127.0.0.1 (localhost) siempre tiene acceso a cualquier cuenta, independientemente de la configuración.

Estructura XML

< AccessRules >

< DefaultAccessRules >

<

<

GrantAnyIPToUndefinedUsers />

GrantAllIPRangesToUndefinedUsers />

< DenyAccessToUndefinedUsers />

</ DefaultAccessRules >

< IPRanges >

< IPRange RangeID ="" FromIPAddress ="" ToIPAddress ="" RangeDescription =""/>

< IPRange RangeID ="" FromIPAddress ="" ToIPAddress ="" RangeDescription =""/>

</ IPRanges >

< UserMapping >

< User UserName ="" RangeID ="" GrantAllRanges ="" GrantAnyIP ="" DenyAccess =""/>

< User UserName ="" RangeID ="" GrantAllRanges ="" GrantAnyIP ="" DenyAccess =""/>

</ UserMapping >

</ AccessRules >

Reglas de acceso predeterminadas

Los elementos de esta sección definen las reglas de acceso para aquellas cuentas que no están direccionadas en forma específica en la sección Mapeo de usuario.

< GrantAnyIPToUndefinedUsers/ > true/false verdadero: Cualquier usuario que no esté en UserMapping obtiene acceso desde cualquier dirección IP.

< GrantAllIPRangesToUndefinedUsers/ > true/false verdadero: Cualquier usuario que no esté en UserMapping obtiene acceso desde cualquier dirección IP contenida en IPRanges.

< DenyAccessToUndefinedUsers/ > true/false verdadero: Cualquier usuario que no esté en UserMapping al que se le denega el acceso.

531

Servicios web API

Rangos de IP

Esta sección se usa para definir máquinas específicas o rangos de máquinas, por IP, que se usan para asignar acceso a usuarios.

RangeID ="integer"

Un entero arbitrario, asignado por el usuario que se usa para referirse al Rango en UserMapping.

FromIPAddress ="string"

La dirección IP de inicio, inclusiva. Las primeras tres posiciones del cuarteto deben coincidir con

ToIPAddress.

ToIPAddress =" string"

La dirección IP final, inclusiva. Las primeras tres posiciones del cuarteto deben coincidir con

FromIPAddress.

RangeDescription =" string"

Descripción del Rango IP. Por ejemplo: "Servidores de producción"

Mapeo de usuario

UserName ="string"

El nombre del administrador del VSA. El servicio web API para el VSA usa el mismo cifrado de credenciales y contraseña que el VSA. Por lo tanto, si cambia su contraseña en el VSA, asegúrese de cambiarla también en su implementación de cliente del servicio web API para el VSA.

RangeID ="integer"

Se usa para señalar a un Rango IP definido en la sección Rangos IP. El usuario puede tener múltiples elementos de UserMapping para expresar todos los Rangos IP desde los que tiene acceso. No se usa cuando se usan uno de los siguientes atributos Otorgar / Denegar.

GrantAllRanges ="true/false" verdadero: El usuario tiene acceso desde cualquier rango definido en la sección Rangos IP.

GrantAnyIP =" true/false" verdadero: El usuario tiene acceso desde cualquier dirección IP.

DenyAccess =" true/false" verdadero: El usuario no tiene acceso.

XML de configuración de acceso de muestra

< AccessRules >

< DefaultAccessRules >

<

<

GrantAnyIPToUndefinedUsers > false

GrantAllIPRangesToUndefinedUsers

</

>

GrantAnyIPToUndefinedUsers false </

>

GrantAllIPRangesToUndefinedUsers >

< DenyAccessToUndefinedUsers > true </ DenyAccessToUndefinedUsers >

</ DefaultAccessRules >

< IPRanges >

< IPRange RangeID =" 1 " FromIPAddress =" 192.168.214.01

" ToIPAddress =" 192.168.214.10

"

RangeDescription =" Partner X Production Web Farm "/>

< IPRange RangeID =" 2 " FromIPAddress =" 192.168.15.102

" ToIPAddress =" 192.168.15.102

"

RangeDescription =" Senior Developer Machine "/>

< IPRange RangeID =" 3 " FromIPAddress =" 192.168.15.105

" ToIPAddress =" 192.168.15.109

"

RangeDescription =" Sales Demo Machines "/>

< IPRange RangeID =" 4 " FromIPAddress =" 192.168.210.35

" ToIPAddress =" 192.168.210.35

"

RangeDescription =" Interal QA Machine "/>

</ IPRanges >

< 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 "/>

< User UserName =" SalesTestAccount2 " RangeID =" 3 " GrantAllRanges =" false " GrantAnyIP =" false "

DenyAccess =" false "/>

< User UserName =" QAMasterAdmin " RangeID =" 4 " GrantAllRanges =" false " GrantAnyIP =" false "

DenyAccess =" false "/>

532

Servicios web API

< User UserName =" SalesTravellingTestAccount " RangeID ="" GrantAllRanges =" false "

GrantAnyIP =" true " DenyAccess =" false "/>

<

<

User

User

UserName

UserName

="

="

Bob " RangeID

Sally "

=""

RangeID

GrantAllRanges

=""

=" true

GrantAllRanges ="

" GrantAnyIP false "

=" false

GrantAnyIP ="

" DenyAccess false "

=" false "/>

DenyAccess =" true "/>

</ UserMapping >

</ AccessRules >

Vínculos Web - Entrantes y salientes

Además de las operaciones de la API que se describen más adelante en el documento, Kaseya Server también admite los siguientes vínculos de entrada y de salida:

Entrantes

El URL para mostrar la página Web Ticket para una ID de ticket específica es: http://...?ticid=<TicketID>

Por ejemplo: http://demo.kaseya.com?ticid=1234

Salientes

Para personalizar los vínculos de Nuevo ticket en la página Live Connect , complete el archivo externalLink.xml como se describe en la sección de comentarios del XML a continuación. Para activar el nuevo vínculo de ticket, coloque el archivo externalLink.xml en el directorio \WebPages\install\ de Kaseya Server.

<?xml version="1.0" encoding="ISO-8859-1" ?>

< externalLinks >

<!--

URL STRING SUBSTITUTIONS: The URL string displayed is associated

with a particular machine ID. The string is searched for the following

case sensitive values and substituted for the values below.

machineNameVal - the machine name for the active machine is substituted

in the URL string.

groupNameVal - the group name for the active group.

533

Servicios web API

-->

< ticketLink displayName =" Ext Ticket " url =" http://192.168.212.52/?mname=machineNameVal&amp;gname=groupNameVal "/>

</ externalLinks >

534

C a p í t u l o 1 3

Limitación de solicitudes por dirección IP y usuario

En algunas operaciones, como AddTicRequest

(página 538)

, se incluye un elemento <BrowserIP> en la solicitud.

<BrowserIP> string </BrowserIP>

Este elemento se puede usar para limitar las solicitudes a un intervalo de direcciones IP especificado.

También puede limitar las solicitudes a usuarios seleccionados. Asimismo, este elemento se puede ignorar.

Para habilitar esta característica:

1. Ubique el archivo AccessRights.xml en el directorio <KaseyInstallationDirectory>\vsaWS.

2. Actualice el archivo con intervalos IP especificados y, opcionalmente, con usuarios.

3. Mueva el archivo al directorio <KaseyInstallationDirectory>\vsaWS\bin.

4. Reinicie IIS.

AccessRights.xml

<AccessRules>

<DefaultAccessRules>

<GrantAnyIPToUndefinedUsers> false </GrantAnyIPToUndefinedUsers>

<GrantAllIPRangesToUndefinedUsers> false </GrantAllIPRangesToUndefinedUsers>

<DenyAccessToUndefinedUsers> true </DenyAccessToUndefinedUsers>

</DefaultAccessRules>

<IPRanges>

<IPRange RangeID =

"1"

FromIPAddress =

"192.168.214.01"

ToIPAddress =

"192.168.214.10"

RangeDescription =

"Partner X

Production Web Farm"

/>

<IPRange RangeID =

"2"

FromIPAddress =

"192.168.15.102"

ToIPAddress =

"192.168.15.102"

RangeDescription =

"Senior

Developer Machine"

/>

<IPRange RangeID =

"3"

FromIPAddress =

"192.168.15.105"

ToIPAddress =

"192.168.15.109"

RangeDescription =

"Sales Demo

Machines"

/>

<IPRange RangeID =

"4"

FromIPAddress =

"192.168.210.35"

ToIPAddress =

"192.168.210.35"

RangeDescription =

"Internal QA

Machine"

/>

</IPRanges>

<UserMapping>

<User UserName =

"B2BMasterAdmin"

RangeID =

"1"

<User UserName =

<User

<User

<User

<User

UserName

UserName

UserName

UserName

=

=

=

=

"DevTestAccount"

"QAMasterAdmin"

RangeID =

"SalesTestAccount"

"SalesTestAccount2"

RangeID

RangeID =

"SalesTravellingTestAccount"

"2"

RangeID =

=

"4"

GrantAllRanges

GrantAllRanges

RangeID =

""

=

GrantAllRanges =

"3"

"3"

GrantAllRanges

=

=

"false"

"false"

GrantAllRanges =

"false"

"false"

GrantAnyIP =

GrantAnyIP =

"false"

GrantAnyIP =

GrantAllRanges

GrantAnyIP

GrantAnyIP =

=

"false"

=

"false"

"false"

"false"

"false"

"false"

DenyAccess =

DenyAccess

DenyAccess

GrantAnyIP =

"true"

=

DenyAccess =

=

DenyAccess =

"false"

"false"

"false"

"false"

"false"

/>

/>

/>

/>

/>

DenyAccess =

"false"

/>

<User UserName

</UserMapping>

=

"Bob"

RangeID =

""

GrantAllRanges =

"true"

GrantAnyIP =

"false"

DenyAccess =

<User UserName =

"Sally"

RangeID =

""

GrantAllRanges =

"false"

GrantAnyIP =

"false"

"false"

/>

DenyAccess =

"true"

/>

</AccessRules>

535

Servicios web API

Servicio web API para el VSA: Operaciones

Se pueden realizar las siguientes operaciones mediante el

Servicio web API para el VSA

:

AddMachGrouptoScope

Agrega una máquina por GroupName a ScopeName.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddOrg

Agrega una organización.

Se devuelve un registro simple de los siguientes campos. orgOutId orgOutRef

Method

TransactionID

ErrorMessage

ErrorLocation decimal string string decimal string string

La ID de organización de la organización recientemente agregada.

El nombre totalmente calificado de la organización. Utiliza notación de punto si existen organizaciones matrices o secundarias. Ejemplos:

 neworgname

 parentorgname.neworgname

 parentorgname.childorgname.neworgname

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddOrgDepartment

Agrega un departamento a una organización.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddOrgDeptStaff

Agrega un miembro de personal al departamento de una organización.

Campos de solicitud seleccionada

 Estado : introduzca 0 o deje en blanco. El VSA no la utiliza.

 Ver todos los tickets : si el resultado es verdadero, el usuario del VSA asociado con este miembro del personal puede ver todos los tickets en su ámbito, así como los tickets asociados con este

536

Servicios web API registro específico del miembro del personal. Si el resultado es falso, el usuario del VSA sólo puede ver los tickets asociados con este registro específico del miembro del personal. Para obtener más información, consulte Sistema > Orgs/Grupos/Deptos/Personal > Administrar >

Administrar - pestaña Personal

(página 420)

.

Respuesta

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddOrgToScope

Agrega una organización a un ámbito.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddScope

Agrega un ámbito.

Se devuelve un registro simple de los siguientes campos. scopeOutId

Method

TransactionID

ErrorMessage

ErrorLocation decimal string decimal string string

El identificador del ámbito creado.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddScopeOrg

Agrega una organización y un ámbito en un pase y asocia la organización al ámbito.

Se devuelve un registro simple de los siguientes campos. orgOutId orgOutRef

Method

TransactionID

ErrorMessage decimal string string decimal string

El identificador de la organización creada.

El nombre totalmente calificado de la organización. Utiliza notación de punto si existen organizaciones matrices o secundarias. Ejemplos:

 neworgname

 parentorgname.neworgname

 parentorgname.childorgname.neworgname

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

537

Servicios web API

ErrorLocation string Si está en blanco, no devolvió error.

AddTicRequest

Agrega un TicketRequest provisional.

Se devuelve un registro simple de los siguientes campos. newId

Method

TransactionID

ErrorMessage

ErrorLocation string string decimal string string

Identificador único.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddUserToRole

Agrega un usuario a un rol de usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AddUserToScope

Agrega un usuario a un ámbito.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AdminGroupAccess

Asigna un grupo de máquinas a un rol de usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AssignRole

Asigna o remueve un usuario de un rol de usuario.

538

Servicios web API

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AssignScope

Asigna o remueve un usuario de un ámbito.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Autenticar

Necesario para iniciar la sesión del servicio web API para el VSA. La SessionID que se devuelve debe enviarse con cada método invocado durante la sesión. La SessionID sólo es válida cuando se recibe desde la misma máquina en la que se origina la autenticación.

Se devuelve un registro simple de los siguientes campos.

SessionID decimal

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La ID única de sesión asignada a una conexión de usuario con el URL de destino.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error. Los posibles mensajes de error devueltos incluyen los siguientes:

 username/password incorrect



API disabled



API disabled for tenant

 user disabled



IP address incorrect

Si está en blanco, no devolvió error.

Conexión automática durante la autenticación

Cuando realiza la autenticación a través de la API, también inicia sesión automáticamente en el VSA.

Si ya tiene una sesión iniciada en el VSA en el momento de la autenticación, las 2 sesiones se sincronizan. De cualquier manera, el resultado es el mismo: termina con sesiones válidas en ambos mundos.

El VSA busca el SessionID de 26 dígitos de la API en la cadena de consulta de cada página del VSA.

Si la aplicación lo redirige a una página del VSA, esta se muestra sin obligar al usuario a que inicie sesión nuevamente. La sintaxis es:

URL?apiLogonGuid=12345678901234567890123456

Por ejemplo: http://someServer:123/Systemtab/SomePage?apiLogonGuid=12345678901234567890123456&SomeVar=SomeValue

La actividad de la API mantiene activa la sesión del VSA. Sin embargo, debido a que el VSA no presupone que siempre hay necesidad de una sesión de API, la actividad del VSA no mantiene activa

539

Servicios web API dicha sesión.

La API utiliza el mismo valor de tiempo de espera que el VSA, que se mantiene mediante la página

Directiva de inicio de sesión

(página 438)

del VSA, en Sistema, y tiene un valor predeterminado del sistema de 30 minutos.

Algoritmo hash

Con la versión 6.2, K2 adoptó el algoritmo hash SHA-256 para autenticaciones seguras.

Anteriormente, el estándar era el SHA-1. Consulte el tema Cambio de contraseñas que usan las aplicaciones externas

(página 407)

de la ayuda del sistema en línea para acceder a una introducción general sobre esta mejora.

 A las contraseñas recientemente creadas o restablecidas se les aplica el algoritmo hash

SHA-256.

 Las contraseñas heredadas que no fueron restablecidas siguen requiriendo SHA-1.

 Si se deja en blanco, el parámetro HashingAlgorithm en Autenticar tiene como valor predeterminado SHA-1.

 En Aplicación API C# de muestra

(página 526)

y en la página ASP de API de muestra

(página 528)

, se proporciona una opción para alternar el algoritmo hash entre SHA-1 y SHA-256.

 Las contraseñas del VSA sólo se pueden restablecer mediante la aplicación VSA, no mediante la

API.

Advertencia:

Al cambiar una contraseña que utiliza una aplicación externa heredada, se deshabilita la integración

hasta que la aplicación externa se actualice para usar el algoritmo hash SHA-256 o hasta que se cree una credencial SHA-1 nueva y se implemente. Asegúrese de no cambiar las contraseñas que usan las aplicaciones externas antes de que se implemente la actualización. Consulte

Creación de una credencial SHA-1 nueva para una aplicación externa heredada

a continuación.

Prácticas recomendadas

Para asegurar una migración sin problemas de versiones anteriores a esta versión, Kaseya recomienda que el código de cliente de servicios web API se escriba o modifique para intentar una autenticación primero en SHA-256 y después en SHA-1, en orden sucesivo. Esto asegura que el código de cliente sea compatible con contraseñas creadas en la versión actual y en versiones anteriores del VSA.

1. Establezca el parámetro HashingAlgorithm en la solicitud Autenticar en SHA-256. Asegúrese de que se aplique el algoritmo hash SHA-256 a la contraseña. Emita la solicitud Autenticar .

Compruebe si se devuelve un ID de sesión válido.

 La autenticación es correcta si el parámetro SessionID devuelve un valor distinto de cero y el parámetro ErrorMessage está en blanco.

 La autenticación no es correcta si el parámetro SessionID devuelve un valor igual a cero.

Realice el paso 2.

2. Establezca el parámetro HashingAlgorithm en SHA-1. Vuelva a aplicar un algoritmo hash

(SHA-1) al valor de la contraseña. Emita nuevamente la solicitud Autenticar . Compruebe si se devuelve un ID de sesión válido.

Creación de una credencial SHA-1 nueva para una aplicación externa heredada

Si está ejecutando la versión 6.2 del VSA o una versión superior, y necesita crear un nombre de usuario y una contraseña de SHA-1 que sean compatibles con una aplicación externa heredada, y estos aún no se actualizaron para ser compatibles con las contraseñas de la versión 6.2, use uno de los siguientes procedimientos. Puede crear un usuario maestro y una contraseña nuevos o restablecer la contraseña de un usuario maestro existente.

Nota: Debe tener privilegios de administrador en Kaseya Server. Por razones de seguridad, no puede realizar el siguiente procedimiento en forma remota.

540

Servicios web API

Crear una nueva cuenta de usuario maestro

1. Conéctese a la máquina que ejecuta Kaseya Server.

2. Acceda a la siguiente página web: http://localhost/localAuth/setAccountV61.asp

3. Ingrese un nuevo nombre de cuenta en el campo

Nombre de usuario maestro

.

4. Ingrese una contraseña en el campo Ingresar contraseña y confírmela escribiéndola nuevamente en el campo

Confirmar contraseña

.

5. Ingrese una dirección de correo electrónico en la Dirección de correo electrónico .

6. Haga clic en Crear .

La aplicación externa ahora puede actualizarse para usar la nueva cuenta de usuario y la contraseña de SHA-1 para conectarse al VSA.

Resetee la contraseña de una cuenta de usuario maestro existente

Nota: La cuenta de usuario maestro no puede deshabilitarse.

1. Conéctese a la máquina que ejecuta Kaseya Server.

2. Acceda a la siguiente página web: http://localhost/localAuth/setAccountV61.asp

3. Ingrese un nombre de usuario maestro de cuenta habilitado y existente en el campo Nombre de usuario maestro

.

4. Ingrese una contraseña en el campo Ingresar contraseña y confírmela escribiéndola nuevamente en el campo

Confirmar contraseña

.

5. Omita la Dirección de correo electrónico . No es posible resetear la dirección de correo electrónico de un usuario existente utilizando esta página Web.

6. Haga clic en Crear .

La aplicación externa ahora puede actualizarse para usar la nueva contraseña de SHA-1 para conectarse al VSA.

AuthenticateWithAppSessionID

Obtiene el SessionID de API de una AppSession válida. Sólo disponible de un servidor local.

Se devuelve un registro simple de los siguientes campos.

SessionID decimal

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La ID única de sesión asignada a una conexión de usuario con el URL de destino.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error. Los posibles mensajes de error devueltos incluyen los siguientes:

 username/password incorrect



API disabled



API disabled for tenant

 user disabled



IP address incorrect

Si está en blanco, no devolvió error.

Nota:

: Consulte Autenticar (página 539) para iniciar una nueva sesión.

541

Servicios web API

CloseAlarm

Cierra la alarma para la MonitorAlarmID enviada. En la interfaz de usuario del VSA, las alarmas se cierran manualmente en la página Resumen de Alarmas

(página 253)

de Monitor.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

CreateAdmin

Crea un usuario del VSA. Se debe aplicar un algoritmo hash a la contraseña.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

CreateAgentInstallPackage

Crea un paquete de instalación de agente.

Solicitud

<?

xml version =

"1.0" encoding =

"utf-8"

?>

<req>

<GroupName> string </GroupName>

<DefaultAccount> decimal </DefaultAccount>

<AgentType> int

</AgentType>

<CommandLineSwitches> string

</CommandLineSwitches>

<PackageName> string </PackageName>

<PackageDescription> string </PackageDescription>

<BrowserIP> string </BrowserIP>

<SessionID> decimal

</SessionID>

</req>

Donde:

 GroupName: nombre del grupo de máquinas, existente o nuevo. (Paso 2 en el asistente para crear paquetes).

 DefaultAccount: optativo. GUID de agente para un agente existente o plantilla para copiar configuración. (Paso 4).

 AgentType: -1 = Auto, 0 = Windows, 4 = MAC, 5 = Linux. (Paso 5).

 CommandLineSwitches: no requiere explicación. (Paso 3).

 PackageName, PackageDescription: no requiere explicación. (Paso 7).

Respuesta

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID string decimal

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

542

Servicios web API

ErrorMessage

ErrorLocation string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

CreateMachineGroup

Crea un grupo de máquinas.

Se devuelve un registro simple de los siguientes campos. machGroupGuid

Method

TransactionID

ErrorMessage

ErrorLocation decimal string decimal string string

El GUID del grupo de máquinas creado.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

CreateRole

Crea un rol de usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteAdmin

Borra el usuario determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteAgent

Elimina el agente en la máquina de destino y la cuenta de ID de máquina correspondiente en el VSA.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

543

Servicios web API

DeleteAgentInstallPackage

Elimina un paquete de instalación del agente.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteMachineGroup

Elimina el grupo de máquinas determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteOrg

Elimina la organización determinada.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteRole

Elimina el rol de usuario determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteScope

Elimina el ámbito determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID string decimal

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

544

Servicios web API

ErrorMessage

ErrorLocation string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DisableAdmin

Deshabilita un usuario determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Eco

Método de prueba para evaluar conectividad y para estudios comparativos. No requiere autenticación.

Devuelve la cadena enviada.

Se devuelve un registro simple del siguiente campo.

EchoResult string Este valor debe coincidir con el ingreso incluido en la solicitud.

EchoMt

Método de prueba para evaluar conectividad y para estudios comparativos en el nivel medio. Requiere autenticación. Devuelve la cadena enviada. Devuelve (hace eco) la cadena de carga útil enviada.

Se devuelve un registro simple de los siguientes campos.

Payload

Method

TransactionID

ErrorMessage

ErrorLocation string string decimal string string

La cadena enviada con la solicitud.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

EnableAdmin

Habilita un usuario determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetAlarm

Devuelve detalle de alarma para la MonitorAlarmID enviada.

545

Servicios web API

Se devuelve un registro simple de los siguientes campos.

Machine_GroupID agentGuid

MachineName

GroupName

MonitorAlarmID

MonitorType

AlarmType

Message

AlarmSubject

AlarmEmail

EventTime

TicketID

AdminName

MonitorName

LogType

EventType

LogValue

SNMPName

SNMPCustomName

SystemCheckParam1

SystemCheckParam2

MonitorAlarmStateId

Method

TransactionID

ErrorMessage

ErrorLocation string string string int string string string Una representación concatenada de la ID de máquina y la ID de grupo con la está asociada. decimal Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente. string Nombre de Máquina utilizado para cada agente

Nombre de Grupo utilizado por cada agente string int int string string número único de alarma de monitoreo

0 - Contador

1 - Servicio

2 - Proceso

3 - SNMP

4 - Alerta - Las alertas se clasifican además utilizando tipos de alertas

(página 624).

5 - Verificación del sistema

6 - EPS

7 - Monitoreo de registro

0: Alarma

1: Tendencia

Mensaje creado desde la alarma, cuerpo del mensaje del correo electrónico

Asunto de la alarma y asunto del correo electrónico

Dirección(es) de correo electrónico a la que se envía la alarma

Fecha y hora de la alarma

ID de ticket creada desde la alarma

Usuario que asignó el contador de monitoreo a la máquina

Nombre de Obtener objeto SNMP de monitoreo

1: Registro de aplicación

2: Registro de seguridad

3: Registro del sistema int 1: Error

2: Advertencia

4: Informativo

8: Auditoría de aciertos

16: Auditoría de errores decimal Valor que dispara la alarma, si el valor de devolución del comando

Obtener objeto SNMP es una cadena, el valor será el Mensaje string Nombre devuelto desde el Dispositivo SNMP en el escaneo string string string int string

Nombre personalizado para Dispositivo SNMP

Primer parámetro usado en la verificación del sistema

(Opcional) Segundo parámetro usado por la verificación del sistema

1: Abierto, 2: Cerrado

La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string Si está en blanco, no devolvió error. string Si está en blanco, no devolvió error.

546

Servicios web API

GetAlarmList

Devuelve una conjunto de alarmas nuevas agregadas desde la última solicitud predeterminada.

Devuelve todas las alarmas cuando RetunrAllRecords está configurado en verdadero.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

Machine_GroupID string agentGuid

MonitorAlarmID

AlertType

AlarmSubject

EventTime

MonitorAlarmStateI d decimal int int string dateTime int

Una representación concatenada de la ID de máquina y la ID de grupo con la está asociada.

Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente. número único de alarma de monitoreo

Los servicios Alerta son uno de varios tipos de supervisión

(página 624).

1. Cuenta de administrador deshabilitada

2. Alerta de cambios en Obtener archivo

3. Se registró un nuevo agente por primera vez

4. Se instaló o se eliminó la aplicación

5. Se detectó un error en el procedimiento de agente

6. Se detectó un error de Registro de evento NT

7. Kaseya Server se detuvo

8. Se detectó una infracción de la protección

9. Se cambió la configuración de PCI

10. Cambio de configuración de unidad de disco

11. Cambió el tamaño de RAM

12. Correo electrónico de prueba enviado por serverInfo.asp

13. Se completó el informe programado

14. Tipo de alerta de Observación de LAN

15. Agente desconectado

16. Poco espacio en disco

17. Control remoto deshabilitado

18. Agente conectado

19. Se encontró un nuevo parche

20. Falta la ruta del parche

21. Instalación de parche con error

23. Alerta de copia de seguridad

Asunto de la alarma y asunto del correo electrónico

Fecha y hora de la alarma

1: Abierto, 2: Cerrado

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetGroupLicenseInfo

Obtiene el número permitido de asientos para el grupo determinado.

Se devuelve un registro simple de los siguientes campos.

MaxAgents int

Method

TransactionID string decimal

El número máximo de agentes que puede instalarse para este grupo de máquinas.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

547

Servicios web API

ErrorMessage

ErrorLocation string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetLogEntry

Devuelve el detalle de registro de transacción para la TransactionID enviada.

Se devuelve un registro simple de los siguientes campos.

LogTransactionId

LogErrorLocation

LogErrorMessage

LogMethod

ExecutionTimeInSeconds

SessionId

UserName

ClientIP

DateSubmitted

DateUpdated

TransactionXML

Method

TransactionID

ErrorMessage

ErrorLocation decimal string string string decimal decimal string string dateTime dateTime string string decimal string string

El transactionID de registro.

La ubicación del error de registro.

El mensaje del error de registro.

La operación de registro que solicitó una respuesta.

El tiempo de registro requerido para responder a la solicitud.

La ID de la sesión de registro.

El nombre de usuario de registro.

La dirección IP de registro del cliente.

La fecha y hora de registro en que se envío la solicitud.

La fecha y hora de registro en que se devolvió la respuesta.

El mensaje XML utilizado para enviar la solicitud.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetMachine

Devuelve detalle de máquina para la Machine_GroupID enviada.

Se devuelve un registro simple de los siguientes campos.

Machine_GroupID agentGuid machName groupName

Manufacturer

ProductName

MachineVersion

SysSerialNumber

ChassisSerialNumber

ChassisAssetTag

ChassisType

BusSpeed string Una representación concatenada del ID de la máquina y el ID del grupo asociado. decimal Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente. string Nombre de Máquina completo. Todo lo que está a la izquierda de la coma decimal en el extremo izquierdo es el nombre de la máquina. string string string

Nombre de grupo completo para esta cuenta. Lo que esta a la derecha del punto que se encuentra mas a la izquierda es el nombre de grupo.

Fabricante (tipo 1) string string string

Nombre del Producto (tipo 1)

Versión (tipo 1)

Número de Serie (tipo 1)

Número de Serie del Chasis (tipo 3) string string string

Etiqueta del Activo en el Chasis (tipo 3)

Tipo de Chasis (tipo 3)

Velocidad del Bus Externo (en MHz) (tipo 4)

548

Servicios web API

MaxMemorySize

MaxMemorySlots

ChassisManufacturer

ChassisVersion

MotherboardManufacturer

MotherboardProductCode

MotherboardVersion

MotherboardSerialNumber

ComputerName

IpAddress

SubnetMask

DefaultGateway

DnsServer1

DnsServer2

DnsServer3

DnsServer4

DhcpEnabled

DhcpServer

WinsEnabled

PrimaryWinsServer

SecondaryWinsServer

ConnectionGatewayIp

OsType

OsInfo

MajorVersion string string string string string string string string string string string string string string string string int string string string int int

Tamaño Máximo de Módulos de Memoria (en MB) (tipo 16 - Maxima

Capacidad o si el tipo 16 no esta disponible, Tamaño Máximo de

Módulos de Memoria tipo 5)

Cantidad de Ranuras de Memoria Asociadas (Cantidad de

Dispositivos de Memoria en tipo 16 o si el tipo 16 no esta disponible,

Cantidad de Ranuras de Memoria Asociadas en tipo tipo 5)

Fabricante Chasis (tipo 3)

Version de Chasis (tipo 3)

Fabricante del motherboard (placa base) (tipo 2)

Id del producto del motherboard (placa base) (tipo 2)

Número de versión del motherboard (placa base) (tipo 2)

Número de serie del motherboard (placa base) (tipo 2)

Nombre de la Computadora

Dirección de IP de la computadora en notación a.b.c.d

Máscara de subred en notación a.b.c.d. La cadena está vacía si los datos no están disponibles

Dirección de IP de la puerta de enlace predeterminada en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

Dirección de IP #1s servidor DNS en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

Dirección de IP #2s servidor DNS en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

Dirección de IP #3s servidor DNS en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

Dirección de IP #4s servidor DNS en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

0 -> Los datos no están disponibles, 1 -> DHCP habilitado en la computadora cliente, 2 -> Deshabilitado

Dirección de IP de servidores DHCP en notación a.b.c.d. La cadena está vacía si los datos no están disponibles.

0 -> Los datos no están disponibles, 1 -> Resolución WINS habilitada en la computadora cliente, 2 -> Deshabilitado

Dirección de IP de servidores WINS primarios en notación a.b.c.d.

Vacío si el dato no esta disponible.

Dirección de IP de servidores WINS secundarios en notación a.b.c.d.

Vacío si el dato no esta disponible.

Dirección IP en notación a.b.c.d que obtuvo Kaseya Server como dirección de origen del agente. Este IP es la puerta de enlace de red del Agente y será distinta de la IpAddress so la computadora esta, por ejemplo, detrás de un NAT. Vacío si el dato no esta disponible. string string

Cadena que contiene el tipo de SO, como NT4, 2000, NT3.51 o

WIN32s. Derivado de porciones de MajorVersion, MinorVersion, y

PlatformId.

Cadena de caracteres que contiene info adicional del SO, como ser

Build 1381 Service Pack 3. Derivado de pociones de BuildNumber y

CsdVersion. decimal Mayor número de versión de la llamada a la función GetVersionEx() de

Windows.

549

Servicios web API

MinorVersion string El número de versión secundaria de la llamada de función de Windows

GetVersionEx. Si el PlatformId es Win32 para Windows, un 0 en

MinorVersion indica Windows 95. Si el PlatformId es Win32 para

Windows, > 0 en MinorVersion indica Windows 98.

MacAddr

LoginName firstCheckin lastCheckin currentUser lastLoginName lastReboot agentVersion contactName contactEmail contactPhone contactNotes enableTickets enableRemoteControl enableChat credentialName primaryKServer secondaryKServer quickCheckinSecs agentTempDir string string

Cadena de caracteres conteniendo la dirección física, ej. la dirección

MAC (Media Access Control), de la conexión. Una Dirección MAC tiene el formato: 00-03- 47-12-65-77

Nombre de usuario actualmente conectado. Este valor es actualizado con cada registro rápido. El registro de errores del agente es actualizado con cada cambio. dateTime fecha y hora registrando la primera vez que este agente se registróen el sistema dateTime fecha y hora registrando el último y mas reciente registro de este agente en el sistema string nombre de usuario del usuario actualmente conectado. En blanco si no hay nadie conectado en este momento string nombre de usuario del último usuario conectado a este sistema dateTime fecha y hora cuando este sistema fue reiniciado por última vez int string string número de versión del agente instalado en este sistema

Nombre del Contacto asignado a este agente

Correo Electrónico del Contacto asignado a este agente string string int int int

Correo Electrónico del Contacto asignado a este agente

Notas asociadas con la información de contacto para este agente

0 si este usuario no tiene acceso al sistema de tickets a través de la interfaz de usuario

0 si este usuario no tiene acceso a controlar remoto su máquina a través de la interfaz de usuario

0 si este usuario no tiene acceso al chat a través de la interfaz de usuario string string string int string

El usuario de la credencial fijada para este agente (si tiene) address:port al que el agente se conecta para la conexión al Kaseya

Server principal address:port al que el agente se conecta para la conexión al Kaseya

Server secundario el tiempo a esperar, en segundos, antes de realizar otra verificación rápida del agente.

El directorio de trabajo usado por el agente en este sistema

Se devuelven registros múltiples de los siguientes campos, si corresponde.

CpuDesc

CpuSpeed

CpuCount

TotalRam string int int int

Descripción de CPU (por ej. Pentium III Model 8)

Velocidad CPU en MHz (por ej.

Cantidad de procesadores (por ej.

Cantidad de RAM en MBytes (por ej.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

DriveLetter

TotalSpace string int

Letra de la unidad de disco lógica (por ej. C)

MBytes totales en el disco (ej. 28609 para 28,609 GB) Puede ser nulo si no está disponible.

550

Servicios web API

UsedSpace

FreeSpace

DriveType

VolumeName int int string string

Cantidad de MBytes usados (por ej. 21406 para 21.406 GB). Puede ser nulo si no está disponible.

Cantidad de MBytes libres (por ej. 21406 para 21.406 GB). Puede ser nulo si no está disponible.

Fijo = disco duro removible = disquette u otro medio removible de

CDROM de red = unidad de red asignada

Nombre asignado al volumen

FormatType string NTFS, FAT32, CDFS, etc.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetMachineCollectionList

Devuelve una conjunto de las recopilaciones de máquinas. Los elementos devueltos pueden usarse como argumentos en GetMachineList para filtrar resultado.

Se devuelven registros múltiples del siguiente campo, si corresponde. collectionName string El nombre de la recopilación.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetMachineGroupList

Devuelve una conjunto de todos los MachineGroups que la cuenta autenticada tiene privilegios para ver. Los elementos devueltos pueden usarse como argumentos en GetMachineList para filtrar resultado.

Se devuelven registros múltiples del siguiente campo, si corresponde. groupName string La ID de grupo de máquinas.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetMachineList

Devuelve una conjunto de todas las máquinas que el usuario autenticado tiene derechos de acceso para ver. Admite filtrado opcional de la devolución mediante MachineGroup o MachineCollection

551

Servicios web API enviada. Se devuelven registros múltiples de los siguientes campos, si corresponde.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

MachineGroupID string

IpAddress

MacAddr groupName firstCheckin agentGuid string string string datetime decimal

Un grupo de máquinas actualmente existente. Si el campo queda en blanco se devolverán todas las máquinas. la dirección IP de la máquina agente la dirección MAC de la máquina agente

Nombre de Grupo utilizado por cada agente

La primera vez que el agente se registra en el VSA

Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetMachineUptime

Devuelve un conjunto de estadísticas de tiempo activo de máquina para un AgentGuid o un

MachineGroup enviado, o para todas las máquinas cuando ReturnAllRecords se establece en verdadero. rptDate establece la fecha de muestra de inicio del cálculo en la fecha actual.

Todos los resultados se someten a un filtrado de seguridad, incluido el singleton agentGuid y el subgrupo MachineGroup. Por lo tanto, si envía un agentGuid o un MachineGroup que no está autorizado a ver, no recibirá nada.

Se devuelven registros múltiples del siguiente campo, si corresponde. agentGuid machineName totalOnline measureTime latestStatDate olderStatDate decimal string int int dateTime dateTime

Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente.

Nombre de máquina completo. Todo lo que está a la izquierda de la coma decimal en el extremo izquierdo es el nombre de la máquina.

Total de segundos en que el sistema estuvo en línea a través del tiempo de medición.

Total de segundos en que se midió el sistema (último - más antiguo - suspender horas de alarmas).

Última hora en que se midió el sistema, normalmente la última entrada de registro del agente para un sistema fuera de línea.

Primera hora en que se midió el sistema.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetNotesList

Devuelve un conjunto de notas de ticket nuevos agregados desde la última solicitud. Genera un

552

Servicios web API máximo de 500 registros ordenados por fecha y registra el resultado de nota más reciente. El usuario puede continuar ejecutando este método hasta que no devuelva más registros.

 AddedSince: Al incluir esta fecha en la solicitud, se reemplaza el comportamiento predeterminado del sistema “desde última lectura”.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

TicketID

Author

DateEntered

NoteText int string dateTime string

La ID de ticket.

El autor de la nota.

La fecha en que se creó o modificó la nota por última vez.

El texto de la nota.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetOrgLocation

Devuelve la dirección física de una organización, incluyendo latitud y longitud.

Se devuelve un registro simple de los siguientes campos. orgId orgRef partitionId orgName street city usState postalCode country countryCode longitude latitude

Method

TransactionID

ErrorMessage

ErrorLocation string string string string string string string string string string string string string decimal string string

Identificador único.

Nombre único.

Identificador de abonado.

El nombre de la organización.

La dirección física.

La ciudad.

El estado.

El código postal.

El país.

El código de país.

La longitud de la ubicación de la organización.

La latitud de la ubicación de la organización.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetOrgTypes

Devuelve detalle de máquina para la Machine_GroupID enviada.

Se devuelven registros múltiples de los siguientes campos. orgTypeID orgTypeRef decimal Identificador único. string El nombre único del tipo de organización.

553

Servicios web API status description int string

1=Activo

Una descripción del tipo de organización.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string Si está en blanco, no devolvió error. string Si está en blanco, no devolvió error.

GetOrgs

Devuelve las organizaciones a las que puede acceder el usuario conectado al VSA.

Se devuelven registros múltiples del siguiente campo, si corresponde. orgID orgName orgRef

CustomerID string string string string

Identificador único.

El nombre de la organización.

Nombre único.

Identificador de cliente único.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage string decimal string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

ErrorLocation string Si está en blanco, no devolvió error.

GetOrgsByScopeID

Devuelve las organizaciones a las que puede acceder un ámbito determinado.

Se devuelven registros múltiples del siguiente campo, si corresponde. orgID orgName orgRef

CustomerID string string string string

Identificador único.

El nombre de la organización.

Nombre único.

Identificador de cliente único.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetPackageURLs

Obtiene una lista de todos los URL de los paquetes de distribución de agente disponibles para el usuario registrado.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

554

Servicios web API

URL

PackageName

Description

AgentType string string string string

El URL.

El nombre del paquete de distribución de agente.

La descripción del paquete de distribución de agente.

El tipo de agente que se registra.

0 = Windows

4 = Apple

5 = Linux

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetPartnerUserLocation

Devuelve la ubicación de un usuario del VSA específico del abonado, incluidas la latitud y la longitud del usuario del VSA.

Se devuelve un registro simple de los siguientes campos. adminId adminName partitionId longitude latitude

Method

TransactionID

ErrorMessage

ErrorLocation string string string string string string decimal string string

El identificador único del usuario del VSA.

El nombre de usuario del VSA.

El identificador del abonado.

La longitud de la ubicación del usuario del VSA.

La latitud de la ubicación del usuario del VSA.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetPublishedViewColumns

Devuelve un conjunto de todas las columnas para la vista de una base de datos publicada.

Nota: Puede revisar la documentación para conocer las vistas disponibles de la base de datos en Vistas de

base de datos > Vistas proporcionadas (página 476).

Se devuelven registros múltiples de los siguientes campos. name dataType string string

Nombre de la columna de vista de base de datos.

Tipo de datos de la columna de vista de la base de datos.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

555

Servicios web API

Ejemplo

Nota: El siguiente ejemplo se ejecutó mediante la página de prueba publicada con cada instalación, ubicada en http://localhost/vsaWS/testClient/testClient.asp.

Solicitud

< req >

< viewName > vScriptLog </ viewName >

< SessionID > 42131527423841487151422001 </ SessionID >

</ req >

Respuesta

< GetPublishedViewColumnsResponse >

< GetPublishedViewColumnsResult >

< PublishedViewColumns >

< PublishedViewColumn >

< name > AdminName </ name >

< dataType > varchar(100) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > agentGuid </ name >

< dataType > numeric(26,0) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > EventTime </ name >

< dataType > datetime </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > groupName </ name >

< dataType > varchar(100) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > Machine_GroupID </ name >

< dataType > varchar(201) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > machName </ name >

< dataType > varchar(100) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > ScriptDesc </ name >

< dataType > varchar(1000) </ dataType >

</ PublishedViewColumn >

< PublishedViewColumn >

< name > ScriptName </ name >

< dataType > varchar(260) </ dataType >

</ PublishedViewColumn >

</ PublishedViewColumns >

< Method > GetPublishedViewColumns </ Method >

< TransactionID > 3 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ GetPublishedViewColumnsResult >

</ GetPublishedViewColumnsResponse >

GetPublishedViewRows

Devuelve un conjunto de todas las columnas para la vista de una base de datos publicada ante una sentencia WHERE.

Nota: Puede revisar la documentación para conocer las vistas disponibles de la base de datos en Vistas de

base de datos > Vistas proporcionadas (página 476).

556

Servicios web API

Se devuelve un registro simple de los siguientes campos.

PublishedViewRows

Method

TransactionID

ErrorMessage

ErrorLocation string Conjunto de datos de filas. string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Ejemplo

Nota: El siguiente ejemplo se ejecutó mediante la página de prueba publicada con cada instalación, ubicada en http://localhost/vsaWS/testClient/testClient.asp.

Solicitud

< req >

< viewName > vScriptLog </ viewName >

< columnsList > AdminName,agentGuid,EventTime,Machine_GroupID,ScriptDesc,ScriptName </ columnsList >

< whereClause > EventTime > DATEADD(hour,4,getdate()) </ whereClause >

< orderByList > agentGuid,EventTime </ orderByList >

< ReturnAllRows > false </ ReturnAllRows >

< SessionID > 42131527423841487151422001 </ SessionID >

</ req >

Equivalente a SQL

select top 5000 AdminName,agentGuid,EventTime,Machine_GroupID,ScriptDesc,ScriptName from vScriptLog where EventTime > DATEADD(hour,-4,getdate()) order by agentGuid,EventTime

Selecciona 6 de las 8 columnas disponibles en vScriptLog en las que hubo actividad dentro de las

últimas 4 horas y ordena los resultados por máquina y, luego, por fecha de actividad.

Nota: Cuando <ReturnAllRows> está establecido como falso, se aplica un conjunto de filas máximo de

5000 para proteger la base de datos de conjuntos de resultados excesivamente grandes.

Respuesta

< GetPublishedViewRowsResponse >

< GetPublishedViewRowsResult >

< PublishedViewRows >

< vScriptLog >

< Row >

< AdminName > *System* </ AdminName >

< agentGuid > 517481450374694 </ agentGuid >

< EventTime > 20100913T09:24:1905:00 </ EventTime >

< Machine_GroupID > xpprox86001.agents.hyperv.kserver

</ Machine_GroupID >

< ScriptDesc > Script Summary: Success THEN </ ScriptDesc >

< ScriptName > KES Update AVG via Internet </ ScriptName >

</ Row >

< Row >

< AdminName > *System* </ AdminName >

< agentGuid > 517481450374694 </ agentGuid >

< EventTime > 20100913T09:24:20.00305:00 </ EventTime >

< Machine_GroupID > xpprox86001.agents.hyperv.kserver

</ Machine_GroupID >

< ScriptDesc > Script Summary: Success THEN </ ScriptDesc >

< ScriptName > KES Update </ ScriptName >

</ Row >

< Row >

< AdminName > *System* </ AdminName >

< agentGuid > 517481450374694 </ agentGuid >

< EventTime > 20100913T09:24:20.00705:00 </ EventTime >

< Machine_GroupID > xpprox86001.agents.hyperv.kserver

</ Machine_GroupID >

557

Servicios web API

< ScriptDesc > Script Summary: Success THEN </ ScriptDesc >

< ScriptName > Run Now KES Update </ ScriptName >

</ Row >

</ vScriptLog >

</ PublishedViewRows >

< Method > GetPublishedViewRows </ Method >

< TransactionID > 4 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ GetPublishedViewRowsResult >

</ GetPublishedViewRowsResponse >

GetPublishedViews

Devuelve un conjunto de todas las vistas de bases de datos publicadas.

Nota: Puede revisar la documentación para conocer las vistas disponibles de la base de datos en Vistas de

base de datos > Vistas proporcionadas (página 476).

Se devuelven registros múltiples de los siguientes campos. viewName string Nombre de la vista de base de datos.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string Si está en blanco, no devolvió error. string Si está en blanco, no devolvió error.

Ejemplo

Nota: El siguiente ejemplo se ejecutó mediante la página de prueba publicada con cada instalación, ubicada en http://localhost/vsaWS/testClient/testClient.asp.

Los detalles de uso de cada vista en esta lista están publicados en Vistas de base de datos

(página 476)

en la ayuda en línea y en la guía del usuario. Puede haber más vistas totales documentadas que las publicadas mediante la API.

Solicitud

< req >

< SessionID > 42131527423841487151422001 </ SessionID >

</ req >

Respuesta

< GetPublishedViewsResponse >

< GetPublishedViewsResult >

< PublishedViews >

< PublishedView >

< viewName > vAddRemoveList </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vAdminNotesLog </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vAgentConfiguration </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vAgentLabel </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vAlertLog </ viewName >

558

</ PublishedView >

< PublishedView >

< viewName > vBackupLog </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBaseApplicationInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBaseCpuInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBaseDiskInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBaseDriveManufacturer </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBasePciInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vBasePrinterInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCollectionMember </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vConfigLog </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrApplicationInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrCpuInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrDiskInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrDriveManufacturer </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrPciInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vCurrPrinterInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vEventDetail </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vEventInstanceDetail </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vEventInstanceHistoryDetail </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vkadComputers </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vkadUsers </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vLicenseInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMachine </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmAlert </ viewName >

Servicios web API

559

Servicios web API

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmCounter </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmProcess </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmService </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmSNMP </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vMonitorAlarmSystemCheck </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vNetStatsLog </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vNtEventLogs </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vOnBoardDeviceInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vPatchApprovalStatus </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vPatchPolicy </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vPatchPolicyMember </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vPatchStatus </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vPortInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vScriptLog </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vScriptStatus </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vSystemInfo </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vTicketField </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vTicketNote </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vTicketSummary </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vUptimeHistory </ viewName >

</ PublishedView >

< PublishedView >

< viewName > vVproAssetDetails </ viewName >

</ PublishedView >

</ PublishedViews >

< Method > GetPublishedViews </ Method >

< TransactionID > 2 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

560

Servicios web API

</ GetPublishedViewsResult >

</ GetPublishedViewsResponse >

GetRoles

Devuelve los roles a los que puede acceder el usuario conectado al VSA.

Se devuelven registros múltiples del siguiente campo, si corresponde.

RoleID

IsActive string boolean

Identificador único

El rol es activo o inactivo.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetScopes

Devuelve los ámbitos a los que puede acceder el usuario conectado al VSA.

Se devuelven registros múltiples del siguiente campo, si corresponde.

ScopeID string Identificador único.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetSessionDetails

Obtiene detalles de sesión de un AppSessionID enviado o de un API SessionID válido. La variante

AppSessionID sólo está disponible de un servidor local.

Se devuelve un registro simple de los siguientes campos. adminId partitionId machineIdFil activeViewId groupIdFil rowPerPage startRow sortField sortOrder

RoleId

AdminRole

ScopeId

AdminScope int decimal string int string int int string int int string decimal string

Identificador de usuario del VSA

Identificador de partición

Valor de sesión del filtro de máquina

Valor de sesión de la vista de máquina

Valor de sesión del filtro de grupo

Valor de sesión de filas por página

Posición inicial en el conjunto de resultados

Campo Ordenar documentos de datos actuales

Orden de los documentos de datos actuales

Identificador de rol

Nombre del rol

Identificador de ámbito

Nombre del ámbito

561

Servicios web API

AppSessionExpiration adminName

Method

TransactionID

ErrorMessage

ErrorLocation dateTime string string decimal string string

Caducidad de la sesión

Nombre de usuario del VSA

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetTicket

Devuelve detalle de ticket para la MonitorTicketID enviada.

TicketID int

Machine_GroupID string agentGuid machName groupName

TicketSummary

Assignee

CreatedBy

CreationDate

DueDate

LastModifiedDate

ResolutionDate

UserName

UserEmail

UserPhone

MonitorAlarmID decimal string string string string string string string string string string string string int

Número de ID único de ticket de problemas

Una representación concatenada del ID de la máquina y el ID del grupo asociado.

Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente.

Nombre de Máquina utilizado para cada agente

Nombre de Grupo utilizado por cada agente

Texto resumen describiendo brevemente el ticket

Nombre del Admin al cual el ticket es asignado

Nombre del Admin (o ID de máquina si fue ingresado por un usuario) de la persona que creóeste ticket

Fecha y hora cuando el ticket fue creado

Fecha de vencimiento del ticket

Fecha del la nota mas reciente ingresada para este ticket

Fecha y hora cuando el ticket fue cerrado

El nombre del Remitente

La dirección de correo electrónico del Remitente

El número de teléfono del Remitente

El identificador de la alarma de supervisión.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

TicketLabel

IntegerValue

NumberValue

StringValue

ListValue string int decimal string string

La etiqueta del campo

El valor de un campo entero

El valor de un campo numérico

El valor de un campo texto

El valor de un campo lista

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

562

Servicios web API

GetTicketList

Devuelve una conjunto de tickets nuevos agregados desde la última solicitud predeterminada.

Devuelve todos los tickets cuando RetunrAllRecords está configurado en verdadero.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

TicketID int

Machine_GroupID string agentGuid

TicketSummary decimal string

Número de ID único de ticket de problemas

Una representación concatenada del ID de la máquina y el ID del grupo asociado.

Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente.

Texto resumen describiendo brevemente el ticket

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetTicketNotes

Devuelve un conjunto de notas pertenecientes al ticket enviado.

Se devuelven registros múltiples de los siguientes campos, si corresponde.

TicketID

Author

DateEntered

NoteText int string dateTime string

La ID de ticket.

El autor de la nota.

La fecha en que se creó o modificó la nota por última vez.

El texto de la nota.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetTicRequestTicket

Devuelve la ticketID asociada con una ID de solicitud de ticket.

Se devuelve un registro simple de los siguientes campos. ticketId

Method

TransactionID

ErrorMessage

ErrorLocation string string decimal string string identificador único para ticket

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

563

Servicios web API

GetVerboseMachineGroupList

Se devuelven registros múltiples del siguiente campo, si corresponde. groupName machGroupGuid parentGroupGuid orgFK string string string string

La ID de grupo de máquinas.

GUID del grupo de máquinas.

GUID del grupo de máquinas matrices, si existe uno.

Clave externa de la organización que contiene al grupo de máquinas.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

LockFunctionAccess

Bloquea el acceso a funciones del rol de usuario enviado para el rol de usuario básico enviado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

MergeAgent

Fusiona una cuenta de ID de máquina desconectada con otra cuenta de ID de máquina.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

MoveMachineToAnotherGroup

Mueve la máquina a otro grupo.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

564

Servicios web API

Primitivas

Se suministran también las siguientes operaciones primitivas de tipos de datos. Cada operación primitiva usa el mismo contrato xml que su correspondiente operación de columnas múltiples. Cada primitiva devuelve un valor de cadena que necesita procesamiento posterior.

Primitiva

PrimitiveAddMachGroupToScope

PrimitiveAddOrg

PrimitiveAddOrgDepartment

PrimitiveAddOrgDeptStaff

PrimitiveAddOrgToScope

PrimitiveAddScope

PrimitiveAddScopeOrg

PrimitiveAddTicRequest

PrimitiveAddUserToRole

PrimitiveAddUserToScope

PrimitiveAssignRole

PrimitiveAssignScope

PrimitiveAuthenticate

PrimitiveCloseAlarm

PrimitiveCreateMachineGroup

PrimitiveCreateRole

PrimitiveDeleteMachineGroup

PrimitiveDeleteOrg

PrimitiveDeleteScope

PrimitiveEchoMt

PrimitiveGetAlarm

Resultado

PrimitiveAddMachGroupToScopeResult

PrimitiveAddOrgResult

PrimitiveAddOrgDepartment

PrimitiveAddOrgDeptStaffResult

PrimitiveAddOrgToScopeResult

PrimitiveAddScopeResult

PrimitiveAddScopeOrgResult

PrimitiveAddTicRequestResult

PrimitiveAddUserToRoleResult

PrimitiveAddUserToScopeResult

PrimitiveAssignRoleResult

PrimitiveAssignScopeResult

PrimitiveAuthenticateResult

PrimitiveCloseAlarmResult

PrimitiveCreateMachineGroupResult

PrimitiveCreateRoleResult

PrimitiveDeleteMachineGroupResult

PrimitiveDeleteOrgResult

PrimitiveDeleteScopeResult

PrimitiveEchoMtResult

PrimitiveGetAlarmResult

Tipo de datos

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

565

Servicios web API

PrimitiveGetAlarmList

PrimitiveGetLogEntry

PrimitiveGetMachine

PrimitiveGetMachineCollectionList

PrimitiveGetMachineGroupList

PrimitiveGetMachineList

PrimitiveGetMachineUptime

PrimitiveGetNotesList

PrimitiveGetOrgLocation

PrimitiveGetOrgTypes

PrimitiveGetOrgs

PrimitiveGetOrgsByScopeID

PrimitiveGetPartnerUserLocation

PrimitiveGetAlarmResult

PrimitiveGetLogEntryResult

PrimitiveGetMachineResult

PrimitiveGetMachineCollectionListResult

PrimitiveGetMachineGroupListResult

PrimitiveGetMachineListResult

PrimitiveGetMachineUptimeResult

PrimitiveGetNotesListResult

PrimitiveGetOrgLocationResult

PrimitiveGetOrgTypesResult

PrimitiveGetOrgsResult

PrimitiveGetOrgsByScopeIDResult

PrimitiveGetPartnerUserLocationResult

PrimitiveGetPublishedViewColumns

PrimitiveGetPublishedViewRows

PrimitiveGetPublishedViews

PrimitiveGetRoles

PrimitiveGetScopes

PrimitiveGetTicRequestTicket

PrimitiveGetPublishedViewColumnsResult

PrimitiveGetPublishedViewRowsResult

PrimitiveGetPublishedViewsResult

PrimitiveGetRolesResult

PrimitiveGetScopesResult

PrimitiveGetTicRequestTicketResult

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

PrimitiveGetTicket

PrimitiveGetTicketList

PrimitiveGetTicketResult

PrimitiveGetTicketListResult

Cadena de

Caracteres

Cadena de

Caracteres

PrimitiveGetTicketNotes PrimitiveGetTicketNotesResult Cadena de

Caracteres

PrimitiveGetVerboseMachineGroupList PrimitiveGetVerboseMachineGroupListResult Cadena de

Caracteres

PrimitiveMoveMachineToAnotherGroup PrimitiveMoveMachineToAnotherGroupResult Cadena de

Caracteres

PrimitiveRemoveUserFromRole PrimitiveRemoveUserFromRoleResult Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

566

Servicios web API

PrimitiveRemoveUserFromScope

PrimitiveRenameMachine

PrimitiveResetPassword

PrimitiveSetLicenseByOrg

PrimitiveSetPartnerUserLocation

PrimitiveUpdateOrg

PrimitiveUpdateTicket

PrimitiveUpdateUser

PrimitiveRemoveUserFromScopeResult

PrimitiveRenameMachineResult

PrimitiveResetPasswordResult

PrimitiveSetLicenseByOrgResult

PrimitiveSetPartnerUserLocationResult

PrimitiveUpdateOrgResult

PrimitiveUpdateTicketResult

PrimitiveUpdateUserResult

RemoveUserFromRole

Quita un usuario del VSA de un rol.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

RemoveUserFromScope

Quita un usuario del VSA de un ámbito.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

RenameMachine

Cambia el nombre de una máquina y, opcionalmente, la asigna a otro grupo de máquinas.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

Cadena de

Caracteres

567

Servicios web API

ResetPassword

Reconfigura la contraseña del usuario determinada.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

RoleMembership

Asigna un usuario a un rol de usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

SendAdminMessage

Enviar un mensaje a un usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

SetAdminPassword

Reconfigura la contraseña para un usuario determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

SetGroupLicenseInfo

Establece la cantidad máxima de agentes permitidos para un grupo determinado.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID string decimal

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

568

Servicios web API

ErrorMessage

ErrorLocation string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

SetLicenseByOrg

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

SetPartnerUserLocation

Establece la latitud y la longitud actuales del usuario del VSA.

Se devuelve un registro simple de los siguientes campos.

AdminId

Method

TransactionID

ErrorMessage

ErrorLocation decimal string decimal string string

Identificador único del usuario del VSA.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

UpdateOrg

Actualiza la información para una organización.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

UpdateTicket

Actualiza uno o más campos de un ticket. Sólo se pueden actualizar los campos incluidos en la página

Editar campos

(página 462)

de Sistema de tickets.

Actualización de campos de la lista

En el siguiente ejemplo, el campo Origin es un tipo de campo List con cuatro valores posibles. Una solicitud envía el nombre del campo, Origin, y un número que representa la posición del valor en la lista contando a partir de 1. Por ejemplo, el valor Phone está en la segunda posición de la lista, por lo que el valor transmitido para modificar el campo Origin a Phone es 2.

Advertencia: Al cambiar el orden de los valores de las listas desplegables de los campos mediante un cambio en su secuenciación o la introducción de un nuevo valor en el medio de la lista, se modifica el valor

569

Servicios web API seleccionado por la operación Actualizar ticket. Asegúrese de que los usuarios estén al tanto de esta limitación de integración antes de hacer cambios en los valores del campo Editar campos.

Cierre de un ticket

La actualización de un ticket puede incluir el cierre de un MonitorTicketID enviado al actualizar el campo

Estado

con un valor de 3, el cual representa el tercer valor en la lista desplegable del campo

Estado . A continuación se muestra un ejemplo. Se pueden agregar elementos adicionales de nombre/valor de <TicketField> al siguiente ejemplo para actualizar varios campos.

< UpdateTicketRequest >

< TicketID > 1 </ TicketID >

< TicketFields >

< TicketField >

< Name > Status </ Name >

< Value > 3 </ Value >

</ TicketField >

</ TicketFields >

< SessionID > 13642146236194247244181221 </ SessionID >

</ UpdateTicketRequest >

Actualización de otros tipos de campos

Pueden actualizarse los siguientes tipos de campos de ticket:

 String: puede contener cualquier texto con hasta 500 caracteres de longitud. Utilizado principalmente para mantener datos como ser ubicación del problema o otras variables que no pertenecen a la línea de resumen.

 Integer: puede contener cualquier valor entero positivo o negativo.

 Number (nn.d): un número que siempre muestra un dígito a la derecha de la coma decimal.

 Number (nn.dd): un número que siempre muestra dos dígitos a la derecha de la coma decimal.

 Number (nn.ddd): un número que siempre muestra tres dígitos a la derecha de la coma decimal.

 Number (nn.dddd): un número que siempre muestra cuatro dígitos a la derecha de la coma decimal.

 AddNote: agrega una nota de texto sin formato al ticket especificado.

 HideNote: establece la propiedad de oculta de la nota que se agrega.

Los campos que modifica el conjunto de campos escriben una nota de auditoría oculta en el ticket especificado que incluye nombre de campo, valor anterior y nuevo valor. Por ejemplo, ~API~ [CR]

Status has changed from Open to Closed.

Campos devueltos

Se devuelve un registro simple de los siguientes campos.

570

Servicios web API

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Adjuntos de ticket

El servicio Web API no puede usarse para obtener o actualizar adjuntos de archivos de ticket. Los datos adjuntos de los tickets se suelen ubicar en el directorio C:\Kaseya\WebPages\ManagedFiles del Kaseya Server. Los desarrolladores de API son responsables de escribir el código para ubicar los archivos adjuntos en este directorio antes de hacer las llamadas del servicio Web API con referencia a estos adjuntos.

UpdateUser

Actualiza información del usuario.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Algoritmo hash

Con la versión 6.2, K2 adoptó el algoritmo hash SHA-256 para autenticaciones seguras.

Anteriormente, el estándar era el SHA-1. Consulte el tema

Cambio de contraseñas que usan las aplicaciones externas

(página 407)

de la ayuda del sistema en línea para acceder a una introducción general sobre esta mejora.

 A las contraseñas recientemente creadas o restablecidas se les aplica el algoritmo hash

SHA-256.

 Las contraseñas heredadas que no fueron restablecidas siguen requiriendo SHA-1.

 Si se deja en blanco, el parámetro HashingAlgorithm en Autenticar

tiene como valor predeterminado SHA-1.

 En Aplicación API C# de muestra

(página 526)

y en la página ASP de API de muestra

(página 528)

, se proporciona una opción para alternar el algoritmo hash entre SHA-1 y SHA-256.

 Las contraseñas del VSA sólo se pueden restablecer mediante la aplicación VSA, no mediante la

API.

Advertencia:

Al cambiar una contraseña que utiliza una aplicación externa heredada, se deshabilita la integración

hasta que la aplicación externa se actualice para usar el algoritmo hash SHA-256 o hasta que se cree una credencial SHA-1 nueva y se implemente. Asegúrese de no cambiar las contraseñas que usan las aplicaciones externas antes de que se implemente la actualización. Consulte

Creación de una credencial SHA-1 nueva para una aplicación externa heredada

a continuación.

Prácticas recomendadas

Para asegurar una migración sin problemas de versiones anteriores a esta versión, Kaseya recomienda que el código de cliente de servicios web API se escriba o modifique para intentar una autenticación primero en SHA-256 y después en SHA-1, en orden sucesivo. Esto asegura que el código de cliente sea compatible con contraseñas creadas en la versión actual y en versiones anteriores del VSA.

571

Servicios web API

1. Establezca el parámetro HashingAlgorithm en la solicitud Autenticar

en SHA-256. Asegúrese de que se aplique el algoritmo hash SHA-256 a la contraseña. Emita la solicitud Autenticar .

Compruebe si se devuelve un ID de sesión válido.

 La autenticación es correcta si el parámetro SessionID devuelve un valor distinto de cero y el parámetro ErrorMessage está en blanco.

 La autenticación no es correcta si el parámetro SessionID devuelve un valor igual a cero.

Realice el paso 2.

2. Establezca el parámetro HashingAlgorithm en SHA-1. Vuelva a aplicar un algoritmo hash

(SHA-1) al valor de la contraseña. Emita nuevamente la solicitud Autenticar . Compruebe si se devuelve un ID de sesión válido.

572

Servicios web API

Servicio web API para el procedimiento de agente

En esta sección

Habilitación del servicio web API para el procedimiento de agente .............................. 573

Servicio web API para el procedimiento de agente: Operaciones ................................. 573

Habilitación del servicio web API para el procedimiento de agente

Ver la ayuda en línea o la guía del usuario del

Servicio Web API VSA

(página 524)

para obtener una introducción general al API de Kaseya.

Para habilitar el servicio web API para el procedimiento de agente, realice lo siguiente:

 Abra la página Sistema > Configurar

(http://help.kaseya.com/webhelp/ES/VSA/R8/index.asp#248.htm) en el

VSA.

 Active la casilla de verificación Habilitar servicio web API para el VSA

.

 Acceda al servicio web API para el procedimiento de agente en http://<your-KServer>/vsaWS/AgentProcWS.asmx.

Servicio web API para el procedimiento de agente:

Operaciones

Se pueden realizar las siguientes operaciones mediante el

Servicio web API para el procedimiento de agente .

AddScriptAssignment

Agrega una fila de scriptAssignment para ejecutar el script RunNow. El usuario autenticado debe tener acceso para ver el script, y el rol actual debe tener permiso para la función Habilitar programación.

Se devuelve un registro simple del siguiente campo.

ScriptAssignmentId int Un identificador único de una fila en scriptAssignmentTable que represente la combinación de un agentGUID y un scriptID.

AddScriptPrompt

Agrega variables de solicitud de procedimiento de agente a un procedimiento de agente. Los scripts que solicitan variables en el horario programado almacenan los valores en una tabla. Estas variables son exclusivas para cada instancia programada del script (pero no para el script). Esto permite que distintas personas programen el mismo script con diferentes valores de variable. El usuario autenticado debe tener acceso para ver el procedimiento de agente al cual se agregan las solicitudes.

Se devuelve un registro simple del siguiente campo.

AddScriptPromptResult No hay respuesta, excepto un mensaje de error, si corresponde.

573

Servicios web API

Eco

Método de prueba para estudios comparativos y pruebas de conectividad. No requiere autenticación.

Devuelve la cadena enviada.

Se devuelve un registro simple del siguiente campo.

Echo string Este valor debe coincidir con el ingreso incluido en la solicitud.

EchoMt

Método de prueba para evaluar conectividad y para estudios comparativos en el nivel medio. Requiere autenticación. Devuelve la cadena enviada. Devuelve (hace eco) la cadena de carga útil enviada.

Se devuelve un registro simple de los siguientes campos.

Payload

Method

TransactionID

ErrorMessage

ErrorLocation string string decimal string string

La cadena enviada con la solicitud.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetScriptAssignmentId

Obtiene el scriptAssignmentId para una combinación de scriptId/agentGuid.

Se devuelve un registro simple del siguiente campo.

ScriptAssignmentId int Un identificador único de una fila en scriptAssignmentTable que represente la combinación de un agentGUID y un scriptID.

GetScriptIdFromScriptName

Devuelve un conjunto de objetos de script con información básica acerca de todos los scripts con el nombres de la solicitud. Sólo devuelve los scripts con acceso para ver para el usuario autenticado.

Se devuelve un registro único de los siguientes campos:

ScriptId

ScriptName

TreePath int string string

Identificador único del script.

Nombre del script.

Ubicación del script en el árbol de carpetas.

Servicio web API para supervisión

En esta sección

Habilitación del servicio web API para supervisión ........................................................ 575

Servicio web API para supervisión: Operaciones .......................................................... 575

574

Servicios web API

Habilitación del servicio web API para supervisión

Ver la ayuda en línea o la guía del usuario del

Servicio Web API VSA

(página 524)

para obtener una introducción general al API de Kaseya.

Para habilitar el servicio web API para supervisión, realice lo siguiente:

 Abra la página Sistema > Configurar

(http://help.kaseya.com/webhelp/ES/VSA/R8/index.asp#248.htm) en el

VSA.

 Active la casilla de verificación Habilitar servicio web API para el VSA .

 Acceda al servicio web API para supervisión en http://<your-KServer>/vsaWS/monitoringWS.asmx.

Servicio web API para supervisión: Operaciones

Se pueden realizar las siguientes operaciones mediante el Servicio web API para supervisión :

AssignEventAlertToMachine

Asigna una alerta de evento a una máquina.

Se devuelve un registro simple de los siguientes campos.

NewId

Method

TransactionID

ErrorMessage

ErrorLocation int string decimal string string

Un identificador único de la alerta de evento.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

AssignEventLogMachineSettings

Asigna la configuración del registro de eventos a una máquina.

Se devuelve un registro simple de los siguientes campos.

NewId

Method

TransactionID

ErrorMessage

ErrorLocation int string decimal string string

Un identificador único de la asignación de la configuración del registro de eventos.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

CreateEventSet

Crea un nuevo conjunto de eventos. Devuelve el ID del nuevo conjunto de eventos.

Se devuelve un registro simple de los siguientes campos.

NewId

Method

TransactionID

ErrorMessage

ErrorLocation int string decimal string string

Un identificador único del nuevo conjunto de eventos.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

575

Servicios web API

CreateEventSetDefinition

Crea una definición de un conjunto de eventos.

Se devuelve un registro simple de los siguientes campos.

NewId

Method

TransactionID

ErrorMessage

ErrorLocation int string decimal string string

Un identificador único de la definición del nuevo conjunto de eventos.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteAllEventAlertsFromMachine

Elimina todas las alertas de eventos asignadas a una máquina.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteAllEventLogMachineSettings

Elimina toda la configuración del registro de eventos de Windows asignada a una máquina.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteEventAlertFromMachine

Elimina alertas de eventos específicas de la máquina por tipo de registro de evento y categoría.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteEventLogMachineSettings

Elimina la configuración del registro de eventos de Windows asignada a una máquina por tipo de evento.

Se devuelve un registro simple de los siguientes campos.

Method string La operación que solicitó esta respuesta.

576

Servicios web API

TransactionID

ErrorMessage

ErrorLocation decimal string string

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteEventSet

Elimina un conjunto de eventos y todas sus definiciones.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

DeleteEventSetDefinition

Elimina una definición de conjunto de eventos por ID de definición de conjunto de eventos.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetEventAlertList

Obtiene eventos de alerta asignados a una máquina.

Se devuelven registros múltiples de los siguientes campos.

AgentGuid

AlertEmail

EventLogTypeId

EventLogCategoryValue

EventSetId decimal Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente. string int

Dirección de correo electrónico a la que se envía un correo de alerta.

Número de ID único asociado con este registro de eventos. Por ejemplo:

Aplicación -> 796450521

Servidor DNS -> 1208407329

Seguridad -> 1664713117

Sistema -> 1380569194

Cuando el tipo de registro de eventos se extrae de un equipo Windows, si no existe se crea en esta tabla con un identificador único. Este identificador será el mismo en todos los sistemas; esto se logra al usar el nombre en la creación del identificador. int int

1: Error

2: Advertencia

4: Informativo

8: Auditoría de aciertos

16: Auditoría de errores

256: Crítico

512: Detallado

Un identificador único del conjunto de eventos.

577

Servicios web API

AgentProcedureId int

AgentProcedureMachGuid decimal El identificador único de la máquina en la que se ejecuta el procedimiento de agente.

CreateTicket boolean Si el resultado es verdadero, se crea un ticket si se crea una alerta.

SendEmail

Identificador único de procedimiento de agente que se debe ejecutar si se crea una alerta.

0 o nulo = no ejecutar un script.

CreateAlarm

CriteriaType boolean Si el resultado es verdadero, se envía un correo electrónico si se crea una alerta. boolean Si el resultado es verdadero, se crea una alarma si se crea una alerta. int

EventCount

AlarmDurationSecs int int

El criterio que se debe cumplir para desencadenar una alerta.

0, nulo = único evento

1 = varios eventos para la duración

2 = evento faltante para la duración

Número de eventos que deben suceder antes de que se desencadene una alerta.

Número de segundos que se deben esperar antes de que se desencadene una alerta.

AlarmRearmSec int Número de segundos para esperar después de que ocurre una alerta antes de que se desencadene una nueva alerta por el mismo criterio.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetEventLogMachineSettingsList

Devuelve la configuración del registro de eventos de una máquina específica.

Se devuelven registros múltiples de los siguientes campos.

MachineName

AgentGuid

EventLogTypeId

EventLogName string decimal Un identificador exclusivo para una cuenta de machine ID.group ID y su agente correspondiente. int

Nombre de máquina completo. Lo que esta a la izquierda del punto que se encuentra mas a la izquierda es el Nombre de Máquina.

Número de ID único asociado con este registro de eventos. Por ejemplo:

Aplicación -> 796450521

Servidor DNS -> 1208407329

Seguridad -> 1664713117

Sistema -> 1380569194

Cuando el tipo de registro de eventos se extrae de un equipo Windows, si no existe se crea en esta tabla con un identificador único. Este identificador será el mismo en todos los sistemas; esto se logra al usar el nombre en la creación del identificador. string El nombre del tipo de registro de eventos.

578

Servicios web API

EventAssignValue int El valor que determina los tipos de eventos que se deben extraer del registro de eventos. Se almacena como un mapa de bits con los siguientes valores:

1: error

2: advertencia

4: información

8: auditoría de aciertos

16: auditoría de errores

256: crítico

512: detallado

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string Si está en blanco, no devolvió error. string Si está en blanco, no devolvió error.

GetEventSetDefinitionList

Devuelve una definición de conjunto de eventos.

Se devuelven registros múltiples de los siguientes campos.

EventSetId

Ignore

Source

Category

EventId

UserName

Description

EventSetDefId int int string string int string string int

Un identificador único del conjunto de eventos.

0,nulo: para aplicar esta configuración de filtro mediante LIKE

1: para aplicar esta configuración de filtro mediante NOT LIKE

Filtro utilizado para correspondencia con el campo de origen del registro de eventos.

Filtro utilizado para correspondencia con el campo de categoría del registro de eventos.

Filtro utilizado para correspondencia con el campo de ID de evento del registro de eventos.

Filtro utilizado para correspondencia con el campo de nombre de usuario del registro de eventos.

Filtro utilizado para correspondencia con el campo de descripción del registro de eventos.

Un identificador único de la definición del conjunto de eventos.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetEventSetList

Devuelve una lista de conjuntos de eventos.

Se devuelven registros múltiples de los siguientes campos.

SetName

EventSetId string int

El nombre del conjunto de eventos.

Un identificador único del conjunto de eventos.

Se devuelve un registro simple de los siguientes campos.

579

Servicios web API

Method

TransactionID

ErrorMessage

ErrorLocation string La operación que solicitó esta respuesta. decimal La ID única de mensaje para este mensaje. string string

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Servicio web API para KSD

En esta sección

Habilitación del servicio web API para KSD ................................................................... 580

Tipos de datos del servicio Web API KSD ..................................................................... 580

Servicio Web API KSD: operaciones ............................................................................. 587

Mensajes de muestra ..................................................................................................... 592

Habilitación del servicio web API para KSD

Ver la ayuda en línea o la guía del usuario del Servicio Web API VSA

(http://help.kaseya.com/webhelp/ES/VSA/R8/index.asp#3433.htm) para obtener una introducción general al API de Kaseya.

Para habilitar el servicio web API para KSD, realice lo siguiente:

 Abra la página Sistema > Configurar

(http://help.kaseya.com/webhelp/ES/VSA/R8/index.asp#248.htm) en el

VSA.

 Active la casilla de verificación Habilitar servicio web API para el VSA .

 Acceda al servicio web API para KSD en http://<your-KServer>/vsaWS/vsaServiceDeskWS.asmx.

Tipos de datos del servicio Web API KSD

Los siguientes son los principales tipos de datos utilizados en el Servicio Web API KSD . Estos tipos de datos se definen en el documento de esquema XML en el archivo

XML\Schemas\ServiceDesk\ServiceDeskDefinition.xsd ubicado en el directorio donde está instalado el software de Kaseya.

Nota: En las descripciones a continuación, cuando dice (content) en el nombre, eso indica que el valor es el contenido del elemento.

Leyenda

 A - AddIncident

 G - GetIncident

 L - ListIncidents

 U - UpdateIncident

RefItem

El RefItem describe un ítem que es un ítem de referencia en la mesa de servicio. Estos tienen un valor

ID en la base de datos interna, un nombre interno, una descripción opcional y el valor que se muestra.

G ref string El nombre interno del ítem. Generalmente, esto lleva como prefijo el nombre del Departamento de servicios y ||, por ejemplo,

580

Servicios web API

G

G

G id description

(content) string string string

Standard||Open.

La clave de la base de datos interna para el ítem.

La descripción opcional para el ítem.

La forma legible por el usuario del ítem.

CustomField

El CustomField describe el valor de un campo personalizado en un incidente.

AGU

AGU fieldName

(content) string string

El nombre del campo dentro de la mesa de servicio.

El valor del campo personalizado.

Nota

La

Nota

describe una única nota anexada a un ticket.

G User string El nombre del usuario que creó la nota.

G

AG

Timestamp

Text dateTime string

AG

AG

AG

Hidden boolean

HoursWorked Decimal

SuppressNotify Boolean

La hora a la que se creó la nota.

El contenido de la nota. Este puede tener formato HTML y puede incluir referencias a los adjuntos.

Verdadero si la nota debe estar oculta.

La cantidad de horas trabajadas en esta actualización del ticket.

Verdadero si las notificaciones para esta actualización deben suprimirse.

Adjunto

El Adjunto describe un único adjunto para el ticket.

A Name string Una cadena de identificación única para este adjunto.

A

A

A

A

DisplayName

FileName string string

El nombre del adjunto como lo ve el usuario.

El nombre original del archivo o URL.

DocumentType string

Content Base64Binary

El formato MIME del adjunto.

El contenido codificado de base 64 para el adjunto.

RelatedIncident

La

RelatedIncident

es otro incidente que ha sido relacionado con este incidente actual

El identificador único para el incidente. AGU IncidentNumb er string

G

G

G

Summary

Status string string

Description string

El resumen del incidente relacionado.

El estado legible por el usuario del incidente relacionado.

El campo de descripción del incidente.

581

Servicios web API

ServiceDeskDefinition

Los siguientes elementos ServiceDeskDefinition devueltos describen la definición del Departamento de servicios usada para editar el ticket. Esto brinda cada uno de los posibles valores para cada campo en el ticket.

Se devuelve un registro simple de los siguientes elementos.

ServiceDeskDefinition

Name

Description

RequireTime

DisplayMachineInfo id="decimal" Un identificador único string string

El nombre de la definición del Departamento de servicios.

Una breve descripción de la definición del Departamento de servicios. boolean boolean

Si es verdadero, es necesario ingresar las horas trabajadas.

Si es verdadero, se muestra el campo de búsqueda de máquina.

RequireMachineInfo

DisplayOrgInfo

RequireOrgInfo boolean boolean boolean

DisplayCI

RequireCI

AllAdmins

AutoStartClock

AutoSaveClock

AutoInsertNote

AutoInsertNoteHidden

NeedStatusNote

SDPrefix

DefaultStatus

DefaultStage

DefaultPriority

DefaultSeverity

DefaultResolution

DefaultCategory

DefaultSubCategory

DefaultServiceDesk

TemplateName

TemplateType

SequenceName

EditingTemplate boolean boolean boolean boolean boolean boolean boolean boolean string decimal decimal decimal decimal decimal decimal decimal boolean string int string string

Si es verdadero, es necesaria la asociación de búsqueda de máquina.

Si es verdadero, se muestra el campo de búsqueda de organización.

Si es verdadero, es necesaria la asociación de búsqueda de organización. obsoleto obsoleto obsoleto

Si es verdadero, se inicia un reloj automáticamente cuando el usuario comienza a editar el ticket.

Si es verdadero, cuando se guarda el ticket, la diferencia entre la hora actual y la hora de inicio se ingresa como las Horas trabajadas.

Si es verdadero, las notas se agregan automáticamente a cada ticket para los cambios realizados al ticket.

Si es verdadero, las notas generadas automáticamente se dejan ocultas. obsoleto

El código de prefijo agregado al comienzo de la ID de ticket.

Valor predeterminado de estado. Refiere a uno de los elementos al atributo de ID coincidente en la sección Estado.

Valor predeterminado de etapa. Refiere a uno de los elementos al atributo de ID coincidente en la sección Etapa.

Valor predeterminado de prioridad. Refiere a uno de los elementos al atributo de ID coincidente en la sección Prioridad.

Valor predeterminado de severidad. Refiere a uno de los elementos al atributo de ID coincidente en la sección Severidad.

Valor predeterminado de resolución. Refiere a uno de los elementos al atributo de ID coincidente en la sección Resolución.

Valor predeterminado de categoría. Refiere a uno de los elementos al atributo de ID coincidente en la sección Categoría.

Obsoleto

Si es verdadero, esta es la mesa de servicio predeterminada, la primera seleccionada al crear nuevos tickets.

El archivo de plantilla usado para crear inicialmente la mesa de servicio.

De lo contrario no se usa.

El tipo de mesa de servicio: 1=ticket, 3=base de conocimientos.

Sólo para uso de desarrollo interno.

El nombre de la forma usada para editar tickets para la mesa de servicio.

582

ShowNotesPane

ShowWorkOrders

ShowSessionTimers

ShowTasks

EstimatedHours

ActualHours

EmailReader

Administrator boolean boolean boolean boolean double double string string

DefaultPolicy

Status

Priority

Severity

Resolution

TaskStatus

Categories

Stages string

RefItem

RefItem

RefItem

RefItem

RefItem

RefItem

Participants RefItem

Servicios web API

Si el resultado es verdadero, se muestra un panel de notas en el panel inferior de la tabla de tickets.

Si el resultado es verdadero, se muestran el pedido de trabajo y la línea del pedido de trabajo en el editor de tickets.

Si el resultado es verdadero, se muestran los temporizadores de sesión en el editor de tickets.

Si el resultado es verdadero, se muestran la pestaña Tareas y los campos relacionados con las tareas.

Número total de horas trabajadas estimadas para resolver este ticket.

Número total de horas introducidas para resolver este ticket.

El lector de correo electrónico asociado con la mesa de servicio.

El usuario que es el "administrador de mesa" de la mesa de servicio. El administrador de mesa es notificado sobre determinados errores dentro de la mesa de servicio.

La política predeterminada asignada a la mesa.

Devuelve una lista de elementos secundarios de cada valor Estado en la mesa de servicio.

Devuelve una lista de elementos secundarios de cada valor Prioridad en la mesa de servicio.

Devuelve una lista de elementos secundarios de cada valor Severidad en la mesa de servicio.

Devuelve una lista de elementos secundarios de cada valor Resolución en la mesa de servicio.

Devuelve una lista de elementos secundarios de cada valor TaskStatus en el Departamento de servicios.

Devuelve una lista de elementos secundarios de cada valor Categoría en la mesa de servicio.

Devuelve una lista de elementos secundarios de cada valor Etapa en la mesa de servicio. Cada Etapa se identifica mediante un atributo stegetype inicial, medio o final. Cada etapa tiene los siguientes elementos secundarios:



Ítem: el nombre de la etapa.



Inicialización: el procedimiento de Entrada a etapa vinculado a la etapa.



Escalación: el procedimiento de Escalación vinculado a la etapa. El tiempo y las unidades se especifican como atributos.



Objetivo: el objetivo vinculado a la etapa. Objetivo: el objetivo vinculado a la etapa. El tiempo y las unidades se especifican como atributos.



NextStage: una de las etapas siguientes a las que puede pasar esta etapa.

La lista de usuarios como grupos que pueden ser asignatarios o propietarios para la mesa de servicio.

583

Servicios web API

CurrentContact

SubmitterTypes

CustomFields

AccessRights

NoteTemplates

ChangeProcedure

GoalProcedure string string decimal

Información de contacto acerca del usuario conectado durante esta transacción. Si el usuario está asociado a un registro de personal, la información de CurrentContact se obtiene del registro de personal. Si el usuario conectado actualmente es un usuario de máquina que utiliza

Portal Access

, la información de CurrentContact se obtiene de la pestaña Cambiar perfil de

Portal Access

, dentro de Inicio.



ContactName



PhoneNumber



Organización



EmailAddress

El tipo de persona que envía el ticket:



DESCONOCIDO



PARTICIPANTE: un participante es un usuario de VSA.



USUARIO: alguien desconocido para el VSA.

Devuelve cero o más elementos de Campo, cada uno con la siguiente jerarquía:



Subtítulo: subtítulo de pantalla.



Título: título del informe.



Fieldname: el nombre del campo.



FieldFormat: tipo de datos.



DefaultValue: valor predeterminado, si es un tipo de datos de

Lista.



Valores: elemento de recopilación, si es un tipo de datos de

Lista.

Ítem: valor de ítem de Lista.

Devuelve una jerarquía de elementos secundarios:



ViewHiddenNotes: verdadero o falso



ChangeHiddenNotes: verdadero o falso



Derechos de campo> Derecho de campo: elementos de recolección

Fieldname: el nombre del campo del ticket.

AccessType: Requerido, Editar, Sólo vista, Oculto

Devuelve una lista de plantillas de notas, cada una representando texto estándar que puede agregarse a las notas del ticket.

El procedimiento Cambiar ticket asociado con la mesa de servicio.

El procedimiento Objetivo asociado con la mesa de servicio.



tiempo: el tiempo para el objetivo



unidad: las unidades de tiempo



(contenido): el nombre del procedimiento de objetivo.

La lista de tipos de recursos que se pueden asignar a un ticket.

La lista de valores de tareas que se pueden asignar a un estado de tarea.

La lista de políticas que se pueden asociar a un ticket.

ResourceTypes

TaskDefinitions

AssocPolicies

Resumen de incidentes

El Resumen de incidente contiene la descripción básica de un ticket.

AGLU ServiceDeskName

GLU IncidentNumber

AGLU Summary string string string

El nombre de la definición del Departamento de servicios.

El identificador de ticket.

El texto de resumen del ticket.

584

Servicios web API

AGLU Description

AGLU Status

AGLU Priority

AGLU Resolution

AGLU Stage

AGLU Severity

AGLU Category

AGLU SubCategory

GL

GL

Policy

CreateDateTime

GL

GL

LastEditDateTime

CloseDateTime

AGLU OrgID string string string string string string

AGLU OrganizationName

AGLU Organization string string

AGLU OrganizationStaffName string

AGLU OrganizationStaff

El texto de descripción del ticket.

El estado de referencia del ticket.

La prioridad de referencia del ticket.

El tipo de resolución de referencia del ticket.

La etapa de referencia del ticket.

La severidad de referencia del ticket. string string

La categoría de referencia del ticket.

La subcategoría de referencia del ticket. string La política del ticket. dateTime La fecha y hora en que se creó el ticket. dateTime La fecha y hora en que se editó el ticket por última vez. dateTime La fecha y hora en que se cerró el ticket. decimal El identificador único de la organización asociada con el ticket. string

El nombre de organización asociado con el ticket.

La ID de organización asociada con el ticket.

El nombre del miembro de personal de la organización asociado con el ticket.

La ID única del miembro de personal de la organización asociado con el ticket.

AGLU OrganizationStaffEmail

AGLU

AGLU

AGLU

AGLU

AGLU Submitter

AGLU SubmitterEmail

AGLU SubmitterPhone

AGLU SubmitterType

GL

Machine

MachineGuid

MachineGroup

MachineGroupGuid

IsUnread string string decimal string decimal string string string

El correo electrónico del miembro de personal de la organización asociado con el ticket.

La máquina asociada con el ticket.

La GUID de la máquina asociada con el ticket.

El grupo de máquina de la máquina asociada con el ticket.

La GUID del grupo de máquina asociada con el ticket.

El nombre del remitente que envió el ticket.

El correo electrónico del remitente del ticket.

El teléfono del remitente del ticket. string El tipo de persona que envía el ticket:



DESCONOCIDO



PARTICIPANTE: un participante es un usuario de

VSA.



USUARIO: alguien desconocido para el VSA. boolean Si es verdadero, el ticket no ha sido visualizado por el usuario actualmente conectado.

Incidente

El Incidente se deriva del IncidentSummary y contiene todos los campos del IncidentSummary además de estos campos.

G IsParticipant boolean obsoleto

G

G

G

IsClosed boolean

CurrentStageEscalation

DateTime dateTime

CurrentGoalDateTime dateTime

Verdadero si está cerrado.

Fecha y hora de escalación de etapa.

Fecha y hora de objetivo de etapa.

585

Servicios web API

AGU

AGU

AGU

AGU

G

G

G

AGU

G

G

G

G

AGU

G

G

G

AGU

Owner

Participant

AssigneeType

IsArchived

IsError

IsPoolAssignee

ErrorMessage

Notify

CurrentStage

ResolutionNote

LockTime string string string

Assignee string

AssigneeEmail string

ActualCompletionDate dateTime

ExpectedCompletion

Date dateTime

ActualResolutionDate dateTime

PromisedDate dateTime

LockUser

StageGoalTime

Remaining

SourceType

OrgAddress/Address

OrgAddress/Address

OrgAddress/City

OrgAddress/State

OrgAddress/Zip

OrgAddress/Country

AGLU Field

Propietario del ticket. obsoleto

Tipo de asignatario:



DESCONOCIDO



PARTICIPANTE: asignatario individual



GRUPO: un grupo de usuarios

Nombre del asignatario.

Correo electrónico del asignatario. obsoleto

La fecha y hora en que el ticket se cierra o debía cerrarse (la fecha de vencimiento del objetivo del ticket).

Fecha y hora en que se fijó un tipo de resolución para el ticket.

La fecha y hora en que la fecha comprometida fue ingresada por el representante del cliente para resolver el ticket.

Verdadero si el ticket está archivado. obsoleto obsoleto obsoleto obsoleto boolean boolean boolean string boolean string string dateTime string int string

La etapa actual.

Texto descriptivo ingresado con el tipo de resolución.

La fecha y hora en que el ticket se bloqueó al abrir el ticket para edición.

El usuario que bloquea el ticket abriendo el ticket para edición.

El tiempo que queda antes de que el cronómetro del objetivo de etapa ejecute el procedimiento de objetivo. Relevante cuando el objetivo de etapa ha sido pausado.

El tipo de fuente, ya sea un evento del sistema o correo electrónico, que generó una solicitud de ticket.



Correo Electrónico



Respaldo



KES



Parche



Monitorear



Tendencia



Portal



ServiceDesk



Otros

Dirección 1 de la organización

Dirección 2 de la organización string string string string string

Ciudad de la organización

Estado de la organización

Código postal de la organización string Dirección de la organización

CustomField Cero o más valores de campos predeterminados

586

Servicios web API

AGU

AGU

AGU

GU

Notes

Attachments

RelatedIncidents

StartDate

EndDate

UpdateTime

FollowupDate

CompletionDate

ApprovalDate

PromiseDate

PercentCompletion

TaskStatus

ActualHours

Resource

Assignee

Note Cero o más notas.

Attachment Cero o más adjuntos.

Cero o más incidentes relacionados. Related

Incident datetime Fecha y hora de inicio de la tarea datetime datetime datetime datetime datetime datetime int string double

Resource string

Fecha y hora de finalización de la tarea

Última fecha y hora de actualización de esta tarea

Fecha y hora para realizar seguimiento de esta tarea

Fecha y hora de compleción de esta tarea

Fecha y hora de aprobación de esta tarea

Fecha y hora prometida para esta tarea

Porcentaje de compleción de esta tarea

Estado de esta tarea

Total de horas trabajadas en esta tarea

Cero o más recursos

Asignatario asignado a esta tarea

EstimatedHours

TotalHours decimal decimal

Estimación del total de horas trabajadas por este ticket.

Horas reales trabajadas por este ticket.

PreviousStage string Etapa anterior de este ticket.

WorkPerformedDateTim e datetime

EditingTemplate string

Fecha y hora en que se trabajó en este ticket.

ServiceDeskDefinition ServiceDesk

Definition

Plantilla de edición usada para editar este ticket.

Servicio Web API KSD: operaciones

Las siguientes operaciones pueden realizarse utilizando el

Servicio Web API KSD

.

AddIncident

La solicitud es:

AddSDIncident

SessionId

Incident

Decimal

El contenido del nuevo incidente a crear. Sólo los campos marcados con una A en la primera columna pueden configurarse.

La ID de sesión del servicio Web.

Se devuelve un registro simple de los siguientes campos.

IncidentNumber

IncidentID

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string decimal string string

El identificador único del ticket.

El identificador del ticket.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

587

Servicios web API

AddServDeskToScope

La solicitud es: servDeskName scopeName

SessionId string string decimal

El nombre de la mesa de servicio.

El nombre del ámbito.

La ID de sesión del servicio Web.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetIncident

Recupera un solo incidente desde la base de datos. La solicitud es:

IncidentRequest

SessionId Decimal

El incidente a recuperar. Éste tiene los siguientes campos:



IncidentNumber: el ID de ticket como lo ve el usuario, por ejemplo, STD000001



IncidentId: el ID de base de datos del ticket que se desea recuperar.



IncludeNotes: verdadero para incluir notas en el ticket recuperado.



IncludeDefinition: verdadero para incluir la definición del

Departamento de servicios en la respuesta.



IncludeAttachment: verdadero para incluir adjuntos en el ticket recuperado.

La ID de sesión del servicio Web.

Se devuelve un registro simple de los siguientes campos.

IncidentResponse

Method

Incident string

El incidente recuperado.

La operación que solicitó esta respuesta.

TransactionID

ErrorMessage

ErrorLocation decimal string string

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetIncidentList

Recupera una lista de incidentes que coinciden con los criterios de solicitud.

La solicitud es:

IncidentListRequest La lista de incidentes que se deben recuperar. La lista se puede filtrar mediante los siguientes elementos:



ServiceDeskName: el nombre del Departamento de servicios al que se debe consultar.



Status: uno o más valores de estado con los cuales debe haber coincidencias. Si no se suministran valores de

588

SessionId

ReturnDescription

La respuesta es la siguiente:

IncidentList decimal boolean

Servicios web API estado, los tickets se recuperan sin considerar el estado.



Priority: uno o más valores de prioridad con los cuales debe haber coincidencias. Si no se suministran valores de prioridad, los tickets se recuperan sin considerar la prioridad.



Stage: uno o más valores de etapa con los cuales debe haber coincidencias. Si no se suministran valores de etapa, los tickets se recuperan sin considerar la etapa.



SummarySearch: una cadena o expresión para buscar en el resumen de tickets.



Organization: el nombre completo o parcial de las organizaciones con los que debe haber coincidencias. Si no se suministra, los tickets se recuperan para todas las organizaciones dentro del ámbito.



OrganizationStaff: el nombre de un miembro del personal de la organización asociado con los tickets. Si no se suministra, los tickets se recuperan para todas las organizaciones dentro del ámbito.



Machine: el nombre de una máquina con el que debe haber coincidencia. Si no se suministra, los tickets se recuperan para todas las máquinas dentro del ámbito.



MachineGroup: el nombre de un grupo de máquinas con el que debe haber coincidencia. Si no se suministra, los tickets se recuperan para todos los grupos de máquinas dentro del ámbito.



Assignee: el nombre completo o parcial de los asignatarios con los que debe haber coincidencias. Si no se suministra, los tickets se recuperan para todos los asignatarios dentro del ámbito.



StartingIncident: al paginar, este es el siguiente número de incidente que se debe recuperar. Este valor viene desde el valor nextStartingIncident de una solicitud previa

GetIncidentList.



IncidentCount: cuando se indica, especifica el número de incidentes que se deben recuperar.

 SortField: cuando se indica, ordena los resultados por el nombre de campo.

La ID de sesión del servicio Web.

Si es verdadero, la respuesta incluye un elemento Description para cada incidente de la lista. Si es falso, el elemento Description no se incluye en la respuesta.

La lista de incidentes coincidentes.

Se devuelven los siguientes atributos.

 totalIncidents: el número total de incidentes que coinciden con la solicitud.

 nextStartingIncident: el identificador del siguiente incidente que se debe recuperar.

Cada incidente devuelve los siguientes elementos:



ServiceDeskName



IncidentNumber

 Summary: la línea de resumen del ticket.



Description: la descripción del incidente. Sólo se proporciona si la solicitud incluye el elemento

589

Servicios web API

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

ReturnDescription establecido en verdadero.



Status



Stage

 CreateDateTime



LastEditDateTime



OrgID



OrganizationName



Machine



MachineGroup



IsUnread: el ticket aún no se abrió.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetIncident2

Devuelve todos los valores en GetIncidentList, además de los campos personalizados y valores por incidente. Consulte

GetIncidentList

(página 588)

para obtener más información.

Devuelve varios registros del campo siguiente, si corresponde.

CustomFields string or null El valor del campo personalizado que se especificó en la solicitud.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

GetServiceDesk

Recupera la definición de una mesa de servicio. Debe denominarse antes de crear una interfaz de usuario para permitirle al usuario ingresar un ticket. La solicitud es:

ServiceDeskDefinitionReq uest

SessionId Decimal

La mesa de servicio a recuperar. Ésta tiene los siguientes elementos:



ServiceDeskName: el nombre de la mesa de servicio a recuperar.



ServiceDeskID: la base de datos de la mesa de servicio a recuperar. No debe usarse.

La ID de sesión del servicio Web.

Se devuelve un registro simple de los siguientes elementos.

ServiceDeskDefinitionRes ponse

Method

TransactionID

ErrorMessage

ErrorLocation

ServiceDeskDe finition string decimal string string

La definición del Departamento de servicios recuperada.

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

590

Servicios web API

GetServiceDesks

Se devuelven registros múltiples de los siguientes campos, si corresponde. La solicitud es:

IsDefault

ServiceDeskID

ServiceDeskName boolean decimal string

Si es verdadero, la mesa de servicio es la mesa de servicio predeterminada.

Un identificador único

El nombre de la mesa de servicio.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Primitivas

Se suministran también las siguientes operaciones primitivas de tipos de datos. Cada operación primitiva usa el mismo contrato xml que su correspondiente operación de columnas múltiples. Cada primitiva devuelve un valor de cadena que necesita procesamiento posterior. No se recomienda utilizar estos métodos.

Primitiva

PrimitiveAddIncident

PrimitiveAddServDeskToScope

PrimitiveGetIncident

PrimitiveGetIncidentList

PrimitiveGetServiceDesk

PrimitiveGetServiceDesks

PrimitiveUpdateIncident

Resultado

PrimitiveAddIncidentResult

PrimitiveAddServDeskToScopeResult

PrimitiveGetIncidentResult

PrimitiveGetIncidentListResult

PrimitiveGetServiceDeskResult

PrimitiveGetServiceDesksResult

PrimitiveUpdateIncidentResult

Tipo de datos string string string string string string string

QueueAddIncident

Pone en cola una solicitud AddIncident

(página 587)

. Esto se suele usar en situaciones de mucho volumen en las que se crean muchos tickets mediante la API en un período breve, a fin de que el sistema no exceda el tiempo de espera. La solicitud AddIncident se agrega a una tabla, y un evento en curso extrae datos de esa tabla para crear los tickets, a fin que la solicitud no deba esperar a que se cree el ticket.

La solicitud es:

AddSDIncident

SessionId

Incident

Decimal

El incidente por agregar.

La ID de sesión del servicio Web.

Se devuelve un registro único de los siguientes campos:

Method

TransactionID

ErrorMessage string decimal string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

591

Servicios web API

ErrorLocation string Si está en blanco, no devolvió error.

UpdateIncident

Actualiza un solo incidente en la base de datos. La solicitud es:

UpdateSDIncident

SessionId

Incident

Decimal

El incidente a actualizar. Ver la primera columna del tipo de datos del Incidente para ver los campos que son válidos en la actualización.

La ID de sesión del servicio Web.

Se devuelve un registro simple de los siguientes campos.

Method

TransactionID

ErrorMessage

ErrorLocation string decimal string string

La operación que solicitó esta respuesta.

La ID única de mensaje para este mensaje.

Si está en blanco, no devolvió error.

Si está en blanco, no devolvió error.

Mensajes de muestra

Los datos de muestra se incluyen en los siguientes XML.

GetServiceDesks Request

< GetServiceDesks xmlns =" vsaServiceDeskWS ">

< req >

< SessionID > 62648424383576321292545755 </ SessionID >

</ req >

</ GetServiceDesks >

GetServiceDesks Response

< GetServiceDesksResponse xmlns =" vsaServiceDeskWS ">

< GetServiceDesksResult >

< ServiceDesks >

< ServiceDesk >

< IsDefault > false </ IsDefault >

< ServiceDeskID > 291273277175176 </ ServiceDeskID >

< ServiceDeskName > KnowledgeBase </ ServiceDeskName >

</ ServiceDesk >

< ServiceDesk >

< IsDefault > false </ IsDefault >

< ServiceDeskID > 696191121914314 </ ServiceDeskID >

< ServiceDeskName > Standard </ ServiceDeskName >

</ ServiceDesk >

</ ServiceDesks >

< Method > GetServiceDesks </ Method >

< TransactionID > 144 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ GetServiceDesksResult >

</ GetServiceDesksResponse >

GetServiceDesk Request

< GetServiceDesk xmlns =" vsaServiceDeskWS ">

< req >

592

Servicios web API

< ServiceDeskDefinitionRequest >

< ServiceDeskName xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard </ ServiceDeskName >

< ServiceDeskID xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 696191121914314 </ ServiceDeskID >

</ ServiceDeskDefinitionRequest >

< SessionID > 62648424383576321292545755 </ SessionID >

</ req >

</ GetServiceDesk >

GetServiceDesk Response

< GetServiceDeskResponse xmlns =" vsaServiceDeskWS ">

< GetServiceDeskResult >

< ServiceDeskDefinitionResponse id =" 696191121914314 ">

< Name xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard </ Name >

< Description xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard

SD </ Description >

< RequireTime xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ RequireTime >

< DisplayMachineInfo xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ DisplayMachineInfo >

< RequireMachineInfo xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ RequireMachineInfo >

< DisplayOrgInfo xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ DisplayOrgInfo >

< RequireOrgInfo xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ RequireOrgInfo >

< DisplayCI xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ DisplayCI >

< RequireCI xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ RequireCI >

< AllAdmins xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ AllAdmins >

< AutoStartClock xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ AutoStartClock >

< AutoSaveClock xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ AutoSaveClock >

< AutoInsertNote xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ AutoInsertNote >

< AutoInsertNoteHidden xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ AutoInsertNoteHidden >

< NeedStatusNote xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ NeedStatusNote >

< SDPrefix xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> STD </ SDPrefix >

< DefaultStatus xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 218924116119912 </ DefaultStatus >

< DefaultStage xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 831768438118427 </ DefaultStage >

< DefaultPriority xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 693719171716599 </ DefaultPriority >

< DefaultSeverity xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 0 </ DefaultSeverity >

< DefaultResolution xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 0 </ DefaultResolution >

< DefaultCategory xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 0 </ DefaultCategory >

< DefaultServiceDesk xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ DefaultServiceDesk >

< TemplateType xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 1 </ TemplateType >

< SequenceName xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> SEQ129 </ SequenceName >

< EditingTemplate xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Fixed_Width_Tabbed.xml

</ EditingTe mplate >

< Status xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Item ref =" Standard||AwaitingHardware " id =" 541491145218711 "> Awaiting Hardware </ Item >

< Item ref =" Standard||AwaitingUserFeedback " id =" 281767467828324 "> Awaiting User Feedback </ Item >

< Item ref =" Standard||Closed " id =" 989295147216226 "> Closed </ Item >

< Item ref =" Standard||Escalated " id =" 551271771474242 "> Escalated </ Item >

< Item ref =" Standard||Hold " id =" 172151822788151 "> Hold </ Item >

593

Servicios web API

< Item ref =" Standard||InProgress " id =" 111313126312233 "> In Progress </ Item >

< Item ref =" Standard||New " id =" 218924116119912 "> New </ Item >

</ Status >

< Priority xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Item ref =" Standard||CriticalHigh " id =" 744512181719881 "> Critical High </ Item >

< Item ref =" Standard||High " id =" 982525519923522 "> High </ Item >

< Item ref =" Standard||Low " id =" 291721863176342 "> Low </ Item >

< Item ref =" Standard||Medium " id =" 693719171716599 "> Medium </ Item >

< Item ref =" Standard||Planning " id =" 176222131631332 "> Planning </ Item >

</ Priority >

< Severity xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Item ref =" Standard||CompanyWide(High) " id =" 315477225242249 "> Whole Company (High) </ Item >

< Item ref =" Standard||MultipleUsers(Medium) " id =" 262164368749722 "> Multiple users (Medium) </ Item >

< Item ref =" Standard||OneUser(Low) " id =" 917688316816914 "> Single User (Low) </ Item >

</ Severity >

< Resolution xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Item ref =" Standard||AdviceGiven " id =" 498162732192611 "> Advice Given </ Item >

< Item ref =" Standard||CannotDuplicate " id =" 262514419248621 "> Cannot Duplicate </ Item >

< Item ref =" Standard||ClosedbyCustomerRequest " id =" 525192125718333 "> Closed by Customer

Request </ Item >

< Item ref =" Standard||HardwareReplaced " id =" 432262321578326 "> Hardware Replaced </ Item >

< Item ref =" Standard||HotFixReleased " id =" 189239616133249 "> Hot Fix Released </ Item >

< Item ref =" Standard||InstallationCompleted " id =" 139764799836252 "> Installation Completed </ Item >

< Item ref =" Standard||NewSoftwareInstalled " id =" 521637923418319 "> New Software Installed </ Item >

< Item ref =" Standard||Noresponsefromuser " id =" 115424612244857 "> No response from user </ Item >

< Item ref =" Standard||OSReinstalled " id =" 531617444692623 "> OS Reinstalled </ Item >

< Item ref =" Standard||Other " id =" 711261961631328 "> Other </ Item >

< Item ref =" Standard||PassedtoSales " id =" 191482475814123 "> Passed to Sales </ Item >

< Item ref =" Standard||Pendingscriptcleared " id =" 762515513181192 "> Pending script cleared </ Item >

< Item ref =" Standard||ReapplySchema " id =" 525317525441497 "> Reapply Schema </ Item >

< Item ref =" Standard||Reboot " id =" 832182442825238 "> Reboot </ Item >

< Item ref =" Standard||ResolvedbyCustomer " id =" 243623591961272 "> Resolved by Customer </ Item >

< Item ref =" Standard||ResolvedbyTechnition " id =" 423939164212169 "> Resolved </ Item >

< Item ref =" Standard||SolvedwithKBarticle " id =" 272199179212412 "> Solved with KB article </ Item >

< Item ref =" Standard||TrainingGiven " id =" 622224812237126 "> Training Given </ Item >

</ Resolution >

< Categories xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Category >

< Item ref =" Standard||Advice&amp;Guidance " id =" 161211171768212 "> Advice &amp; Guidance </ Item >

< SubCategory ref =" Standard||Advice&amp;Guidance||General " id =" 561699795215782 "> General </ SubCategory >

</ Category >

< Category >

< Item ref =" Standard||Kaseya " id =" 641881726251641 "> Kaseya </ Item >

< SubCategory ref =" Standard||Kaseya||AgentIcon " id =" 821781865922435 "> Agent Icon </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Alarm " id =" 481422361723261 "> Alarm </ SubCategory >

< SubCategory ref =" Standard||Kaseya||ApplicationChanges " id =" 525187874623717 "> Application

Changes </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Disk " id =" 919621482151882 "> Disk </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Eventlog " id =" 814714713317798 "> Eventlog </ SubCategory >

< SubCategory ref =" Standard||Kaseya||GetFile " id =" 322618792314914 "> Get File </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Hardware " id =" 176166136238942 "> Hardware </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Lanwatch " id =" 214791394922624 "> Lanwatch </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Logon_Admin " id =" 943315515116292 "> Logon_Admin </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Logon_User " id =" 636613429245187 "> Logon_User </ SubCategory >

< SubCategory ref =" Standard||Kaseya||NewAgent " id =" 557214511134217 "> New Agent </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Other " id =" 631281678197153 "> Other </ SubCategory >

< SubCategory ref =" Standard||Kaseya||PatchManagement " id =" 462824113621914 "> Patch

Management </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Procedure " id =" 274262311559714 "> Procedure </ SubCategory >

< SubCategory ref =" Standard||Kaseya||RCDisabled " id =" 641624812335116 "> RC

Disabled </ SubCategory >

< SubCategory ref =" Standard||Kaseya||Script " id =" 471482131991414 "> Script </ SubCategory >

< SubCategory ref =" Standard||Kaseya||SystemOffline " id =" 113411182222324 "> System

Offline </ SubCategory >

< SubCategory ref =" Standard||Kaseya||SystemOnline " id =" 251814418923368 "> System

Online </ SubCategory >

594

Servicios web API

< SubCategory ref =" Standard||Kaseya||Unidentified " id =" 617313577253122 "> Unidentified </ SubCategory >

</ Category >

< Category >

< Item ref =" Standard||Network " id =" 414766231875111 "> Network </ Item >

< SubCategory ref =" Standard||Network||Connectivity " id =" 122145211361321 "> Connectivity </ SubCategory >

< SubCategory ref =" Standard||Network||Design " id =" 495611529142242 "> Design </ SubCategory >

< SubCategory ref =" Standard||Network||Firewall " id =" 812515316323522 "> Firewall </ SubCategory >

< SubCategory ref =" Standard||Network||Other " id =" 946227769167531 "> Other </ SubCategory >

< SubCategory ref =" Standard||Network||Performance " id =" 941891772111717 "> Performance </ SubCategory >

</ Category >

< Category >

< Item ref =" Standard||Printer " id =" 155243642251342 "> Printer </ Item >

< SubCategory ref =" Standard||Printer||Other " id =" 341431321188813 "> Other </ SubCategory >

< SubCategory ref =" Standard||Printer||PrinterProblem " id =" 851831547314111 "> Printer

Problem </ SubCategory >

< SubCategory ref =" Standard||Printer||PrinterSetup " id =" 619395216749723 "> Printer

Setup </ SubCategory >

< SubCategory ref =" Standard||Printer||Toner " id =" 161984536861723 "> Toner </ SubCategory >

</ Category >

< Category >

< Item ref =" Standard||ServiceRequest " id =" 541124124415221 "> Service Request </ Item >

< SubCategory ref =" Standard||ServiceRequest||EquipmentMove " id =" 862712311517672 "> Equipment

Move </ SubCategory >

< SubCategory ref =" Standard||ServiceRequest||NewLaptop " id =" 266812518245792 "> New

Laptop </ SubCategory >

< SubCategory ref =" Standard||ServiceRequest||NewServer " id =" 322872913227349 "> New

Server </ SubCategory >

< SubCategory ref =" Standard||ServiceRequest||NewWorkstation " id =" 224115236352441 "> New

Workstation </ SubCategory >

</ Category >

</ Categories >

< Stages xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Stage stageType =" End ">

< Item ref =" Standard||Closed " id =" 213813735111171 " description =" Auto Generated "> Closed </ Item >

< Initialization > Standard Enters Closed </ Initialization >

</ Stage >

< Stage stageType =" Begin ">

< Item ref =" Standard||Identified " id =" 831768438118427 " description =" New ticket is received "> Identified </ Item >

< Initialization > Standard Enters Identified </ Initialization >

< Escalation time =" 15 " unit =" MINUTE "> Incident is Escalated </ Escalation >

< Goal time =" 1 " unit =" HOUR "> Identified Goal </ Goal >

< NextStage ref =" Standard||Tier1 " id =" 546812745461511 " description =" Tier 1

Support "> Tier1 </ NextStage >

</ Stage >

< Stage stageType =" Middle ">

< Item ref =" Standard||Tier1 " id =" 546812745461511 " description =" Tier 1 Support "> Tier1 </ Item >

< Initialization > Standard Enters Tier1 </ Initialization >

< Escalation time =" 3 " unit =" HOUR "> Incident is Escalated </ Escalation >

< Goal time =" 2 " unit =" HOUR "> Tier1 Goal </ Goal >

< NextStage ref =" Standard||Closed " id =" 213813735111171 " description =" Auto

Generated "> Closed </ NextStage >

< NextStage ref =" Standard||Tier2 " id =" 318527191192719 " description =" Tier 2 Specialist

Support "> Tier2 </ NextStage >

</ Stage >

< Stage stageType =" Middle ">

< Item ref =" Standard||Tier2 " id =" 318527191192719 " description =" Tier 2 Specialist

Support "> Tier2 </ Item >

< Initialization > Standard Enters Tier2 </ Initialization >

< Escalation time =" 3 " unit =" HOUR "> Incident is Escalated </ Escalation >

< Goal time =" 4 " unit =" HOUR "> Tier2 Goal </ Goal >

< NextStage ref =" Standard||Closed " id =" 213813735111171 " description =" Auto

Generated "> Closed </ NextStage >

</ Stage >

</ Stages >

< Participants xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

595

Servicios web API

< Participant ref =" garyw " id =" 67511883639135112891416313 " isPool =" false "> garyw </ Participant >

< Participant ref =" jschenck " id =" 72381729521421633172123416 " isPool =" false "> jschenck </ Participant >

< Participant ref =" NickT " id =" 96171921315349923924634249 " isPool =" false "> NickT </ Participant >

< Participant ref =" Standard||SupportManager " id =" 654222596258293 " isPool =" true "> SupportManager

(Pool) </ Participant >

< Participant ref =" Standard||Tier1Support " id =" 352161952139188 " isPool =" true "> Tier1Support

(Pool) </ Participant >

< Participant ref =" Standard||Tier2Support " id =" 921522231318131 " isPool =" true "> Tier2Support

(Pool) </ Participant >

</ Participants >

< CustomFields xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Field id =" 221552971661261 ">

< Caption > Source </ Caption >

< Title > Source </ Title >

< FieldName > Source </ FieldName >

< FieldFormat > List </ FieldFormat >

< DefaultValue > Call </ DefaultValue >

< Values >

< Item ref =" Call " id =" 0 "> Call </ Item >

< Item ref =" EMail " id =" 0 "> EMail </ Item >

< Item ref =" Text " id =" 0 "> Text </ Item >

</ Values >

</ Field >

< Field id =" 818831117157241 ">

< Caption > Urgency </ Caption >

< Title > Urgency </ Title >

< FieldName > Urgency </ FieldName >

< FieldFormat > List </ FieldFormat >

< DefaultValue > Medium </ DefaultValue >

< Values >

< Item ref =" High " id =" 0 "> High </ Item >

< Item ref =" Low " id =" 0 "> Low </ Item >

< Item ref =" Medium " id =" 0 "> Medium </ Item >

</ Values >

</ Field >

< Field id =" 513119818455188 ">

< Caption > KB Article created </ Caption >

< Title > KB Article Created </ Title >

< FieldName > KB_Article </ FieldName >

< FieldFormat > List </ FieldFormat >

< DefaultValue > No </ DefaultValue >

< Values >

< Item ref =" No " id =" 0 "> No </ Item >

< Item ref =" Yes " id =" 0 "> Yes </ Item >

</ Values >

</ Field >

< Field id =" 291214644251233 ">

< Caption > Dept </ Caption >

< Title > Department </ Title >

< FieldName > Dept </ FieldName >

< FieldFormat > List </ FieldFormat >

< DefaultValue > IT </ DefaultValue >

< Values >

< Item ref =" Accounting " id =" 0 "> Accounting </ Item >

< Item ref =" Accounts Payable " id =" 0 "> Accounts Payable </ Item >

< Item ref =" Facilities " id =" 0 "> Facilities </ Item >

< Item ref =" HR " id =" 0 "> HR </ Item >

< Item ref =" IT " id =" 0 "> IT </ Item >

< Item ref =" Other " id =" 0 "> Other </ Item >

< Item ref =" Payroll " id =" 0 "> Payroll </ Item >

< Item ref =" Sales " id =" 0 "> Sales </ Item >

< Item ref =" Telecom " id =" 0 "> Telecom </ Item >

</ Values >

</ Field >

</ CustomFields >

< AccessRights xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< ViewHiddenNotes > true </ ViewHiddenNotes >

< ChangeHiddenNotes > true </ ChangeHiddenNotes >

596

< FieldRights >

< FieldRight >

< FieldName > ID </ FieldName >

< AccessType > Required </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Summary </ FieldName >

< AccessType > Required </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Description </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > CreationDtTm </ FieldName >

< AccessType > ViewOnly </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > SubmitterName </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > SubmitterEmailAddr </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > ContactPhone </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > OrgName </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > OrgID </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > StaffID </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > ContactEmail </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > MachineID </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Note </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > ClosedDtTm </ FieldName >

< AccessType > ViewOnly </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > PromiseDtTm </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > DueDtTm </ FieldName >

< AccessType > ViewOnly </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > ActualCompletedDate </ FieldName >

< AccessType > ViewOnly </ AccessType >

</ FieldRight >

Servicios web API

597

Servicios web API

< FieldRight >

< FieldName > HiddenNote </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Owner </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > LockUser </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > EditDtTm </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > current_esc_datetime </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > current_goal_datetime </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > lockTime </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > sourceType </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Status </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Priority </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Severity </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Category </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > SubCategory </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Stage </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Resolution </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Assignee </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Source </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

598

Servicios web API

< FieldName > Urgency </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > KB_Article </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

< FieldRight >

< FieldName > Dept </ FieldName >

< AccessType > Edit </ AccessType >

</ FieldRight >

</ FieldRights >

</ AccessRights >

< NoteTemplates xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Item ref =" My Note " id =" 196429316815241 "> My Note </ Item >

< Item ref =" Note 2 " id =" 167218821431219 "> Second note </ Item >

</ NoteTemplates >

< ChangeProcedure xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard is

Changed </ ChangeProcedure >

< GoalProcedure time =" 1 " unit =" DAY " xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard Goal - All

Stages </ GoalProcedure >

</ ServiceDeskDefinitionResponse >

< Method > GetServiceDesk </ Method >

< TransactionID > 146 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ GetServiceDeskResult >

</ GetServiceDeskResponse >

GetIncidentList Request

< GetIncidentList xmlns =" vsaServiceDeskWS ">

< req >

< IncidentListRequest >

< ServiceDeskName xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard </ ServiceDeskName >

< IncidentCount xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 30 </ IncidentCount >

</ IncidentListRequest >

< SessionID > 62648424383576321292545755 </ SessionID >

</ req >

</ GetIncidentList >

GetIncidentList Response

< GetIncidentListResponse xmlns =" vsaServiceDeskWS ">

< GetIncidentListResult >

< IncidentList >

< Incident xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< ServiceDeskName > Standard </ ServiceDeskName >

< IncidentNumber > STD000001 </ IncidentNumber >

< Summary > Monitoring generated Counter ALARM at 7:03:04 am 05-Feb-10 on ag-yellow-w732.root.myOrg

</ Summary >

< Description > Monitoring generated Counter ALARM at 7:03:04 am 05-Feb-10 on ag-yellow-w732.root.myOrg<br/><br/>SNMP Device: N/A<br/>Monitor Set: _ZC-CM2-Disk Drive C Free

Space_Copy<br/>Type: Counter<br/>Log Object Name: DiskSpace...

</ Description >

< Status > Closed </ Status >

< Priority > Low </ Priority >

< Stage > Closed </ Stage >

< CreateDateTime > 2010-02-05T17:07:21.55-08:00 </ CreateDateTime >

< LastEditDateTime > 2010-02-05T22:59:22.64-08:00 </ LastEditDateTime >

< Submitter > Kaseya Support </ Submitter >

< SubmitterEmail > [email protected]

</ SubmitterEmail >

</ Incident >

</ IncidentList >

< Method > GetIncidentList </ Method >

< TransactionID > 147 </ TransactionID >

599

Servicios web API

< ErrorMessage />

< ErrorLocation />

</ GetIncidentListResult >

</ GetIncidentListResponse >

GetIncident Request

< GetIncident xmlns =" vsaServiceDeskWS ">

< req >

< IncidentRequest >

< IncidentNumber xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> STD000001 </ IncidentNumber >

< IncludeNotes xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ IncludeNotes >

< IncludeDefinition xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ IncludeDefinition >

</ IncidentRequest >

< SessionID > 67223225114316912673490269 </ SessionID >

</ req >

</ GetIncident >

GetIncident Response

< GetIncidentResponse xmlns =" vsaServiceDeskWS ">

< GetIncidentResult >

< IncidentResponse id =" 611922114996841 ">

< IncidentNumber xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> STD000001 </ IncidentNumber >

< Summary xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Getting Started with

Service Desk – PLEASE READ!

</ Summary >

< Description xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

&lt;p&gt;&lt;strong&gt;&lt;span style='font-size:11.0pt;font-family:"Calibri","sans-serif";color:blue'&gt;WELCOME TO SERVICE

DESK&lt;/span&gt;&lt;/strong&gt;&lt;br/&gt;

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 &lt;a href="http://help.kaseya.com/WebHelp/EN/KSD/1000000/index.htm?toc.htm?5982.htm"&gt;Getting

Started&lt;/a&gt; to quickstart your implementation of Service Desk.

&lt;/p&gt;

</ Description >

< Status xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Closed </ Status >

< Priority xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Low </ Priority >

< Stage xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Closed </ Stage >

< Category xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Advice&amp;Guidance </ Ca tegory >

< CreateDateTime xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 2010-02-05T17:07:21.55-08:00 </ Cre ateDateTime >

< LastEditDateTime xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 2010-02-05T22:59:22.64-08:00 </ Las tEditDateTime >

< Submitter xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Kaseya

Support </ Submitter >

< SubmitterEmail xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> [email protected]

</ SubmitterEmai l >

< SubmitterType xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> UNKNOWN </ SubmitterType >

< IsUnread xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> true </ IsUnread >

< IsParticipant xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ IsParticipant >

< Owner xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> garyw </ Owner >

< AssigneeType xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> POOL </ AssigneeType >

600

Servicios web API

< Assignee xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Tier1Support </ Assignee >

< ActualCompletionDate xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 2010-02-05T22:59:29.28-08:00 </ Act ualCompletionDate >

< ExpectedCompletionDate xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 2010-02-06T17:07:22.283-08:00 </ Ex pectedCompletionDate >

< IsArchived xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ IsArchived >

< IsError xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ IsError >

< Notify xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> false </ Notify >

< SourceType xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> ServiceDesk </ SourceType >

< CustomFields xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Field fieldName =" Source "> Text </ Field >

< Field fieldName =" Urgency "> Low </ Field >

< Field fieldName =" KB_Article "> No </ Field >

< Field fieldName =" Dept "> Sales </ Field >

</ CustomFields >

< Notes xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

">

< Note id =" 213494962391116 ">

< Timestamp > 2010-02-05T22:59:25.127-08:00 </ Timestamp >

< Text > Auto Generated Note:&lt;br/&gt;

Ticket Changed&lt;br/&gt; 'currentStageGoalDateTime' cleared&lt;br/&gt; </ Text >

< Hidden > true </ Hidden >

</ Note >

< Note id =" 356934215185622 ">

< User > garyw </ User >

< Timestamp > 2010-02-05T17:07:21.55-08:00 </ Timestamp >

< Text > Auto Generated Note:&lt;br/&gt;

Ticket Added&lt;br/&gt; </ Text >

< Hidden > true </ Hidden >

</ Note >

</ Notes >

</ IncidentResponse >

< Method > GetIncident </ Method >

< TransactionID > 200 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ GetIncidentResult >

</ GetIncidentResponse >

AddIncident Request

< AddIncident xmlns =" vsaServiceDeskWS ">

< req >

< AddSDIncident >

< ServiceDeskName xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard </ ServiceDeskName >

< Summary xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Test Ticket From Web

Service </ Summary >

< Description xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> This ticket was created with the web service.

</ Description >

< Status xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||New </ Status >

< Priority xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Medium </ Priority >

< Category xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> Standard||Network </ Category >

</ AddSDIncident >

< SessionID > 67223225114316912673490269 </ SessionID >

</ req >

</ AddIncident >

AddIncident Response

< AddIncidentResponse xmlns =" vsaServiceDeskWS ">

601

Servicios web API

< AddIncidentResult >

< AddSDIncidentResponse >

< IncidentNumber xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> STD000002 </ IncidentNumber >

< IncidentID xmlns =" http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd

"> 249259141859248 </ IncidentID >

</ AddSDIncidentResponse >

< Method > AddIncident </ Method >

< TransactionID > 203 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ AddIncidentResult >

</ AddIncidentResponse >

602

C a p í t u l o 1 4

Solicitud de actualización de incidente

<UpdateIncident xmlns ="vsaServiceDeskWS" >

<req>

<UpdateSDIncident id ="89421281980071930157491435" >

<ServiceDeskName xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Customer_SD_Basic </ServiceDeskNam e>

<IncidentNumber xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > CSN000380 </IncidentNumber>

<Summary xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Test Ticket From Web

Service </Summary>

<Description xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > This ticket was created with the web service.

</Description>

<Status xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Standard||InProgress </Status>

<Priority xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Standard||Low </Priority>

<Stage xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Standard||Identified </Stage>

<CreateDateTime xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > 2010-03-10T21:07:31.923-08:00 </Cr eateDateTime>

<LastEditDateTime xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > 2010-03-10T21:07:31.923-08:00 </La stEditDateTime>

<Submitter xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > garyw </Submitter>

<SubmitterType xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > UNKNOWN </SubmitterType>

<IsUnread xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > true </IsUnread>

<IsParticipant xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > false </IsParticipant>

<CurrentStageEscalationDateTime xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > 2010-03-10T21:22:43.063-08:00 </Cu rrentStageEscalationDateTime>

<CurrentGoalDateTime xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > 2010-03-10T22:07:43.077-08:00 </Cu rrentGoalDateTime>

<Owner xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > garyw </Owner>

<AssigneeType xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > POOL </AssigneeType>

<Assignee xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > Tier1Support </Assignee>

<ExpectedCompletionDate xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > 2010-03-11T21:07:43.077-08:00 </Ex pectedCompletionDate>

<IsArchived xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > false </IsArchived>

<IsError xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > false </IsError>

603

Servicios web API

<Notify xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" > false </Notify>

<Notes xmlns ="http://www.kaseya.com/vsa/2007/12/ServiceDeskDefinition.xsd" >

<Note id ="281273717819319" >

<User> garyw </User>

<Timestamp> 2010-03-10T21:07:31.923-08:00 </Timestamp>

<Text> Auto Generated Note:&lt;br/&gt; Ticket Added&lt;br/&gt; </Text>

<Hidden> true </Hidden>

</Note>

</Notes>

</UpdateSDIncident>

<SessionID xmlns ="" > 98782788528483188965186776 </SessionID>

</req>

</UpdateIncident>

UpdateIncident Response

< UpdateIncidentResponse xmlns =" vsaServiceDeskWS ">

< UpdateIncidentResult >

< Method > UpdateIncident </ Method >

< TransactionID > 205 </ TransactionID >

< ErrorMessage />

< ErrorLocation />

</ UpdateIncidentResult >

</ UpdateIncidentResponse >

604