Consultar nodos del negocio

Este endpoint permite consultar los nodos que forman parte de la estructura organizativa de un negocio.

GET /api/v3/businesses/{businessId}/nodes

Si los datos incluidos en la petición son correctos, la respuesta contendrá el listado de nodos del negocio, detallando la siguiente información:

  • 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.

Ejemplo de la petición

GET /api/v3/businesses/BUSINESSID/nodes

Fragmento 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
    }
]

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.

Enlaces de interés

¿Qué es un nodo?

¿Qué es un servicio?

¿Cómo puede ser la estructura organizativa de un negocio?