Operaciones Masivas

Las API de operaciones masivas están diseñadas para realizar el mismo conjunto de operaciones para varios registros de una hoja en una única solicitud.

Hay dos formas de especificar los registros que se actualizarán:

• Filtros where

https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/< tipo de operación masiva >?api&where=< ID de campo >,< Operando de filtro >,< Valor >

• recordId en la cadena de consulta, recordId=< recordId >. p. ej. recordId=1&recordId=2

https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/< tipo de operación masiva >?api&recordId=< recordId >

Formato de Solicitud

• Las API de operaciones masivas son operaciones sincronizadas.
• Es necesario modificar www a na3, ap5 o eu2 en la URL de la API según la URL de la cuenta de la base de datos de Ragic.

Método HTTP: POST
URL: https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/< tipo de operación masiva >?api


Encabezados
Autorización: Básica < Clave API >

Cuerpo
{
// Datos JSON que describen la operación a realizar
}

==========

Response
{
"taskId": < A UUID Que Identifica la Tarea >
}

Bloqueo Masivo

La API de bloqueo masivo permite bloquear o desbloquear varios registros a la vez.

Bloqueo masivo de documentos

Método HTTP - POST
URL - https://www.ragic.com/< cuenta >/< tarea de pestaña >/< índice de hoja >/massOperation/massLock?api

{
"action": < bloquear o desbloquear >
}

==========

Response
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

Aprobación Masiva

La API de aprobación masiva permite la aprobación o el rechazo de varios registros a la vez.

Documento de aprobación masiva

Método HTTP: POST
URL: https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/massApproval?api

{
"action": < aprobar o rechazar >,
"comment": < comentario opcional > // opcional
}

==========

Response
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

Botón de Acción Masiva

La API del botón de acción masiva permite la ejecución de un botón de acción en varios registros a la vez.

Documento del botón de acción masiva

Método HTTP: POST
URL: https://www.ragic.com/< cuenta >/< carpeta de pestaña >/< índice de hoja >/massOperation/massActionButton?api

{
"buttonId": < ID del botón >
}

==========

Response
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

Para obtener la lista de botones de acción disponibles en una hoja

Método HTTP: GET
URL: https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/metadata/actionButton?api&category=massOperation

==========

Respuesta
{
"actionButtons": [
{
"id": < ID del botón 1 >,
"name": < nombre del botón 1 >
},
.....
,{
"id": < ID del botón 2 >,
"name": < nombre del botón 2 >
}
]
}

Actualización Masiva

La API de actualización masiva permite actualizaciones de valores de campo en varios registros a la vez.

Documento de Actualización masiva

Método HTTP: POST
URL: https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/massUpdate?api

{
    "action": [
        {
            "field": < ID de Campo >,
            "value": < Nuevo Valor de Campo >
        }
    ]
}

==========

Response
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

La API de actualización masiva también admite el uso de usuarios internos y usuarios externos, pero existen algunas restricciones.

Los siguientes campos no se pueden actualizar de forma masiva:

• Correo electrónico (domainId: 1)
• Nombre completo (domainId: 4)
• Registro del sistema (domainId: 10)
• Estado (domainId: 31)
• Interno/Externo (domainId: 43)

La actualización masiva de grupos Ragic (domainId: 3) debe seguir las siguientes reglas:

• El valor de la clave "valor" debe escribirse en una matriz JSON, que tiene cadenas como contenido.
• Todos los caracteres especiales deben usarse con el carácter de escape (\), especialmente " debe usarse como \".

Método HTTP: POST
URL: https://www.ragic.com/< cuenta >/< carpeta pestaña >/< índice de hoja >/massOperation/massUpdate?api

{
    "action": [
        {
            "field": 3,
            "value": "[\"SYSAdmin\"]"
        }
    ]
}

==========

Respuesta
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

• En Usuarios internos, es necesario tener al menos un usuario cuyo Grupo Ragic sea SYSAdmin.
• En Usuarios externos, el nombre del Grupo Ragic de los usuarios debe comenzar con "x-" o "X-".

Búsqueda y Reemplazo Masivo

La API de búsqueda y reemplazo masivo permite reemplazar valores en varios registros a la vez.

Búsqueda y reemplazo masivo de documentos

HTTP Method - POST
URL - https://www.ragic.com/< cuenta >/< carpeta de pestañas >/< índice de hoja >/massOperation/massSearchReplace?api

{
"action": [
{
"field": < ID de campo >,
"valueReplaced": < Valor a Reemplazar >,
"valueNew": < Nuevo Valor >,
}
]
}

==========

Respuesta
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

Seguimiento del Progreso de las Tareas

Las operaciones masivas son operaciones asincrónicas.

El identificador de la tarea de la operación se puede utilizar para supervisar su progreso.

Método HTTP - GET
URL - https://www.ragic.com/< account >?api&taskId=< ID de Tarea >

==========

Respuesta
{
"id": < ID de Tarea >,
"ap": < cuenta >,
"taskName": < nombre de la tarea >,
"status": < estado >
}