Speicherdienst
Auf dieser Seite
Operationen für Ressourcen des Speicherdienstes. 4 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.
POST /storage-service/clip
Cip hochladen in Cloud Storage
Parameter
Name | In | Typ | Erforderlich | Beschreibung |
|---|---|---|---|---|
Datei | formData | Datei | ja | Datei zum Hochladen. |
sensorId | formData | Zeichenkette | nein | Sensor-ID |
deviceId | formData | Zeichenkette | nein | Device ID |
Antworten
Status | Beschreibung | Inhalt |
|---|---|---|
200 | Erfolg | |
400 | Ungültige Eingabe | |
401 | Nicht autorisiert | |
403 | Verboten | |
412 | Kein Inhalt | |
500 | interner Serverfehler |
Beispiel 200 Antwort:
{
"id": "string",
"filepath": "string"
}POST /storage-service/clip/filter
Ruft die Dateiliste mit Filter, Sortierung und Pagination ab. Es ermöglicht die Suche auf hierarchischer Ebene. Es kann anhand einer angegebenen Hierarchie gefiltert werden oder verwendet die Hierarchie des angemeldeten Benutzers. Dies bietet die Möglichkeit, zusätzliche Entitätsfelder in der Antwort zu erhalten. Außerdem werden Konfigurations‑Metadaten zur Entität bereitgestellt.
Anfragekörper
Dateifilterung und -sortierung
{
"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"
}Antworten
Status | Beschreibung | Inhalt |
|---|---|---|
200 | Erfolg | Objekt |
204 | Kein Inhalt | |
400 | Ungültige Eingabe | |
401 | Nicht autorisiert | |
403 | Verboten |
Beispiel 200 Antwort:
{
"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}
Cip aus AWS S3 löschen
Parameter
Name | In | Typ | Erforderlich | Beschreibung |
|---|---|---|---|---|
ID | Pfad | string | ja |
Antworten
Status | Beschreibung | Body |
|---|---|---|
200 | Erfolg | |
204 | Kein Inhalt | |
401 | Nicht autorisiert | |
403 | Verboten | |
404 | Nicht gefunden |
Beispiel 200 Antwort:
{
"message": "File deleted successfully"
}GET /storage-service/clip?folderId={folderId}&hierarchyLevel={hierarchyLevel}&hierarchyId={hierarchyId}
Clip von S3 herunterladen
Parameter
Name | In | Typ | Erforderlich | Beschreibung |
|---|---|---|---|---|
folderId | query | string | ja | FileUpload-Ordner-ID |
path | query | string | nein | Lokaler Pfad zum Speichern des Downloads |
hierarchyLevel | query | string | ja | hierarchyLevel |
hierarchyId | query | string | ja | hierarchyId |
Antworten
Status | Beschreibung | Body |
|---|---|---|
200 | Erfolg | |
400 | Ungültige Eingabe | |
401 | Nicht autorisiert | |
403 | Verboten | |
404 | Nicht gefunden |
Beispiel 200Antwort:
{
"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"
}Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.