1. REST API Reference for Offline Mediation Controller
  2. Tasks
  3. Node Chains

List All Node Chains

get

/nodeChains/{nodeManagerId}

Returns a list of all the node chains in a node manager.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The node chains were listed successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : NodeChainResponse
Type: object
Response schema for getting list of node chains associated with the queried node manager
Show Source
Nested Schema : nodeChains
Type: array
Details of the node chains
Show Source
Nested Schema : nodeManagers
Type: array
All the node managers associated with nodes that are part of node chain
Show Source
Nested Schema : NodeChainResponseChainItem
Type: object
Schema defining a node chain's information which is part of list node chains response
Show Source
Nested Schema : nodes
Type: array
Details for nodes that are part of the node chain
Show Source
Nested Schema : NodeChainResponseNodeItem
Type: object
Schema defining a node's information associated with a node chain which is part of list node chains response
Show Source
Nested Schema : nodeType
Match All
Show Source
Nested Schema : routes
Type: array
Details for outgoing routes from the node
Show Source
Nested Schema : NodeChainResponseNodeTypeItem
Type: object
Schema defining node type information for a node associated with a node chain which is part of list node chains response
Show Source
Nested Schema : NodeChainResponseRouteAttrs
Type: object
Schema defining a route's information associated with a node chain which is part of list node chains response
Show Source
Nested Schema : NodeChainResponseNMItem
Type: object
Schema defining a node manager's information associated with a node chain which is part of list node chains response
Show Source

400 Response

The server cannot process the request due to a client error.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

The client does not have the correct privileges.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

The request was not authorized.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

The requested resource cannot be found.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

The request could not be processed due to the conflict with the existing state of the resource.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

The system has encountered an internal server error.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to get a list of all the node chains by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET 'http://host:port/nodeChains/{NMGR-31eoen-otm-lne65v6v}'

Example of the Response Body

If successful, the response code 200 is returned with the following response body.

{
  "nodeChains": [
    {
      "nmId": "NMGR-31eoen-otm-lne65v6v",
      "nodes": [
        {
          "displayName": "Node-8",
          "id": "31eoen-otm-lne7oftw",
          "nodeType": {
            "context": "CartridgeKit#OI#FFOINode",
            "marketSegment": "CartridgeKit",
            "name": "ASCII Distribution Cartridge",
            "type": "DC"
          },
          "routes": []
        }
      ]
    },
    {
      "nmId": "NMGR-31eoen-otm-lne65v6v",
      "nodes": [
        {
          "displayName": "CC_a",
          "id": "31eoen-otm-lne9hugk",
          "nodeType": {
            "context": "CartridgeKit#EI#FlatFileEINode",
            "marketSegment": "CartridgeKit",
            "name": "ASCII Collection Cartridge",
            "type": "CC"
          },
          "routes": []
        }
      ]
    },
    {
      "nmId": "NMGR-31eoen-otm-lne65v6v",
      "nodes": [
        {
          "displayName": "CC1",
          "id": "31eoen-otm-lnec47yr",
          "nodeType": {
            "context": "CartridgeKit#EI#FlatFileEINode",
            "marketSegment": "CartridgeKit",
            "name": "ASCII Collection Cartridge",
            "type": "CC"
          },
          "routes": []
        }
      ]
    },
    {
      "nmId": "NMGR-31eoen-otm-lne65v6v",
      "nodes": [
        {
          "displayName": "DC1",
          "id": "31eoen-otm-lnejuqgh",
          "nodeType": {
            "context": "CartridgeKit#OI#FFOINode",
            "marketSegment": "CartridgeKit",
            "name": "ASCII Distribution Cartridge",
            "type": "DC"
          },
          "routes": []
        }
      ]
    }
  ],
  "nodeManagers": [
    {
      "nmHost": "node-mgr-app",
      "nmId": "NMGR-31eoen-otm-lne65v6v",
      "nmName": "nm1",
      "nmPort": 32170,
      "nodesCount": 4
    }
  ],
  "queryNmId": "NMGR-31eoen-otm-lne65v6v"
}
Back to Top