Storage Service
Op deze pagina
Operaties op opslagservice‑bronnen. 4 eindpunten, elk relatief aan https://api.nxgen.cloud/api/v1 en geauthenticeerd zoals beschreven onder Authentication.
POST /storage-service/clip
Upload Cip naar Cloud Storage
Parameters
Naam | In | Type | Verplicht | Beschrijving |
|---|---|---|---|---|
file | formData | file | yes | Bestand om te uploaden. |
sensorId | formData | string | no | Sensor‑ID |
deviceId | formData | string | no | Device ID |
Responses
Status | Beschrijving | Body |
|---|---|---|
200 | Success | |
400 | Invalid Input | |
401 | Unauthorized | |
403 | Niet toegestaan | |
412 | Geen inhoud | |
500 | Interne Server Fout |
Example 200 response:
{
"id": "string",
"filepath": "string"
}POST /storage-service/clip/filter
Haalt lijst met bestanden op met filteren, sorteren en paginering. Het ondersteunt zoeken op hiërarchisch niveau. Het kan gefilterd worden met een opgegeven hiërarchie of gebruikt de hiërarchie van de aangemelde gebruiker. Dit biedt de mogelijkheid om extra entiteitsvelden in de respons op te nemen. Biedt tevens configuratiemetadata over de entiteit.
Request body
Bestanden filteren en sorteren
{
"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"
}Responses
Status | Description | Body |
|---|---|---|
200 | Success | object |
204 | Geen inhoud | |
400 | Ongeldige invoer | |
401 | Niet toegestaan | |
403 | Niet toegestaan |
Example 200 response:
{
"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}
Delete Cip from AWS S3
Parameters
Name | In | Type | Vereist | Beschrijving |
|---|---|---|---|---|
id | pad | string | ja |
Responsen
Status | Beschrijving | Body |
|---|---|---|
200 | Succes | |
204 | Geen inhoud | |
401 | Niet toegestaan | |
403 | Verboden | |
404 | Niet gevonden |
Voorbeeld200 respons:
{
"message": "File deleted successfully"
}GET /storage-service/clip?folderId={folderId}&hierarchyLevel={hierarchyLevel}&hierarchyId={hierarchyId}
Clip downloaden van S3
Parameters
Naam | In | Type | Verplicht | Beschrijving |
|---|---|---|---|---|
folderId | query | string | ja | FileUpload map-id |
path | query | string | nee | Lokale pad om download op te slaan |
hierarchyLevel | query | string | ja | hierarchyLevel |
hierarchyId | query | string | ja | hierarchyId |
Responsen
Status | Beschrijving | Inhoud |
|---|---|---|
200 | Succes | |
400 | Ongeldige invoer | |
401 | Niet toegestaan | |
403 | Verboden | |
404 | Niet gevonden |
Voorbeeld 200 respons:
{
"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"
}Bedankt — uw feedback gaat naar het team dat deze pagina beheert.