Diferencias

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

Enlace a la vista de comparación

Ambos lados, revisión anteriorRevisión previa
Próxima revisión		Revisión previa
apiba360_105 [2024/05/24 16:11] – scantorapiba360_105 [2025/04/03 23:01] (actual) – scantor
Línea 77: Línea 77:
  
 ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^ ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
-| [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Crea una actividad programada. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% |+| [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Hace la creación de un caso en Be Aware 360. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% |
  
 ===== Primeros pasos ===== ===== Primeros pasos =====
Línea 1438: Línea 1438:
  
 ---- ----
 +===== Recursos para Grupos =====
 +
 +==== Consultar grupos ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +Existen distintas formas de consultar cuentas a través de la API. A continuación, se detallan:
 +
 +  * **Consultar todos los grupos:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get%%.
 +  * **Consultar grupos por parámetros:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?parametro=valor%%.
 +  * **Consultar grupos con paginación:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%.
 +  * **Consultar grupo por filtro:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%.
 +
 +----
 +
 +=== Request: ===
 +
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +----
 +
 +Existen distintas formas de consultar grupos a través de la API. A continuación, se detallan:
 +
 +=== Consultar todos los grupos ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +
 +----
 +
 +=== Consultar grupos por parámetros ===
 +
 +**Grupos:**
 +
 +  idgrupo -> Recibe el id de Be Aware 360 correspondiente a la cuenta.
 +
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?idgrupo=1
 +
 +</code>
 +
 +----
 +
 +=== Consultar grupos con paginación ===
 +
 +**Parámetros:**
 +
 +  pagina -> Indica el número de página a retornar.
 +  cantidad -> Indica el número de cuentas a retornar por página.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?pagina=1&cantidad=10
 +</code>
 +
 +----
 +
 +=== Consultar grupo por filtro ===
 +
 +**Parámetros:**
 +
 +  pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
 +  cantidad -> Indica la cantidad de grupos a mostrar por página.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?filtrobuscar=soft&pagina=1&cantidad=10
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la lista de todas los grupos.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "usuarios": [],
 +            "nombre": "Grupo de prueba (antiguo)",
 +            "idgrupo": 0,
 +            "grupousuarios": null,
 +            "eid": null,
 +            "uuid": null,
 +            "id": 1
 +        }
 +    ],
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +==== Crear grupo ====
 +
 +----
 +=== Método === 
 +
 +''**POST**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/add%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| nombre | Nombre del grupo | String | Sí | Este campo tiene una validación que sea menor a 255 caracteres. | “Grupo API” |
 +| descripcion | Descripción del grupo | String | No | Debe ser único. Este campo tiene una validación que sea menor a 20 caracteres. | “Grupo creado desde API” |
 +| tipo | Grupo Usuario / Contacto | Integer | No | Indica si el grupo será de usuarios o contactos | 1 |
 +| grupousuarios | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| pordefecto | Grupo por defecto para usuarios | String | No | Indica si será un grupo por defecto para nuevos usuarios | 0 |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "nombre": "grupo API",
 +  "descripcion": "grupo creado desde API",
 +  "tipo": 1,
 +  "grupousuarios": [],
 +  "pordefecto": 0
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema crea la cuenta con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": "grupo API",
 +        "descripcion": "grupo creado desde API",
 +        "tipo": 1,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": 0,
 +        "multityping": null,
 +        "descmultityping": null,
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 55
 +    },
 +    "code": 200,
 +    "message": "Cuenta creada con éxito.",
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Actualizar grupo ====
 +
 +**Nota:** Para utilizar este recurso es necesario siempre enviar todos los campos del grupo y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.
 +
 +----
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/upd%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| nombre | Nombre del grupo | String | Sí | Nombre del grupo | "grupo API actualizado" |
 +| descripcion | Descripción del grupo | String | Sí | Descripción del grupo | "grupo creado desde API" |
 +| tipo | Tipo de grupo | Integer | Sí | Grupo de contactos o usuarios | 2 |
 +| grupocontactos | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosplus | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosout | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosin | Grupo de contactos | Integer | No | Lista de IDs de contactos que se añaden al grupo. **Nota:** Aplica si el grupo es Tipo Contacto | [1, 2, 3, 4, 5] |
 +| pordefecto | Grupo por defecto | Integer | No | Indica si el grupo es predeterminado para los usuarios nuevos | 0 |
 +| multityping | Tipificaciones del grupo | Integer | No | Indica las tipificaciones asociadas al grupo | [1, 2] |
 +| descmultityping | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosplus | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosout | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosin | Grupo de usuarios | Integer | No | Lista de IDs de usuarios que se añaden al grupo. **Nota:** Aplica si el grupo es Tipo Usuario | [1, 2, 3, 4, 5] |
 +| contactosfuera | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| gruposkillrelacion | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuarios | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| gruposkillmultityping | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| total | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| eid | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| uuid | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| id | Identificador del grupo | Integer | Sí | Identifica el grupo que se va a actualizar | 58 |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 + {
 +  "nombre": "grupo API actualizado",
 +  "descripcion": "grupo creado desde API",
 +  "tipo": 2,
 +  "grupocontactos": [],
 +  "grupocontactosplus": null,
 +  "grupocontactosout": null,
 +  "grupocontactosin": [1, 2, 3, 4, 5],
 +  "pordefecto": 0,
 +  "multityping": [1, 2],
 +  "descmultityping": {},
 +  "grupousuariosplus": null,
 +  "grupousuariosout": null,
 +  "grupousuariosin": [7, 8, 9, 10, 11],
 +  "contactosfuera": null,
 +  "gruposkillrelacion": null,
 +  "grupousuarios": null,
 +  "gruposkillmultityping": null,
 +  "total": null,
 +  "eid": null,
 +  "uuid": null,
 +  "id": 58
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el grupo con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": "grupo API actualizado",
 +        "descripcion": "grupo creado desde API",
 +        "tipo": 2,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": 0,
 +        "multityping": [
 +            1,
 +            2
 +        ],
 +        "descmultityping": {
 +            "1": "Soporte BeAware 360",
 +            "2": "Requerimientos BA360"
 +        },
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 58
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Eliminar grupo ====
 +
 +----
 +
 +=== Método === 
 +
 +''**DELETE**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/del/?id=<id_cuenta>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Id del grupo.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +  
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/gruposkill/del/?id=58
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Elimina una grupo específica de la base de datos de Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": null,
 +        "descripcion": null,
 +        "tipo": null,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": null,
 +        "multityping": null,
 +        "descmultityping": null,
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 58
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
  
 ===== Recursos para Casos ===== ===== Recursos para Casos =====
Línea 1462: Línea 1881:
   * **[[apiba360_105#Consultar caso por Id contacto|Consultar caso por Id contacto:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?icontacto=<id_contacto_ba360>%%.   * **[[apiba360_105#Consultar caso por Id contacto|Consultar caso por Id contacto:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?icontacto=<id_contacto_ba360>%%.
   * **[[apiba360_105#Consultar casos abiertos creados por el usuario|Consultar casos abiertos creados por el usuario:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>&filtro=created%%.   * **[[apiba360_105#Consultar casos abiertos creados por el usuario|Consultar casos abiertos creados por el usuario:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/get/?pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>&filtro=created%%.
 +  * **[[apiba360_105#Consultar caso por búsqueda avanzada|Consultar caso por búsqueda avanzada:]]** %%https://api.beaware360.com/ba360/apir/v10_5/caso/getBusquedaAvanzada%%.
  
 ---- ----
Línea 3474: Línea 3894:
         "id": 5039         "id": 5039
     },     },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Consultar caso por búsqueda avanzada ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/caso/getBusquedaAvanzada%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +Al ser una búsqueda avanzada se podrán usar como parámetros los campos estándar de un caso y/o también los campos personalizados (Custom Fields) definidos para los casos, en este último caso se debe **enviar como parámetro el valor del campo __label__**.
 +
 +La búsqueda corresponde a un operador AND, por lo tanto, el resultado retornará los casos que cumplen con todos los parámetros de búsqueda. 
 +
 +**Nota:** Si se desea buscar más de un valor para un mismo parámetro, estos deben separarse por comas (",").
 +  
 +A continuación, listamos los campos estándar del caso que pueden utilizar para este recurso:
 +
 +^ Campo ^ Descripción ^
 +| id | Identificador único del caso asignado por Be Aware 360. |
 +| idestado | Identificador del estado asignado al caso. |
 +| idestadodesc | Descripción del estado asignado al caso. |
 +| refnum | Número del caso. |
 +| idcontacto | Identificador del contacto asignado al caso. |
 +| idcontactodesc | Nombre del contacto asignado al caso. |
 +| idcuenta | Identificador de la cuenta asignada al caso. |
 +| razonsocial | Nombre de la cuenta asignada al caso. |
 +| idusuarioasignado | Identificador del usuario asignado al caso. |
 +| idusuarioasignadodesc | Nombre del usuario asignado al caso. |
 +| idproducto | Identificador del producto asignado al caso. |
 +| idproductodesc | Nombre del producto asignado al caso. |
 +| idtipo | Identificador del motivo asignado al caso. |
 +| idtipodesc | Nombre del motivo asignado al caso. |
 +| idsubtipo | Identificador del submotivo asignado al caso. |
 +| idsubtipodesc | Nombre del submotivo asignado al caso. |
 +| origen | Nombre del canal por el cual se creó el caso. |
 +| asunto | Asunto del caso. |
 +| fechacreacion | Fecha de creación del caso. |
 +| finalizado | Indica si el caso está finalizado. 0 indica que el caso no está finalizado y 1 indica que sí está finalizado el caso. |
 +
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +  
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/caso/getBusquedaAvanzada?refnum=231128-001422&nombre y apellido=perez&medio de comunicacion=celular.
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la lista de todos los casos que cumplen con los criterios de búsqueda especificados en los parámetros.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "checkList": null,
 +            "idcontacto": 777,
 +            "origen": "AgenteWeb",
 +            "finalizado": 0,
 +            "refnum": "231128-001422",
 +            "asunto": "Prueba Masiva",
 +            "fechacreacion": "2023-11-28",
 +            "idcontactodesc": "Andrés Olano",
 +            "idtipodesc": "Facturación y Pago",
 +            "idestadodesc": "Completado",
 +            "idusuarioasignadodesc": "MartaC",
 +            "idcuentadesc": null,
 +            "descripcion": null,
 +            "idworkflow": 54,
 +            "idtipo": 6,
 +            "idcuenta": null,
 +            "direccion": null,
 +            "latitud": null,
 +            "longitud": null,
 +            "idsla": null,
 +            "idproducto": 9,
 +            "idsubtipo": 1,
 +            "urlorigin": null,
 +            "canal": null,
 +            "idinteraccion": null,
 +            "idconversacion": null,
 +            "idusuarioasignado": 173,
 +            "idstageactual": 116,
 +            "idestado": 5,
 +            "idusuariocreacion": 84,
 +            "idworkflowdesc": "Prueba Olayo Rojas",
 +            "color": "NEGRO",
 +            "duedate": "2024-05-29 15:03:51.0",
 +            "duedateslan": null,
 +            "duedatesloutc": null,
 +            "duedateslouser": "2024-05-29 19:03:51.0",
 +            "duedateslorol": "2024-05-29 15:03:51.0",
 +            "tmzcontacto": "America/Santiago",
 +            "destacado": false,
 +            "porcentaje": -230923,
 +            "cf": {
 +                "Orden": "Tipo B",
 +                "tipo_caso": "Medio",
 +                "tipo_enfermedad": "Ninguna",
 +                "caracteristicas_caso": "[Escalado, Priorizado]",
 +                "medio": "Celular",
 +                "campo_ex": "2024-04-26T03:00:00.000Z",
 +                "guia": "1234",
 +                "nombre": "Juan Perez",
 +                "TipoCliente": "A"
 +            },
 +            "idusuariomodificacion": 131,
 +            "ccemails": null,
 +            "textreopencase": null,
 +            "idsubtipodesc": "Solicitud",
 +            "idprioridaddesc": "Media",
 +            "idproductodesc": "Crédito Inteligente",
 +            "idprioridad": 2,
 +            "colorusuario": "NEGRO",
 +            "fingreso": "2024-05-29 18:33:51.0",
 +            "flexible": null,
 +            "primerpaso": 0,
 +            "psolucionado": "0",
 +            "pcreado": "0",
 +            "ppendiente": "0",
 +            "horastranscurridas2": null,
 +            "totalnotas2": null,
 +            "horastranscurridas": null,
 +            "urgente": null,
 +            "normal": null,
 +            "totalnotas": null,
 +            "solucionado": null,
 +            "creado": null,
 +            "pendiente": null,
 +            "totalcasos": null,
 +            "fechacreacionstr": "2023-11-28 00:00:00",
 +            "fechamodificacionstr": "2024-05-29 00:00:00",
 +            "timeactual": null,
 +            "idprioridadcolor": "#27AE60",
 +            "idstageactualdesc": "Completado",
 +            "idusuariomodificaciondesc": "María Benedicto",
 +            "idusuariocreaciondesc": "Germán Andrés Olano",
 +            "idsladesc": null,
 +            "logauditoria": null,
 +            "fechafinalizacionhoralimit": null,
 +            "fechamodificacionhora": "2024-05-29 14:33:51.0",
 +            "fechamodificacionhoralimit": "2024-05-29 19:33:51",
 +            "fechareapertura": null,
 +            "porcentajeslan": null,
 +            "tmzinstance": "America/Santiago",
 +            "duedateslo": null,
 +            "porcentajeslo": null,
 +            "datafor": null,
 +            "operationsistext": null,
 +            "fechafinalizacion": null,
 +            "slavalue": 30,
 +            "sistemaexterno": null,
 +            "fechamodificacion": "2024-05-29",
 +            "fechahoracreacionutc": "2023-11-28 23:28:43.0",
 +            "cantidadcasos": null,
 +            "id": 5412,
 +            "eid": null,
 +            "uuid": null
 +        }
 +    ],
     "code": 200,     "code": 200,
     "message": null,     "message": null,
Línea 3999: Línea 4611:
  
 Para más información sobre la parametrización de Tipificación caso en creación, haga clic [[parametrosdeconfiguracion#(parametros_de_casos)|aquí.]] Para más información sobre la parametrización de Tipificación caso en creación, haga clic [[parametrosdeconfiguracion#(parametros_de_casos)|aquí.]]
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/producto/get?idcontacto=<id contacto>%%**.
 +
 +Este endpoint devuelve todos productos cargados en la instancia que puede visualizar un contacto en particular.
  
 ---- ----
Línea 4071: Línea 4687:
  
 **%%https://api.beaware360.com/ba360/apir/v10_5/tipo/get%%**. **%%https://api.beaware360.com/ba360/apir/v10_5/tipo/get%%**.
 +
 +Este endpoint retorna todos los motivos que existen en la plataforma.
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/tipo/get?idproducto=<idproducto>&idcontacto=<idcontacto>%%**.
 +
 +Este endpoint retorna todos los motivos que pertenecen a un producto específico y que el contacto puede visualizar.
  
 ---- ----
Línea 4149: Línea 4771:
 **%%https://api.beaware360.com/ba360/apir/v10_5/subtipo/get%%**. **%%https://api.beaware360.com/ba360/apir/v10_5/subtipo/get%%**.
  
 +Este endpoint retorna todo el listado de submotivos registrados en la plataforma.
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/subtipo/get?idtipo=<idmotivo>&idproducto=<idproducto>&idcontacto=<idcontacto>%%**.
 +
 +Este endpoint retorna todos los submotivos que pertenecen al producto y motivo y que solo el contacto puede visualizar.
 ---- ----
  
Línea 4277: Línea 4904:
                 14                 14
             ],             ],
 +            "mtdocumentosobligatorios": [
 +                1
 +            ],
 +            "mtdocumentosopcionales": [
 +                2
 +            ],
 +            "carpetadestino": null,
             "eid": null,             "eid": null,
             "uuid": null,             "uuid": null,
Línea 4293: Línea 4927:
                 2                 2
             ],             ],
 +            "mtdocumentosobligatorios": [],
 +            "mtdocumentosopcionales": [
 +                5
 +            ],
 +            "carpetadestino": null,
             "eid": null,             "eid": null,
             "uuid": null,             "uuid": null,
             "id": 2             "id": 2
         }         }
-    ], 
-    "code": 200, 
-    "message": null, 
-    "pagination": { 
-        "cantPages": 0, 
-        "size": 0, 
-        "actualPage": 0 
-    } 
-} 
 </code> </code>
  
Línea 4428: Línea 5058:
 | mtsubtipos | Listado de los submotivos que harán parte de la tipificación | Id de submotivo | Sí | Se debe indicar el Id de los submotivos separados por comas '','' y enmarcados en corchetes cuadrados ''[]'' | [3, 5] | | mtsubtipos | Listado de los submotivos que harán parte de la tipificación | Id de submotivo | Sí | Se debe indicar el Id de los submotivos separados por comas '','' y enmarcados en corchetes cuadrados ''[]'' | [3, 5] |
 | descripcion | Texto de explicación de la tipificación | String | No |  | Descripción de tipificación de prueba | | descripcion | Texto de explicación de la tipificación | String | No |  | Descripción de tipificación de prueba |
 +| mtdocumentosopcionales | Listado de los catálogos de documentos que se podrán usar en la tipificación | Id de catálogo de documentos | No |  | [5] |
  
 **Ejemplo:** **Ejemplo:**
Línea 4433: Línea 5064:
 <code java> <code java>
 { {
-    "nombre": "Tipificación de prueba", +    "nombre": "Tipificación de prueba API 2", 
     "mtproductos": [5, 6],      "mtproductos": [5, 6], 
     "mttipos": [3, 4, 5],      "mttipos": [3, 4, 5], 
-    "mtsubtipos": [5, 3], +    "mtsubtipos": [5, 3],     
-    "descripcion": "Descripción de tipificación de prueba"+    "mtdocumentosopcionales": [3, 5], 
 +    "descripcion": "Descripción de tipificación de prueba por API"
 } }
 </code> </code>
Línea 4459: Línea 5091:
 { {
     "data": {     "data": {
-        "nombre": "Tipificación de prueba", +        "nombre": "Tipificación de prueba API 2", 
-        "descripcion": "Descripción de tipificación de prueba",+        "descripcion": "Descripción de tipificación de prueba por API",
         "mtproductos": [         "mtproductos": [
             5,             5,
Línea 4474: Línea 5106:
             5             5
         ],         ],
 +        "mtdocumentosobligatorios": [],
 +        "mtdocumentosopcionales": [
 +            3,
 +            5
 +        ],
 +        "carpetadestino": null,
         "eid": null,         "eid": null,
         "uuid": null,         "uuid": null,
-        "id": 40+        "id": 97
     },     },
     "code": 200,     "code": 200,
Línea 4517: Línea 5155:
 | mtsubtipos | Listado de los submotivos que harán parte de la tipificación | Id de submotivo | Sí | Se debe indicar el Id de los submotivos separados por comas '','' y enmarcados en corchetes cuadrados ''[]'' | [3, 5] | | mtsubtipos | Listado de los submotivos que harán parte de la tipificación | Id de submotivo | Sí | Se debe indicar el Id de los submotivos separados por comas '','' y enmarcados en corchetes cuadrados ''[]'' | [3, 5] |
 | descripcion | Texto de explicación de la tipificación | String | No |  | Descripción de tipificación de prueba | | descripcion | Texto de explicación de la tipificación | String | No |  | Descripción de tipificación de prueba |
 +| mtdocumentosopcionales | Listado de los catálogos de documentos que se podrán usar en la tipificación | Id de catálogo de documentos | No |  | [5] |
 | id | Identificador de la tipificación | Integer | Sí |  | 18 | | id | Identificador de la tipificación | Integer | Sí |  | 18 |
  
Línea 4528: Línea 5167:
     "mtsubtipos": [6, 7],     "mtsubtipos": [6, 7],
     "descripcion": "Actualización de la descripción de tipificación de prueba",     "descripcion": "Actualización de la descripción de tipificación de prueba",
 +    "mtdocumentosopcionales": [3, 5],
     "id": 40     "id": 40
 } }
Línea 4543: Línea 5183:
 { {
     "data": {     "data": {
-        "nombre": "Tipificación de prueba actualizada", +        "nombre": "Tipificación de prueba API 2", 
-        "descripcion": "Actualización de la descripción de tipificación de prueba",+        "descripcion": "Descripción de tipificación de prueba por API",
         "mtproductos": [         "mtproductos": [
             5,             5,
Línea 4550: Línea 5190:
         ],         ],
         "mtsubtipos": [         "mtsubtipos": [
-            6, +            5, 
-            7+            3
         ],         ],
         "mttipos": [         "mttipos": [
Línea 4558: Línea 5198:
             5             5
         ],         ],
 +        "mtdocumentosobligatorios": [],
 +        "mtdocumentosopcionales": [
 +            3,
 +            5
 +        ],
 +        "carpetadestino": null,
         "eid": null,         "eid": null,
         "uuid": null,         "uuid": null,
-        "id": 40+        "id": 97
     },     },
     "code": 200,     "code": 200,
Línea 4873: Línea 5519:
     "code": 200,     "code": 200,
     "message": "Nota creada exitosamente.",     "message": "Nota creada exitosamente.",
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Consultar archivos adjuntos del caso ====
 +
 +----
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/archivos/get?idobjeto=<id_caso>&tipoobjeto=casos%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  idobjeto -> Corresponde al id del caso.
 +  tipoobjeto -> Corresponde al tipo de objeto del cual se están consultando las notas. En este caso el valor corresponde a //caso//.
 +
 +**Autenticación:**
 +
 +Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
 +
 +**Campos:**
 +
 +No requiere enviar campos.
 +
 +**Ejemplo:**
 +
 +%%https://api.beaware360.com/ba360/apir/v10_5/archivos/get?idobjeto=442&tipoobjeto=casos%%
 +
 +----
 +
 +=== Response ===
 +
 +El sistema retorna los archivos adjuntos del caso consultado.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "idrol": 6,
 +            "nombre": "Archivo de prueba.pdf",
 +            "idstage": 47,
 +            "metadatos": [
 +                {
 +                    "clave": "GRUPO_DOCUMENTO",
 +                    "valor": "43"
 +                },
 +                {
 +                    "clave": " TIPO_DOCUMENTO",
 +                    "valor": "752"
 +                }
 +            ],
 +            "idusuario": 29,
 +            "idobjeto": 442,
 +            "tipoobjeto": "casos",
 +            "fechacreacion": "2025-03-17 21:38:07",
 +            "file": null,
 +            "idtipodocumento": 1,
 +            "seen": 0,
 +            "tipodocumento": "Acta de nacimiento",
 +            "tag": "Archivo de prueba.pdf",
 +            "filesize": 15895,
 +            "clasificacion": null,
 +            "idusuariodesc": "Juan Pérez",
 +            "idroldesc": "Ejecutivo de atención",
 +            "idstagedesc": "Registro información",
 +            "eid": null,
 +            "uuid": null,
 +            "id": 255
 +        },
 +        {
 +            "idrol": 6,
 +            "nombre": "Documento de reembolso.pdf",
 +            "idstage": 47,
 +            "metadatos": [
 +                {
 +                    "clave": "GRUPO_DOCUMENTO",
 +                    "valor": "5050010005"
 +                },
 +                {
 +                    "clave": "TIPO_DOCUMENTO",
 +                    "valor": "5050010005009"
 +                }
 +            ],
 +            "idusuario": 29,
 +            "idobjeto": 442,
 +            "tipoobjeto": "casos",
 +            "fechacreacion": "2025-03-17 21:38:32",
 +            "file": null,
 +            "idtipodocumento": 5,
 +            "seen": 0,
 +            "tipodocumento": "Reembolso de pago",
 +            "tag": "Documento de reembolso.pdf",
 +            "filesize": 15804,
 +            "clasificacion": null,
 +            "idusuariodesc": "Juan Pérez",
 +            "idroldesc": "Ejecutivo de atención",
 +            "idstagedesc": "Análisis de Información",
 +            "eid": null,
 +            "uuid": null,
 +            "id": 256
 +        }
 +    ],
 +    "code": 200,
 +    "message": null,
     "pagination": null     "pagination": null
 } }
Línea 4891: Línea 5655:
  
 **%%https://api.beaware360.com/ba360/uploadfile%%**. **%%https://api.beaware360.com/ba360/uploadfile%%**.
 +
  
 ---- ----
Línea 4911: Línea 5676:
 ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review | | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review |
-| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 203 |+| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 6542 |
 | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: "casos" | casos | | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: "casos" | casos |
 | TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | Prueba API | | TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | Prueba API |
 | FILE | Archivo adjunto del caso | Archivo (Formato binario). | Sí | De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario. |  | | FILE | Archivo adjunto del caso | Archivo (Formato binario). | Sí | De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario. |  |
-| IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 3 |+| IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 44 | 
 +| IDTIPODOCUMENTO | Identifica el ID del Catálogo de documentos con el que se subirá el archivo al caso. | Integer | No |  | 1 |
  
 **Ejemplo:** **Ejemplo:**
  
-{{:ejemplo_carga_de_archivos_adjuntos.png?nolink|Ejemplo de carga de archivos adjuntos desde Postman}}+{{:api.png?1200|}}
  
 ---- ----
Línea 5291: Línea 6057:
     "message": null,     "message": null,
     "pagination": null     "pagination": null
 +}
 +</code>
 +
 +----
 +
 +===== Recursos para Catálogo de Documentos =====
 +
 +==== Consultar Catálogo de Documentos ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +https://api.beaware360.com/ba360/apir/v11/catalogodocumentos/get
 +
 +----
 +
 +=== Request: ===
 +
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la lista de los catálogos de documentos.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "idusuariocreacion": 3,
 +            "idusuariomodificacion": 0,
 +            "metadatos": [],
 +            "fechacreacion": "2025-02-27 05:08:26",
 +            "tipodocumento": "Cédula de ciudadanía",
 +            "idusuariomodificaciondesc": null,
 +            "idusuariocreaciondesc": "scantor",
 +            "extensionespermitidas": "pdf, jpg, jpeg, png",
 +            "eid": null,
 +            "uuid": null,
 +            "id": 1
 +        },
 +        {
 +            "idusuariocreacion": 3,
 +            "idusuariomodificacion": 0,
 +            "metadatos": [],
 +            "fechacreacion": "2025-02-28 20:30:31",
 +            "tipodocumento": "Certificado de libertad y tradición del inmueble",
 +            "idusuariomodificaciondesc": null,
 +            "idusuariocreaciondesc": "scantor",
 +            "extensionespermitidas": "zip, rar, docx, pdf",
 +            "eid": null,
 +            "uuid": null,
 +            "id": 2
 +        }
 +}
 +</code>
 +
 +----
 +
 +==== Consultar Catálogo de Documentos por ID ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/catalogodocumentos/getby?id=<id_catálogodocumento>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Recibe el id del catálogo de documento en Be Aware 360.
 +
 +**Campos:**
 +
 +  No requiere enviar campos.
 +  
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/catalogodocumentos/getby?id=3
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la información de un catálogo de documentos en específico, según su Id en Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "idusuariocreacion": 3,
 +            "idusuariomodificacion": 0,
 +            "metadatos": [],
 +            "fechacreacion": "2025-02-28 20:30:31",
 +            "tipodocumento": "Certificado de libertad y tradición del inmueble",
 +            "idusuariomodificaciondesc": null,
 +            "idusuariocreaciondesc": "scantor",
 +            "extensionespermitidas": "zip, rar, docx, pdf",
 +            "eid": null,
 +            "uuid": null,
 +            "id": 2
 +        }
 } }
 </code> </code>
apiba360_105.1716567114.txt.gz · Última modificación: 2024/05/24 16:11 por scantor
Excepto donde se indique lo contrario, el contenido de este wiki esta bajo la siguiente licencia: CC Attribution-Noncommercial-Share Alike 4.0 International


  • Ver página
  • Revisiones antiguas
  • Enlaces a esta página
  • Cambios recientes
  • Administrador de Ficheros
  • Índice