Para obtener información sobre el uso de bioStar 2 New Local API, consulte el artículo a continuación.
[API de BioStar 2] Cómo usar e iniciar bioStar 2 Local API Server
Si va a su BioStar 2 Settings -> Server, puede establecer su propio campo de usuario personalizado. El campo de usuario personalizado es una información definida por el usuario que se puede utilizar para los USUARIOS registrados de su BioStar 2.
Por ejemplo, puede agregar información de 'Cumpleaños' o 'NickName' además de la información básica del USUARIO (como Nombre, Departamento, Correo electrónico, ID ... etc.)
Puede agregar un campo de usuario personalizado utilizando las funciones básicas de su BioStar 2, siguiendo el siguiente artículo:
Cómo crear campos de usuario personalizados
Y también puede agregar un campo de usuario personalizado utilizando la nueva API local de BioStar 2. Veremos 2 funciones de API relacionadas con custom user field:
- Cómo buscar el campo de usuario personalizado
- Cómo actualizar (o agregar) el campo de usuario personalizado
*Las llamadas a la API anteriores aún no aparecen en la fanfarronería. (2021-09-30)
1. Cómo buscar el campo de usuario personalizado
Método | API | Qué hace | Parámetros |
OBTENER | /api/setting/custom_fields | Buscar todos los campos de usuario personalizados en BioStar 2 |
|
[GET] /api/setting/custom_fields
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Tipo de parámetro |
|
|
|
|
|
* M – Obligatorio, O – Opcional
[Órgano de solicitud]
|
[Respuesta]
{ "CustomFieldCollection": { "total": "3", "filas": [ { "id": "1", "nombre": "Cumpleaños", "tipo": "0", "orden": "1" }, { "id": "8", "nombre": "CUF_Number", "tipo": "1", "orden": "2" }, { "id": "9", "nombre": "CUF_Combo", "tipo": "2", "orden": "3", "datos": "Opción 1; Opción 2; Opción 3" } ] }, "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
- 'total': Número de elementos de campo de usuario personalizados
- 'id': ID de campo de usuario personalizado
- 'nombre': Nombre de campo de usuario personalizado
- 'type': Tipo de campo de usuario personalizado. 0 = texto, 1 = número, 2 = combo
- 'data': Este parámetro solo existe para los campos 'combo'. Indica las opciones de elección.
2. Cómo actualizar (o agregar) el campo de usuario personalizado
Método | API | Qué hace | Parámetros |
PONER | /api/setting/custom_fields | Actualizar los campos de usuario personalizados en BioStar 2 | Id, nombre, tipo, orden, datos, habilitar |
[PUT] /api/setting/custom_fields
[Parámetros – para campos ya existentes]
Nombre | Tipo | *M/O | Explicación |
Identificación | Cuerda | M | ID de campo de usuario personalizado |
Nombre | Cuerda | M | Nombre de campo de usuario personalizado |
Tipo | Cuerda | M | Tipo de campo de usuario personalizado 0 = Texto 1 = Número 2 = Combo |
Orden | Cuerda | O | Combinación de campos de usuario personalizados |
* M – Obligatorio, O – Opcional
[Parámetros: para agregar nuevos campos de usuario personalizados]
Nombre | Tipo | *M/O | Explicación |
Orden | Cuerda | O | Combinación de campos de usuario personalizados |
Nombre | Cuerda | M | Nombre de campo de usuario personalizado |
Tipo | Cuerda | M | Tipo de campo de usuario personalizado 0 = Texto 1 = Número 2 = Combo |
Habilitar | Verdadero/Falso | M | Si usar o no. Configúrelo como 'verdadero' para su uso. |
* M – Obligatorio, O – Opcional
[Órgano de solicitud]
{ "CustomFieldCollection": { "total": "3", "filas": [ { "id": "1", "nombre": "Cumpleaños", "tipo": "0", "orden": "1" }, { "id": "8", "nombre": "CUF_Number", "tipo": "1", "orden": "2" }, { "id": "9", "nombre": "CUF_Combo", "tipo": "2", "orden": "3", "datos": "Opción 1; Opción 2; Opción 3; Opción 4" }, { "orden": 4, "nombre": "CUF_NEW", "tipo": 0, "enable": verdadero } ] } } |
*amarillo indica el nuevo campo de usuario personalizado que se va a agregar
[Respuesta]
{ "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
*Puedes ver el campo de usuario personalizado que acabas de agregar en tu BioStar2.
3. Ejemplo: obtenga información del usuario con el campo personalizado
Cuando llame a [GET] /api/users/{user_id}, puede comprobar los valores de campo personalizados del usuario seleccionado.
{ "UserCollection": { "total": "6", "filas": [ { "user_id": "2", "nombre": "Sharon", "género": "0", "photo_exists": "falso", "pin_exists": "falso", "login_id": "sharon", ... (omitido) "user_custom_fields": [ { "artículo": "1990-02-31", "user_id": { "user_id": "2", "nombre": "Sharon" }, "custom_field": { "id": "1", "nombre": "Cumpleaños", "tipo": "0", "orden": "1" } }, { "artículo": "33333", "user_id": { "user_id": "2", "nombre": "Sharon" }, "custom_field": { "id": "8", "nombre": "CUF_Number", "tipo": "1", "orden": "2" } }, { "artículo": "Opción 1", "user_id": { "user_id": "2", "nombre": "Sharon" }, "custom_field": { "id": "9", "nombre": "CUF_Combo", "tipo": "2", "orden": "3" } }, { "item": "Nuevo campo", "user_id": { "user_id": "2", "nombre": "Sharon" }, "custom_field": { "id": "10", "nombre": "CUF_NEW", "tipo": "0", "orden": "4" } } ] } ] }, ... "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |