ProactivaNET WebServices PDF

Integración
Webservices
Integración Webservices
Proactivanet, Espiral MS
Fecha última revisión: 18/10/2018
Versión Proactivanet asociada: 10.02.00.00
2 de 55
AVISO LEGAL
El presente aviso legal regula el uso de la información incluida en el presente archivo y en la documentación complementaria
que pudiera entregarse, relativo al software Proactivanet®, propiedad de la empresa ESPIRAL MICROSISTEMAS, S.L. con CIF
número B33848789, Avda. Estadio del Molinón 100, Gijón – Asturias, teléfono 985099215. Este fichero, y sus posibles anexos,
contienen materiales preparados por Espiral Microsistemas, S.L. o cualquiera de las empresas que conforman el grupo ESPIRAL
MS, pudiendo ser modificados, desarrollados o actualizados, sin previo aviso, por personal integrante del mismo.
La información contenida en este archivo y sus anexos es confidencial y está dirigida exclusivamente a los destinatarios de los
mismos. Si por error ha recibido este documento y no es el destinatario, por favor, notifíqueselo al remitente y no use, informe,
distribuya, imprima, copie o difunda este documento por ningún medio. Su uso no autorizado está sujeto a responsabilidades
legales.
PROPIEDAD INTELECTUAL E INDUSTRIAL
Proactivanet® es una marca registrada en la Oficina Española de Patentes y Marcas por la compañía española Espiral
Microsistemas S.L., cumplidas las disposiciones establecidas en la ley 17/2001, de 7 de diciembre. Los derechos de propiedad
intelectual de distintos elementos contenidos en este documento (imágenes, ficheros, logos y cualquier otro elemento
susceptible de protección) así como toda la información relativa al software Proactivanet® son titularidad de Espiral
Microsistemas, S.L., a quien corresponde el ejercicio exclusivo de los derechos de explotación, reproducción, distribución,
comunicación pública y transformación. De igual forma, la documentación generada por el grupo ESPIRAL MS, a partir de la
información compartida por las partes o en desarrollo de las anteriores será propiedad de Espiral Microsistemas, S.L., siendo
aplicable a la misma los derechos y obligaciones dispuestos en los párrafos siguientes.
Están expresamente prohibidas la reproducción, transformación, distribución, comunicación pública, puesta a disposición del
público y, en general cualquier otra forma de explotación, parcial o total de los elementos referidos en el apartado anterior.
Queda igualmente prohibida la utilización total o parcial de la información contenida en el presente archivo, y en especial su
traslado a terceros o su por cualquier medio y soporte, y con cualquier finalidad, gratuita u onerosa.
La utilización o distribución no autorizada de la información contenida en el presente fichero, de la que se genere a partir del
intercambio de información o en desarrollo de las mismas, así como la lesión de los derechos de Propiedad Intelectual e
Industrial de Espiral Microsistemas, S.L., dará lugar a las responsabilidades legalmente establecidas.
CLÁUSULA DE PRIVACIDAD
En cumplimiento de las disposiciones recogidas en la normativa vigente en materia de protección de datos personales
(Reglamento (UE) 2016/679 del Parlamento Europeo y del Consejo de 27 de abril de 2016 relativo a la protección de las
personas físicas en lo que respecta al tratamiento de datos personales y a la libre circulación de estos datos y por el que se
deroga la Directiva 95/46/CE, en adelante GDPR; Ley Orgánica 15/1999, de 13 de diciembre, de Protección de Datos de
Carácter Personal, y en el Real Decreto 1720/2007, de 21 de diciembre), le informamos que los datos que facilite se incluirán en
un fichero automatizado propiedad de Espiral Microsistemas, S.L cuya finalidad es permitir las relaciones comerciales con su
empresa; el usuario consiente y acepta de forma expresa que sus datos pasen a formar parte del fichero automatizado y que
sean utilizados con fines comerciales y/o de envío de información desde el momento en que sean enviados/entregados a Espiral
Microsistemas S.L. o a cualquier persona de su organización. Le informamos que los titulares de dichos datos tienen la
posibilidad de ejercer los derechos de acceso, rectificación, supresión, oposición, limitación del tratamiento o portabilidad,
enviando un correo electrónico a la dirección notificaciones.espiralms@espiralms.com o a la dirección postal arriba indicada, en
los términos establecidos en el RGPD
3 de 55
Índice de contenidos
Objetivo ................................................................................................................................................... 8
Definición del servicio web ..................................................................................................................... 9
1.1 Descripción general ................................................................................................................. 9
1.2 Definición de métodos ............................................................................................................ 9
1.2.1 newDefaultIncidentURL .................................................................................................. 9
1.2.2 newIncidentURL ............................................................................................................ 10
1.2.3 newIncident ................................................................................................................... 11
1.2.4 newIncidentWithDescription ........................................................................................ 11
1.2.5 newIncidentWithPortfolioAndDescription .................................................................... 12
1.2.6 newIncidentWithTechnician.......................................................................................... 13
1.2.7 getJSONIncidentDataById.............................................................................................. 14
1.2.8 getJSONTranslatedIncidentDataById ............................................................................ 14
1.2.9 getIncidentCode ............................................................................................................ 15
1.2.10 getIncidentURL .............................................................................................................. 15
1.2.11 getJSONUserOpenIncidents .......................................................................................... 15
1.2.12 getJSONTranslatedUserOpenIncidents ......................................................................... 16
1.2.13 getUserIncidents ........................................................................................................... 16
1.2.14 getUserIncidentsURL ..................................................................................................... 17
1.2.15 countUserIncidents ....................................................................................................... 17
1.2.16 getJSONUserDataByUsernameAndDomain................................................................... 17
1.2.17 getUserId ....................................................................................................................... 18
1.2.18 getUserIdByTelephone .................................................................................................. 18
1.2.19 getUserUrl ..................................................................................................................... 19
1.2.20 getUserUrlByTelephone ................................................................................................ 19
1.2.21 getTypeId ....................................................................................................................... 19
1.2.22 getPortfolioId ................................................................................................................ 20
1.2.23 getCategoryId ................................................................................................................ 20
1.2.24 getJSONNewIncidentCustomFieldsRequired ................................................................ 20
1.2.25 getJSONTranslatedNewIncidentCustomFieldsRequired ............................................... 21
4 de 55
1.2.26 getJSONElementsToUser ............................................................................................... 21
1.2.27 getJSONTranslatedElementsToUser .............................................................................. 22
1.2.28 getCustomFieldId .......................................................................................................... 22
1.2.29 setCustomFieldValue ..................................................................................................... 23
1.2.30 setSDCustomFieldValue ................................................................................................ 24
1.2.31 addComment ................................................................................................................. 25
1.2.32 addAnnotation............................................................................................................... 25
1.2.33 insertUser ...................................................................................................................... 26
1.2.34 updateUser .................................................................................................................... 27
1.2.35 disableUser .................................................................................................................... 28
1.2.36 enableUser .................................................................................................................... 28
1.2.37 insertCustomer .............................................................................................................. 29
1.2.38 updateCustomer............................................................................................................ 30
1.2.39 disableCustomer............................................................................................................ 30
1.2.40 enableCustomer ............................................................................................................ 31
1.2.41 getCustomerId ............................................................................................................... 31
1.2.42 setUserCustomer ........................................................................................................... 31
1.2.43 setCategoryCustomerVisibility ...................................................................................... 32
1.2.44 deleteCategoryCustomerVisibility ................................................................................. 32
1.2.45 insertDomain ................................................................................................................. 33
1.2.46 getDomainId .................................................................................................................. 33
1.2.47 getUserOpenIncidents................................................................................................... 33
1.2.48 getIncidentId ................................................................................................................. 34
1.2.49 getSubstatusStr ............................................................................................................. 34
1.2.50 getIncidentSubstatusId.................................................................................................. 34
1.2.51 getTechnicianId ............................................................................................................. 35
1.2.52 getIncidentMainStatusId ............................................................................................... 35
1.2.53 getIncidentSubstatus ..................................................................................................... 35
1.2.54 updateIncidentSubstatus .............................................................................................. 36
1.2.55 GetImpactId ................................................................................................................... 36
1.2.56 GetUrgencyId................................................................................................................. 36
1.2.57 GetPriorityId .................................................................................................................. 37
1.2.58 SetUrgencyAndImpact................................................................................................... 37
5 de 55
1.2.59 SetPriority ...................................................................................................................... 38
1.2.60 getSDCustomFieldIdBySource ....................................................................................... 38
1.2.61 newIncidentWithTechnicianTypeAndCategory ............................................................. 39
1.2.62 CloseIncident ................................................................................................................. 39
1.2.63 SolveIncident ................................................................................................................. 40
1.2.64 AddAttachment ............................................................................................................. 40
1.2.65 getTypeIdByLang ........................................................................................................... 41
1.2.66 getCategoryIdByLang..................................................................................................... 41
1.2.67 getCustomFieldIdByLang ............................................................................................... 42
1.2.68 getSDCustomFieldIdBySourceAndLang ......................................................................... 42
1.2.69 GetCalendarIdByIncident .............................................................................................. 43
1.2.70 GetSLAIdByIncident ....................................................................................................... 43
1.2.71 GetDateDiffHours .......................................................................................................... 43
1.2.72 GetElapsedTimeFromCreationByIncident ..................................................................... 44
1.2.73 GetSLAElapsedTimeFromCreationByIncident ............................................................... 44
1.2.74 GetCMDBRelShipTypeId ................................................................................................ 44
1.2.75 GetCMDBStatusId .......................................................................................................... 45
1.2.76 GetCMDBCustomFieldId ................................................................................................ 45
1.2.77 SetCMDBCIStatus .......................................................................................................... 45
1.2.78 CreateCIsRel .................................................................................................................. 46
1.2.79 DeleteCIsRel................................................................................................................... 46
1.2.80 setCMDBCustomFieldValue........................................................................................... 47
1.2.81 GetUserCustomField (obsoleto) .................................................................................... 47
1.2.82 GetDomainByUser ......................................................................................................... 48
1.2.83 GetUserByDNI................................................................................................................ 48
1.2.84 GetCustomFieldValue .................................................................................................... 48
1.2.85 GetJSONTableData ........................................................................................................ 49
Cómo utilizar WebServices públicos de Proactivanet ........................................................................... 50
6 de 55
Histórico de cambios
Versión Fecha Descripción cambios
8.6 05/07/2012 Versión inicial del documento.
8.7 23/07/2012 Revisado texto descripción general.
8.10 21/01/2013 Nuevos métodos añadidos.
8.11 12/04/2013 Nuevo método añadido.
8.16.2.0 23/07/2014 Añadidos métodos y nueva forma de autentificación / autorización a

través del Referee.
Añadidos métodos para habilitar/deshabilitar clientes y usuarios,
modificar usuarios y campos personalizados.
8.18.0.0 16/12/2014 Añadidos métodos para asignar prioridad, impacto y urgencia a las
incidencias además de observadores para esas entidades. También se
han añadido métodos para el control de estados de las incidencias.
8.19.0.0 12/03/2015 Añadidos métodos para la resolución y cierre de incidencias.
8.21.0.0 01/07/2015 Añadidos métodos para dar soporte multi-idioma a campos

personalizados, tipos y categorías.
Añadidos métodos de cálculo de tiempos.
8.22.0.0 24/09/2015 Añadidos métodos para actualizar CMDB
8.24.0.0 31/05/2016 Añadida información sobre cómo consumir los webservices.
8.30.0.0 23/06/2017 Añadidos métodos de obtención de datos JSON e inserción de adjuntos

a incidencias
10.0.0.0 28/06/2018
10.0.0.1 16/07/2018 Añadidos 3 nuevos métodos.
10.1.0.0 16/08/2018 Nuevos métodos añadidos y método marcado como obsoleto
10.2.0.0 18/10/2018 Añadido método para crear anotaciones de una incidencia

Añadido método para crear incidencias con un servicio del catálogo
7 de 55
Objetivo
El objetivo del presente documento es introducir, y posteriormente detallar el servicio web

(webservice ) y los métodos publicados en el mismo para la integración de Proactivanet®
con sistemas externos, tales como sistemas de telefonía, monitorización de redes,... Estos
sistemas externos podrán consumir el servicio web con el objetivo principal de crear nuevos
registros de incidencias y/o peticiones en Proactivanet, así como añadir
comentarios/actualizaciones a registros previamente creados.
8 de 55
Definición del servicio web
1.1 Descripción general
El servicio web desarrollado e incluido en Proactivanet® se comportará de manera estándar
para este tipo de servicios, según WSDL.
Los mecanismos de autentificación y autorización podrán ser dos:
- Autentificación / Autorización a través de los mecanismos que utiliza la aplicación.
- Autentificación / Autorización anónima. En este caso se utilizará un Proxy de conexión

que generará el personal de soporte de Proactivanet a tal efecto. En este proxy se
utilizará como Referee el ClientID (para más detalle, ver último apartado del
documento “cómo utilizar WebServices públicos de Proactivanet”).
1.2 Definición de métodos

Todos los métodos ofrecidos por el servicio web trabajan sobre las siguientes
consideraciones generales:
- Los métodos trabajarán siempre con parámetros tipo string o int.
- Los métodos se implementarán como webservices lo que posibilitará llamarlos tanto

desde código cliente como desde código servidor.
- Todos los métodos tienen autentificación y autorización anónima.
- Los parámetros fecha se pasarán como string y tendrán el formato

YYYY#MM#DD#HH#MM.
- Si alguno de los métodos produce un error devolverá “-1”.
- Si algún parámetro no aplica, se pasará en la llamada la cadena vacía “”.
- Si el método devuelve varios valores, los devolverá en una sola cadena separados por
‘;’.
- El técnico que registra la incidencia no se establece como parámetro en ninguno de

los métodos, ya que será calculado automáticamente al acceder al registro en
Proactivanet®
- Si no existen resultados para la llamada se devolverá la cadena vacía.
1.2.1 newDefaultIncidentURL
Método que devuelve la URL para acceder al formulario de creación de incidencias, en modo
creación de nuevos registros, pero sin precargar ningún dato.
9 de 55
Este método no recibe parámetros.
1.2.2 newIncidentURL
Método que devuelve la URL para acceder al formulario de creación de incidencias, en modo
creación de nuevos registros, precargando los datos que se proporcionen como parámetros.
String newIndicentURL (string user_id, string title, string creationDate, string type_id,
string category_id, string source_id)
Parámetro Tipo Obligatorio Descripción
user_id string Obligatorio ID del usuario que reporta la incidencia.

GUID (uniqueidentifier) en formato string.
title string Opcional Título de la incidencia
creationDate string Opcional Fecha de creación de la incidencia.

Si no se indica, se calculará por defecto.
type_id string Opcional ID del tipo de la incidencia.
category_id string Opcional ID de la categoría de la incidencia.
source_id string Opcional ID del origen de la incidencia.
Devuelve la URL para acceder al formulario de creación de incidencias donde el notificador,

título, fecha de creación, tipo, categoría y origen de la incidencia son los especificados como
parámetros de entrada.
10 de 55
1.2.3 newIncident
Método que permite crear una incidencia a partir de los datos pasados como parámetros.
Si el usuario infiere una localización, y bien el usuario o la localización inferida infieren a su

vez un cliente, se insertan en la incidencia.
Devuelve el id de la incidencia ya creada en Proactivanet®.
String newIncident(string user_id, string title, string creationDate, string type_id, string
category_id, string source_id)

title string Obligatorio Título de la incidencia

1.2.4 newIncidentWithDescription

Análogo al método newIncident pero permitiendo añadir una descripción al nuevo registro
creado.
11 de 55
String newIncidentWithDescription(string user_id, string title, string creationDate, string
type_id, string category_id, string source_id, string description)


description string Opcional Descripción de la incidencia/petición.
1.2.5 newIncidentWithPortfolioAndDescription

Si el servicio infiere una categoría, y ésta no se pasa como parámetro, se inserta a su vez en
la incidencia, siempre y cuando sea compatible en cuestiones de visibilidad.
Análogo al método newIncidentWithDescription pero permitiendo añadir un servicio del

catálogo (portfolio) al nuevo registro creado.
12 de 55
String newIncidentWithPortfolioAndDescription(string user_id, string title, string
creationDate, string type_id, string portfolio_id, string category_id, string source_id, string
description)


portfolio_id string Opcional ID del servicio de la incidencia.
description string Opcional Descripción de la incidencia/petición.
1.2.6 newIncidentWithTechnician
Método que permite crear una incidencia con origen ‘Técnico’ a partir de los datos pasados
como parámetros. Devuelve el id de la incidencia ya creada en Proactivanet®.

Análogo al método newIncident pero permitiendo añadir una descripción al nuevo registro
creado.
String newIncidentWithTechnician(string pawSvcAuthUsers_id, string title, string

creationDate)
pawSvcAuthUsers_id string Obligatorio ID del técnico que registra la incidencia.


13 de 55
1.2.7 getJSONIncidentDataById
Devuelve los datos de una incidencia en formato JSON y, en caso de estar activada la
característica de multidioma, traducidos al idioma por defecto de la aplicación. Los datos
incluidos son:
 id: identificador de la incidencia (GUID (uniqueidentifier) en formato string).
 code: código de la incidencia (string con formato "INC 2017..." o "REQ 2017...").
 title: título de la incidencia (string).
 creationDate: fecha de creación de la incidencia (string con formato "2014-12-

31T23:59:59").
 description: texto enriquecido con la descripción de la incidencia (string).
 padMainStatus_id: identificador del estado principal de la incidencia: nueva,

rechazada, asignada, resuelta, cerrada (GUID (uniqueidentifier) en formato string).
 padMainStatusName: nombre del estado principal de la incidencia (string).
 padStatus_id: identificador del subestado de la incidencia (GUID (uniqueidentifier)

en formato string).
 padStatusName: nombre del subestado de la incidencia (string).
string getJSONIncidentDataById (string incident_id)
incident_id string Obligatorio ID de la incidencia a consultar.

1.2.8 getJSONTranslatedIncidentDataById
Método análogo al anterior pero traduciendo los datos a uno de los idiomas soportados por
la aplicación. En caso de no existir la traducción tomará el idioma por defecto.
string getJSONTranslatedIncidentDataById (string incident_id)

lang string Opcional Cadena con el código del idioma en el que se
desea obtener la traducción: es, en y ca. Por
defecto el idioma principal de la aplicación
14 de 55
1.2.9 getIncidentCode
Devuelve el código de la incidencia cuyo id se especifica como parámetro de entrada.
string getJSONIncidentDataById (string incident_id)

1.2.10 getIncidentURL
Devuelve la URL del formulario de incidencias de la incidencia especificada como parámetro
en modo lectura o en modo edición según se indique en el parámetro.
string getIncidentURL(string incident_id, int mode)

mode int Obligatorio Mode de acceso al formulario:
0 – Modo lectura
1 – Modo edición
1.2.11 getJSONUserOpenIncidents
Devuelve una lista de objetos JSON con los datos de las incidencias notificadas por el usuario
indicado y aún abiertas. En caso de estar activada la característica de multidioma, los datos
de las incidencias serán traducidos al idioma por defecto de la aplicación. Los datos de cada
uno de los elementos devueltos en la colección son:
 id: identificador de la incidencia (GUID (uniqueidentifier) en formato string).
 code: código de la incidencia (string con formato "INC 2017..." o "REQ 2017...").
 title: título de la incidencia (string).
 creationDate: fecha de creación de la incidencia (string con formato "2014-12-

31T23:59:59").
 description: texto enriquecido con la descripción de la incidencia (string).
 padMainStatus_id: identificador del estado principal de la incidencia: nueva,

rechazada, asignada, resuelta, cerrada (GUID (uniqueidentifier) en formato string).
 padMainStatusName: nombre del estado principal de la incidencia (string).
15 de 55
 padStatus_id: identificador del subestado de la incidencia (GUID (uniqueidentifier)
en formato string).
 padStatusName: nombre del subestado de la incidencia (string).
string getJSONUserOpenIncident (string user_id, string includeResolved)
incident_id string Obligatorio ID del usuario notificador.

includeResolved String Obligatorio Incluir incidencias resueltas o únicamente
nuevas y asignadas. Booleano en formato string:
“true” / “false”
1.2.12 getJSONTranslatedUserOpenIncidents
string getJSONTranslatedUserOpenIncidents (string user_id, string includeResolved,

string lang)

includeResolved String Obligatorio Incluir incidencias resueltas o únicamente
nuevas y asignadas. Booleano en formato string:
“true” / “false”
lang string opcional Cadena con el código del idioma en el que se
1.2.13 getUserIncidents
Devuelve una cadena con los identificadores de las incidencias del usuario especificado como
parámetro de entrada.
string getUserIncidents (string user_id)
user_id string Obligatorio ID del usuario a consultar.

16 de 55
1.2.14 getUserIncidentsURL
Devuelve una URL a una tabla en la que visualizar las incidencias del usuario especificado
como parámetro de entrada.
string getUserIncidentsURL (string user_id)

1.2.15 countUserIncidents
Devuelve el número de incidencias reportadas por el usuario especificado como parámetro
de entrada.
Int countUserIncidents (string user_id)

1.2.16 getJSONUserDataByUsernameAndDomain
Devuelve una colección con los datos de los usuarios en formato JSON que coincidan en
nombre (y dominio) con los suministrados. Los datos incluidos son:
 id: identificador del usuario (GUID (uniqueidentifier) en formato string).
 name: nombre completo del usuario (string).
 telephone: número de teléfono del usuario (string).
 email: correo electrónico del usuario (string).
 inactive: estado del usuario, activo / inactivo (boolean).
17 de 55
string getJSONUserDataByUsernameAndDomain (string username, string domain)
username string Obligatorio Username del usuario a consultar.

Se realizará la búsqueda por el campo de
idéntico nombre en Proactivanet®
domain string Opcional Dominio al que pertenece el usuario.
1.2.17 getUserId
Devuelve el identificador del usuario especificado como parámetro.
string getUserId (string username)
username string Obligatorio Username del usuario a consultar.

domain string Opcional Dominio al que pertenece el usuario.
1.2.18 getUserIdByTelephone
Devuelve el identificador o identificadores de los usuarios cuyo campo teléfono especificado
como parámetro coincide.
string getUserIdByTelephone (string telephone, int field)
telephone string Obligatorio Número de teléfono a consultar.
field int Obligatorio Campo de Proactivanet® en donde se realizará la

búsqueda:
0 – Campo teléfono manual
1 – Campo teléfono personal del AD
2 – Campo teléfono trabajo del AD
18 de 55
1.2.19 getUserUrl
Devuelve la URL de acceso al formulario del usuario especificado como parámetro de
entrada.
string getUserUrl (string user_id)

1.2.20 getUserUrlByTelephone
Devuelve la URL de acceso a los datos del usuario o usuarios cuyo campo teléfono
especificado como parámetro coincide.
Si sólo se encuentra un usuario que cumple el criterio de entada, la URL será la del
formulario del usuario en modo lectura. Si se encuentran varios usuarios, la URL será la de
una tabla donde se mostrarán todos los usuarios encontrados.
string getUserUrlByTelephone(string telephone, int field)
telephone string Obligatorio Número de teléfono a consultar.
field int Obligatorio Campo de Proactivanet® en donde se realizará la

búsqueda:
0 – Campo teléfono manual
1 – Campo teléfono personal del AD
2 – Campo teléfono trabajo del AD
1.2.21 getTypeId
Devuelve el identificador del tipo cuyo nombre coincida exactamente con el especificado
como parámetro. Si no encuentra ningún valor, devolverá cadena vacía.
string getTypeId (string type)
type string Obligatorio Cadena literal con el nombre exacto del tipo a
consultar.
19 de 55
1.2.22 getPortfolioId
Devuelve el identificador del servicio cuyo código coincida exactamente con el especificado
string getPortfolioId (string code)
code string Obligatorio Cadena literal con el código completo exacto del
servicio a consultar.
1.2.23 getCategoryId
Devuelve el identificador de la categoría cuyo nombre completo (path) coincida exactamente
con el especificado como parámetro. Si no encuentra ningún valor, devolverá cadena vacía.
string getCategoryId (string category)
category string Obligatorio Cadena literal con el nombre completo exacto

(path) de la categoría a consultar.
1.2.24 getJSONNewIncidentCustomFieldsRequired
Devuelve una colección con los datos de los campos personalizados obligatorios en la
creación de una incidencia. Si la característica multidioma está activa en la aplicación
devolverá los nombres de los campos en el idioma por defecto de la aplicación. Los datos
incluidos son:
 id: identificador del campo personalizado (GUID (uniqueidentifier) en formato string).
 name: nombre del campo personalizado (string).
string getJSONNewIncidentCustomFieldsRequired (string type_id, string category_id)
type_id string Opcional Identificador del tipo con el que se va a crear la

incidencia.
category_id string Opcional Identificador de la categoría con la que se va a
crear la incidencia.
20 de 55
1.2.25 getJSONTranslatedNewIncidentCustomFieldsRequi
red
string getJSONTranslatedNewIncidentCustomFieldsRequired (string type_id, string

category_id, string lang)
type_id string Opcional Identificador del tipo con el que se va a crear la

incidencia.
category_id string Opcional Identificador de la categoría con la que se va a
crear la incidencia.
1.2.26 getJSONElementsToUser
Devuelve los activos relacionados con el usuario especificado como parámetro. Si el usuario
especificado no tiene ningún elemento relacionado, devolverá cadena vacía. Si el usuario no
existe en la base de datos, devolverá -1.
El WebService devolverá un string que representa un JSon con información detallada para
cada activo relacionado con el usuario dado. La información que devolverá para cada activo
será:
 Id: Identificador del usuario en Proactivanet.

 PanElementId: Identificador del activo en Proactivanet
 Name: Nombre del activo.
 Type: Tipo de activo: PC habitual, PC Responsable, o tipo de dispositivo.
 VendorName: Nombre del fabricante del activo. Puede ser nulo.
 ModelName: Nombre del modelo del fabricante del activo. Puede ser nulo.
 Associated: Nombre del usuario del que se están consultando los activos.
 Serial: Nº de serie del activo. Puede ser nulo.
 LocationTranslatedPath: Ruta completa de la localización del activo. Puede ser
nula.
 Label: Etiqueta del active. Puede ser nula.
21 de 55
 FromAgent: Indica si el activo es de detección automática (1) o manual(0) por parte
de Proactivanet
 padHardwareStatusName: Estado del activo.
 URL: URL para el acceso al formulario de Proactivanet con todo el detalle del activo.
Si los datos tienen valores multi-idioma se mostrarán en el idioma por defecto establecido en
la aplicación.
string getJSONElementsToUser (string username)
username string Obligatorio Username del usuario que se quiere obtener la

información. Si el usuario tiene dominio,
especificar como dominio\username.
1.2.27 getJSONTranslatedElementsToUser
string getJSONTranslatedElementsToUser (string username, string lang)
username string Obligatorio Username del usuario que se quiere obtener la

información. Si el usuario tiene dominio,
especificar como dominio\username.
1.2.28 getCustomFieldId
Devuelve el identificador del campo cuyo nombre coincida exactamente con el especificado
string getCustomFieldId (string customField)
customField string Obligatorio Cadena literal con el nombre exacto del campo a
consultar.
22 de 55
1.2.29 setCustomFieldValue
Este método está deprecado y se recomienda el uso de setSDCustomFieldValue en su lugar.
Actualiza el valor del campo personalizado de Incidencias indicado como parámetro.

Devuelve un entero que indica si la actualización se realizó correctamente o no:
1 – Actualización correcta,
-1 – Se produjo algún error en la actualización.
int setCustomFieldValue (string incident_id, string customFieldId, string value)
incident_id string Obligatorio ID de la incidencia a actualizar

customFieldId string Obligatorio ID del campo personalizado a actualizar
value string Obligatorio Nuevo valor para el campo personalizado.
Cadena de texto que representará un valor
entero, float, fecha o texto en función del tipo
del campo personalizado.
Para campos personalizados de tipo lista deberá introducirse como valor un entero que
represente el índice de las diferentes opciones. El valor para el índice de la primera opción
será 0.
Para el campo personalizado de tipo check deberá introducirse un entero: 0 para No y 1 para
Sí.
23 de 55
1.2.30 setSDCustomFieldValue
Actualiza el valor del campo personalizado de entidades del Service Desk indicado como
parámetro. Devuelve un entero que indica si la actualización se realizó correctamente o no:
int setSDCustomFieldValue (string element_id, string customFieldId, string value)
element_id string Obligatorio ID de la entidad del SD a actualizar

customFieldId string Obligatorio ID del campo personalizado a actualizar
Para campos personalizados de tipo lista deberá introducirse como valor un entero que
represente el índice de las diferentes opciones. El valor para el índice de la primera opción
será 0.
Para el campo personalizado de tipo check deberá introducirse un entero: 0 para No y 1 para
Sí.
No se admite la modificación de campos personalizados de tipo bitácora.
24 de 55
1.2.31 addComment
Actualiza un registro de incidencia o petición añadiendo un comentario de usuario (análogo
al que se hubiese realizado directamente desde el portal de usuarios). Para respuestas de
tipo Si / No el comentario debe ser un 0 para el valor No y un 1 para el valor Si. Devuelve un
entero que indica si la actualización se realizó correctamente o no:
int addComment (string incident_id, string user_id, string comment)

user_id string Opcional ID del usuario que realiza el comentario.
Si no se especifica se usará el usuario notificador
de la incidencia/petición
comment string Obligatorio Comentario que realiza el ususario
1.2.32 addAnnotation
Actualiza un registro de incidencia o petición añadiendo una anotación sin tipo de un técnico.
Si no se indica técnico, la anotación llevará el nombre del último técnico modificador de la
incidencia. Devuelve un entero que indica si la actualización se realizó correctamente o no:
int addComment (string incident_id, string tech_id, string comment)

tech_id string Opcional ID del técnico que realiza la anotación.
Si no se especifica se usará el último técnico
modificador de la incidencia.
comment string Obligatorio Texto de la anotación del técnico
25 de 55
1.2.33 insertUser
Método que permite crear un usuario a partir de los datos pasados como parámetros.
Devuelve el id del usuario ya creado en Proactivanet®.
string insertUser(string username, string domain_id, string name, string surname, string
DNI, string email, string telephone, string description)
username string Obligatorio Nombre de usuario.
domain _id string Opcional ID del dominio

name string Opcional Nombre.
surname string Opcional Apellidos.
DNI string Opcional DNI/Identificador del usuario.
email string Opcional Email del usuario.
telephone string Opcional Teléfono del usuario.
description string Opcional Descripción del usuario.
26 de 55
1.2.34 updateUser
Método que permite actualizar un usuario existente a partir de los datos pasados como
parámetros. Devuelve un entero que indica si la actualización se realizó correctamente o no:
int updateUser(string user_id, string username, string domain_id, string name, string
surname, string DNI, string email, string telephone, string description)
user_id string Obligatorio ID del usuario a actualizar

username string Opcional Nombre de usuario.
Si es blanco no se actualiza.
domain _id string Opcional ID del dominio
Si es blanco no se actualiza, si es la cadena
“NULL” se blanquea.
name string Opcional Nombre.
surname string Opcional Apellidos.
DNI string Opcional DNI/Identificador del usuario.
email string Opcional Email del usuario.
telephone string Opcional Teléfono del usuario.
description string Opcional Descripción del usuario.
27 de 55
1.2.35 disableUser
Desactiva un usuario. Devuelve un entero que indica si la operación se realizó correctamente
o no:
-1 – Se produjo algún error en la operación.
public int disable-User(string user_id)
user_id String Obligatorio ID del usuario

El método no considera un caso especial cuando el usuario ya esté desactivado antes de

ejecutarse. En esta situación el método retornará 1 y el usuario continuará desactivado.
1.2.36 enableUser
Activa un usuario. Devuelve un entero que indica si la operación se realizó correctamente o
no:
public int enableUser(string user_id)
user_id String Obligatorio ID del usuario

28 de 55
1.2.37 insertCustomer
Método que permite crear un cliente a partir de los datos pasados como parámetros.
Devuelve el id del cliente ya creado en Proactivanet®.
string insertCustomer(string name, string tradeName, string CIF, string businessAddress,

string description)
customer_id string Obligatorio ID del cliente a actualizar

name string Opcional Nombre del cliente.
tradename string Opcional Razón social del cliente.
CIF string Opcional CIF del cliente.
businessAddress string Opcional Domicilio social del ciente.
description string Opcional Descripción del cliente.
29 de 55
1.2.38 updateCustomer
Método que permite actualizar un cliente existente a partir de los datos pasados como
parámetros. Devuelve un entero que indica si la actualización se realizó correctamente o no:
int updateCustomer(string customer_id, string name, string tradeName, string CIF, string
businessAddress, string description)
name string Opcional Nombre del cliente.

Si es blanco no se actualiza.
tradename string Opcional Razón social del cliente.
CIF string Opcional CIF del cliente.
businessAddress string Opcional Domicilio social del ciente.
description string Opcional Descripción del cliente.
1.2.39 disableCustomer
Desactiva un cliente. Devuelve un entero que indica si la operación se realizó correctamente
o no:
public int disableCustomer(string customer_id)
customer_id string Obligatorio ID del cliente

El método no considera un caso especial cuando el cliente ya esté desactivado antes de

ejecutarse. En esta situación el método retornará 1 y el cliente continuará desactivado.
30 de 55
1.2.40 enableCustomer
Activa un cliente. Devuelve un entero que indica si la operación se realizó correctamente o
no:
public int enableCustomer(string customer_id)
customer_id string Obligatorio ID del cliente

El método no considera un caso especial cuando el cliente ya esté activado antes de
ejecutarse. En esta situación el método retornará 1 y el cliente continuará activado.
1.2.41 getCustomerId
Devuelve el identificador del cliente especificado como parámetro.
string getCustomerId (string name)
name string Obligatorio Nombre del cliente a consultar.

1.2.42 setUserCustomer
Método que asigna un cliente a un usuario. Devuelve un entero que indica si la actualización
se realizó correctamente o no:
int setUserCustomer(string user_id, string customer_id)
user_id string Obligatorio ID del usuario a actualizar

customer_id string Opcional ID del cliente a actualizar
Si no se especifica, se desasocia el cliente que
hubiese para ese usuario.
31 de 55
1.2.43 setCategoryCustomerVisibility
Incluye a un cliente en la lista de clientes que pueden ver una categoría restringida.
category_id string Obligatorio ID de la categoría a actualizar

customer_id string Obligatorio ID del cliente al que se quiere permitir ver la
categoría restringida.
1.2.44 deleteCategoryCustomerVisibility
Elimina a un cliente de la lista de clientes que pueden ver una categoría restringida.
category_id string Obligatorio ID de la categoría a actualizar

customer_id string Obligatorio ID del cliente al que se quiere restringir la
visibilidad de la categoría.
32 de 55
1.2.45 insertDomain
Método que permite crear un dominio a partir de los datos pasados como parámetros.
Devuelve el id del dominio ya creado en Proactivanet®.
string insertDomain(string name, string type, string description)
name string Obligatorio Nombre del dominio.
type string Opcional Tipo de dominio:

0 – Global
1 – Grupo de trabajo
2 – Local
description string Opcional Descripción del dominio.
1.2.46 getDomainId
Devuelve el identificador del dominio especificado como parámetro.
string getDomainId (string name)
name string Obligatorio Nombre del dominio a consultar.

1.2.47 getUserOpenIncidents
Devuelve un xml con los identificadores de las incidencias de un usuario en estado nueva,
asignada y, en caso de indicarse, resuelta.
string getUserOpenIncidents (string user_id, includeResolved)
User_id string Obligatorio Usuario al que pertenecen las incidencias.
includeResolved Bool Obligatorio Indica si se han de incluir en los resultados las

incidencias resultas
33 de 55
1.2.48 getIncidentId
Método que devuelve el id de una incidencia / petición a partir de su código pasado como
parámetro.
string getIncidentId(string code)
code string Obligatorio Código de la incidencia.

INC YYYY-000000 / REQ YYYY-000000
Devuelve el id de la incidencia o petición que tiene ese código. El id de la incidencia se
corresponde con un dato de tipo GUID.
1.2.49 getSubstatusStr
Método que devuelve el nombre amigable de un subestado en el idioma indicado a partir de
su id pasado como parámetro.
string getSubstatusStr(string id, string lang)
id string Obligatorio ID del subestado.

lang string Opcional Código del idioma en formato ISO 639. Si no se
especifica devuelve el idioma por defecto.
Devuelve una cadena con el nombre del subestado.
1.2.50 getIncidentSubstatusId
Método que dado un nombre y un código del idioma en el que se encuentra, devuelve el id o
ids de los subestados que coincidan con el nombre suministrado.
string getIncidentSubstatusId(string name, string lang)
name string Obligatorio Nombre amigable del subestado
lang string Opcional Código del idioma en formato ISO 639. Si no

se especifica devuelve el idioma por defecto.
Lista de GUID (uniqueidentifier) en formato string que cumplen que su nombre en el idioma
indicado sea igual al suministrado y apliquen a incidencias
34 de 55
1.2.51 getTechnicianId
Devuelve el código de un técnico cuyo nombre de usuario se especifica como parámetro de
entrada.
string getTechnicianId(string username)
username string Obligatorio Username único del técnico a consultar.
Devuelve el id del técnico que tiene ese nombre de usuario. El id se corresponde con un dato
de tipo GUID.
1.2.52 getIncidentMainStatusId
Devuelve el estado principal (0: Nueva, 1: Rechazada, 2: Asignada,3: Resuelta y 4: Cerrada)
de un subestado que aplique a incidencias mediante su id suministrado como parámetro.
int getIncidentMainStatusId(string substatus_id)
substatus_id string Obligatorio ID del subestado a consultar.

Número entero con el estado principal del que depende el subestado.
1.2.53 getIncidentSubstatus
Devuelve el ID del subestado en el que se encuentra una incidencia / petición.
string getIncidentSubstatus(string incident_id)

A partir del ID devuelto por este método, y utilizando el método getSubstatusStr, se podrá
obtener el nombre amigable del subestado. Las incidencias pueden no tener subestado
asignado.
35 de 55
1.2.54 updateIncidentSubstatus
Actualiza el subestado de la incidencia pasada como parámetro.
int updateIncidentSubstatus (string incident_id, substatus_id, technician_id)
incident_id string Obligatorio ID de la incidencia a actualizar.

substatus_id string Opcional ID del nuevo subestado que se asignará a la
incidencia.
technician_id string Obligatorio ID del técnico a nombre del cual se hará la
anotación de cambio en el histórico del ticket
Devuelve un 1 si se actualiza correctamente el estado, -1 en caso contrario.
1.2.55 GetImpactId
Obtiene el identificador de un impacto en función de su nombre. Puede indicarse el idioma
en el que suministra el nombre, que en caso de omitirse funcionará con el valor por defecto
de la aplicación.
int GetImpactId(string name, string lang)
Name string Obligatorio Nombre del impacto en el idioma indicado
Lang String Opcional Cadena con el código del idioma en el que se

suministra el nombre (En blanco indica idioma
por defecto)
El identificador del impacto (uniqueidentifier en formato string) si existe el nombre, vacío si
no existe y -1 en caso de error.
1.2.56 GetUrgencyId
Obtiene el identificador de una urgencia en función de su nombre. Puede indicarse el idioma
de la aplicación.
int GetUrgencyId(string name, string lang)
Name string Obligatorio Nombre de la urgencia en el idioma indicado

por defecto)
36 de 55
El identificador de la urgencia (uniqueidentifier en formato string) si existe el nombre, vacío
si no existe y -1 en caso de error.
1.2.57 GetPriorityId
Obtiene el identificador de una prioridad en función de su nombre. Puede indicarse el idioma
de la aplicación.
int GetPriorityId(string name, string lang)
Name string Obligatorio Nombre de la urgencia en el idioma indicado

por defecto)
El identificador de la prioridad (uniqueidentifier en formato string) si existe el nombre, vacío
si no existe y -1 en caso de error
1.2.58 SetUrgencyAndImpact
Establece la urgencia e impacto de una incidencia (actualizando también su prioridad si es
necesario) en función de su id. Para utilizar este servicio debe estar activo el cálculo de
prioridad en función de impacto y urgencia. Además, si se encuentra activo el campo que
inhabilita la edición de prioridades calculadas, la prioridad obtenida por la pareja
impacto/urgencia debe ser válida.
int SetUrgencyAndImpact (string incident_id, string urgency_id, string impact_id)
incident_id string Obligatorio Identificador de la incidencia. GUID

(uniqueidentifier) en formato string
urgency_id String Obligatorio Identificador de la urgencia. GUID
impact_id String Obligatorio Identificador del impacto. GUID
Devuelve 1 si se actualiza con éxito y -1 en caso de error.
37 de 55
1.2.59 SetPriority
Establece la prioridad de una incidencia en función de su id. Para utilizar este servicio debe
estar inactivo el campo deshabilita el cambio en prioridades calculadas.
int SetPriority (string incident_id, string priority_id)

priority_id String Obligatorio Identificador de la prioridad. GUID
Devuelve 1 si se actualiza con éxito y -1 en caso de error.
1.2.60 getSDCustomFieldIdBySource
Devuelve el identificador del campo personalizado del Service Desk cuyo nombre coincida
exactamente con el especificado como parámetro para el tipo de elemento indicado.
string getSDCustomFieldIdBySource(string incident_id)
customField String Obligatorio Cadena literal con el nombre exacto del campo
personalizado a consultar
sourceElementCode Integer Obligatorio Identificador del tipo de elemento ( 0 :
Incidencias, 1 : Problemas, 2 : KnowledgeBase, 3
: Clientes, 4 : Cambios, 5 : Entregas, 6 : Usuarios,
7 : Servicios, 8 - SLAs, 9 : OLAs, 10 : UCs, 11 :
SLRs, 12 : SIPs, 13 : SQPs, 14 : Localizaciones, 15 :
BIAs, 16 : DRPs, 17 : Riesgos, 18 : Amenazas, 19 :
MTAs.)
38 de 55
1.2.61 newIncidentWithTechnicianTypeAndCategory
Creación de una nueva incidencia registrada por un técnico y a la que se le puede indicar el
tipo la categoría y el origen.
string newIncidentWithTechnicianTypeAndCategory (string incident_id)
pawSvcAuthUsers_id String Opcional Identificador del técnico que registra la

incidencia
Title String Obligatorio Título de la incidencia
creationDate String Opcional Fecha de creación de la incidencia (formato

YYYY#MM#DD#HH#MM)
typeId String Opcional Identificador del tipo de la incidencia
categoryId String Opcional Identificador de la categoria de la incidencia
sourceId String Opcional Identificador del origen de la incidencia
Retorna el identificador de la incidencia creada.
1.2.62 CloseIncident
Cierra una incidencia / petición en 1ª o 2ª línea en función de su id.
int CloseIncident (string incident_id, string pawSvcAuthUsers_id, int resolution, string

closingComments)

(uniqueidentifier) en formato string.
pawSvcAuthUsers_id String Opcional Identificador del técnico que cierra la
incidencia. Vacío si quien cierra es el usuario
notificador.
Resolution Integer Opcional Tipo de resolución: 0 - Correcta, 1 - Incorrecta.
Se asume 'Correcta' por defecto.
closingComments string Opcional Comentarios de cierre de la incidencia en
formato texto
Devuelve 1 si se resuelve con éxito y -1 en caso de error.
39 de 55
1.2.63 SolveIncident
Resuelve una incidencia / petición asignada a un grupo en función de su id.
int SolveIncident (string incident_id, string pawSvcAuthUsers_id, string solution)
incident_id String Obligatorio Identificador de la incidencia. GUID

pawSvcAuthUsers_id String Obligatorio Identificador del técnico que resuelve la
incidencia.
solution Integer Opcional Solución de la incidencia en formato texto
Devuelve 1 si se resuelve con éxito y -1 en caso de error.
1.2.64 AddAttachment
Método que inserta un anexo a una incidencia simulando el comportamiento del portal de
usuarios.
string AddAttachment (string incident_id, string user_id, string fileNameWithExtension,

string fileBase64Content, string comment)
incident_id string Obligatorio Identificador de la incidencia

user_id string Obligatorio Identificador del usuario que adjunta el
fichero
fileNameWithExtension string Obligatorio Nombre del fichero a subir (sin ruta completa
pero incluyendo su extensión).
fileBase64Content string Obligatorio Texto con el contenido del fichero codificado
en base 64.
comment String Opcional Comentario sobre el fichero adjuntado
40 de 55
1.2.65 getTypeIdByLang
Obtiene el identificador de un tipo en función de su nombre. Puede indicarse el idioma en el
que suministra el nombre, que en caso de omitirse funcionará con el valor por defecto de la
aplicación.
string getTypeIdByLang(string type, string lang)
Type string Obligatorio Nombre del tipo en el idioma indicado

suministra el tipo (En blanco indica idioma por
defecto)
El identificador del tipo (uniqueidentifier en formato string) si existe el nombre, vacío si no
existe y -1 en caso de error.
1.2.66 getCategoryIdByLang
Obtiene el identificador de una categoría en función de su ruta completa. Puede indicarse el
idioma en el que suministra la ruta, que en caso de omitirse funcionará con el valor por
defecto de la aplicación.
string getCategoryIdByLang (string category, string lang)
Category string Obligatorio Ruta de la categoría en el idioma indicado

suministra la categoría (En blanco indica idioma
por defecto)
El identificador de la categoría (uniqueidentifier en formato string) si existe la ruta, vacío si
no existe y -1 en caso de error.
41 de 55
1.2.67 getCustomFieldIdByLang
Obtiene el identificador de un campo personalizado del ServiceDesk en función de su
nombre. Puede indicarse el idioma en el que suministra el nombre, que en caso de omitirse
funcionará con el valor por defecto de la aplicación.
string getCustomFieldIdByLang (string customField, string lang)
CustomField string Obligatorio Nombre del campo personalizado en el idioma

indicado
por defecto)
El identificador del campo personalizado (uniqueidentifier en formato string) si existe el
nombre, vacío si no existe y -1 en caso de error.
1.2.68 getSDCustomFieldIdBySourceAndLang
Obtiene el identificador de un campo personalizado del ServiceDesk en función de su nombre
y elemento al que aplica. Puede indicarse el idioma en el que suministra el nombre, que en
caso de omitirse funcionará con el valor por defecto de la aplicación.
string getSDCustomFieldIdBySourceAndLang (string customField , int

sourceElementcode, string lang)
CustomField string Obligatorio Nombre del campo personalizado en el idioma

indicado
sourceElementCode Integer Obligatorio Identificador del tipo de elemento ( 0 :
Incidencias, 1 : Problemas, 2 : KnowledgeBase,
3 : Clientes, 4 : Cambios, 5 : Entregas, 6 :
Usuarios, 7 : Servicios, 8 - SLAs, 9 : OLAs, 10 :
UCs, 11 : SLRs, 12 : SIPs, 13 : SQPs, 14 :
Localizaciones, 15 : BIAs, 16 : DRPs, 17 :
Riesgos, 18 : Amenazas, 19 : MTAs.)
por defecto)
El identificador del campo personalizado (uniqueidentifier en formato string) si existe el
42 de 55
1.2.69 GetCalendarIdByIncident
Obtiene el identificador del calendario utilizado por una incidencia para su cálculo de
tiempos.
string GetCalendarIdByIncident (string incident_id)
Incident_id string Obligatorio Identificador de la incidencia. GUID

El identificador del calendario (uniqueidentifier en formato string) si existe la incidencia y
tiene calendario asociado, vacío si existe la incidencia pero no tiene calendario y -1 en
cualquier otro caso.
1.2.70 GetSLAIdByIncident
Obtiene el identificador del SLA utilizado por una incidencia para su cálculo de tiempos.
string GetCalendarIdByIncident (string incident_id)

El identificador del SLA (uniqueidentifier en formato string) si existe la incidencia y tiene SLA
asociado, vacío si existe la incidencia pero no tiene SLA y -1 en cualquier otro caso.
1.2.71 GetDateDiffHours
Obtiene la diferencia en horas entre dos fechas según el SLA y calendario dados. Si no es
posible obtener el calendario toma por defecto 24x7.
string GetDateDiffHours (string date1, string date2, string padSLAs_id, string

padCalendars_id)
date1 string Obligatorio Fecha inicial del intervalo
date2 string Obligatorio Fecha final del intervalo
padSLAs_id string Opcional Id del SLA sobre el que se quiere basar el

cálculo
padCalendars_id string Opcional Id del Calendario sobre el que se quiere basar
el cálculo
El número decimal de horas transcurridas en función del calendario indicado o en caso de
error un -1.
43 de 55
1.2.72 GetElapsedTimeFromCreationByIncident
Obtiene el tiempo transcurrido desde la creación de un ticket hasta el instante actual en
función de su SLA y Calendario.
string GetElapsedTimeFromCreationByIncident (string incident_id)

El número decimal de horas transcurridas desde la fecha de creación de la incidencia y la
fecha/hora actual en función de su SLA y Calendario o en caso de error un -1.
1.2.73 GetSLAElapsedTimeFromCreationByIncident
Obtiene el acumulado de tiempo consumido desde la creación de un ticket descontando las
horas en que ha estado en un subestado de parada de reloj hasta el instante actual en
función a su Calendario y SLA.
string GetSLAElapsedTimeFromCreationByIncident (string incident_id)

El número decimal de horas consumidas desde la fecha de creación de un ticket
descontando el tiempo en que ha estado en un subestado de parada de reloj o en caso de
error un -1.
1.2.74 GetCMDBRelShipTypeId
Obtiene el identificador de un tipo de relación de la CMDB en función de su nombre directo.
string GetCMDBRelShipTypeId (string name)
Name string Obligatorio Nombre de la relación
Devuelve el identificador del tipo de relación (uniqueidentifier en formato string) si existe el

44 de 55
1.2.75 GetCMDBStatusId
Obtiene el identificador de un tipo de relación de la CMDB en función de su nombre directo.
string GetCMDBStatusId (string name)
Name string Obligatorio Nombre del estado
Devuelve el identificador del estado (uniqueidentifier en formato string) si existe el nombre,

vacío si no existe y -1 en caso de error.
1.2.76 GetCMDBCustomFieldId
Devuelve el identificador del campo personalizado de la CMDB cuyo nombre coincida
exactamente con el especificado como parámetro.
string getCMDBCustomFieldId (string customField)
customField string Obligatorio Nombre del campo personalizado
Devuelve el identificador del campo personalizado (uniqueidentifier en formato string) si

existe el nombre, vacío si no existe y -1 en caso de error.
1.2.77 SetCMDBCIStatus
Cambia el estado del CI al nuevo estado indicado como parámetro. Junto con la modificación
se registrará la correspondiente entrada en el log de cambios del CI, y se invalidará su línea
base en el caso de que estuviese establecida.
int SetCMDBCIStatus (string ci_id, string status_id, string tech_id)
ci_id string Obligatorio Identificador del CI.

GUID (uniqueidentifier) en formato string
status_id string Obligatorio Identificador del estado.
tech_id string Obligatorio Identificador del técnico a cuyo nombre se
realizará la modificación (quedará así
registrado en el log de cambios del CI)
Devuelve 1 si se realiza lo operación con éxito y -1 en caso de error. Si el estado que se
desea cambiar es el mismo que ya tenía el CI, no realizará la actualización y devolverá éxito.
45 de 55
1.2.78 CreateCIsRel
Añade una nueva relación entre dos CIs, siempre y cuando dicha relación sea compatible con
los tipos de CIs, y no exista una relación de ese mismo tipo entre esos dos CIs. Junto con la
creación de la relación se registrarán las correspondientes entradas en los log de cambios de
ambos CIs, y se invalidarán sus líneas base en el caso de que estuviesen establecidas.
int CreateCIsRel (string ci1_id, string ci2_id, string rel_id, int impact, string tech_id)
Ci1_id string Obligatorio Identificador del primer CI de la relación.

Ci2_id String Obligatorio Identificador del segundo CI de la relación.
Rel_id String Obligatorio Identificador del tipo de la nueva relación a
crear.
Impact Int Opcional Impacto de la nueva relación
tech_id String Obligatorio Identificador del técnico a cuyo nombre se
Devuelve 1 si se crea la relación con éxito y -1 en caso de error.
1.2.79 DeleteCIsRel
Elimina una nueva relación existente entre dos CIs, siempre y cuando dicha relación ya
exista. Tras eliminar la relación se registrarán las correspondientes entradas en los log de
cambios de ambos CIs, y se invalidarán sus líneas base en el caso de que estuviesen
establecidas.
int DeleteCIsRel (string ci1_id, string ci2_id, string rel_id, string tech_id)
Ci1_id string Obligatorio Identificador del primer CI de la relación.

Ci2_id String Obligatorio Identificador del segundo CI de la relación.
Rel_id String Obligatorio Identificador del tipo de la relación a borrar.
Devuelve 1 si se borra la relación con éxito y -1 en caso de error.
46 de 55
1.2.80 setCMDBCustomFieldValue
Actualiza el valor del campo personalizado de CIs indicado como parámetro. Junto con la
modificación se registrará la correspondiente entrada en el log de cambios del CI, y se
invalidará su línea base en el caso de que estuviese establecida.
int setCMDBCustomFieldValue (string ci_id, string customField_id, string value, string

tech_id)
ci_id string Obligatorio ID del CI a actualizar.

customField_id string Obligatorio ID del campo personalizado a actualizar
Se puede especificar cadena vacía si se quiere
borrar el contenido del campo.
Devuelve 1 si se borra la relación con éxito y -1 en caso de error.
Para campos personalizados de tipo lista deberá introducirse como valor un entero que represente el
índice de las diferentes opciones. El valor para el índice de la primera opción será 0.
Para el campo personalizado de tipo check deberá introducirse un entero: 0 para No y 1 para Sí.
Para el campo personalizado de tipo fecha, se introducirá según el formato definido (YYYY#MM#DD).
En cambios realizados sobre campos personalizados de tipo bitácora la fecha será tomada a
partir de la fecha configurada en el servidor web en donde se aloje el servicio web.
1.2.81 GetUserCustomField (obsoleto)

Obtener el valor de un campo personalizado de un usuario. Este WebService es obsoleto y
desaparecerá en las próximas versiones. Usar GetCustomFieldValue en su lugar.
string GetUserCustomField (string user_id, string customField_id, string language)
user_id string Obligatorio ID del usuario.

customField_id string Obligatorio ID del campo personalizado.
language string Opcional Código del idioma en el que se desea la
información en formato ISO 639-1 Code
47 de 55
Devuelve un string con el valor (o los valores separados por punto y coma si es una lista
multi-selección) del campo personalizado indicado. Si es de tipo fecha tendrá formato
YYYY#MM#DD o YYYY#MM#DD#HH#MM. En caso de que haya algún error devuelve -1.
1.2.82 GetDomainByUser
Obtiene el dominio de un usuario.
string GetDomainByUser (string user_id)
user_id string Obligatorio ID del usuario.

Devuelve una cadena con el dominio del usuario indicado por parámetro. En caso de que
haya algún error devuelve -1.
1.2.83 GetUserByDNI
Obtiene el username de un usuario activo.
string GetUserByDNI (string dni)
dni string Obligatorio DNI del usuario en formato string.

Devuelve una cadena con el username del usuario con el DNI/identificador del parámetro.
Sólo buscará entre los usuarios activos, y si hubiera más de uno, aparecerían sus usernames
separados por “;”. En caso de que haya algún error devuelve -1.
1.2.84 GetCustomFieldValue
Obtener el valor de un campo personalizado de un elemento
string GetCustomFieldValue (string element_id, string customField_id, string language)
element_id string Obligatorio ID del elemento.

customField_id string Obligatorio ID del campo personalizado.
language string Opcional Código del idioma en el que se desea la
información en formato ISO 639-1 Code
Devuelve un string con el valor (o los valores separados por punto y coma si es una lista
multi-selección) del campo personalizado indicado. Si es de tipo fecha tendrá formato
YYYY#MM#DD o YYYY#MM#DD#HH#MM. En caso de que haya algún error devuelve -1.
48 de 55
1.2.85 GetJSONTableData
Obtener los datos de un listado (Ptable) de Proactivanet.
string GetJSONTableData (string URLTable, string pageNumber, string pageRows)
URLTable string Obligatorio URL completa de lla tabla o listado específico

del que se quieran obtener los datos.
pageNumber string Opcional Número de página (en el caso que se quiera
paginación)
pageRows string Opcional Número de filas por página (en el caso que se
quiera paginación)
Devuelve un JSON con los datos que visualiza a PTable o listado específico de Proactivanet.
La URL que se pasa como parámetro puede tener parámetros pasados por GET.
La paginación está basada en la ordenación del listado y puede ser opcional.
La PTable o listado del que se extrae la información debe poder accederse de forma
anónima.
49 de 55
Cómo utilizar WebServices públicos de
Proactivanet
A continuación se describe cómo consumir los WebServices públicos de Proactivanet

(externalServices.asmx) en un proyecto de Visual Studio.
Los pasos a seguir para generar el proxy de conexión son:
1) Añadir referencia al webService.
Crear proyecto que va a utilizar los webServices en el Visual Studio. Hacer click botón
derecho sobre “References” y seleccionar “Add Service Reference”.
50 de 55
2) Enlazar referencia con servicios web de Proactivanet
En el cuadro de diálogo que se muestra, hacer click sobre “Advanced”.
Sobre el nuevo diálogo que se muestra, hacer click sobre “Add Web Reference…” e introducir
la URL donde está accesible Proactivanet.
http://URLServidor/Proactivanet/externalServices/externalServices.asmx
Donde “URLServidor” será el nombre del servidor web donde está accesible Proactivanet
51 de 55
3) Autentificarse en Proactivanet
Introducir URL, pulsar “Enter” y acceder a Proactivanet con sus credenciales. Estos
credenciales serán sólo para establecer la conexión, luego se accederá de forma anónima
una vez terminada la configuración.
4) Crear referencia
Una vez que se acceda a los servicios web, introducir nombre para la referencia “Web
reference name” y hacer click sobre “Add Reference”.
5) Añadir Referee en la cabecera de los métodos
52 de 55
Una vez generada la referencia web, acceder al código .cs haciendo click sobre un método.
Localizar constructor ProactivanetServices y añadir después del constructor la función
GetWebRequest para especificar el Referee necesario para autentificar el acceso.
El valor del Referee debe ser el CLIENTID proporcionado por Proactivanet para que conecte
con la aplicación.
6) Probar acceso a los WebServices
Se puede probar el acceso a los webServices haciendo una llamada desde código cs del
proyecto creado.
Este sería un ejemplo de llamada en un programa de consola.
Otro ejemplo de llamada para insertar un usuario:
53 de 55
54 de 55

ProactivaNET WebServices PDF

Cargado por

Información del documento

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

ProactivaNET WebServices PDF

Cargado por

Copyright:

Formatos disponibles

Integración

Fecha última revisión: 18/10/2018

Versión Proactivanet asociada: 10.02.00.00

PROPIEDAD INTELECTUAL E INDUSTRIAL

8.6 05/07/2012 Versión inicial del documento.

8.7 23/07/2012 Revisado texto descripción general.

8.10 21/01/2013 Nuevos métodos añadidos.

8.11 12/04/2013 Nuevo método añadido.

8.16.2.0 23/07/2014 Añadidos métodos y nueva forma de autentificación / autorización a

8.21.0.0 01/07/2015 Añadidos métodos para dar soporte multi-idioma a campos

8.24.0.0 31/05/2016 Añadida información sobre cómo consumir los webservices.

8.30.0.0 23/06/2017 Añadidos métodos de obtención de datos JSON e inserción de adjuntos

10.0.0.1 16/07/2018 Añadidos 3 nuevos métodos.

10.1.0.0 16/08/2018 Nuevos métodos añadidos y método marcado como obsoleto

10.2.0.0 18/10/2018 Añadido método para crear anotaciones de una incidencia

El objetivo del presente documento es introducir, y posteriormente detallar el servicio web

Los mecanismos de autentificación y autorización podrán ser dos:

- Autentificación / Autorización a través de los mecanismos que utiliza la aplicación.

- Autentificación / Autorización anónima. En este caso se utilizará un Proxy de conexión

1.2 Definición de métodos

- Los métodos trabajarán siempre con parámetros tipo string o int.

- Los métodos se implementarán como webservices lo que posibilitará llamarlos tanto

- Todos los métodos tienen autentificación y autorización anónima.

- Los parámetros fecha se pasarán como string y tendrán el formato

- Si alguno de los métodos produce un error devolverá “-1”.

- Si algún parámetro no aplica, se pasará en la llamada la cadena vacía “”.

- El técnico que registra la incidencia no se establece como parámetro en ninguno de

- Si no existen resultados para la llamada se devolverá la cadena vacía.

Parámetro Tipo Obligatorio Descripción

user_id string Obligatorio ID del usuario que reporta la incidencia.

creationDate string Opcional Fecha de creación de la incidencia.

Devuelve la URL para acceder al formulario de creación de incidencias donde el notificador,

Si el usuario infiere una localización, y bien el usuario o la localización inferida infieren a su

Devuelve el id de la incidencia ya creada en Proactivanet®.

Parámetro Tipo Obligatorio Descripción

user_id string Obligatorio ID del usuario que reporta la incidencia.

creationDate string Opcional Fecha de creación de la incidencia.

Si el usuario infiere una localización, y bien el usuario o la localización inferida infieren a su

Parámetro Tipo Obligatorio Descripción

user_id string Obligatorio ID del usuario que reporta la incidencia.

creationDate string Opcional Fecha de creación de la incidencia.

Si el usuario infiere una localización, y bien el usuario o la localización inferida infieren a su

Análogo al método newIncidentWithDescription pero permitiendo añadir un servicio del

Parámetro Tipo Obligatorio Descripción

user_id string Obligatorio ID del usuario que reporta la incidencia.

creationDate string Opcional Fecha de creación de la incidencia.

Si el usuario infiere una localización, y bien el usuario o la localización inferida infieren a su

String newIncidentWithTechnician(string pawSvcAuthUsers_id, string title, string

Parámetro Tipo Obligatorio Descripción

pawSvcAuthUsers_id string Obligatorio ID del técnico que registra la incidencia.

creationDate string Opcional Fecha de creación de la incidencia.

 id: identificador de la incidencia (GUID (uniqueidentifier) en formato string).

 title: título de la incidencia (string).

 creationDate: fecha de creación de la incidencia (string con formato "2014-12-

 description: texto enriquecido con la descripción de la incidencia (string).

 padMainStatus_id: identificador del estado principal de la incidencia: nueva,

 padMainStatusName: nombre del estado principal de la incidencia (string).

 padStatus_id: identificador del subestado de la incidencia (GUID (uniqueidentifier)

 padStatusName: nombre del subestado de la incidencia (string).

string getJSONIncidentDataById (string incident_id)

Parámetro Tipo Obligatorio Descripción

incident_id string Obligatorio ID de la incidencia a consultar.

string getJSONTranslatedIncidentDataById (string incident_id)