Jump to

• Request
• Response
• Examples

Create a Node

post

/nodes

Creates a node in the node manager.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

Payload schema to create add a node to a node manager

Show Source

• dcNodeConfigData(required): dcNodeConfigData
• displayName(required): string
  Minimum Length: 1

  Display name of the node

  Example: CC Node 1
• nodeContext(required): string
  Minimum Length: 1

  Context of the node
• nodeManagerID(required): string
  Identifier of the node manager
• ruleFileDisplayName(required): string
  Selected rule file display name for the node"
• ruleFileName(required): string
  Minimum Length: 1

  Selected rule file name for the node

  Example: ASCII_Sample.npl

{
    "required":[
        "dcNodeConfigData",
        "displayName",
        "nodeContext",
        "nodeManagerID",
        "ruleFileDisplayName",
        "ruleFileName"
    ],
    "properties":{
        "dcNodeConfigData":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DCNodeConfigDataRSM"
                },
                {
                    "description":"Configuration data of the node",
                    "nullable":false
                }
            ]
        },
        "displayName":{
            "description":"Display name of the node",
            "example":"CC Node 1",
            "minLength":1,
            "nullable":false,
            "type":"string"
        },
        "nodeContext":{
            "description":"Context of the node",
            "minLength":1,
            "nullable":false,
            "type":"string"
        },
        "nodeManagerID":{
            "description":"Identifier of the node manager",
            "nullable":false,
            "type":"string"
        },
        "ruleFileDisplayName":{
            "description":"Selected rule file display name for the node\"",
            "nullable":false,
            "type":"string"
        },
        "ruleFileName":{
            "description":"Selected rule file name for the node",
            "example":"ASCII_Sample.npl",
            "minLength":1,
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Payload schema to create add a node to a node manager",
    "type":"object"
}

Nested Schema : dcNodeConfigData

Match All

Show Source

• object DCNodeConfigDataRSM
  Schema defining node configuration data for a node.
• Configuration data of the node

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DCNodeConfigDataRSM"
        },
        {
            "description":"Configuration data of the node",
            "nullable":false
        }
    ]
}

Nested Schema : DCNodeConfigDataRSM

Type: object

Schema defining node configuration data for a node.

Show Source

• configRules: array configRules
  Secondary configuration data of the node.
• nodeConfigVariables: array nodeConfigVariables
  General configuration data of the node.
• ruleName: string
  Selected rule file name for the node.

{
    "properties":{
        "configRules":{
            "description":"Secondary configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/SecondaryConfigData"
            },
            "type":"array"
        },
        "nodeConfigVariables":{
            "description":"General configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "type":"array"
        },
        "ruleName":{
            "description":"Selected rule file name for the node.",
            "type":"string"
        }
    },
    "description":"Schema defining node configuration data for a node.",
    "type":"object"
}

Nested Schema : configRules

Type: array

Secondary configuration data of the node.

Show Source

• Array of: object SecondaryConfigData
  Schema defining secondary configuration data for a node

{
    "description":"Secondary configuration data of the node.",
    "items":{
        "$ref":"#/components/schemas/SecondaryConfigData"
    },
    "type":"array"
}

Nested Schema : nodeConfigVariables

Type: array

General configuration data of the node.

Show Source

• Array of: object NodeConfigVariable
  Schema defining configuration variable for a node

{
    "description":"General configuration data of the node.",
    "items":{
        "$ref":"#/components/schemas/NodeConfigVariable"
    },
    "type":"array"
}

Nested Schema : SecondaryConfigData

Type: object

Schema defining secondary configuration data for a node

Show Source

• fileConfigVariables(required): array fileConfigVariables
  List secondary configuration variables for the node
• fileName(required): string
  Secondary configuration data file name

{
    "required":[
        "fileConfigVariables",
        "fileName"
    ],
    "properties":{
        "fileConfigVariables":{
            "description":"List secondary configuration variables for the node",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "nullable":false,
            "type":"array"
        },
        "fileName":{
            "description":"Secondary configuration data file name",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining secondary configuration data for a node",
    "type":"object"
}

Nested Schema : fileConfigVariables

Type: array

List secondary configuration variables for the node

Show Source

• Array of: object NodeConfigVariable
  Schema defining configuration variable for a node

{
    "description":"List secondary configuration variables for the node",
    "items":{
        "$ref":"#/components/schemas/NodeConfigVariable"
    },
    "nullable":false,
    "type":"array"
}

Nested Schema : NodeConfigVariable

Type: object

Schema defining configuration variable for a node

Show Source

• name(required): string
  Key name of the configuration variable

  Example: processedFileSuffix
• value(required): string
  Value of the configuration variable for a key

  Example: complete

{
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "description":"Key name of the configuration variable",
            "example":"processedFileSuffix",
            "nullable":false,
            "type":"string"
        },
        "value":{
            "description":"Value of the configuration variable for a key",
            "example":"complete",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining configuration variable for a node",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The node has been added successfully.

Body ()

Root Schema : NodeResponse

Type: object

Response schema for getting a node's information.

Show Source

• @type: string
  Defines the sub-class entity when sub-classing. name
• dcNodeConfigData: dcNodeConfigData
• dcNodeType: dcNodeType
• destinationNode: array destinationNode
  Details of destination nodes for routes originating from the node.
• displayName(required): string
  Display name of the node.

  Example: CC Node 1
• marketSegment(required): string
  Market segment of the node.

  Example: CartridgeKit
• NMhref(required): string (uri)
  Reference to get node manager information.
• nodeContext(required): string
  Context of a node.
• nodeId(required): string
  Identifier of a node.

  Example: z8kfsx-16it-l0mbm95p
• nodeLabel(required): string
  Label of the node.

  Example: 3
• nodeManagerID(required): string
  Identifier of a node manager.
• ruleFileDisplayName(required): string
  Selected rule file display name of the node.
• ruleFileName(required): string
  Selected rule file name of the node.

  Example: ASCII_Sample.npl
• startState(required): boolean
  Start state of the node.

  Example: STOPPED

{
    "required":[
        "displayName",
        "marketSegment",
        "NMhref",
        "nodeContext",
        "nodeId",
        "nodeLabel",
        "nodeManagerID",
        "ruleFileDisplayName",
        "ruleFileName",
        "startState"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing. name",
            "type":"string"
        },
        "dcNodeConfigData":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DCNodeConfigDataRSM"
                },
                {
                    "description":"Configuration data of the node."
                }
            ]
        },
        "dcNodeType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DCNodeTypeRSM"
                },
                {
                    "description":"Node type information of the node."
                }
            ]
        },
        "destinationNode":{
            "description":"Details of destination nodes for routes originating from the node.",
            "items":{
                "$ref":"#/components/schemas/DestinationNodeConfig"
            },
            "type":"array"
        },
        "displayName":{
            "description":"Display name of the node.",
            "example":"CC Node 1",
            "nullable":false,
            "type":"string"
        },
        "marketSegment":{
            "description":"Market segment of the node.",
            "example":"CartridgeKit",
            "nullable":false,
            "type":"string"
        },
        "NMhref":{
            "description":"Reference to get node manager information.",
            "format":"uri",
            "nullable":false,
            "type":"string"
        },
        "nodeContext":{
            "description":"Context of a node.",
            "nullable":false,
            "type":"string"
        },
        "nodeId":{
            "description":"Identifier of a node.",
            "example":"z8kfsx-16it-l0mbm95p",
            "nullable":false,
            "type":"string"
        },
        "nodeLabel":{
            "description":"Label of the node.",
            "example":"3",
            "nullable":false,
            "type":"string"
        },
        "nodeManagerID":{
            "description":"Identifier of a node manager.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileDisplayName":{
            "description":"Selected rule file display name of the node.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileName":{
            "description":"Selected rule file name of the node.",
            "example":"ASCII_Sample.npl",
            "nullable":false,
            "type":"string"
        },
        "startState":{
            "description":"Start state of the node.",
            "example":"STOPPED",
            "nullable":false,
            "type":"boolean"
        }
    },
    "description":"Response schema for getting a node's information.",
    "type":"object"
}

Nested Schema : dcNodeConfigData

Match All

Show Source

• object DCNodeConfigDataRSM
  Schema defining node configuration data for a node.
• Configuration data of the node.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DCNodeConfigDataRSM"
        },
        {
            "description":"Configuration data of the node."
        }
    ]
}

Nested Schema : dcNodeType

Match All

Show Source

• object DCNodeTypeRSM
  Schema defining node type information for a node
• Node type information of the node.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DCNodeTypeRSM"
        },
        {
            "description":"Node type information of the node."
        }
    ]
}

Nested Schema : destinationNode

Type: array

Details of destination nodes for routes originating from the node.

Show Source

• Array of: object DestinationNodeConfig
  Schema defining destination node's reference for a route

{
    "description":"Details of destination nodes for routes originating from the node.",
    "items":{
        "$ref":"#/components/schemas/DestinationNodeConfig"
    },
    "type":"array"
}

Nested Schema : DCNodeConfigDataRSM

Type: object

Schema defining node configuration data for a node.

Show Source

• configRules: array configRules
  Secondary configuration data of the node.
• nodeConfigVariables: array nodeConfigVariables
  General configuration data of the node.
• ruleName: string
  Selected rule file name for the node.

{
    "properties":{
        "configRules":{
            "description":"Secondary configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/SecondaryConfigData"
            },
            "type":"array"
        },
        "nodeConfigVariables":{
            "description":"General configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "type":"array"
        },
        "ruleName":{
            "description":"Selected rule file name for the node.",
            "type":"string"
        }
    },
    "description":"Schema defining node configuration data for a node.",
    "type":"object"
}

Nested Schema : configRules

Type: array

Secondary configuration data of the node.

Show Source

• Array of: object SecondaryConfigData
  Schema defining secondary configuration data for a node

{
    "description":"Secondary configuration data of the node.",
    "items":{
        "$ref":"#/components/schemas/SecondaryConfigData"
    },
    "type":"array"
}

Nested Schema : nodeConfigVariables

Type: array

General configuration data of the node.

Show Source

• Array of: object NodeConfigVariable
  Schema defining configuration variable for a node

{
    "description":"General configuration data of the node.",
    "items":{
        "$ref":"#/components/schemas/NodeConfigVariable"
    },
    "type":"array"
}

Nested Schema : SecondaryConfigData

Type: object

Schema defining secondary configuration data for a node

Show Source

• fileConfigVariables(required): array fileConfigVariables
  List secondary configuration variables for the node
• fileName(required): string
  Secondary configuration data file name

{
    "required":[
        "fileConfigVariables",
        "fileName"
    ],
    "properties":{
        "fileConfigVariables":{
            "description":"List secondary configuration variables for the node",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "nullable":false,
            "type":"array"
        },
        "fileName":{
            "description":"Secondary configuration data file name",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining secondary configuration data for a node",
    "type":"object"
}

Nested Schema : fileConfigVariables

Type: array

List secondary configuration variables for the node

Show Source

• Array of: object NodeConfigVariable
  Schema defining configuration variable for a node

{
    "description":"List secondary configuration variables for the node",
    "items":{
        "$ref":"#/components/schemas/NodeConfigVariable"
    },
    "nullable":false,
    "type":"array"
}

Nested Schema : NodeConfigVariable

Type: object

Schema defining configuration variable for a node

Show Source

• name(required): string
  Key name of the configuration variable

  Example: processedFileSuffix
• value(required): string
  Value of the configuration variable for a key

  Example: complete

{
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "description":"Key name of the configuration variable",
            "example":"processedFileSuffix",
            "nullable":false,
            "type":"string"
        },
        "value":{
            "description":"Value of the configuration variable for a key",
            "example":"complete",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining configuration variable for a node",
    "type":"object"
}

Nested Schema : DCNodeTypeRSM

Type: object

Schema defining node type information for a node

Show Source

• configDataClass(required): string
  Config data class name of the node

  Example: com.oracle.nm.collector.file.FtpEIConfigData
• configDataGuiClass(required): string
  Config data GUI class name of the node

  Example: com.oracle.nm.collector.file.FileEIConfigGUI
• displayString(required): string
  Display string represented as 'majorType : minorType'

  Example: EI : FileEI
• majorType(required): string
  Major type of the node

  Example: EI
• minorType(required): string
  Minor type of the node

  Example: FileEI
• nodeClass(required): string
  Class name of the node

  Example: com.oracle.nm.collector.file.FileEINode

{
    "required":[
        "configDataClass",
        "configDataGuiClass",
        "displayString",
        "majorType",
        "minorType",
        "nodeClass"
    ],
    "properties":{
        "configDataClass":{
            "description":"Config data class name of the node",
            "example":"com.oracle.nm.collector.file.FtpEIConfigData",
            "nullable":false,
            "type":"string"
        },
        "configDataGuiClass":{
            "description":"Config data GUI class name of the node",
            "example":"com.oracle.nm.collector.file.FileEIConfigGUI",
            "nullable":false,
            "type":"string"
        },
        "displayString":{
            "description":"Display string represented as 'majorType : minorType'",
            "example":"EI : FileEI",
            "nullable":false,
            "type":"string"
        },
        "majorType":{
            "description":"Major type of the node",
            "example":"EI",
            "nullable":false,
            "type":"string"
        },
        "minorType":{
            "description":"Minor type of the node",
            "example":"FileEI",
            "nullable":false,
            "type":"string"
        },
        "nodeClass":{
            "description":"Class name of the node",
            "example":"com.oracle.nm.collector.file.FileEINode",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining node type information for a node",
    "type":"object"
}

Nested Schema : DestinationNodeConfig

Type: object

Schema defining destination node's reference for a route

Show Source

• channelID(required): string
  Identifier of the channel

  Example: 1
• destinationNodeID(required): string
  Identifier of the destination node

  Example: z8kfsx-16it-3res21sew
• Returns an object of type RoutingConfig(required): string (uri)
  Reference to get channel information for the route between the given node and it's destination node

  Example: server:port/nodes/{id}/route/{destNodeId}

{
    "required":[
        "channelID",
        "destinationNodeID",
        "Returns an object of type RoutingConfig"
    ],
    "properties":{
        "channelID":{
            "description":"Identifier of the channel",
            "example":"1",
            "nullable":false,
            "type":"string"
        },
        "destinationNodeID":{
            "description":"Identifier of the destination node",
            "example":"z8kfsx-16it-3res21sew",
            "nullable":false,
            "type":"string"
        },
        "Returns an object of type RoutingConfig":{
            "description":"Reference to get channel information for the route between the given node and it's destination node",
            "example":"server:port/nodes/{id}/route/{destNodeId}",
            "format":"uri",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining destination node's reference for a route",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "code":{
            "description":"Application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"Details and corrective actions related to the error which is shown to a client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error Code describiing the error.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Back to Top

Examples

The following example shows how to add a new node to the node manager by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/nodes' -d @sampleAddaNodetoNodeManager.json

Example of Request Body

The following is an example of the contents of the sampleAddaNodetoNodeManager.json file sent as the request body.

{
  "dcNodeConfigData": {
    "nodeConfigVariables": [
      {
        "name": "fileLocation",
        "value": "/"
      },
      {
        "name": "useFtp",
        "value": "false"
      },
      {
        "name": "pollingInterval",
        "value": "600000"
      },
      {
        "name": "intervalUnits",
        "value": "Minutes"
      },
      {
        "name": "filePatternMode",
        "value": "simple"
      },
      {
        "name": "processedFileSuffix",
        "value": ".done"
      },
      {
        "name": "unprocessedFileSuffix",
        "value": ".complete"
      },
      {
        "name": "deleteLocalFiles",
        "value": "false"
      },
      {
        "name": "mtCheck",
        "value": "false"
      },
      {
        "name": "fileleveltransaction",
        "value": "false"
      },
      {
        "name": "fdCheck",
        "value": "false"
      },
      {
        "name": "fsCheck",
        "value": "false"
      },
      {
        "name": "inputBackupDir",
        "value": ""
      }
    ],
    "configRules" : [
 
    ]
  },
  "displayName": "Node-abc",
  "nodeContext": "CartridgeKit#EI#FlexibleAsciiEINode",
  "nodeManagerID": "NMGR-31eoel-otm-lnij9v9p",
  "ruleFileDisplayName": "NewFile1",
  "ruleFileName": "NewFile1.npl"}

Example of Response Body

The following is an example of a response body.

{
  "dcNodeConfigData": {
    "configRules": [],
    "nodeConfigVariables": [
      {
        "name": "fileLocation",
        "value": "/"
      },
      {
        "name": "osarsperfile",
        "value": "2000"
      },
      {
        "name": "idleosarwritetime",
        "value": "60"
      },
      {
        "name": "debuglevel",
        "value": "OFF"
      },
      {
        "name": "backup",
        "value": "false"
      },
      {
        "name": "filePatternMode",
        "value": "simple"
      },
      {
        "name": "unprocessedFileSuffix",
        "value": ".complete"
      },
      {
        "name": "asCodebase",
        "value": "file:/home/ocomcuser/install/ocomc/config/31eoen-otm-lne95s3y"
      },
      {
        "name": "bulkio",
        "value": "false"
      },
      {
        "name": "mtCheck",
        "value": "false"
      },
      {
        "name": "useFtp",
        "value": "false"
      },
      {
        "name": "ftpcfgfile",
        "value": "/home/ocomcuser/install/ocomc/config/31eoen-otm-lne95s3y/ftp.cfg"
      },
      {
        "name": "pollingInterval",
        "value": "600000"
      },
      {
        "name": "intervalUnits",
        "value": "Minutes"
      },
      {
        "name": "secondaryConfigFile",
        "value": "secondary.cfg"
      },
      {
        "name": "monitorinput",
        "value": "false"
      },
      {
        "name": "checkforosarstimer",
        "value": "20"
      },
      {
        "name": "fdCheck",
        "value": "false"
      },
      {
        "name": "fileleveltransaction",
        "value": "false"
      },
      {
        "name": "maxlogfilesize",
        "value": "100000"
      },
      {
        "name": "processedFileSuffix",
        "value": ".done"
      },
      {
        "name": "fsCheck",
        "value": "false"
      },
      {
        "name": "deleteLocalFiles",
        "value": "false"
      },
      {
        "name": "monitorinputtime",
        "value": "1"
      },
      {
        "name": "rulesfile",
        "value": "file:/home/ocomcuser/install/ocomc/config/31eoen-otm-lne95s3y/?class=com.nt.udc.rules.EI.FileEI.NewFile1_npl"
      },
      {
        "name": "monitorinputtimeunit",
        "value": "Day"
      },
      {
        "name": "inputBackupDir",
        "value": ""
      }
    ],
    "ruleName": "file:/home/ocomcuser/install/ocomc/config/31eoen-otm-lne95s3y/?class=com.nt.udc.rules.EI.FileEI.NewFile1_npl"
  },
  "dcNodeType": {
    "configDataClass": "com.metasolv.nm.collector.file.FtpEIConfigData",
    "configDataGuiClass": "com.metasolv.nm.collector.file.FileEIConfigGUI",
    "displayString": "EI : FileEI",
    "majorType": "EI",
    "minorType": "FileEI",
    "nodeClass": "com.metasolv.nm.collector.file.FileEINode"
  },
  "destinationNode": [],
  "displayName": "Node-abc",
  "marketSegment": "CartridgeKit",
  "nodeContext": "CartridgeKit#EI#FlexibleAsciiEINode",
  "nodeId": "31eoen-otm-lne95s3y",
  "nodeLabel": "12",
  "ruleFileDisplayName": "NewFile1",
  "ruleFileName": "NewFile1.npl",
  "startState": false
}

Back to Top