Obtener nodos del negocio
Este endpoint permite consultar los nodos que forman parte de la estructura organizativa de un negocio.
GET /api/v3/businesses/{businessId}/nodesSi los datos incluidos en la petición son correctos, la respuesta contendrá el listado de nodos del negocio.
Ejemplo de respuesta
[
{
"name": "ROOT NODE",
"orquestId": 35388
},
{
"name": "STORE-1",
"ancestors": [
35388,
35390,
35413
],
"id": "0001",
"orquestId": 35391
},
{
"name": "STORE-2",
"ancestors": [
35388,
35823
],
"orquestId": 35824
}
]Detalles
-
name: nombre del nodo o servicio.
-
ancestors: lista de identificadores internos de los nodos antecesores en la jerarquía organizativa.
-
id: identificador externo del nodo o servicio.
-
orquestId: identificador interno del nodo o servicio en Orquest.
Como se puede apreciar en el ejemplo, la petición devolverá la información tal y como se haya definido en la estructura organizativa del negocio.
Aspectos que tener en cuenta
El nodo raíz no tiene nodos antecesores.
Si un nodo o servicio no tiene identificador externo configurado en Orquest, la respuesta no incluirá este dato.
Si el negocio no tiene nodos, o el usuario no tiene ninguno visible, la petición devolverá un array vacío [].
Códigos de error
Este endpoint no devuelve códigos de error propios que no se encuentren descritos en errores comunes.