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 [2020/04/27 23:46]
manu
guia_administracion:api [2020/10/14 06:27] (actual)
dani [get_incidents_summary]
Línea 199: 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 208: 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). Se pueden crear incidencias con varios objetos de inventario. Tendrán que ir separados entre sí por :     * 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.
Línea 262: Línea 262:
   </​xml>​   </​xml>​
   ​   ​
-**ADVERTENCIA**:​ La separación entre campos debe ser con dos puntos (:). 
   ​   ​
 ==== update_incident ==== ==== update_incident ====
Línea 311: Línea 310:
  
 **ADVERTENCIA**:​ Si no se desea modificar el valor actual de los campos del tipo de ticket se deberán rellenar dichos campos con su valor correspondiente. En el caso de estar vacíos, se actualizarán sin valor. ​ **ADVERTENCIA**:​ Si no se desea modificar el valor actual de los campos del tipo de ticket se deberán rellenar dichos campos con su valor correspondiente. En el caso de estar vacíos, se actualizarán sin valor. ​
-La separación entre campos debe ser con dos puntos (:). 
  
 **Llamada con resultado en CSV** **Llamada con resultado en CSV**
Línea 602: 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 723: 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 741: 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 871: 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 935: 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 1365: Línea 1363:
      97      97
   </​xml>​   </​xml>​
 +  ​
 +==== get_incidents_summary ====
 +
 +  * Resultado: Devuelve el resumen del estado de los tickets.
 +  * Parámetros:​ Campo, si se añade el campo solo mostrará dicho valor, los campos permitidos son: 
 +    * new
 +    * unconfirmed
 +    * assigned
 +    * reopened
 +    * verified
 +    * pending_third_person
 +    * closed
 +    * not_closed
 +    * total 
 +  ​
 +**Llamada con resultado en CSV**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=get_incidents_summary&​return_type=csv
 +
 +**Resultado CSV**
 +
 +  NEW,1
 +  UNCONFIRMED,​0
 +  ASSIGNED,70
 +  REOPENED,3
 +  VERIFIED,12
 +  PENDING_THIRD_PERSON,​308
 +  CLOSED,3382
 +  NOT_CLOSED,​393
 +  TOTAL,3776
 +
 +**Llamada con resultado en XML**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=get_incidents_summary&​return_type=xml
 +
 +**Resultado XML**
 +
 +  <xml>
 +     <​new>​1</​new>​
 +     <​unconfirmed>​0</​unconfirmed>​
 +     <​assigned>​70</​assigned>​
 +     <​reopened>​3</​reopened>​
 +     <​verified>​12</​verified>​
 +     <​pending_third_person>​308</​pending_third_person>​
 +     <​closed>​3382</​closed>​
 +     <​not_closed>​393</​not_closed>​
 +     <​total>​3776</​total>​
 +  </​xml>​
 + 
 +**LLamada con un campo específico**
 +
 +**Llamada con resultado en CSV**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=get_incidents_summary&​return_type=csv&​params=not_closed
 +
 +**Resultado CSV**
 +  ​
 +  393
 +
 +**Llamada con resultado en XML**
 +
 +  http://​127.0.0.1/​integria/​include/​api.php?​user=user&​user_pass=
 +  userpass&​pass=api_pass&​op=get_incidents_summary&​return_type=xml&​params=not_closed
 +
 +**Resultado XML**
 +
 +  <xml>
 +     <​data>​393</​data>​
 +  </​xml>​
 +
  
 ==== get_inventories ==== ==== get_inventories ====