Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

Ambos lados, revisión anterior Revisión previa
Próxima revisión
Revisión previa
guia_administracion:api [2017/09/18 03:39]
vanessa [get_incidents]
guia_administracion:api [2020/05/06 07:50] (actual)
manu
Línea 1: Línea 1:
-====== ​13. API de Integria IMS ======+====== ​12. API de Integria IMS ======
  
 ===== API externa de Integria ===== ===== API externa de Integria =====
Línea 86: Línea 86:
     * Filtro de propietario:​ Id del usuario al que está asignada la incidencia (opcional).     * Filtro de propietario:​ Id del usuario al que está asignada la incidencia (opcional).
     * Filtro de creador: Id del usuario que ha creado la incidencia (opcional).     * Filtro de creador: Id del usuario que ha creado la incidencia (opcional).
 +    * Filtro de incidencia: Id de incidencia (opcional).
  
  
Línea 198: Línea 199:
   * User: Es el creador del ticket.   * User: Es el creador del ticket.
   * Parámetros:​   * Parámetros:​
-    * Título (Obligatorio). Títulos vacíos no están admitidos.+    * Título (Obligatorio). Títulos vacíos no están admitidos. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Id del grupo (obligatorio).     * Id del grupo (obligatorio).
     * Prioridad (no obligatorio). Puede tener estos valores:     * Prioridad (no obligatorio). Puede tener estos valores:
Línea 207: Línea 208:
       * 3 -> 4 Serious.       * 3 -> 4 Serious.
       * 4 -> 5 Very serious.       * 4 -> 5 Very serious.
-    * Descripción (no obligatorio). Vacío por defecto +    * Descripción (no obligatorio). Vacío por defecto. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​. 
-    * Id de inventario (no obligatorio).+    * Id de inventario (no obligatorio). ​Se pueden crear incidencias con varios objetos de inventario. Tendrán que ir separados entre sí por :
     * Id de tipo de incidencia (no obligatorio). 0 (ninguno) por defecto.     * Id de tipo de incidencia (no obligatorio). 0 (ninguno) por defecto.
     * Email en copia (no obligatorio):​ Por defecto vacío.     * Email en copia (no obligatorio):​ Por defecto vacío.
     * Propietario (no obligatorio). Por defecto admin.     * Propietario (no obligatorio). Por defecto admin.
     * Id ticket padre (no obligatorio). Por defecto, 0 (sin padre)     * Id ticket padre (no obligatorio). Por defecto, 0 (sin padre)
-    * Estado (no obligatorio). Puede tomar los siguientes valores:+    * Estado (obligatorio). Puede tomar los siguientes valores:
       * 1 -> Nuevo (por defecto)       * 1 -> Nuevo (por defecto)
       * 2 -> No confirmado       * 2 -> No confirmado
Línea 242: Línea 243:
   http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=   http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
   userpass&​pass=api_pass&​op=create_incident&​params=Titulo%20de%20la%20incidencia,​   userpass&​pass=api_pass&​op=create_incident&​params=Titulo%20de%20la%20incidencia,​
-  2,​1,​Descripcion%20de%20la%incidencia,​1,​1,​[email protected],​admin,​0,​1+  2,​1,​Descripcion%20de%20la%incidencia,​1:2:3,​1,​[email protected],​admin,​0,​1
  
 **Resultado CSV** **Resultado CSV**
Línea 250: Línea 251:
 **Llamada con resultado en XML** **Llamada con resultado en XML**
  
-  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​pass=+  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass= 
 +  userpass&pass=
   api_pass&​op=create_incident&​params=Titulo%20de%20la%20incidencia,​2,​1,​   api_pass&​op=create_incident&​params=Titulo%20de%20la%20incidencia,​2,​1,​
-  Descripcion%20de%20la%incidencia,​1,​1,​[email protected],​admin,​0&​return_type=xml+  Descripcion%20de%20la%incidencia,​1:2:3,​1,​[email protected],​admin,​0&​return_type=xml
  
 **Resultado XML** **Resultado XML**
Línea 259: Línea 261:
      0      0
   </​xml>​   </​xml>​
 +  ​
   ​   ​
 ==== update_incident ==== ==== update_incident ====
Línea 299: Línea 302:
     * Id de tipo de incidencia (no obligatorio). 0 (ninguno) por defecto.     * Id de tipo de incidencia (no obligatorio). 0 (ninguno) por defecto.
     * Info_extra (no obligatorio)     * Info_extra (no obligatorio)
 +    * Info_extra2 (no obligatorio)
 +    * Info_extra3 (no obligatorio)
 +    * Info_extra4 (no obligatorio)
     * CampoTipoIncidencia1     * CampoTipoIncidencia1
     * ...     * ...
Línea 325: Línea 331:
   <xml>   <xml>
      0      0
 +  </​xml>​
 +
 +==== add_inventory_to_ticket ====
 +
 +  * Resultado: Permite asociar un objeto de inventario a un ticket.
 +  * Parámetros:​
 +    * Id del ticket (obligatorio).
 +    * Id del objeto de inventario (Obligatorio).
 + 
 +
 +**Llamada con resultado en CSV**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=userpass&​pass=api_pass&​op=add_inventory_to_ticket&​params=1,​2
 +
 +**Resultado CSV**
 +
 +  1
 +
 +**Llamada con resultado en XML**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=userpass&​pass=api_pass&​op=add_inventory_to_ticket&​params=1,​2&​return_type=xml
 +
 +**Resultado XML**
 +
 +  <xml>
 +     1
   </​xml>​   </​xml>​
  
Línea 568: Línea 600:
   * Resultado: Devuelve 1 si se crea correctamente,​ 0 si no.   * Resultado: Devuelve 1 si se crea correctamente,​ 0 si no.
   * Parámetros:​   * Parámetros:​
-    * Username: (obligatorio)+    * Username: (obligatorio). Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Id del grupo: (obligatorio)     * Id del grupo: (obligatorio)
     * Id del perfil: (obligatorio)     * Id del perfil: (obligatorio)
     * Email: (no obligatorio). Por defecto vacío     * Email: (no obligatorio). Por defecto vacío
     * Password: (no obligatorio). Por defecto es el nombre del usuario     * Password: (no obligatorio). Por defecto es el nombre del usuario
-    * Descripción:​ (no obligatorio). Por defecto vacío.+    * Descripción:​ (no obligatorio). Por defecto vacío. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Nombre Real: (no obligatorio). Por defecto vacío.     * Nombre Real: (no obligatorio). Por defecto vacío.
     * Externaluser:​ (no obligatorio). Por defecto 0.     * Externaluser:​ (no obligatorio). Por defecto 0.
Línea 689: Línea 721:
   * Resultado: Devuelve 1 si se crea correctamente,​ 0 si no.   * Resultado: Devuelve 1 si se crea correctamente,​ 0 si no.
   * Parámetros:​   * Parámetros:​
-    * Nombre completo: (obligatorio)+    * Nombre completo: (obligatorio). Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Compañía: (obligatorio)     * Compañía: (obligatorio)
     * Email (obligatorio)     * Email (obligatorio)
Línea 707: Línea 739:
       * ru -> Русский       * ru -> Русский
       * zh_CN -> 简化字       * zh_CN -> 简化字
-    * Comentarios:​ (no obligatorio). Por defecto vacío.+    * Comentarios:​ (no obligatorio). Por defecto vacío. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Id de categoría: (no obligatorio). Por defecto 0 (ninguna).     * Id de categoría: (no obligatorio). Por defecto 0 (ninguna).
     * Dirigido por: (no obligatorio). Por defecto 0.     * Dirigido por: (no obligatorio). Por defecto 0.
Línea 837: Línea 869:
     * Id compañía: (obligatorio).     * Id compañía: (obligatorio).
     * Id factura: (obligatorio).     * Id factura: (obligatorio).
-    * Concepto: (obligatorio).+    * Concepto: (obligatorio). Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Cantidad: (obligatorio).     * Cantidad: (obligatorio).
     * Impuestos: Porcentaje de impuestos (no obligatorio). Por defecto 0.     * Impuestos: Porcentaje de impuestos (no obligatorio). Por defecto 0.
     * Moneda: Cadena de texto (obligatorio).     * Moneda: Cadena de texto (obligatorio).
-    * Descripción:​ (no obligatorio). Por defecto vacío.+    * Descripción:​ (no obligatorio). Por defecto vacío. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Flag bloqueado: Booleano (no obligatorio). Por defecto 0 (no bloqueado).     * Flag bloqueado: Booleano (no obligatorio). Por defecto 0 (no bloqueado).
     * Id usuario bloqueador: (obligatorio si flag bloqueado está activo). Por defecto vacío     * Id usuario bloqueador: (obligatorio si flag bloqueado está activo). Por defecto vacío
Línea 901: Línea 933:
   * Resultado: Devuelve el id de la compañía creada   * Resultado: Devuelve el id de la compañía creada
   * Parámetros:​   * Parámetros:​
-    * Nombre: (obligatorio) +    * Nombre: (obligatorio). Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​. 
-    * Dirección: (no obligatorio). Por defecto vacío.+    * Dirección: (no obligatorio). Por defecto vacío. Para introducir comas en este parámetro habrá que sustituirla por (:::). Por ejemplo, para introducir "Doe, John" habrá que insertar en la url "​Doe:::​%20John"​.
     * Identificación fiscal: (no obligatorio). Por defecto vacío.     * Identificación fiscal: (no obligatorio). Por defecto vacío.
     * Id del rol de compañía: (no obligatorio). Por defecto 0 (ningún rol).     * Id del rol de compañía: (no obligatorio). Por defecto 0 (ningún rol).
Línea 1131: Línea 1163:
                  <​name>​Muy grave</​name>​                  <​name>​Muy grave</​name>​
          </​priority>​          </​priority>​
 +  </​xml>​
 +  ​
 +==== get_types ====
 +
 +  * Resultado: Devuelve una lista con los tipos de tickets disponibles en Integria.
 +  * Parámetros:​ -
 +
 +**Llamada con resultado en CSV**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=get_types
 +  ​
 +**Resultado CSV**
 +
 +  1,Tipo 1
 +  2,Tipo 2
 +  3,Tipo 3
 +
 +**Llamada con resultado en XML**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=userpass&​pass=
 +  api_pass&​op=get_types&​return_type=xml
 +
 +**Resultado XML**
 +
 +  <xml>
 +         <​status>​
 +                 <​id>​1</​id>​
 +                 <​name>​Tipo 1</​name>​
 +         </​status>​
 +         <​status>​
 +                 <​id>​2</​id>​
 +                 <​name>​Tipo 2</​name>​
 +         </​status>​
 +         <​status>​
 +                 <​id>​3</​id>​
 +                 <​name>​Tipo 3</​name>​
 +         </​status>​
   </​xml>​   </​xml>​
   ​   ​
Línea 1332: Línea 1402:
   </​xml>​   </​xml>​
  
 +==== get_user_exists_in_group ====
 +
 +  * Resultado: Devuelve 1 si el usuario dado existe en alguno de los grupos dados. 0 en caso contrario
 +  * Parámetros serializados: ​
 +    * id_usuario
 +    * id_grupo: Pueden ser varios grupos separados por un token.
 +
 +**Llamada**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=user_exists_in_group&​params=test,​4,​5
 ==== get_incident_inventories ==== ==== get_incident_inventories ====