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

Get a Node

get

/v1/nodes/{id}

Returns the specified node.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The nodes have been returned successfully.
Body ()
Root Schema : NodeResponse
Type: object
The response schema for getting a node's information.
Show Source
Nested Schema : dcNodeConfigData
Match All
The configuration data of the node.
Show Source
Nested Schema : dcNodeType
Match All
The node type information of the node.
Show Source
  • DCNodeTypeRSM
    The schema defining node type information for a node.
  • The node type information of the node.
Nested Schema : destinationNode
Type: array
The details of destination nodes for routes originating from the node.
Show Source
Nested Schema : DCNodeConfigDataRSM
Type: object
The schema defining node configuration data for a node.
Show Source
Nested Schema : configRules
Type: array
The secondary configuration data of the node.
Show Source
Nested Schema : nodeConfigVariables
Type: array
The general configuration data of the node.
Show Source
Nested Schema : SecondaryConfigData
Type: object
The schema defining secondary configuration data for a node.
Show Source
Nested Schema : fileConfigVariables
Type: array
The list of secondary configuration variables for the node.
Show Source
Nested Schema : NodeConfigVariable
Type: object
The schema defining configuration variable for a node.
Show Source
Nested Schema : DCNodeTypeRSM
Type: object
The schema defining node type information for a node.
Show Source
Nested Schema : DestinationNodeConfig
Type: object
The schema defining destination node's reference for a route.
Show Source

400 Response

The request cannot be processed 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 cannot be processed due to a conflict in 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 the node details for a specified node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET 'http://hostname:port/nodes/31eoef-otm-lna53s09'

Example of the Response Body

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

{
  "dcNodeConfigData": {
    "configRules": [],
    "nodeConfigVariables": [
      {
        "name": "recordStatistics",
        "value": "false"
      },
      {
        "name": "backup",
        "value": "false"
      },
      {
        "name": "numThreads",
        "value": "2"
      },
      {
        "name": "debuglevel",
        "value": "OFF"
      },
      {
        "name": "numchannels",
        "value": "0"
      },
      {
        "name": "maxrecsperfile",
        "value": "10000"
      },
      {
        "name": "filename",
        "value": "data"
      },
      {
        "name": "currentfileextension",
        "value": "act"
      },
      {
        "name": "filedir",
        "value": "/tmp"
      },
      {
        "name": "secondaryConfigFile",
        "value": "secondary.cfg"
      },
      {
        "name": "timeperiod",
        "value": "hour:1"
      },
      {
        "name": "idleosarwritetime",
        "value": "60"
      },
      {
        "name": "checkforosarstimer",
        "value": "20"
      },
      {
        "name": "fileretentionfolder",
        "value": "/opt/backup"
      },
      {
        "name": "asCodebase",
        "value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna53s09"
      },
      {
        "name": "mtCheck",
        "value": "false"
      },
      {
        "name": "ftpdirectory",
        "value": "/tmp"
      },
      {
        "name": "completedfileextension",
        "value": "fin"
      },
      {
        "name": "narbackup",
        "value": "false"
      },
      {
        "name": "ftpport",
        "value": "21"
      },
      {
        "name": "monitorinput",
        "value": "false"
      },
      {
        "name": "narbackupdays",
        "value": "7"
      },
      {
        "name": "ftpuser",
        "value": ""
      },
      {
        "name": "fielddelimiter",
        "value": ","
      },
      {
        "name": "compression",
        "value": "NONE"
      },
      {
        "name": "fileretentionused",
        "value": "0"
      },
      {
        "name": "rulesfile",
        "value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna53s09/?class=com.nt.udc.rules.OI.FlatFile.DC1_npl"
      },
      {
        "name": "enableOrder",
        "value": "false"
      },
      {
        "name": "ftpused",
        "value": "0"
      },
      {
        "name": "monitorinputtime",
        "value": "1"
      },
      {
        "name": "ftpextension",
        "value": "ftp"
      },
      {
        "name": "maxlogfilesize",
        "value": "100000"
      },
      {
        "name": "fileretentionaction",
        "value": "archive"
      },
      {
        "name": "fileleveltransaction",
        "value": "false"
      },
      {
        "name": "bulkio",
        "value": "false"
      },
      {
        "name": "ftpsleeptime",
        "value": "1"
      },
      {
        "name": "addheader",
        "value": "true"
      },
      {
        "name": "sftpused",
        "value": "0"
      },
      {
        "name": "fieldcontainer",
        "value": "'"
      },
      {
        "name": "ftphost",
        "value": ""
      },
      {
        "name": "monitorinputtimeunit",
        "value": "Day"
      },
      {
        "name": "fileretentiondays",
        "value": "60"
      },
      {
        "name": "osarsperfile",
        "value": "2000"
      },
      {
        "name": "ftpsleeptimeUnit",
        "value": "min"
      }
    ],
    "ruleName": "rules.cfg"
  },
  "dcNodeType": {
    "configDataClass": "com.nt.udc.ndk.gui.DCNodeConfigData",
    "configDataGuiClass": "com.nt.udc.oi.node.flatfile.FFOINodeConfigGUI",
    "displayString": "OI : FlatFile",
    "majorType": "OI",
    "minorType": "FlatFile",
    "nodeClass": "com.nt.udc.oi.node.flatfile.FFOINode"
  },
  "destinationNode": [],
  "displayName": "DC1",
  "marketSegment": "CartridgeKit",
  "nodeContext": "CartridgeKit#OI#FFOINode",
  "nodeId": "31eoef-otm-lna53s09",
  "nodeLabel": "4",
  "ruleFileDisplayName": "DC1",
  "ruleFileName": "DC1.npl",
  "startState": true
}
Back to Top