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 [2025/03/17 22:10] – [Consultar Catálogo de Documentos por ID] scantorapiba360_105 [2025/04/03 23:01] (actual) – scantor
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 4485: Línea 4904:
                 14                 14
             ],             ],
 +            "mtdocumentosobligatorios": [
 +                1
 +            ],
 +            "mtdocumentosopcionales": [
 +                2
 +            ],
 +            "carpetadestino": null,
             "eid": null,             "eid": null,
             "uuid": null,             "uuid": null,
Línea 4501: 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 4636: 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 4641: 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 4667: 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 4682: 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 4725: 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 4736: 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 4751: 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 4758: Línea 5190:
         ],         ],
         "mtsubtipos": [         "mtsubtipos": [
-            6, +            5, 
-            7+            3
         ],         ],
         "mttipos": [         "mttipos": [
Línea 4766: 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 5217: Línea 5655:
  
 **%%https://api.beaware360.com/ba360/uploadfile%%**. **%%https://api.beaware360.com/ba360/uploadfile%%**.
 +
  
 ---- ----
Línea 5237: 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 5725: Línea 6165:
  
 <code java> <code java>
-https://api.beaware360.com/ba360/apir/v10_5/contacto/getby?id=60+https://api.beaware360.com/ba360/apir/v11/catalogodocumentos/getby?id=3
 </code> </code>
  
Línea 5738: Línea 6178:
 <code java> <code java>
 { {
-        "idusuariocreacion": 44, +    "data": [ 
-        "idusuariomodificacion": 0, +        { 
-        "metadatos": [], +            "idusuariocreacion": 3, 
-        "fechacreacion": "2025-03-17 21:52:25", +            "idusuariomodificacion": 0, 
-        "tipodocumento": "hospitalario", +            "metadatos": [], 
-        "idusuariomodificaciondesc": null, +            "fechacreacion": "2025-02-28 20:30:31", 
-        "idusuariocreaciondesc": "jjerez", +            "tipodocumento": "Certificado de libertad y tradición del inmueble", 
-        "extensionespermitidas": "rar, zip, ppt", +            "idusuariomodificaciondesc": null, 
-        "eid": null, +            "idusuariocreaciondesc": "scantor", 
-        "uuid": null, +            "extensionespermitidas": "zip, rar, docx, pdf", 
-        "id": 3 +            "eid": null, 
-    }+            "uuid": null, 
 +            "id": 2 
 +        } 
 +} 
 +</code>
  
 ---- ----
  
apiba360_105.1742249438.txt.gz · Última modificación: 2025/03/17 22:10 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