Carpeta
En esta página
Operaciones sobre recursos de carpeta. 6 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado como se describe en Authentication.
POST /folder
Agregar carpeta, Agregar carpeta con nodos y agregar nodos
Cuerpo de la solicitud
Agregar una carpeta
{
"name": "string",
"sharedWithUser": [
"any"
],
"sharedWithRole": [
"any"
],
"childNodes": [
{
"id": "string",
"type": "string"
}
],
"parentFolderId": "string"
}Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
400 | Entrada inválida | |
401 | No autorizado |
Ejemplo 200 respuesta:
{
"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
Agregar nodos a una carpeta existente
Cuerpo de la solicitud
Para agregar nodos a una carpeta existente
{
"folderId": "string",
"childNodes": [
{
"id": "string",
"type": "string"
}
]
}Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
400 | Entrada inválida | |
401 | No autorizado | |
403 | Prohibido | |
404 | No Encontrado |
Ejemplo 200 respuesta:
{
"result": true
}POST /folder/bulkUpdateNodeIndex
Actualizar índice de carpeta
Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
204 | Sin contenido | |
401 | No autorizado | |
404 | No Encontrado |
Ejemplo 200 respuesta:
[
{
"label": "folder 1",
"key": "a4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 2",
"key": "ea4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 3",
"key": "fa4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 4",
"key": "ad4cfa7155aff40248f490deff75c1770"
}
]POST /folder/getAllFolders
Obtiene carpetas con filtrado, ordenación y paginación para la vista de árbol
Cuerpo de la solicitud
Obtener carpetas
{
"folderId": "string",
"skip": "string",
"limit": "string",
"searchString": "string"
}Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | objeto |
204 | Sin contenido | |
401 | No autorizado | |
404 | No Encontrado |
Ejemplo 200 respuesta:
[
{
"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
Obtiene la lista de carpetas
Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
204 | Sin contenido | |
401 | No autorizado | |
404 | No Encontrado |
Ejemplo 200 respuesta:
[
{
"label": "folder 1",
"key": "a4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 2",
"key": "ea4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 3",
"key": "fa4cfa7155aff40248f490deff75c1770"
},
{
"label": "folder 4",
"key": "ad4cfa7155aff40248f490deff75c1770"
}
]POST /folder/moveFolderAndNodes
Mover carpeta
Cuerpo de la solicitud
Mover carpetas
{
"id": "string",
"name": "string",
"type": "string",
"fromParentFolderId": "string",
"toParentFolderId": "string",
"fromIndex": "number",
"toIndex": "number"
}Respuestas
Estado | Descripción | Cuerpo |
|---|---|---|
200 | Éxito | |
204 | Sin contenido | |
401 | No autorizado | |
404 | No Encontrado |
Gracias — sus comentarios llegan al equipo responsable de esta página.