Dossier
Sur cette page
Opérations sur les ressources de dossiers. 6 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentification.
POST /folder
Ajouter un dossier, Ajouter un dossier avec nœuds et ajouter des nœuds
Corps de la requête
Ajouter un dossier
{
"name": "string",
"sharedWithUser": [
"any"
],
"sharedWithRole": [
"any"
],
"childNodes": [
{
"id": "string",
"type": "string"
}
],
"parentFolderId": "string"
}Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
400 | Entrée invalide | |
401 | Non autorisé |
Exemple 200 réponse:
{
"uniqueId": "a4cfa7155aff40248f490deff75c1770",
"label": "folder 1.1.1",
"key": "a4cfa7155aff40248f490deff75c1770",
"data": {
"type": "folder"
},
"iconImg": "",
"config": "null",
"children": [
{
"uniqueId": "afcf4aaa7155aff40248f490def1770",
"label": "folder 1.1.1.1",
"key": "afcf4aaa7155aff40248f490def1770",
"parentFolderId": "a4cfa7155aff40248f490deff75c1770",
"data": {
"type": "folder"
},
"iconImg": "",
"isActive": true,
"config": "null",
"children": []
},
{
"uniqueId": "3369348d03d2481097f341d6e2aad9a8",
"key": "3369348d03d2481097f341d6e2aad9a8",
"label": "AZ Site",
"data": {
"type": "device"
},
"iconImg": "",
"isActive": true,
"config": "null"
},
{
"uniqueId": "eeb78a119e2a470bada695518753e7b6",
"key": "eeb78a119e2a470bada695518753e7b6",
"label": "Hoofdtribune Vak E-F1-F2",
"data": {
"type": "sensor"
},
"iconImg": "",
"isActive": true,
"config": "null"
},
{
"uniqueId": "feeeeeeqrg333452rfww442de",
"key": "feeeeeeqrg333452rfww442de",
"label": "Test view",
"data": {
"type": "salvoView"
},
"iconImg": "",
"config": {
"views": {
"type": "16",
"gridPosition": [
{
"positionNumber": 0,
"sensorId": "rfefe3454"
},
{
"positionNumber": 1,
"sensorId": "rfefe3454"
},
{
"positionNumber": 2,
"sensorId": "rfefe3454"
},
{
"positionNumber": 3,
"sensorId": "rfefe3454"
}
]
}
}
}
]
}POST /folder/addNodes
Ajouter des nœuds à un dossier existant
Corps de la requête
Pour ajouter des nœuds à un dossier existant
{
"folderId": "string",
"childNodes": [
{
"id": "string",
"type": "string"
}
]
}Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
400 | Entrée invalide | |
401 | Non autorisé | |
403 | Interdit | |
404 | Pas trouvé |
Exemple 200 réponse :
{
"result": true
}POST /folder/bulkUpdateNodeIndex
Mettre à jour l’index du dossier
Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
204 | Pas de contenu | |
401 | Non autorisé | |
404 | Pas trouvé |
Exemple 200 réponse :
[
{
"label": "folder 1",
"key": "a4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 2",
"key": "ea4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 3",
"key": "fa4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 4",
"key": "ad4cfa7155aff40248f490deff75c1770"
}
]POST /folder/getAllFolders
Récupère les dossiers avec filtrage, tri et pagination pour la vue Arbre
Corps de la requête
Obtenir les dossiers
{
"folderId": "string",
"skip": "string",
"limit": "string",
"searchString": "string"
}Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | objet |
204 | Pas de contenu | |
401 | Non autorisé | |
404 | Pas trouvé |
Exemple 200 réponse:
[
{
"uniqueId": "a4cfa7155aff40248f490deff75c1770",
"label": "folder 1.1.1",
"key": "a4cfa7155aff40248f490deff75c1770",
"data": {
"type": "folder"
},
"iconImg": "",
"config": "null",
"children": [
{
"uniqueId": "afcf4aaa7155aff40248f490def1770",
"label": "folder 1.1.1.1",
"key": "afcf4aaa7155aff40248f490def1770",
"parentFolderId": "a4cfa7155aff40248f490deff75c1770",
"data": {
"type": "folder"
},
"iconImg": "",
"isActive": true,
"config": "null",
"children": [
{
"uniqueId": "3369348d03d2481097f341d6e2aad9a8",
"key": "3369348d03d2481097f341d6e2aad9a8",
"label": "AZ Site",
"data": {
"type": "device"
},
"iconImg": "",
"isActive": true,
"config": "null"
},
{
"uniqueId": "eeb78a119e2a470bada695518753e7b6",
"key": "eeb78a119e2a470bada695518753e7b6",
"label": "Hoofdtribune Vak E-F1-F2",
"data": {
"type": "sensor"
},
"iconImg": "",
"isActive": true,
"config": "null"
}
]
},
{
"uniqueId": "3369348d03d2481097f341d6e2aad9a8",
"key": "3369348d03d2481097f341d6e2aad9a8",
"label": "AZ Site",
"data": {
"type": "device"
},
"iconImg": "",
"isActive": true,
"config": "null"
},
{
"uniqueId": "eeb78a119e2a470bada695518753e7b6",
"key": "eeb78a119e2a470bada695518753e7b6",
"label": "Hoofdtribune Vak E-F1-F2",
"data": {
"type": "sensor"
},
"iconImg": "",
"isActive": true,
"config": "null"
},
{
"uniqueId": "feeeeeeqrg333452rfww442de",
"key": "feeeeeeqrg333452rfww442de",
"label": "Test view",
"data": {
"type": "salvoView"
},
"iconImg": "",
"config": {
"views": {
"type": "4",
"gridPosition": [
{
"positionNumber": 0,
"sensorId": "rfefe3454"
},
{
"positionNumber": 1,
"sensorId": "rfefe3454"
},
{
"positionNumber": 2,
"sensorId": "rfefe3454"
},
{
"positionNumber": 3,
"sensorId": "rfefe3454"
}
]
}
}
}
]
}
]GET /folder/getList
Récupère la liste des dossiers
Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
204 | Pas de contenu | |
401 | Non autorisé | |
404 | Pas trouvé |
Exemple 200 réponse:
[
{
"label": "folder 1",
"key": "a4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 2",
"key": "ea4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 3",
"key": "fa4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 4",
"key": "ad4cfa7155aff40248f490deff75c1770"
}
]POST /folder/moveFolderAndNodes
Déplacer le dossier
Corps de la requête
Déplacer les dossiers
{
"id": "string",
"name": "string",
"type": "string",
"fromParentFolderId": "string",
"toParentFolderId": "string",
"fromIndex": "number",
"toIndex": "number"
}Réponses
Statut | Description | Corps |
|---|---|---|
200 | Succès | |
204 | Pas de contenu | |
401 | Non autorisé | |
404 | Pas trouvé |
Merci — votre retour est transmis à l’équipe responsable de cette page.