Service de stockage
Sur cette page
Opérations sur les ressources du service de stockage. 4 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit dans Authentification.
POST /storage-service/clip
Téléverser Cip vers le stockage cloud
Paramètres
Nom | Dans | Type | Obligatoire | Description |
|---|---|---|---|---|
fichier | formData | fichier | oui | Fichier à téléverser. |
sensorId | formData | chaîne | non | ID du capteur |
deviceId | formData | chaîne | non | Device ID |
Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
400 | Entrée invalide | |
401 | Non autorisé | |
403 | Interdit | |
412 | Pas de contenu | |
500 | Erreur Interne du Serveur |
Exemple 200 réponse:
{
"id": "string",
"filepath": "string"
}POST /storage-service/clip/filter
Récupère la liste des fichiers avec filtrage, tri et pagination. Permet la recherche à différents niveaux hiérarchiques. Peut être filtré en utilisant la hiérarchie spécifiée ou utilise la hiérarchie de l'utilisateur connecté. Offre la possibilité d'obtenir des champs d'entité supplémentaires dans la réponse. Fournit également les métadonnées de configuration de l'entité.
Corps de la Demande
Filtrage et tri des fichiers
{
"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"
}Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | objet |
204 | Pas de contenu | |
400 | Entrée invalide | |
401 | Non autorisé | |
403 | Interdit |
Exemple 200 réponse:
{
"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}
Supprimer le Cip d'AWS S3
Paramètres
Nom | Dans | Type | Obligatoire | Description |
|---|---|---|---|---|
id | chemin | chaîne | oui |
Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
204 | Pas de contenu | |
401 | Non autorisé | |
403 | Interdit | |
404 | Pas trouvé |
Exemple 200 réponse:
{
"message": "File deleted successfully"
}GET /storage-service/clip?folderId={folderId}&hierarchyLevel={hierarchyLevel}&hierarchyId={hierarchyId}
Télécharger le clip depuis S3
Paramètres
Nom | Dans | Type | Obligatoire | Description |
|---|---|---|---|---|
folderId | requête | chaîne | oui | Identifiant du dossier FileUpload |
chemin | requête | chaîne | non | Chemin local pour enregistrer le téléchargement |
hierarchyLevel | requête | chaîne | oui | hierarchyLevel |
hierarchyId | requête | chaîne | oui | hierarchyId |
Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
400 | Entrée invalide | |
401 | Non autorisé | |
403 | Interdit | |
404 | Pas trouvé |
Exemple 200réponse :
{
"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"
}Merci — votre retour est transmis à l’équipe responsable de cette page.