Servicio de almacenamiento
En esta página
Operaciones sobre recursos del servicio de almacenamiento. 4 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Autenticación.
POST /storage-service/clip
Cargar Cip a Cloud Storage
Parámetros
Nombre | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
archivo | formData | archivo | sí | Archivo a cargar. |
sensorId | formData | cadena | no | ID del sensor |
deviceId | formData | cadena | no | Device ID |
Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
400 | Entrada inválida | |
401 | No autorizado | |
403 | Prohibido | |
412 | Sin contenido | |
500 | Error interno del servidor |
Ejemplo 200 respuesta:
{
"id": "string",
"filepath": "string"
}POST /storage-service/clip/filter
Obtiene la lista de archivos con filtrado, ordenación y paginación. Permite la búsqueda a nivel jerárquico. Puede filtrarse usando una jerarquía especificada o utiliza la jerarquía del usuario conectado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.
Cuerpo de la Solicitud
Filtrado y ordenación de archivos
{
"filters": [
{
"columnName": "string (required)",
"type": "distinctList | date | number | StringConditionFilter (required)",
"filter": "object (required)"
}
],
"sortOrder": [
{
"columnName": "string",
"isAscending": "boolean"
}
],
"primaryColumns": [
"string"
],
"hierarchyLevel": "string",
"hierarchyId": "string",
"nPerPage": "number",
"pageNumber": "number",
"isConfigDetailRequired": "boolean",
"getConfig": "boolean",
"getChildOrParent": "boolean"
}Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | objeto |
204 | Sin contenido | |
400 | Entrada inválida | |
401 | No autorizado | |
403 | Prohibido |
Ejemplo 200 respuesta:
{
"config": {
"columns": [
{
"visibility": true,
"columnName": "commercialName",
"DisplayName": "Device",
"isFilterable": true,
"filterType": "stringCondition",
"sticky": true,
"isRightBorder": true,
"isMandatory": true,
"isNotDraggable": true
}
],
"defaultNPerPage": 50,
"defaultFilterCondition": [],
"defaultSortingOrder": [
{
"columnName": "dateTime",
"isAscending": false
}
],
"maxVisibleColumnCount": 6,
"exportLimitNPerPage": 500
},
"dataResult": [
{
"_id": "65b8ae63dc4355286864f6bc",
"timeStamp": 1706602076710,
"userEmail": "admin@web02.io",
"fileName": "Screenshot 2023-11-20 115021 - Copy (2).png",
"mimetype": "image/png",
"size": 1219944,
"folder": "dc79cb2b0907bea776a3fa437b96e53a",
"signedUrl": "https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/dc79cb2b0907bea776a3fa437b96e53a/Screenshot%202023-11-20%20115021%20-%20Copy%20%282%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240202%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240202T072929Z&X-Amz-Expires=3600&X-Amz-Signature=6e0cb0744cd378c74ac2d0bd9199eb82ef278a9d93b4c110b4091efa174df021&X-Amz-SignedHeaders=host"
},
{
"_id": "65bb437ec8c2e356b822beed",
"timeStamp": 1706771321894,
"userEmail": "dinesh@nxgen.io",
"fileName": "vlc-record-2023-12-14-16h34m44s-In The End.mp4",
"mimetype": "video/mp4",
"size": 6478,
"folder": "c206997e6fb05b1ecd131305eb6fa371",
"signedUrl": "https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/c206997e6fb05b1ecd131305eb6fa371/vlc-record-2023-12-14-16h34m44s-In%20The%20End.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240202%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240202T072929Z&X-Amz-Expires=3600&X-Amz-Signature=1680e057f9ec11ca787888859df6ef52863c924c81dc94b9c8e5b016c563ddc8&X-Amz-SignedHeaders=host"
}
],
"totalRecordsCount": 2,
"totalConsumedStorage": 1226422,
"filteredBy": [],
"sortedBy": [
{
"columnName": "dateTime",
"isAscending": false
}
],
"dispatchedAll": false,
"isDefaultProjectionMutated": false,
"isDefaultFilterMutated": false,
"isDefaultSortingMutated": false
}DELETE /storage-service/clip/{id}
Eliminar Cip de AWS S3
Parámetros
Nombre | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id | ruta | cadena | sí |
Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
204 | Sin contenido | |
401 | No autorizado | |
403 | Prohibido | |
404 | No Encontrado |
Ejemplo 200 respuesta:
{
"message": "File deleted successfully"
}GET /storage-service/clip?folderId={folderId}&hierarchyLevel={hierarchyLevel}&hierarchyId={hierarchyId}
Descargar clip de S3
Parámetros
Nombre | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
folderId | consulta | cadena | sí | ID de carpeta FileUpload |
ruta | consulta | cadena | no | Ruta local para guardar la descarga |
hierarchyLevel | consulta | cadena | sí | hierarchyLevel |
hierarchyId | query | string | sí | hierarchyId |
Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
400 | Entrada inválida | |
401 | No autorizado | |
403 | Prohibido | |
404 | No Encontrado |
Ejemplo200 respuesta:
{
"externalUrl": "https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/331ba86e5cbfaa6addf8c3ca369e48/Untitled%20design.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240122%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240122T142622Z&X-Amz-Expires=3600&X-Amz-Signature=b4d134981420b682e17e452662c2ba7bd781371fe0bbfb94f22d39cd240b904f&X-Amz-SignedHeaders=host"
}Gracias — sus comentarios llegan al equipo responsable de esta página.