REST API Reference for Offline Mediation Controller

Create a Node

post

/v1/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

Root Schema : schema

Type: object

The payload schema to create add a node to a Node Manager.

Show Source

dcNodeConfigData(required): dcNodeConfigData
displayName(required): string

Minimum Length: 1

The display name of the node.

Example: CC Node 1
nodeContext(required): string

Minimum Length: 1

The context of the node.
nodeManagerID(required): string

The identifier of the Node Manager.
ruleFileDisplayName(required): string

The selected rule file display name for the node.
ruleFileName(required): string

Minimum Length: 1

The 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":"The configuration data of the node.",
                    "nullable":false
                }
            ]
        },
        "displayName":{
            "description":"The display name of the node.",
            "example":"CC Node 1",
            "minLength":1,
            "nullable":false,
            "type":"string"
        },
        "nodeContext":{
            "description":"The context of the node.",
            "minLength":1,
            "nullable":false,
            "type":"string"
        },
        "nodeManagerID":{
            "description":"The identifier of the Node Manager.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileDisplayName":{
            "description":"The selected rule file display name for the node.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileName":{
            "description":"The selected rule file name for the node.",
            "example":"ASCII_Sample.npl",
            "minLength":1,
            "nullable":false,
            "type":"string"
        }
    },
    "description":"The payload schema to create add a node to a Node Manager.",
    "type":"object"
}

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.

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

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.

{
    "properties":{
        "configRules":{
            "description":"The secondary configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/SecondaryConfigData"
            },
            "type":"array"
        },
        "nodeConfigVariables":{
            "description":"The general configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "type":"array"
        },
        "ruleName":{
            "description":"The selected rule file name for the node.",
            "type":"string"
        }
    },
    "description":"The schema defining node configuration data for a node.",
    "type":"object"
}

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.

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

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.

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

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.

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

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.

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

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

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

Response

Supported Media Types

application/json

201 Response

The node has been added successfully.

Root 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

{
    "required":[
        "displayName",
        "marketSegment",
        "NMhref",
        "nodeContext",
        "nodeId",
        "nodeLabel",
        "nodeManagerID",
        "ruleFileDisplayName",
        "ruleFileName",
        "startState"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "dcNodeConfigData":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DCNodeConfigDataRSM"
                },
                {
                    "description":"The configuration data of the node."
                }
            ]
        },
        "dcNodeType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DCNodeTypeRSM"
                },
                {
                    "description":"The node type information of the node."
                }
            ]
        },
        "destinationNode":{
            "description":"The details of destination nodes for routes originating from the node.",
            "items":{
                "$ref":"#/components/schemas/DestinationNodeConfig"
            },
            "type":"array"
        },
        "displayName":{
            "description":"The display name of the node.",
            "example":"CC Node 1",
            "nullable":false,
            "type":"string"
        },
        "marketSegment":{
            "description":"The market segment of the node.",
            "example":"CartridgeKit",
            "nullable":false,
            "type":"string"
        },
        "NMhref":{
            "description":"The reference to get Node Manager information.",
            "format":"uri",
            "nullable":false,
            "type":"string"
        },
        "nodeContext":{
            "description":"The context of a node.",
            "nullable":false,
            "type":"string"
        },
        "nodeId":{
            "description":"The node identifier.",
            "example":"z8kfsx-16it-l0mbm95p",
            "nullable":false,
            "type":"string"
        },
        "nodeLabel":{
            "description":"The node label.",
            "example":"3",
            "nullable":false,
            "type":"string"
        },
        "nodeManagerID":{
            "description":"The Node Manager identifier.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileDisplayName":{
            "description":"The selected rule file display name of the node.",
            "nullable":false,
            "type":"string"
        },
        "ruleFileName":{
            "description":"The selected rule file name of the node.",
            "example":"ASCII_Sample.npl",
            "nullable":false,
            "type":"string"
        },
        "startState":{
            "description":"The starting state of the node.",
            "example":"STOPPED",
            "nullable":false,
            "type":"boolean"
        }
    },
    "description":"The response schema for getting a node's information.",
    "type":"object"
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DCNodeConfigDataRSM"
        },
        {
            "description":"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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DCNodeTypeRSM"
        },
        {
            "description":"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.

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

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.

{
    "properties":{
        "configRules":{
            "description":"The secondary configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/SecondaryConfigData"
            },
            "type":"array"
        },
        "nodeConfigVariables":{
            "description":"The general configuration data of the node.",
            "items":{
                "$ref":"#/components/schemas/NodeConfigVariable"
            },
            "type":"array"
        },
        "ruleName":{
            "description":"The selected rule file name for the node.",
            "type":"string"
        }
    },
    "description":"The schema defining node configuration data for a node.",
    "type":"object"
}

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.

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

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.

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

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.

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

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.

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

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

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

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

{
    "required":[
        "configDataClass",
        "configDataGuiClass",
        "displayString",
        "majorType",
        "minorType",
        "nodeClass"
    ],
    "properties":{
        "configDataClass":{
            "description":"The config data class name of the node.",
            "example":"com.oracle.nm.collector.file.FtpEIConfigData",
            "nullable":false,
            "type":"string"
        },
        "configDataGuiClass":{
            "description":"The config data GUI class name of the node.",
            "example":"com.oracle.nm.collector.file.FileEIConfigGUI",
            "nullable":false,
            "type":"string"
        },
        "displayString":{
            "description":"The display string represented as 'majorType : minorType'.",
            "example":"EI : FileEI",
            "nullable":false,
            "type":"string"
        },
        "majorType":{
            "description":"The major type of the node.",
            "example":"EI",
            "nullable":false,
            "type":"string"
        },
        "minorType":{
            "description":"The minor type of the node.",
            "example":"FileEI",
            "nullable":false,
            "type":"string"
        },
        "nodeClass":{
            "description":"The class name of the node.",
            "example":"com.oracle.nm.collector.file.FileEINode",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"The schema defining node type information for a node.",
    "type":"object"
}

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}

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

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        },
        "cause":{
            "description":"The cause of the exception.",
            "type":"string"
        },
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "nullable":false,
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "nullable":false,
            "type":"string"
        },
        "referenceError":{
            "description":"The URI of the documentation describing the error.",
            "format":"uri",
            "type":"string"
        },
        "status":{
            "description":"The HTTP error code describing 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.

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.

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

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
}