Para: Administradores
Ejecuta una importación con una clave de administración.
Crea una importación, sube un archivo CSV y adjúntalo, luego revisa cada fila y vuelve a intentar con las que fallaron.
En este artículo9 secciones
Antes de empezar
Esta página explica cómo realizar una importación utilizando una clave de gestión. Las mismas funciones que se describen en Integración › Importaciones. Todos los caminos mencionados aquí están dentro de https://prd-api-manage.caseactive.com/v1/integration/<hub id>. Para conocer las columnas que necesita cada archivo importado, consulte Consulte las columnas requeridas por cada importación.
Llamadas
| Llamar | Lo que hace |
|---|---|
POST /imports | Se crea una operación de importación. |
GET /drive/private?import_id=<id>&media_group=docs&media_extension=csv | Proporciona una dirección para cargar el archivo en ella. |
PUT /imports/<import_id> | Se adjunta el archivo cargado, lo que inicia el proceso de importación. |
GET /imports | Lista de las importaciones, ordenadas por orden de llegada, con información sobre el progreso de cada una. |
GET /imports/<import_id> | Lista las filas de un importador. |
PUT /imports/<import_id>/<unique_id> | Se intenta volver a ejecutar una fila que falló. |
1. Crea la importación
| Campo | Lo que hace | Requerido |
|---|---|---|
name | Un nombre para ello: letras, números, espacios y guiones. | Sí. |
source | Lo que lo inició… como claims-sync. Esto se muestra como su fuente en el Panel de Administración. | Sí. |
type | Uno de los tipos que se mencionan a continuación: | Sí. |
type | En pantalla |
|---|---|
post_user | Añadir usuarios |
put_user | Modificar los usuarios |
post_case | Crea casos. |
put_case | Modificar los casos |
post_case_permission | Asigne usuarios a los casos. |
delete_case_permission | Eliminar a los usuarios asignados a los casos. |
post_case_post | Crea publicaciones relacionadas con casos. |
curl -X POST https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "October claimants", "source": "claims-sync", "type": "post_user"}'
Responde a 201 con import_id, como en el caso de import::20261002141503_3f9a1c2b7d4e60.
2. Sube el archivo
Pídanse una dirección de subida. GET /drive/private?import_id=<import_id>&media_group=docs&media_extension=csv. Responde a una pregunta. url Y un conjunto de… fields. Envíe el archivo allí, como se indica. multipart/form-data POST, con cada entrada de… fields Exactamente como se indica, y el archivo es el último en la lista. file:
curl -X POST "<url>" \
--form-string "key=<fields.key>" \
--form-string "<every other entry of fields, as given>" \
-F "file=@october-claimants.csv"
- Envíe los registros que comiencen con
fieldsy que contengan--form-string, pero no-F. Algunos de estos registros comienzan con<o contienen;. En este caso,-Fse interpreta como un archivo o una opción. - La dirección funciona durante una hora.
- Guarde el archivo en formato CSV, con los nombres de las columnas en la primera línea del archivo.
- Un archivo puede contener hasta 25,000 filas, bajo los nombres de las columnas. Un archivo más largo no puede ser importado; en ese caso, no se importa nada. Es necesario dividir el archivo en archivos de 25,000 filas o menos, y realizar la importación para cada uno de ellos por separado.
- Mantén
fields.key: así es como se adjunta el archivo a continuación.
3. Adjunte el archivo
PUT /imports/<import_id> La importación comienza con la clave de carga. Eso es todo. 204.
{"media_key": "<fields.key>"}
Adjunte un archivo una vez. Si la importación falla, corrija el archivo y vuelva a intentarla.
4. Comprobar el progreso
GET /imports muestra las importaciones que tienes, ordenadas de forma ascendente. Para cada una de ellas, se indican los valores status, total, passed y failed.
QUEUED: ya está creado, o adjuntado, pero aún no se ha leído.PROCESSED: El archivo se ha leído hacia dentro.totalHileras, que se extienden una tras otra. Está terminado cuando…passedyfailedSumarlos, resulta que…total.FAILED: El archivo no pudo ser leído. No contiene ninguna fila, o bien contiene más de 25,000 filas. Laerror_msgindica qué tipo de datos se encuentran en el archivo:ImportFileUnreadableException,ImportFileEmptyExceptionoImportFileTooLargeException.
Las filas se procesan en el centro de control cada vez que se realiza una importación. Por lo tanto, un archivo de gran tamaño puede tomar algo de tiempo para ser procesado. Los administradores y gerentes del centro de control reciben correos electrónicos cuando una importación falla o cuando la primera fila no se procesa correctamente.
GET /imports/<import_id> enumera las filas que han sido ejecutadas, en el orden en que aparecen en el archivo. En limit se indica un número máximo de 1000 filas que pueden ser ejecutadas. En start_key también se indica un número máximo de filas que pueden ser ejecutadas.
{
"data": {
"items": [
{
"unique_id": "unique::20261002141503_3f9a1c2b7d4e60_0000002",
"line": 2,
"type": "post_user",
"status": "SUCCEEDED",
"data": {"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "host_ref_id": "cl-1042"},
"output": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60"}
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports/import::20261002141503_3f9a1c2b7d4e60"
}
}
| Campo | Lo que contiene |
|---|---|
line | El número de filas en tu archivo, ya que una hoja de cálculo cuenta las filas. Los nombres de las columnas corresponden a la primera fila. |
data | Las celdas de la fila, tal como se envían. |
status | SUCCEEDED, FAILED o QUEUED, mientras se espera una nueva tentativa. |
output | Lo que se obtiene es: user_id, case_id, o ambos, para una fila que hace que alguien quede en una situación determinada. |
schema_errors | En el caso de una célula que no cumplió con los requisitos de verificación: la columna en cuestión, y lo que estaba mal. |
error_msg | ¿Por qué el intento falló? ¿Por qué se utilizó un nombre de error como CaseReferenceIdExistsException? |
Un registro solo se considera exitoso si logra realizar su cambio. Un registro cuyo ID de etiqueta, ID de referencia o información personal coincida con la de otro registro, no puede ser procesado; en ese caso, se indica el nombre del registro que rechaza el cambio. error_msg. No se puede asignar usuarios a casos, ni crear entradas de caso con nombres que indiquen que el caso está cerrado. {"_schema": ["Case is closed"]} en schema_errors: Reabrimos el caso, y luego importamos nuevamente esa fila.
El valor de unique_id de una fila está compuesto por el ID de esa fila y el número de esa fila en el archivo. Por lo tanto, import::20261002141503_3f9a1c2b7d4e60 correspondiente a la fila 2 es unique::20261002141503_3f9a1c2b7d4e60_0000002.
5. Reintentar una fila
Con PUT /imports/<import_id>/<unique_id> y {"retry": true}, se produce otro error en la ejecución de la fila correspondiente, tal como ocurrió antes, al final del ciclo de ejecución de las filas. Esto responde a la solicitud enviada por 204. El número de elementos importados, indicado por failed, disminuye en uno hasta que la fila se ejecuta correctamente. Se puede utilizar este método para manejar filas que han fallado por razones como momentos de alta carga. Las filas cuyas celdas están incorrectas también pueden fallar nuevamente. Corrija el archivo y luego inicie una nueva ejecución del proceso de importación.
¿Qué sucede después?
Las filas de los importados hacen lo mismo que las filas en la pantalla: las personas a quienes se les agrega algo no reciben un correo electrónico; aquellos a quienes se les ponen casos reciben la notificación por correo electrónico. Los nuevos casos se manejan según las reglas de asignación de casos, y las nuevas publicaciones notifican a las personas involucradas en el caso. La importación se registra como parte del sistema de gestión de casos. Asistente virtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual.Enviar el mismo archivo dos veces significa que cada fila se ejecuta nuevamente. Las filas que no se ejecutan correctamente en la primera ocasión, también se ejecutan dos veces. Para solucionar este problema, vea… Arregle la importación de los datos en los que hay filas con errores..
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 400 | SchemaFieldsException | Se ha perdido o el campo es inválido. Por ejemplo, un name que contiene otros caracteres, o un media_key en el cual no se ha cargado ningún contenido. |
| 403 | ImportFileAlreadyAttachedException | La importación ya tiene su archivo, o ya se ha leído: inicie una nueva importación. |
| 403 | BotNotAllowedException | Usted utilizó /v1/<hub id>/imports en lugar de /v1/integration/<hub id>/imports. |
| 404 | ItemNotFoundException | No importa, ni tampoco es necesario incluir esa fila en tu lista. |