List All Nodes
get
/v1/nodes
Returns a list of all the nodes.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
All the nodes were listed successfully.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object NodeResponse
The response schema for getting a node's information.
Nested Schema : NodeResponse
Type:
object
The response schema for getting a node's information.
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
dcNodeConfigData:
dcNodeConfigData
-
dcNodeType:
dcNodeType
-
destinationNode: array
destinationNode
The details of destination nodes for routes originating from the node.
-
displayName(required): string
The display name of the node.Example:
CC Node 1
-
marketSegment(required): string
The market segment of the node.Example:
CartridgeKit
-
NMhref(required): string
(uri)
The reference to get Node Manager information.
-
nodeContext(required): string
The context of a node.
-
nodeId(required): string
The node identifier.Example:
z8kfsx-16it-l0mbm95p
-
nodeLabel(required): string
The node label.Example:
3
-
nodeManagerID(required): string
The Node Manager identifier.
-
ruleFileDisplayName(required): string
The selected rule file display name of the node.
-
ruleFileName(required): string
The selected rule file name of the node.Example:
ASCII_Sample.npl
-
startState(required): boolean
The starting state of the node.Example:
STOPPED
Nested Schema : dcNodeConfigData
Match All
The configuration data of the node.
Show Source
-
object
DCNodeConfigDataRSM
The schema defining node configuration data for a node.
-
The configuration data of the node.
Nested Schema : dcNodeType
Match All
The node type information of the node.
Show Source
-
object
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
-
Array of:
object DestinationNodeConfig
The schema defining destination node's reference for a route.
Nested Schema : DCNodeConfigDataRSM
Type:
object
The schema defining node configuration data for a node.
Show Source
-
configRules: array
configRules
The secondary configuration data of the node.
-
nodeConfigVariables: array
nodeConfigVariables
The general configuration data of the node.
-
ruleName: string
The selected rule file name for the node.
Nested Schema : configRules
Type:
array
The secondary configuration data of the node.
Show Source
-
Array of:
object SecondaryConfigData
The schema defining secondary configuration data for a node.
Nested Schema : nodeConfigVariables
Type:
array
The general configuration data of the node.
Show Source
-
Array of:
object NodeConfigVariable
The schema defining configuration variable for a node.
Nested Schema : SecondaryConfigData
Type:
object
The schema defining secondary configuration data for a node.
Show Source
-
fileConfigVariables(required): array
fileConfigVariables
The list of secondary configuration variables for the node.
-
fileName(required): string
The secondary configuration data file name.
Nested Schema : fileConfigVariables
Type:
array
The list of secondary configuration variables for the node.
Show Source
-
Array of:
object NodeConfigVariable
The schema defining configuration variable for a node.
Nested Schema : NodeConfigVariable
Type:
object
The schema defining configuration variable for a node.
Show Source
-
name(required): string
The key name of the configuration variable.Example:
processedFileSuffix
-
value(required): string
TThe value of the configuration variable for a key.Example:
complete
Nested Schema : DCNodeTypeRSM
Type:
object
The schema defining node type information for a node.
Show Source
-
configDataClass(required): string
The config data class name of the node.Example:
com.oracle.nm.collector.file.FtpEIConfigData
-
configDataGuiClass(required): string
The config data GUI class name of the node.Example:
com.oracle.nm.collector.file.FileEIConfigGUI
-
displayString(required): string
The display string represented as 'majorType : minorType'.Example:
EI : FileEI
-
majorType(required): string
The major type of the node.Example:
EI
-
minorType(required): string
The minor type of the node.Example:
FileEI
-
nodeClass(required): string
The class name of the node.Example:
com.oracle.nm.collector.file.FileEINode
Nested Schema : DestinationNodeConfig
Type:
object
The schema defining destination node's reference for a route.
Show Source
-
channelID(required): string
The identifier of the channel.Example:
1
-
destinationNodeID(required): string
The identifier of the destination node.Example:
z8kfsx-16it-3res21sew
-
Returns an object of type RoutingConfig(required): string
(uri)
The reference to get channel information for the route between the given node and its destination node.Example:
server:port/nodes/{id}/route/{destNodeId}
400 Response
The request cannot be processed due to a client error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
403 Response
The request was not authorized.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
404 Response
The requested resource cannot be found.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
405 Response
This method is not allowed.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
409 Response
The request could not be processed due to a conflict with the existing state of the resource.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
The cause of the exception.
-
code(required): string
The application relevant details defined in the API or a common list.
-
message: string
The details and corrective actions for the error shown to the client user.
-
reason(required): string
The reason for the error, which is shown to a client user.
-
referenceError: string
(uri)
The URI of the documentation describing the error.
-
status: string
The HTTP error code describing the error.
Examples
The following example shows how to get a list of all nodes 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'
Example of the Response Body
If successful, response code 200 is returned along with the following response payload.
[
{
"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
},
{
"dcNodeConfigData": {
"configRules": [],
"nodeConfigVariables": [
{
"name": "0routefunct",
"value": "Multicast"
},
{
"name": "monitorinputtime",
"value": "1"
},
{
"name": "mtCheck",
"value": "false"
},
{
"name": "fileleveltransaction",
"value": "false"
},
{
"name": "numThreads",
"value": "2"
},
{
"name": "rulesfile",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna51qht/?class=com.nt.udc.rules.Processor.NPL.EP1_npl"
},
{
"name": "monitorinputtimeunit",
"value": "Day"
},
{
"name": "asCodebase",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna51qht"
},
{
"name": "maxlogfilesize",
"value": "100000"
},
{
"name": "narbackup",
"value": "false"
},
{
"name": "debuglevel",
"value": "OFF"
},
{
"name": "bulkio",
"value": "false"
},
{
"name": "enableOrder",
"value": "false"
},
{
"name": "osarsperfile",
"value": "2000"
},
{
"name": "idleosarwritetime",
"value": "60"
},
{
"name": "numchannels",
"value": "1"
},
{
"name": "backup",
"value": "false"
},
{
"name": "secondaryConfigFile",
"value": "secondary.cfg"
},
{
"name": "monitorinput",
"value": "false"
},
{
"name": "recordStatistics",
"value": "false"
},
{
"name": "checkforosarstimer",
"value": "20"
},
{
"name": "narbackupdays",
"value": "7"
}
],
"ruleName": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna51qht/?class=com.nt.udc.rules.Processor.NPL.EP1_npl"
},
"dcNodeType": {
"configDataClass": "com.nt.udc.ndk.gui.DCNodeConfigData",
"configDataGuiClass": "com.nt.udc.ndk.gui.NPLProcessorNodeConfigGUI",
"displayString": "Processor : NPL",
"majorType": "Processor",
"minorType": "NPL",
"nodeClass": "com.nt.udc.ndk.node.NPLProcessorNode"
},
"destinationNode": [
{
"channelID": "0",
"destinationNodeID": "31eoef-otm-lna53s09",
"href": "/nodes/31eoef-otm-lna53s09"
}
],
"displayName": "EP1",
"marketSegment": "CartridgeKit",
"nodeContext": "CartridgeKit#EP#NPLProcessorNode",
"nodeId": "31eoef-otm-lna51qht",
"nodeLabel": "3",
"ruleFileDisplayName": "EP1",
"ruleFileName": "EP1.npl",
"startState": true
},
{
"dcNodeConfigData": {
"configRules": [
{
"fileConfigVariables": [
{
"name": "NumberOfHosts",
"value": "0"
},
{
"name": "DelayTimeUnits",
"value": "min"
},
{
"name": "DelayTime",
"value": "1"
},
{
"name": "DeleteFiles",
"value": "false"
}
],
"fileName": "ftp.cfg"
}
],
"nodeConfigVariables": [
{
"name": "fileLocation",
"value": "/home/ocomcuser/ext"
},
{
"name": "0routefunct",
"value": "Multicast"
},
{
"name": "asCodebase",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna4vku4"
},
{
"name": "recordStatistics",
"value": "false"
},
{
"name": "numThreads",
"value": "2"
},
{
"name": "narbackupdays",
"value": "1"
},
{
"name": "narbackup",
"value": "false"
},
{
"name": "backup",
"value": "false"
},
{
"name": "useFtp",
"value": "false"
},
{
"name": "intervalUnits",
"value": "Minutes"
},
{
"name": "deleteLocalFiles",
"value": "true"
},
{
"name": "osarsperfile",
"value": "2000"
},
{
"name": "idleosarwritetime",
"value": "60"
},
{
"name": "enableOrder",
"value": "false"
},
{
"name": "ftpcfgfile",
"value": "/home/ocomcuser/install/ocomc/config/31eoef-otm-lna4vku4/ftp.cfg"
},
{
"name": "fileExpiryTime",
"value": "1"
},
{
"name": "pollingInterval",
"value": "600000"
},
{
"name": "secondaryConfigFile",
"value": "secondary.cfg"
},
{
"name": "localFileSuffix",
"value": ".complete"
},
{
"name": "fsCheck",
"value": "false"
},
{
"name": "checkforosarstimer",
"value": "20"
},
{
"name": "monitorinputtimeunit",
"value": "Day"
},
{
"name": "fdCheck",
"value": "false"
},
{
"name": "monitorinput",
"value": "false"
},
{
"name": "fileleveltransaction",
"value": "false"
},
{
"name": "bulkio",
"value": "false"
},
{
"name": "mtCheck",
"value": "false"
},
{
"name": "numchannels",
"value": "1"
},
{
"name": "monitorinputtime",
"value": "1"
},
{
"name": "inputBackupDir",
"value": ""
},
{
"name": "rulesfile",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna4vku4/?class=com.nt.udc.rules.EI.FlatFileEI.CC1_npl"
},
{
"name": "maxlogfilesize",
"value": "100000"
},
{
"name": "debuglevel",
"value": "OFF"
}
],
"ruleName": "file:/home/ocomcuser/install/ocomc/config/31eoef-otm-lna4vku4/?class=com.nt.udc.rules.EI.FlatFileEI.CC1_npl"
},
"dcNodeType": {
"configDataClass": "com.nt.udc.ei.node.ftpei.FtpFileEIConfigData",
"configDataGuiClass": "com.nt.udc.ei.node.ffei.FlatFileEIConfigGUI",
"displayString": "EI : FlatFileEI",
"majorType": "EI",
"minorType": "FlatFileEI",
"nodeClass": "com.nt.udc.ei.node.ffei.FlatFileEINode"
},
"destinationNode": [
{
"channelID": "0",
"destinationNodeID": "31eoef-otm-lna51qht",
"href": "/nodes/31eoef-otm-lna51qht"
}
],
"displayName": "CC1",
"marketSegment": "CartridgeKit",
"nodeContext": "CartridgeKit#EI#FlatFileEINode",
"nodeId": "31eoef-otm-lna4vku4",
"nodeLabel": "1",
"ruleFileDisplayName": "CC1",
"ruleFileName": "CC1.npl",
"startState": true
},
{
"dcNodeConfigData": {
"configRules": [
{
"fileConfigVariables": [
{
"name": "NumberOfHosts",
"value": "0"
},
{
"name": "DelayTimeUnits",
"value": "min"
},
{
"name": "DelayTime",
"value": "1"
},
{
"name": "DeleteFiles",
"value": "false"
}
],
"fileName": "ftp.cfg"
}
],
"nodeConfigVariables": [
{
"name": "ftpcfgfile",
"value": "/home/ocomcuser/install/ocomc/config/31eoep-otm-lnbhn159/ftp.cfg"
},
{
"name": "localFileSuffix",
"value": ".complete"
},
{
"name": "secondaryConfigFile",
"value": "secondary.cfg"
},
{
"name": "monitorinput",
"value": "false"
},
{
"name": "numThreads",
"value": "2"
},
{
"name": "numchannels",
"value": "1"
},
{
"name": "osarsperfile",
"value": "2000"
},
{
"name": "pollingInterval",
"value": "600000"
},
{
"name": "0routefunct",
"value": "Multicast"
},
{
"name": "asCodebase",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoep-otm-lnbhn159"
},
{
"name": "maxlogfilesize",
"value": "100000"
},
{
"name": "rulesfile",
"value": "file:/home/ocomcuser/install/ocomc/config/31eoep-otm-lnbhn159/?class=com.nt.udc.rules.EI.FlatFileEI.CC1_npl"
},
{
"name": "checkforosarstimer",
"value": "20"
},
{
"name": "enableOrder",
"value": "false"
},
{
"name": "recordStatistics",
"value": "false"
},
{
"name": "backup",
"value": "false"
},
{
"name": "monitorinputtime",
"value": "1"
},
{
"name": "fileLocation",
"value": "/home/ocomcuser/ext"
},
{
"name": "fdCheck",
"value": "false"
},
{
"name": "fileleveltransaction",
"value": "false"
},
{
"name": "idleosarwritetime",
"value": "60"
},
{
"name": "intervalUnits",
"value": "Minutes"
},
{
"name": "fileExpiryTime",
"value": "1"
},
{
"name": "inputBackupDir",
"value": ""
},
{
"name": "fsCheck",
"value": "false"
},
{
"name": "useFtp",
"value": "false"
},
{
"name": "narbackupdays",
"value": "1"
},
{
"name": "debuglevel",
"value": "OFF"
},
{
"name": "monitorinputtimeunit",
"value": "Day"
},
{
"name": "bulkio",
"value": "false"
},
{
"name": "narbackup",
"value": "false"
},
{
"name": "mtCheck",
"value": "false"
},
{
"name": "deleteLocalFiles",
"value": "true"
}
],
"ruleName": "file:/home/ocomcuser/install/ocomc/config/31eoep-otm-lnbhn159/?class=com.nt.udc.rules.EI.FlatFileEI.CC1_npl"
},
"dcNodeType": {
"configDataClass": "com.nt.udc.ei.node.ftpei.FtpFileEIConfigData",
"configDataGuiClass": "com.nt.udc.ei.node.ffei.FlatFileEIConfigGUI",
"displayString": "EI : FlatFileEI",
"majorType": "EI",
"minorType": "FlatFileEI",
"nodeClass": "com.nt.udc.ei.node.ffei.FlatFileEINode"
},
"destinationNode": [
{
"channelID": "0",
"destinationNodeID": "31eoef-otm-lna51qht",
"href": "/nodes/31eoef-otm-lna51qht"
}
],
"displayName": "CC2",
"marketSegment": "CartridgeKit",
"nodeContext": "CartridgeKit#EI#FlatFileEINode",
"nodeId": "31eoep-otm-lnbhn159",
"nodeLabel": "8",
"ruleFileDisplayName": "CC1",
"ruleFileName": "CC1.npl",
"startState": true
}
]