---
title: Webservices para Uso en la Plataforma 4biz
slug: dev-es/webservices-para-uso-en-la-plataforma-4biz
description: Learn how to integrate with 4biz Service Management using various web services with this comprehensive document. Get step-by-step guidance on the authentication process, creating and modifying tickets, retrieving ticket details, managing occurrences, fetc
createdAt: 2022-06-26T18:42:20.000Z
---

Este documento está destinado a proporcionar orientaciones sobre los Servicios Web que están disponibles para la integración con la Gestión de Servicio de <font color="#ff6900">**4biz**</font>.

Los Servicios Web se crearon en <font color="#ff6900">**4biz** </font>****para la inclusión, actualización, consulta y cancelación de solicitudes de servicio (incidentes y solicitudes).

## Antes de empezar

1. Antes de utilizar cualquier operación REST de <font color="#ff6900">**4biz**</font>, es necesario que el usuario esté autenticado..
2. La autenticación se realiza a través de la operación REST login en la URL **/services/login**, que recibe un objeto **CtLogin&#x20;**&#x71;ue contiene los atributos **userName**, **password&#x20;**&#x79; **platform**.
3. El atributo platform debe contener la identificación del sitio que está solicitando el servicio.
4. La operación de inicio de sesión devuelve un valor alfanumérico en el atributo **SessionID**. Este mismo **SessionID** debe ser utilizado en las otras llamadas REST. El objeto devuelto contiene el código y la descripción del error en caso de problemas en la ejecución de la operación de inicio de sesión.
5. El usuario autentificado constituye la clave para la sincronización de datos, cuando el atributo **synchronize&#x20;**&#x74;iene el valor **true**.
6. Los servicios de inclusión y actualización de solicitudes tienen el atributo **synchronize**. Cuando este atributo es **true**, el registro de usuarios y el catálogo de servicios serán creados o actualizados automáticamente en <font color="#ff6900">**4biz**</font> basándose en la información enviada en la solicitud del Servicio Web.

:::hint{type="success"}
✅ <u>**Regla**</u>**:&#x20;**&#x54;odos los servicios REST creados en <font color="#ff6900">**4biz**</font> reciben un objeto de entrada y devuelven un objeto. En caso de error, el objeto de retorno contiene el código y la descripción del error. Cuando no hay error, además de los atributos definidos para cada servicio, el objeto de retorno contiene la fecha y hora de ejecución y el id de la operación. <font color="#ff6900">**4biz**</font> garantiza que cada solicitud se registra en su base de datos y se devuelve un ID de operación al solicitante, incluso en caso de error.
:::

## Acciones

### Crear un ticket (request\_create)

- Condiciones previas: **configurar los contratos, grupos, flujos y permisos**.

:::hint{type="info"}
**🖊&#x20;**<u>**Nota**</u>**:&#x20;**&#x50;ara ver el título, el parámetro **301 - Mostrar título en la solicitud de servicio&#x20;**&#x64;ebe estar activado.
:::

El webservice que se muestra a continuación crea un ticket para un usuario que está registrado en el sistema.

**Creación de una Solicitud/Incidente:**

:::CodeblockTabs
URL

```html
/webmvc/servicerequestincident/create
```

Método

```none
POST
```

Atributos de Entrada

```none
• userId: Atributo obligatorio que recibe el identificador del empleado;
• activityId: Atributo obligatorio que recibe el identificador de la actividad a abrir;
• contractId: Atributo obligatorio que recibe el identificador del contrato para abrir el ticket;
• requesttitle: Atributo no obligatorio que recibe el título cuando se abre el ticket;
• description: Atributo obligatorio que recibe la descripción para abrir el ticket;

Los siguientes datos pueden incluirse en el webservice, sin embargo, no son obligatorios. 
El sistema captura los campos por defecto existentes en los registros del sistema y 
aunque pase información diferente a la del registro del empleado, el sistema no sustituye 
la información del empleado.

• contactEmail: Introduzca el correo electrónico para la creación del ticket;
• contactPhone: Introduzca el número de teléfono para la creación del ticket;
• contactExtension: Introduzca la extensión del número de teléfono para la creación del ticket;
• unityId: Introduzca la unidad para abrir el ticket;
• originId: Introduzca el origen del contacto para abrir el ticket - parámetro de origen por defecto;
• urgency: Introduzca la urgencia para abrir el ticket - por defecto B de la parte inferior;
   - Valores posibles: 
        C - Crítica
        A - Alta
        M - Media
        B – Baja

• impact: Introduzca el impacto para la apertura del ticket - por defecto B de la parte inferior;
   - Valores posibles: 
        AL – Altísimo
        A – Alto
        E – Elevado
        M – Medio
        B - Bajo

• userId: Introduzca el responsable de la liberación, que puede ser diferente del solicitante o 
el mismo, en este caso, sólo introduzca uno u otro;

```

Ejemplo de Entrada en el Webservice

```json
{
    "sessionID": "5dcff97d-7f3c-4eed-a3c8-ca2f07fda2e3",
    "requesterId" : 3,
    "activityId" : 29,
    "contractId" : 1,
    "requestTitle": "Prueba de webservice - Título 05"
    "description" : "Prueba de la creación de la solicitud de servicio, a través de Webservice."
}
```

Atributos de Salida

```none
•   idGrupoAtual: Identificador del grupo al que se asignó el ticket;
•   idTarefa: Identificador de la tarea a la que se asignó el ticket;
•   idStatus: Identificador del estado del ticket, que puede ser de 1 a 7, 
como se describe a continuación;
•   status: Descripción del estado del ticket, que puede ser::
    o   1 – IN_PROGRESS
    o   2 - SUSPENDED
    o   3 - CANCELED
    o   4 - SOLVED
    o   5 - REOPENED
    o   6 - CLOSED
    o   7 - RECLASSIFIED
•   localidade: Descripción de la localidad a la que se asignó el ticket
•   dataHoraInicio: Devuelve la fecha y hora de inicio del ticket;
•   dataHoraInicioSLA: Devuelve la fecha y hora de inicio de la captura 
para la contabilidad del SLA;
•   dataHoraLimite: Devuelve la fecha y el tiempo límite para cerrar el SLA;
•   dataHoraSolicitacao: Devuelve la fecha y hora de creación del ticket;
•   descrição: Devuelve la descripción del ticket;
•   emailcontato: Devuelve la dirección de correo electrónico de contacto del ticket;
•   idContrato: Devuelve el identificador del contrato donde se abrió el ticket;
•   idLocalidade: Devuelve el identificador de la localidad donde se abrió el ticket;
•   idServico: Identificador del servicio para el que se abrió el ticket;
•   idSolicitacaoServico: Número de identificación del ticket abierto;
•   idSolicitante: Identificador del solicitante que abrió el ticket;
•   idUnidade: Identificador de la unidad para la que se abrió el ticket;
•   impacto: Devuelve el acrónimo de impacto asignado al ticket;
•   nomecontato: Devuelve el nombre del contacto asignado al ticket abierto;
•   nomeServico: Devuelve el nombre del servicio abierto;
•   nomeTipoDemandaServico: Devuelve si la demanda abierta fue 
I - Incidente o S - Solicitud;
•   nomeUnidadeSolicitante: Devuelve el nombre de la unidad para la que se abrió el ticket;
•   siglaGrupo: Devuelve el acrónimo de registro del grupo actual para el que se abrió el ticket;
•   tarefa: Devuelve la tarea de flujo en la que se abrió el ticket;
•   telefonecontato: Devuelve el número de teléfono de contacto para el que se abrió el ticket;
•   urgência: Devuelve la urgencia del ticket;
•   sla: Devuelve el tiempo de servicio;
•   nomeGrupoAtual: Devuelve la descripción del grupo al que se asignó el ticket
```

Ejemplo de respuesta válida

```json
{
    "idGrupoAtual": 2,
    "idTarefa": 4358,
    "idStatus": 1,
    "status": "En Curso",
    "localidade": "Distrito Federal",
    "dataHoraInicio": "2020-02-10 12:53:46 PM BRST",
    "dataHoraInicioSLA": "2020-02-10 12:53:46 PM BRST",
    "dataHoraLimite": "2020-02-12 12:53:00 PM BRST",
    "dataHoraSolicitacao": "2020-02-10 12:53:46 PM BRST",
    "descricao": "Prueba de la Creación de la solicitud de servicio, a través de Webservice.",
    "emailcontato": "contact@citsmart.com",
    "idContrato": 1,
    "idLocalidade": 1,
    "idServico": 29,
    "idSolicitacaoServico": 3604,
    "idSolicitante": 3,
    "idUnidade": 1,
    "impacto": "B",
    "nomecontato": "Consultor",
    "nomeServico": "La navegación por Internet es lenta",
    "nomeTipoDemandaServico": "I",
    "nomeUnidadeSolicitante": "Ciudad Satélite",
    "siglaGrupo": "SDNIVEL1",
    "tarefa": "Aprobar",
    "telefonecontato": "3242-4433",
    "urgencia": "B",
    "sla": "24:00",
    "nomeGrupoAtual": "1º Nivel"
}
```
:::

### Modificación de la Información de un Ticket (create)

Modificación de la Información de la Solicitud/Incidente:

:::CodeblockTabs
URL

```html
/services/request/create
```

Atributos de entrada

```none
    ​​synchronize - indica si la información del usuario y/o del servicio será sincronizada.
    request - información de la solicitud de origen de la clase CtRequest, que contiene:
        numberOrigin - número de la solicitud en el sistema de origen. Obligatorio cuando el número de atributo no es informado.
        descripción - descripción del incidente o solicitud (opcional).
        userID - ID de usuario del solicitante (obligatorio). Se incluirá si no existe en la base de 4biz y el atributo synchronize es true.
        number - número de la solicitud en 4biz (obligatorio).
        contact - datos del solicitante. (Obligatorio si el solicitante no existe en 4biz y el atributo synchronize es true).
            name - nombre del solicitante (obligatorio).
            phoneNumber - número de teléfono del solicitante (obligatorio).
            correo electrónico - correo electrónico del solicitante (obligatorio).
        service - datos del servicio (opcional).
            code - código del servicio. Opcional, si se informa el nombre del servicio).
            name - nombre del servicio. Se requiere cuando el servicio no existe en 4biz y el atributo synchronize es true.
            category - categoría del servicio. Obligatorio cuando el servicio no existe en 4biz y el atributo synchronize está establecido en true.
                Code - código de la categoría.
                Name - nombre de la categoría.
         Urgency - urgencia de la solicitud (opcional). Valores posibles: H=Alto, M=Medio, L=Bajo. Si no se informa, la urgencia se calculará a partir de los parámetros del catálogo de servicios de 4biz ITSM.
         impacto de la solicitud (opcional). Valores posibles: H=Alto, M=Medio, L=Bajo. Si no se informa, el impacto se calculará a partir de los parámetros del catálogo de servicios de 4biz ITSM.
```

Atributos de salida

```none_1
     Igual que los atributos de entrada.
```

Ejemplo

```json
   {"Synchronize": true,
    "request": {"numberOrigin": "9999",
    "userID": "ciclano.de.tal",
    "contact": {"phoneNumber": "61 84460709",
    "email" "Cyclone",
    "name": "Cyclone of such"},
    "description": "Inclusion of request using REST v3 - Changed",
    "cyclano.de.tal@centralit.com.br",
    "department" "Service": {"name": "SERVICO.TESTE.2",
    "category": {"name": "Category 2"}}}}

    /*Suponiendo que en el atributo platform, en el inicio de sesión, se informara "usuario" y considerando el atributo synchronize igual a true, 4biz va a:
        Incluir el solicitante en el registro de usuarios, si no existe en la base;
        Incluir el servicio en el catálogo de servicios del contrato 1, si no existe en la base, y registrar el DE-PARA de servicios para el cliente;
        Alterar el solicitante y el servicio de la solicitud con el número de origen 9999.*/
```
:::

### Modificación del estado de un Ticket (updateStatus)

Modificación del estado de un Incidente/Solicitud:

:::CodeblockTabs
URL

```html
/services/request/updateStatus
```

Atributos de entrada

```none
    ​number - número de la solicitud en 4biz ITSM. Obligatorio cuando no se indica el atributo numberOrigin.
    numberOrigin - número de la solicitud en el sistema de origen. Obligatorio cuando el atributo de número no es informado.
    status - estado de la solicitud, que contiene:
        code - código del estado (obligatorio). Valores posibles: En curso, Suspendido, Cancelado, Resuelto, Reabierto, Cerrado.
        details - complemento de la justificación para la modificación del estado (opcional).
```

Atributos de salida

```none_1
    Igual que los atributos de entrada.
```

Ejemplo

```json
       {"numberOrigin": "9999",
       "status": {"code": "Suspended",
       "details": "Integration Testing"}}
```
:::

### Consultar Tickets del Solicitante (getByUser)

Consulta de Incidentes y Solicitudes del Solicitante:

:::CodeblockTabs
URL

```html
/services/request/getByUser
```

Atributos de entrada

```none
   userID - identificação de usuário do solicitante (obrigatório).
    description - descrição do incidente ou requisição (opcional).
    startDate - data de início da solicitação (opcional).
    endDate - data de finalização da solicitação (opcional).
    service - dados do serviço (opcional).
       code - código do serviço.
       name - nome do serviço.
    contractID - número do contrato no 4biz (opcional).
    status - situação da solicitação (opcional), contendo:
       code - código da situação. Valores possíveis: Em Andamento, Suspensa, Cancelada, Resolvida, Reaberta, Fechada, Reclassificada.
```

Atributos de salida

```none_1
   Colección de objetos de la clase CtRequest que contiene:
       number - número de la solicitud en 4biz ITSM.
       numberOrigin - número de la solicitud en el sistema de origen.
       type - Tipo de solicitud. Valores posibles: I=Incidente o S=Solicitud
       description - descripción del incidente o de la solicitud.
       userID - ID de usuario del solicitante.
       urgency - urgencia de la solicitud (opcional). Valores posibles: H=Alto, M=Medio, L=Bajo. Si no se informa, la urgencia se calculará a partir de los parámetros del catálogo de servicios de 4biz.
       groupId - acrónimo del grupo ejecutor en 4biz (opcional). Si no se informa, el grupo ejecutor se obtendrá de los parámetros del catálogo de servicios de 4biz.
       startDateTime - fecha y hora de inicio de la solicitud.
       startSLA - fecha y hora de inicio del SLA.
       endSLA - fecha y hora de finalización del SLA.
       status - estado de la solicitud, que contiene:
          code - código del estado.
          name - nombre de la situación.
```

Ejemplo

```json
    {"userID": "john elliot ",
    "startDate": "2015-09-16T03:00:00.000Z",
    "endDate": "2015-09-19T03:00:00.000Z"}
```
:::

### Detalles del Ticket de un Solicitante (getById)

Detalles de la Solicitud/Incidente:

:::CodeblockTabs
URL

```html
/services/request/getById
```

Atributos de entrada

```none
    number - número de la solicitud en 4biz ITSM. Obligatorio cuando no se indica el atributo numberOrigin.
    numberOrigin - número de la solicitud en el sistema de origen. Obligatorio cuando no se indica el número de atributo.
```

Atributos de salida

```none_1
    Los Atributos de salida se componen de todos los atributos de entrada de la clase CtRequest, además de la siguiente información:
      number - número de la solicitud creada en 4biz.
      startSLA - fecha y hora de inicio del SLA.
      endSLA - fecha y hora de finalización del SLA.
      status - estado de la solicitud, que contiene:
         code - código del estado.
         name - nombre del estado.
      currentTask - tarea actual, que contiene:
         number - número de la tarea
         name - nombre de la tarea.
         startDateTime - hora y fecha de inicio
         status - situación de la tarea, que contiene:
            code: código del estado.
            name: nombre del estado.
      userId - inicio de sesión del usuario responsable de la tarea.
      groupId - acrónimo del grupo responsable de la tarea.
```

Ejemplo

```json
    {"numberOrigin":"9999"}
```
:::

### Incluir la Ocurrencia en el Ticket (createOccurrence)

Incluir una ocurrencia en una solicitud:

:::CodeblockTabs
URL

```html
/services/request/createOccurrence
```

Atributos de entrada

```none
    requestNumber - número da solicitação no 4biz. Obrigatório quando o atributo requestNumberOrigin não for informado.
    requestNumberOrigin - número da solicitação no sistema de origem. Obrigatório quando o atributo requestNumber não for informado.
    ocurrence - objeto da classe CtOccurrence, contendo:
        numberOrigin - número da ocorrência no sistema de origem (opcional).
        description - descrição da ocorrência.
        date - data de registro da ocorrência.
        hour - hora de registro da ocorrência no formato HH:MM.
        category - categoria da ocorrência. Valores possíveis: Acompanhamento, Atualização, Diagnostico, Investigação, Memorando, Informação, Retorno, Sintoma, Contorno, Agendamento.
        reason - motivo da ocorrência.
```

Atributos de salida

```none_1
   Objeto de la clase CtOcurrence que contiene:
        number - número de la ocurrencia en 4biz.
        numberOrigin - número de la ocurrencia en el sistema de origen.
        description - descripción de la ocurrencia.
        date - fecha de registro de la ocurrencia.
        Hour - hora de registro de la ocurrencia en el formato HH:MM.
        userID - ID del usuario responsable del registro de la ocurrencia.
        origin - origen de la ocurrencia. Valores posibles: EMAIL, FONE_FAX, VOICE_MAIL, PERSONALLY, OTHER.
        category - categoría de la ocurrencia. Valores posibles: Creation, Monitoring, Update, Diagnosis, Investigation, Memo, Information, Return, Symptom, Outline, Executing, Exchanging, Reclaiming, Reclassification, Schedule, Suspend, Reopen, Targeting, Sharing, Cancellation Task, HomeSLA, SuspendedSLA, Approval, ReactivationSLA.
        elapsedTime - tiempo transcurrido (para la categoría del tipo de Ejecución)
        reason - razón de la ocurrencia.
        task - tarea asociada a la ocurrencia, que contiene:
           number - número de la tarea.
           name - nombre de la tarea.
           startDateTime - fecha y hora de inicio.
           endDateTime - fecha y hora de ejecución.
           status - estado de la tarea, que contiene:
              code - código del estado.
              name - nombre del estado.
          userId - inicio de sesión del usuario responsable de la ejecución de la tarea.
```

Ejemplo

```json
        {"requestNumberOrigin": "9999",
        "occurrence": {"description": "Occurrence test","category": {"code": "Workaround solution"},
        "date": "2015-08-20T03:00:00.000Z",
        "hour": "2219"}}
```
:::

### Consultar las Ocurrencias del Ticket (listOccurrences)

Consultar información de las solicitudes/incidentes:

:::CodeblockTabs
URL

```html
/services/request/listOccurrences
```

Atributos de entrada

```none
    requestNumber - número de la solicitud en 4biz. Obligatorio cuando el atributo requestNumberOrigin no es informado.
    requestNumberOrigin - número de la solicitud en el sistema de origen. Obligatorio cuando no se indica el atributo requestNumber.
```

Atributos de salida

```none_1
    Objeto de la clase CtOcurrence que contiene:
        number - número del evento en 4biz.
        numberOrigin - número de la ocurrencia en el sistema de origen.
        description - descripción de la ocurrencia.
        date - fecha de registro de la ocurrencia.
        Hour - hora de registro de la ocurrencia en el formato HH:MM.
        userID - ID del usuario responsable del registro de la ocurrencia.
        origin - origen de la ocurrencia. Valores posibles: EMAIL, FONE_FAX, VOICE_MAIL, PERSONALLY, OTHERS.
        category - categoría de la ocurrencia. Valores posibles: Creation, Monitoring, Update, Diagnosis, Investigation, Memo, Information, Return, Symptom, Outline, Executing, Exchanging, Reclaiming, Reclassification, Schedule, Suspend, Reopen, Targeting, Sharing, Cancellation Task, HomeSLA, SuspendedSLA, Approval, ReactivationSLA.
        elapsedTime - tiempo transcurrido (para la categoría del tipo de Ejecución)
        reason - razón de la ocurrencia.
        task - tarea asociada a la ocurrencia, que contiene:
           number - número de la tarea.
           name - nombre de la tarea.
           startDateTime - fecha y hora de inicio.
           endDateTime - fecha y hora de ejecución.
           status - estado de la tarea, que contiene:
              code - código de la localización.
              name - nombre del estado.
          userId - inicio de sesión del usuario responsable de la ejecución de la tarea.
```

Ejemplo

```json
    {"requestNumberOrigin":"9999"}
```
:::

### Listar Tickets para el Servicio

Este webservice se debe utilizar para listar los usuarios que pueden ser solicitantes al abrir un ticket.

- **Condiciones previas:&#x20;**&#x45;l solicitante debe estar vinculado a un grupo que tenga permiso para crear en un flujo de trabajo.

Listar las solicitudes/incidentes para el servicio:

:::CodeblockTabs
URL

```html
    /services/request/createOccurrence 
    /webmvc/servicerequestincident/searchTickets
```

Posibles códigos de retorno

```none
    200 – Solicitud realizada con éxito
    401 - Invalid authentication token or user without access to the resource
    406 - Not Acceptable - Business Exception
```

Atributos de entrada

```none_1
    sessionID: Atributo obligatorio que recibe el código de sesión;
    name: Atributo no obligatorio que recibe el nombre del solicitante, parte del nombre;
	    Si el usuario pasa la información %%%, el sistema devolverá todos los solicitantes del sistema.
        •	userId: Atributo obligatorio que recibe el código del usuario conectado;
        •	selectedPage: Atributo obligatorio que pasa la página a traerse;
        •	Pasar el sessionID en el Header;
        •	Filtros permitidos en este servicio web, los atributos descritos a continuación no son obligatorios:
            o	attendantId: Atributo que permite filtrar por nombre del asistente;
            o	groupId: Atributo que permite filtrar por nombre del grupo;
            o	orderBy: Atributo que permite ordenar los registros por los siguientes parámetros:
                	TICKET_ID: Número del ticket, 
                	CREATE_DATE: Fecha de creación, 
                	LIMIT_DATE: Fecha límite para el cumplimiento del ticket,
            o	orderDirection: Atributo que permite encaminar los tickets de dos maneras:
                	ASC: Ordena por número de ticket de forma creciente, 
                	DESC: Ordena por número de ticket de forma decreciente.
            o	requesterId: Atributo que permite filtrar por nombre del solicitante;
            o	status: Atributo que permite filtrar por situaciones de los tickets::
                	IN_PROGRESS,
                	SUSPENDED, 
                	CANCELED, 
                	SOLVED, 
                	CLOSED 
            o	ticketId: Atributo que permite filtrar por número del ticket;
            o	unitId: Atributo que permite filtrar por nombre de la unidad;
     Ejemplo de entrada en el servicio web
    {
        "userId": 4,
        "selectedPage": 1
    Ejemplo de entrada en el servicio web con los atributos no obligatorios
    {
        "userId": 4,
        "selectedPage": 1,
        "attendantId": 0,
        "groupId": 0,
        "orderBy": "TICKET_ID",
        "orderDirection": "ASC",
        "requesterId": 0,
        "selectedPage": 0,
        "status": "IN_PROGRESS",
        "ticketId": 0,
        "unitId": 0
    }
```

Ejemplo

```json
    { 
    "sessionID": "39738a39-836d-4940-94d5-c9235035bb29",

    "name" : "poll" 
    }  
    Ejemplo de entrada en el webservice con atributos no obligatorios
    {
    "userId": 4,
    "selectedPage": 1,
    "attendantId": 0,
    "groupId": 0,
    "orderBy": "TICKET_ID",
    "orderDirection": "ASC",
    "requesterId": 0,
    "selectedPage": 0,
    "status": "IN_PROGRESS",
    "ticketId": 0,
    "unitId": 0
    }
```
:::

:::CodeblockTabs
Ejemplo

```json
    {
	    "status": "SUCCESS",
	    "code": "200",
	    "message": "Request processed successfully",
	    "payload": [
	        {
	            "id": 904,
	            "name": "Lucas Novais",
	            "email": "lucas@rogalabs.com",
	            "unit": {
	                "id": 1,
	                "name": "Default",
	                "places": [
	                    {
	                        "id": 1,
	                        "name": "Brasilia"
	                    }
	                ]
	            },
	            "phone": "(676) 76868-7687"
	        }
	    ]
	}
```

Atributos de salida

```none
	" id " – Respuesta que devuelve el código del solicitante encontrado por la búsqueda;
	“name” - Respuesta que devuelve el nombre del solicitante;
	"email" – Respuesta que devuelve la dirección de correo electrónico del solicitante;
	“Unit” – Respuesta que devuelve:
    	Id: Código de la unidad;
        Name: Nombre de la Unidad;
    “places” – Respuesta que devuelve:
    	Id: Código de la localidad;
    	Name: Nombre de la localidad;
    “phone” – Respuesta que devuelve el número de teléfono del solicitante;
    •	"id" – Respuesta que devuelve el número del ticket;
    •	“tipo” - Respuesta que devuelve el tipo de demanda, es decir, si se trata de una Solicitud (S), Incidente (I) o Procedimiento(P);
    •	"nombrePrioridad" – Respuesta que devuelve el nombre de la Prioridad dada al ticket;
    •	“solicitación” – Respuesta que devuelve la descripción de la actividad solicitada;
    •	“tarea” – Respuesta que devuelve la tarea del flujo en el que se encuentra el ticket;
    •	“status” – Respuesta que devuelve el estado de la tarea del ticket listado;
    •	“dataLimite” – Respuesta que devuelve la fecha y hora de cierre de la solicitud de servicio según el SLA y el calendario vinculado a la actividadxcontrato
    •	“statusFlujoNombre” - Respuesta que devuelve el estado del SLA, que puede ser: Normal, A Vencer, Vencido, Suspendido.
    Ejemplo de respuesta válida de un servicio web
    "code": "200",
    "message": "Request processed successfully",
    "payload":{
    "initialNumber": 1,
    "lastPage": 1.0,
    "finalNumber": 20,
    "totalRequests": 168,
    "result":
    [
    "id": 1251,
    "tipo": "Incidente",
    "nombrePrioridad": "Medium",
    "solicitación": "Servicio de Incidente",
    "tarea": "Cumplir con la solicitud",
    "status": "NORMAL",
    "dataLimite": "2020-06-09 09:18:00 AM UTC"
    ]
    }
```
:::

### Guardar ticket en el servicio&#xD;

Este webservice se debe utilizar para devolver los tickets a los analistas.

- **Condiciones previas:** Tener acceso al sistema y permiso para ejecutar en el flujo de trabajo.

:::CodeblockTabs
URL

```html
Para guardar sólo el ticket: webmvc/servicerequestincident/save  
Para guardar y continuar el ticket: webmvc/servicerequestincident/next
```

Posibles códigos de Retorno

```none
    200 – Solicitud realizada con éxito  
    401 - Invalid authentication token or user without access to the resource  
    406 - Not Acceptable - Business Exception
```

Atributos de Entrada

```none_1
    authentication-token: Atributo obligatorio que recibe el token de autenticación
    	Pasar el authentication-token en el Header;
    serviceRequestId: Atributo obligatorio que recibe el número del ticket; 
    taskId: Atributo obligatorio que recibe el número de tarea del ticket;
    contactEmail: Atributo obligatorio que recibe la dirección de correo electrónico del solicitante;  
    contactExtension: Atributo no obligatorio que recibe el número de extensión del teléfono del solicitante;  
    contactPhone: Atributo no obligatorio que recibe el número de teléfono del solicitante;  
    goupId: Atributo no obligatorio que recibe el número de código del grupo que podrá recibir el ticket;  
    statusId: Atributo obligatorio que recibe el número del código de estado que recibirá el ticket después de guardarlo, en los siguientes estados:  
	In progress (1), Canceled (3) or Resolved (4)  
    originId: Atributo no obligatorio que recibe el número del código de origen que recibirá el ticket después de guardarlo;  
    causeId: Atributo no obligatorio que recibe el número de código de causa de la solución que recibirá el ticket después de guardarlo;  
    idSolutionCategory: Atributo no obligatorio que recibe el número del código de categoría de la solución que recibirá el ticket después de guardarlo;  
    response: Atributo no obligatorio que recibe la descripción de la solución de respuesta que recibirá el ticket después de guardarlo;     
    builderObjects: Atributo no obligatorio que recibe las respuestas capturadas si el ticket tiene un formulario en el ticket;  
    quiz: Atributo no obligatorio que recibe las respuestas capturadas si el ticket tiene un cuestionario en el ticket;  
    flowAction: Atributo que recibe la acción del usuario diseñada en el flujo y contestada por el asistente para resolver el ticket;  
    reasonFlowAction: Atributo que recibe la respuesta dada al campo Motivo, cuando éste está diseñado en el flujo como obligatorio;  
      
    Ejemplo de entrada en el webservice:  
    { 
    	"serviceRequestId": 5409, 
	"taskId": 8342, 
	"contactEmail": "teste@teste.com", 
	"contactExtension": "4979",
	"contactPhone": "(64)999177012", 
	"goupId": 21, 
	"statusId": 1, 
	"originId": 59, 
	"causeId": 7, 
	"idSolutionCategory": 13, 
	"response": "Prueba de Grabación vía webservice", 
    }
```

Atributos de salida

```none_2
    "idGrupoActual" - Respuesta que devuelve el código de grupo actual del ticket;  
    "idTarea" - Respuesta que devuelve el código de tarea del ticket;  
    "idStatus" - Respuesta que devuelve el código de estado actual del ticket;  
    "status" - Respuesta que devuelve la descripción del estado del ticket;  
    "fechaHoraInicio" - Respuesta que devuelve la fecha y hora de creación del ticket;  
    "fechaHoraInicioSLA" - Respuesta que devuelve la fecha y hora de inicio del SLA del ticket;
    "fechaHoraLímite" - Respuesta que devuelve la fecha y la hora del cierre del SLA del ticket;  
    "fechaHoraSolicitud" - Respuesta que devuelve la fecha y hora de creación del ticket;  
    Descripción: Respuesta que devuelve la descripción del ticket;  
    idCategoríaSolución: Respuesta que devuelve el código de la categoría de la solución del ticket;  
    idCausaIncidente: Respuesta que devuelve el código de la causa de la solución del ticket;  
    idContrato: Respuesta que devuelve el código de contrato del ticket;  
    idServicio: Respuesta que devuelve el código del servicio de negocio o del ticket de soporte;  
    idSolicitaciónServicio: Respuesta que devuelve el número de ticket;  
    idSolicitante: Respuesta que devuelve el código del solicitante del ticket;  
    idUnidad: Respuesta que devuelve el código de la unidad del ticket,  
    impacto: Respuesta que devuelve el acrónimo del impacto  
    respuesta: Respuesta que devuelve los dichos de la solución respuesta;  
    acrónimoGrupo: Respuesta que devuelve el acrónimo del grupo;  
    tarea: Respuesta que devuelve la descripción de la tarea;  
    urgencia: Respuesta que devuelve el acrónimo de la urgencia del ticket;  
    idUsuarioResponsableActual: Respuesta que devuelve el código del responsable del ticket;  
    nombreGrupoActual: Respuesta que devuelve la descripción del grupo actual del ticket;  
    solicitanteVip: Respuesta que devuelve si el solicitante es vip o no, posibles respuestas:  
    	false o true
```

Ejemplo

```json
    {
    	"status": "SUCCESS", 
	"code": "200", 
	"message": "Request processed successfully", 
	"payload": {
		"idGrupoAtual": 171, 
		"idTarefa": 8809, 
		"idStatus": 1, 
		"status": "In Progress", 
		"dataHoraInicio": "2020-09-10 11:58:28 AM BRT", 
		"dataHoraInicioSLA": "2020-09-10 11:58:29 AM BRT", 
		"dataHoraLimite": "2020-09-10 17:08:00 PM BRT", 
		"dataHoraSolicitacao": "2020-09-10 11:58:28 AM BRT", 
		"descricao": "<div>test</div>", 
		"idCategoriaSolucao": 13, 
		"idCausaIncidente": 7, 
		"idContrato": 52, 
		"idServico": 670, 
		"idSolicitacaoServico": 5712, 
		"idSolicitante": 456, 
		"idUnidade": 2, 
		"impacto": "A", 
		"resposta": "Teste de Gravação via webservice", 
		"siglaGrupo": "LEVEL1", 
		"tarefa": "Answer Ticket", 
		"urgencia": "A", 
		"idUsuarioResponsavelAtual": 254,
		"nomeGrupoAtual": "Level 1", 
		"solicitanteVip": false
	}  
    }
```
:::

### Recibir Unidades

Este webservice se debe utilizar para devolver las unidades activas existentes en el sistema para su selección al crear un ticket.

- **Condiciones previas:** Este servicio web cambia los resultados si el parámetro 61 - Vincula los contratos a la unidad (Ej.: S o N) está activo.

La documentación de desarrollo está en Swagger.

Ejemplo: [https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/](https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/)

Para leer esta documentación, es necesario estar conectado a la aplicación, y esa aplicación tiene que estar en la versión que tiene estos servicios web.

:::CodeblockTabs
URL

```html
    webmvc/v1/unidad Método: OBTENER Posibles códigos de retorno 
    200 - Solicitud realizada con éxito 
    401 - Token de autenticación no válido o usuario sin acceso al recurso 
    404 - Justificación no encontrada
    
```

Atributos de entrada

```none
• token de autenticación: atributo obligatorio que recibe el token de autenticación
        o Pasar el token de autenticación en el encabezado;
    • employeeId: Atributo obligatorio que recibe el código del usuario que solicita el ticket:
        o Pasar el atributo como parámetro;
    • Límite: Atributo que devuelve el número de unidades a devolver en la búsqueda;
        o Pasar el atributo como parámetro;
    • unitQuery: Atributo no obligatorio que permite buscar por parte del nombre de la unidad;
        o Pasar el atributo como parámetro;
    Ejemplo de entrada de servicio web
    {
        No se aplica ya que la URL pasará todos los atributos requeridos
    }
```

Atributos de salida

```none_1
• id: Devuelve el código de la unidad;
• nombre: Devuelve la descripción de la unidad;
```

Ejemplo

```json
{
        "status": "SUCCESS",
        "code": "200",
        "message": "Request processed successfully",
        "payload": [
            {
                "id": 52,
                "name": "---Human Resourcer"
            }
        ]
    }
```
:::

### &#xD;

### Recibir justificación de suspensión&#x20;

Este webservice debe ser utilizado para devolver las justificaciones de suspensión registradas y activas en el sistema.&#x20;

- **Condiciones previas:** el usuario que se pasa en el servicio web debe tener permiso de suspensión en el flujo de trabajo;

&#x20;La documentación de desarrollo está en Swagger.

Ejemplo: [https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/](https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/)

Para leer esta documentación, el usuario debe iniciar sesión en la aplicación, y esta aplicación debe estar en la versión que tiene estos servicios web.

:::CodeblockTabs
URL

```html
   webmvc/v1/boleto/justificación Método: OBTENER Posibles códigos de retorno 
   200 - Solicitud realizada con éxito 
   401 - Token de autenticación no válido o usuario sin acceso al recurso 
   404 - Justificación no encontrada
```

Atributos de entrada

```none
 •	authentication-token: atributo obligatorio que recibe el token de autenticación
        o	Pasar el authentication-token en el Header;
    •	type: Atributo obligatorio que recibe una de las siguientes siglas:
        o	Pasar el type como parámetro;
        o	Type (S = Suspension, A = Approval)
            Available values : S, A
            Default value : S
    Ejemplo de entrada de webservice
    {
        No se aplica ya que la URL pasará todos los atributos requeridos
    }
```

Atributos de salida

```none_1
• id: Devuelve el código de Justificación de Suspensión;
• descripción: Devuelve la descripción del Motivo de Suspensión
```

Ejemplo

```json
    {
        "status": "SUCCESS",
        "code": "200",
        "message": "Request processed successfully",
        "payload": [
            {
                "id": 1,
                "description": "Default"
            }
        ]
    }
```
:::

### Listar tickets para servicio

Este webservice debe usarse para devolver las opciones permitidas en el flujo en un grupo dado.&#x20;

- **Condiciones previas:** el usuario que se pasa en el servicio web debe tener acceso al sistema. El usuario que se pasa en el servicio web debe tener permiso en el flujo de trabajo;&#x20;

La documentación de desarrollo está en Swagger.

Ejemplo: [https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/](https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/)

Para leer esta documentación, el usuario debe iniciar sesión en la aplicación, y esta aplicación debe estar en la versión que tiene estos servicios web.

:::CodeblockTabs
URL

```html
   /webmvc/v1/ticket/{ticketId}/permisos Método: OBTENER Posibles códigos de retorno 
   200 - Solicitud realizada con éxito 
   401 - Token de autenticación no válido o usuario sin acceso al recurso 
   404 – Ticket no encontrado
```

Atributos de entrada

```none
    •	authentication-token: Atributo obligatorio que recibe el token de autenticación
        o	Pasar el authentication-token en el Header;
    •	taskId: Atributo obligatorio que recibe el número de tarea del ticket;
        o	Pasar el taskId como parámetro en la url;
    •	ticketId: Atributo obligatorio que recibe el número de ticket;
    ejemplo de entrada no webservice
    {No se aplica ya que la URL pasará todos los atributos requeridos}
```

Atributos de salida

```none_1
    • "id" – Respuesta que devuelve el número de ticket;
    • “tipo” - Respuesta que devuelve el tipo de demanda, es decir, si es Solicitud (R), Incidencia (I) o Procedimiento (P);
    • "namePriority" – Respuesta que devuelve el nombre de la Prioridad otorgada al ticket;
    • “solicitud” – Respuesta que devuelve la descripción de la actividad solicitada;
    • “tarea” – Respuesta que devuelve la tarea del flujo donde se encuentra el ticket;
    • “status” – Respuesta que devuelve el estado de la tarea del ticket listado;
    • “dateLimit” – Respuesta que devuelve la fecha y hora de cierre de la solicitud de servicio según el SLA y calendario vinculado a actividadxcontrato
    • “statusFlowName” - Respuesta que devuelve el estado del SLA, que puede ser: Normal, Vencido, Vencido, Suspendido.

```

Ejemplo

```json
    "code": "200",
    "message": "Request processed successfully",
    "payload":{
    "initialNumber": 1,
    "lastPage": 1.0,
    "finalNumber": 20,
    "totalRequests": 168,
    "result":
    [
    "id": 1251,
    "tipo": "Incidente",
    "nomePrioridade": "Medium",
    "solicitacao": "Serviço de Incidente",
    "tarefa": "Atender solicitacao",
    "status": "NORMAL",
    "dataLimite": "2020-06-09 09:18:00 AM UTC"
    ]
    }
```
:::

### Recibir acciones de usuario en un ticket&#x20;

Este servicio web debe usarse para devolver las acciones del usuario dibujadas en un flujo de trabajo.

- **Condiciones previas:&#x20;**&#x65;l usuario que se pasa en el servicio web debe tener acceso al sistema. El usuario que se pasa en el servicio web debe tener permiso de ejecución en el flujo de trabajo;

La documentación de desarrollo está en Swagger.

Ejemplo: [https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/](https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/)

Para leer esta documentación, el usuario debe iniciar sesión en la aplicación, y esta aplicación debe estar en la versión que tiene estos servicios web.

:::CodeblockTabs
URL

```html
    webmvc/v1/ticket/{ticketId}/flow-actions Método: OBTENER Posibles códigos de retorno 
    200 - Solicitud realizada con éxito 
    401 - Token de autenticación no válido o usuario sin acceso al recurso 
    404 – Boleto no encontrado Condición posterior: 
    Para enviar la respuesta seleccionada en la acción del usuario, 
    utilice el servicio web Guardar y reenviar 
    (webmvc/servicerequestincident/next) 
    Atributos: "acción de flujo": 
    "razónFlujoAcción":
```

Atributos de entrada

```none
   • authentication-token: atributo obligatorio que recibe el token de autenticación
        o Pasar el token de autenticación en el Header;
    • taskId: Atributo obligatorio que recibe el número de tarea del ticket;
        o Pasar el taskId como parámetro en la url;
    • ticketId: Atributo obligatorio que recibe el número de ticket;
    Ejemplo de entrada de servicio web
    {
        No se aplica ya que la URL pasará todos los atributos requeridos
```

Atributos de salida

```none_1
• "id: Código de la acción de flujo registrada en el diseño de flujo;
    • Name: nombre de la acción de flujo;
    • Descripción: Descripción de la acción de flujo;
    • requireReason: Informa si el motivo es obligatorio, existen dos respuestas para este atributo:
        o True: Cuando el motivo es obligatorio;
        o False: Cuando el motivo no sea obligatorio;
    • applicationActionId: devuelve el código de respuesta de aprobación;
    • ticketStatusId: Devuelve el código de estado del ticket;
```

Ejemplo

```json
    {
        "status": "SUCCESS",
        "code": "200",
        "message": "Request processed successfully",
        "payload": [
            {
                "id": 1302,
                "name": "ApproveTicket",
                "description": "Approve Ticket",
                "requiresReason": false,
                "approvalActionId": 1,
                "ticketStatusId": 1
            },
            {
                "id": 1304,
                "name": "DenyTicket",
                "description": "Deny Ticket",
                "requiresReason": false,
                "approvalActionId": 2,
                "ticketStatusId": 3
            }
        ]
    }
```
:::

### Listar archivos adjuntos de los tickets

Este servicio web debe usarse para devolver la lista de archivos adjuntos a un ticket para que los analistas asistan.

- **Condiciones previas:&#x20;**&#x65;l usuario que se pasa en el servicio web debe tener acceso al sistema.&#x20;

La documentación de desarrollo está en Swagger.

Ejemplo: [https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/](https://presentation02.citsmartcloud.com/4biz/webmvc/swagger-ui.html#/)

Para leer esta documentación, el usuario debe iniciar sesión en la aplicación, y esta aplicación debe estar en la versión que tiene estos servicios web.&#x20;

**Nota:&#x20;**&#x45;ste documento contiene todos los servicios web necesarios para adjuntar, que incluyen:&#x20;

- Listar adjuntos de un ticket;&#x20;
- Descargar el archivo adjunto;&#x20;
- Adjuntar documento al ticket (cargar);&#x20;
- Eliminar archivo adjunto de ticket



:::CodeblockTabs
URL

```html
    /webmvc/servicerequestincident/{serviceRequestIncidentId}/archivos 
    adjuntos Tipo de método: OBTENER Posibles códigos de retorno 
    200 - Solicitud realizada con éxito 
    401 - Token de autenticación no válido o usuario sin acceso al recurso 
    404 - Ticket no encontrado
```

Atributos de entrada

```none
    • authentication-token: Atributo que recibe el token de acceso a la aplicación:
        o El token debe pasarse en el Header;
    • serviceRequestIncidentId: Atributo obligatorio que recibe el número de ticket;
        o El número de ticket debe ser pasado en el path, junto con la URL;
```

Atributos de salida

```none_1
    • "id" – Respuesta que devuelve el código del adjunto contenido en el ticket;
    • “name” - Respuesta que devuelve la descripción del archivo adjunto;
    • "extention" – Respuesta que devuelve la extensión del archivo adjunto;
```

Ejemplo

```json
{
        "status": "SUCCESS",
        "code": "200",
        "message": "Request processed successfully",
        "payload": [
            {
                "id": 2253,
                "name": "ei_1598697802049.png.png",
                "extension": "png"
            },
            {
                "id": 2252,
                "name": "ei_1598697788434.jpg.jpg",
                "extension": "jpg"
            },
            {
                "id": 2251,
                "name": "ei_1598697777801.jpg.jpg",
                "extension": "jpg"
            }
    ]
    }
```
:::

### Descargar archivos adjuntos de un ticket

:::CodeblockTabs
URL

```html
webmvc/servicerequestincident/{serviceRequestIncidentId}/attachments/{documentId} 
Tipo de método: OBTENER Posibles códigos de retorno 
200 - Solicitud realizada con éxito 
401 - Token de autenticación no válido o usuario sin acceso al recurso 
404 - Documento o ticket no encontrado
```

Atributos de entrada

```none
    • authentication-token: Atributo que recibe el token de acceso a la aplicación:
        o El token debe pasarse en el header;
    • serviceRequestIncidentId: Atributo obligatorio que recibe el número de ticket;
        o El número de ticket debe ser pasado en el path, junto con la URL;
    • documentId: Atributo obligatorio que recibe el código de adjunto contenido en el ticket;
        o La identificación del archivo adjunto debe pasarse en el path, junto con la URL;
```

Atributos de salida

```none_1
el archivo adjunto en sí
```

Ejemplo

```json
        No se aplica   
```
:::

### Cargar los archivos adjuntos de un ticket

:::CodeblockTabs
URL

```html
    /webmvc/services/request/addAttachments Método tipo: POST
    Pre Condición: 
    1. Verifique los parámetros: 
    2. 44 - Cargue el directorio de la ruta del repositorio (Ej.: Windows - C:/temp) 
    3. 278: tamaño máximo de archivo, en bytes, para cargar. Predeterminado[1073741824] = 1GB 
    4. 318 - Lista de extensiones de archivos que no se pueden adjuntar 
    (Para más de una extensión, sepárelas por punto y coma) 
    5. 446 - ¿Enviar archivos adjuntos en el correo electrónico de notificación del ticket? 
    (Ej.: S o N - Predeterminado: 'N') Posibles códigos de retorno 
    200 - Solicitud realizada con éxito 
    500 - Campos obligatorios no informados
```

Atributos de entrada

```none
• mediaType: atributo obligatorio que indica el formato de la conversación
        o Importante dejar fijo en application/json
    • requestNumber: atributo obligatorio que recibe el número de solicitud que recibirá el archivo adjunto;
    • attachments: lista de archivos;
    • name: Atributo obligatorio que recibe el nombre del archivo;
    • content: Atributo obligatorio que debe ser codificado en base64 que recibe el contenido del archivo;
        o O content es el contenido del archivo codificado en base64;
    • extension: Atributo obligatorio que recibe la extensión del archivo: txt, jpg, jpeg,
    Ejemplo de entrada de servicio web 
    {
	    "sessionID": "b7f24d64-5e23-4331-ab89-63403cb00d40",
	    "mediaType": "application/json",
	    "requestNumber": "1351",
	    "attachments": [{
		    "name": "archivo de prueba",
		    "content": "VGVzdGU=",
		    "extension": "txt"
	    }]
    }
```

Atributos de salida

```none_1
    • dateTime: Atributo obligatorio que indica fecha y hora de ejecución;
    • dateTimeMilliseconds: Tiempo en milisegundos;
    • operationID: Número de la operación que se realizó;
    • error: Atributo obligatorio que indica si hubo un error durante la ejecución del webservice;
```

Ejemplo

```json
    {
        "dateTime": "2020-05-19 14:56:00",
        "dateTimeMilliseconds": 1589910960717,
        "operationID": 603,
        "error": null
    }
```
:::

### Eliminar archivos adjuntos de un ticket

:::CodeblockTabs
URL

```html
  /webmvc/v1/ticket/{ticketId}/attachments/{documentId} Método de tipo:
  ELIMINAR Posibles códigos de retorno 
  200 - Solicitud realizada con éxito 
  401 - Token de autenticación no válido o usuario sin acceso al recurso 
  404 - Ticket no encontrado
```

Atributos de entrada

```none
    •authentication-token: Atributo que recibe el token de acceso a la aplicación:
        o El token debe pasarse en el header;
    • serviceRequestIncidentId: Atributo obligatorio que recibe el número de ticket;
        o El número de ticket debe ser pasado en el path, junto con la URL;
    • documentId: Atributo obligatorio que recibe el código de adjunto contenido en el ticket;
        o La identificación del archivo adjunto debe pasarse en el path, junto con la URL;
    Ejemplo de entrada de servicio web
    {
        No aplica, mira que los atributos de entrada estén en el header  y en el Path de la url.
    }
```

Atributos de Saída

```none_1
    {
    No se aplica
    }
```

Exemplo

```json
    {
        "status": "SUCCESS",
        "code": "200",
    }
```
:::
