{ "servers":[ { "url":"/v1" } ], "tags":[ { "name":"Actions" }, { "name":"Import" }, { "name":"Logs" }, { "name":"Management" }, { "name":"NPL" }, { "name":"Node Chains" }, { "name":"Node Managers" }, { "name":"Node Types" }, { "name":"Nodes" }, { "name":"Users" } ], "components":{ "schemas":{ "Actiontype":{ "enum":[ "COMPILE", "SAVE" ], "type":"string" }, "DCNodeConfigDataRSM":{ "properties":{ "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" }, "configRules":{ "description":"The secondary configuration data of the node.", "items":{ "$ref":"#/components/schemas/SecondaryConfigData" }, "type":"array" } }, "description":"The schema defining node configuration data for a node.", "type":"object" }, "DCNodeTypeRSM":{ "required":[ "majorType", "minorType", "displayString", "nodeClass", "configDataClass", "configDataGuiClass" ], "properties":{ "majorType":{ "description":"The major type of the node.", "example":"EI", "type":"string" }, "minorType":{ "description":"The minor type of the node.", "example":"FileEI", "type":"string" }, "displayString":{ "description":"Display string represented as 'majorType : minorType'", "example":"EI : FileEI", "type":"string" }, "nodeClass":{ "description":"The class name of the node.", "example":"com.oracle.nm.collector.file.FileEINode", "type":"string" }, "configDataClass":{ "description":"The config data class name of the node.", "example":"com.oracle.nm.collector.file.FtpEIConfigData", "type":"string" }, "configDataGuiClass":{ "description":"The config data GUI class name of the node.", "example":"com.oracle.nm.collector.file.FileEIConfigGUI", "type":"string" } }, "description":"The schema defining node type information for a node.", "type":"object" }, "DefaultConfigResponse":{ "required":[ "config" ], "properties":{ "config":{ "additionalProperties":{ "additionalProperties":{ "type":"string" }, "type":"object" }, "description":"Configuration map: section -> key/value map", "type":"object" } }, "description":"The response containing default management configuration maps.", "type":"object" }, "DescriptorFileResponse":{ "required":[ "id", "label", "value" ], "properties":{ "id":{ "description":"The identifier of the descriptor file.", "type":"string" }, "label":{ "description":"The file name of the descriptor file.", "type":"string" }, "value":{ "description":"The content of the descriptor file.", "type":"string" } }, "description":"The response schema to get available descriptor files for the Sol42 CC.", "type":"object" }, "DestinationNodeConfig":{ "required":[ "destinationNodeID", "channelID", "Returns an object of type RoutingConfig" ], "properties":{ "destinationNodeID":{ "description":"The identifier of the destination node.", "example":"z8kfsx-16it-3res21sew", "type":"string" }, "channelID":{ "description":"The identifier of the channel.", "example":"1", "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", "type":"string" } }, "description":"The schema defining destination node's reference for a route.", "type":"object" }, "Error":{ "required":[ "code", "reason" ], "properties":{ "code":{ "description":"The application relevant details defined in the API or a common list.", "type":"string" }, "reason":{ "description":"The reason for the error, which is shown to a client user.", "type":"string" }, "message":{ "description":"The details and corrective actions for the error shown to the client user.", "type":"string" }, "cause":{ "description":"Cause of the exception", "type":"string" }, "status":{ "description":"HTTP Error code extension", "type":"string" }, "referenceError":{ "description":"URI of documentation describing the error", "format":"uri", "type":"string" }, "@type":{ "description":"Defines the sub-class entity when sub-classing.", "type":"string" } }, "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).", "type":"object" }, "ExportRequest":{ "required":[ "nodeManagersToExport", "exportNodeChain", "nodeIDsToExport" ], "properties":{ "nodeManagersToExport":{ "description":"The list of Node Managers to export.", "example":[ ], "items":{ "type":"string" }, "type":"array" }, "exportNodeChain":{ "description":"The flag indicating whether to export node chain associated with nodes, identifiers for which are mentioned in nodeIDsToExport.", "example":true, "type":"boolean" }, "nodeIDsToExport":{ "description":"The list of identifiers of the nodes to export.", "items":{ "type":"string" }, "type":"array" }, "fileName":{ "description":"The exported data's file name.", "example":"export", "type":"string" } }, "description":"The payload schema to export nodes and Node Managers data to a file.", "type":"object" }, "ImportErrorItem":{ "required":[ "errorStage", "importErrorLogs" ], "properties":{ "errorStage":{ "description":"The stage at which the error occured.", "type":"object" }, "importErrorLogs":{ "description":"Error Logs", "items":{ "$ref":"#/components/schemas/ImportErrorLogItem" }, "type":"array" } }, "description":"The schema for the Import Error item.", "type":"object" }, "ImportErrorLogItem":{ "required":[ "timeStamp", "message" ], "properties":{ "timeStamp":{ "description":"The time stamp of the error message.", "type":"string" }, "message":{ "description":"Error Message", "type":"string" } }, "description":"The schema for the Import error message.", "type":"object" }, "ImportMetadataUpdateRequest":{ "required":[ "configurationMapping", "customizationMapping", "regenerateNodeIds", "importType" ], "properties":{ "configurationMapping":{ "description":"The list of configuration mappings.", "items":{ "$ref":"#/components/schemas/Mapping" }, "type":"array" }, "customizationMapping":{ "description":"The list of customization mappings.", "items":{ "$ref":"#/components/schemas/Mapping" }, "type":"array" }, "skipConfiguration":{ "description":"The flag to skip configuration.", "type":"boolean" }, "skipCustomization":{ "description":"The flag to skip customization.", "type":"boolean" }, "customJarsToRemove":{ "description":"The list of custom Jars to remove.", "items":{ "type":"string" }, "type":"array" }, "skipRestart":{ "description":"The flag to skip restart after importing customization.", "type":"boolean" }, "regenerateNodeIds":{ "description":"The flag to regenerate node IDs while importing configuration.", "type":"boolean" }, "importType":{ "allOf":[ { "$ref":"#/components/schemas/ImportType" } ], "description":"The flag to check if the node chain has been imported.", "type":"string" } }, "type":"object" }, "ImportType":{ "enum":[ "NODE_MANAGER", "NODE_CHAIN" ], "type":"string" }, "Mapping":{ "required":[ "sourceTriplet", "destinationTriplet" ], "properties":{ "skip":{ "description":"The flag that indicates whether this mapping should be skipped.", "type":"boolean" }, "sourceTriplet":{ "allOf":[ { "$ref":"#/components/schemas/Triplet" } ], "description":"The triplet object that defines the source of the mapping.", "type":"object" }, "destinationTriplet":{ "allOf":[ { "$ref":"#/components/schemas/Triplet" } ], "description":"he triplet object that defines the destination of the mapping.", "type":"object" } }, "description":"Mapping class", "type":"object" }, "NARAttribute":{ "properties":{ "key":{ "description":"The name of the variable key.", "type":"string" }, "type":{ "description":"The type of value that the key holds.", "type":"string" }, "length":{ "description":"The length of the value in bytes.", "format":"int32", "type":"integer" }, "value":{ "description":"The value assigned to the variable." }, "values":{ "description":"The list of nested NAR attributes.", "items":{ "$ref":"#/components/schemas/NARAttribute" }, "type":"array" } }, "description":"The schema that defines the details of a record attribute.", "type":"object" }, "NARDCFieldModel":{ "required":[ "fk", "fv", "ft", "cs" ], "properties":{ "fk":{ "description":"The key or identifier for the field entry.", "type":"string" }, "fv":{ "description":"The value associated with the field key.", "type":"string" }, "ft":{ "description":"The data type or format of the field value.", "type":"string" }, "cs":{ "description":"The character size or length of the field value.", "format":"int64", "type":"integer" } }, "description":"Denotes each NAR Entry.", "type":"object" }, "NARItem":{ "properties":{ "narOffset":{ "description":"The offset value of the NAR.", "format":"int32", "type":"integer" }, "attributes":{ "description":"The list of attributes associated with the NAR.", "items":{ "$ref":"#/components/schemas/NARAttribute" }, "type":"array" }, "filterPath":{ "description":"The list of path indexes for matched attributes.", "items":{ "items":{ "format":"int32", "type":"integer" }, "type":"array" }, "type":"array" } }, "type":"object" }, "NARModel":{ "required":[ "narFields" ], "properties":{ "narFields":{ "description":"The list of field entries that constitute the NAR, where each entry contains field-specific key, value, type, and size information.", "items":{ "$ref":"#/components/schemas/NARDCFieldModel" }, "type":"array" } }, "description":"The model that denotes each NAR.", "type":"object" }, "NARResponse":{ "properties":{ "records":{ "description":"The list of NAR record items retrieved.", "items":{ "$ref":"#/components/schemas/NARItem" }, "type":"array" }, "hasMore":{ "description":"Flag indicating whether there are additional records available beyond the current response.", "type":"boolean" }, "totalRecords":{ "description":"The total number of NAR records available.", "format":"int32", "type":"integer" }, "offset":{ "description":"The starting index from which records are returned in the current response.", "format":"int32", "type":"integer" }, "limit":{ "description":"The maximum number of records included in the current response.", "format":"int32", "type":"integer" } }, "type":"object" }, "NARUploadResponse":{ "properties":{ "uuid":{ "description":"The unique identifier assigned to the uploaded NAR file.", "type":"string" }, "fileSize":{ "description":"The size of the uploaded NAR file, typically in bytes.", "type":"string" } }, "description":"Response for uploaded NAR", "type":"object" }, "NPLContentResponse":{ "required":[ "nodeId", "filename", "content", "marketSegment", "majorType", "minorType" ], "properties":{ "nodeId":{ "description":"The identifier of the node.", "example":"rtvq25-16it-lfj9to04", "type":"string" }, "filename":{ "description":"The name of the NPL file.", "example":"TestFile.npl", "type":"string" }, "content":{ "description":"The content of the NPL file.", "example":"//npl code", "type":"string" }, "marketSegment":{ "description":"The market segment associated with the node.", "example":"CatridgeKit", "type":"string" }, "majorType":{ "description":"The major type classification of the node.", "example":"EI", "type":"string" }, "minorType":{ "description":"The minor type classification of the node.", "example":"FileEI", "type":"string" } }, "description":"The response schema that provides the NPL content for a node.", "type":"object" }, "NPLFileListItem":{ "required":[ "isSysRule", "filename" ], "properties":{ "filename":{ "description":"The name of the NPL file.", "example":"TestFile.npl", "type":"string" }, "isSysRule":{ "description":"Flag indicating if rule file is an OOTB system rule file.", "example":true, "type":"boolean" } }, "description":"Schema defining available NPLs for a node", "type":"object" }, "NPLRequest":{ "required":[ "nplContent", "nodeContext", "ruleFileName", "action" ], "properties":{ "nplContent":{ "description":"NPL content", "example":"The NPL content to be processed.", "minLength":1, "type":"string" }, "nodeContext":{ "description":"The context of the node on which the action is performed.", "example":"nodeContext", "minLength":1, "type":"string" }, "ruleFileName":{ "description":"The name of the rule file associated with the action.", "example":"ruleFileName", "type":"string" }, "action":{ "allOf":[ { "$ref":"#/components/schemas/Actiontype" } ], "description":"The action to be performed on the rule file, such as COMPILE or SAVE.", "example":"action", "type":"string" } }, "description":"The payload schema used to perform an action on a node's NPL.", "type":"object" }, "NPLResponse":{ "required":[ "nodeContext", "ruleFileName", "Response" ], "properties":{ "nodeContext":{ "description":"The context of the node associated with the action.", "example":"nodeContext", "type":"string" }, "ruleFileName":{ "description":"The name of the rule file on which the action was performed.", "example":"ruleFileName", "type":"string" }, "Response":{ "description":"The response message describing the outcome of the action.", "example":"Response", "type":"string" } }, "description":"The response schema that provides the result of an action perfored on a node's NPL. NPL", "type":"object" }, "NarFilterRequest":{ "properties":{ "key":{ "type":"string" }, "value":{ "description":"The list of values to match against the specified filter key.", "items":{ "type":"string" }, "type":"array" } }, "description":"The schema that defines the search parameters for filtering NARs.", "type":"object" }, "NodeChainResponse":{ "required":[ "queryNmId", "nodeChains", "nodeManagers" ], "properties":{ "queryNmId":{ "description":"The identifier of the queried node manager.", "type":"string" }, "nodeChains":{ "description":"The list of node chains associated with the node manager.", "items":{ "$ref":"#/components/schemas/NodeChainResponseChainItem" }, "type":"array" }, "nodeManagers":{ "description":"The list of node managers associated with nodes in the chain.", "items":{ "$ref":"#/components/schemas/NodeChainResponseNMItem" }, "type":"array" } }, "description":"The response schema that provides the list of node chains associated with a queried node manager.", "type":"object" }, "NodeChainResponseChainItem":{ "required":[ "nmId", "nodes" ], "properties":{ "nmId":{ "description":"The identifier of the node manager for this chain.", "type":"string" }, "nodes":{ "description":"The details of the nodes that are part of this node chain.", "items":{ "$ref":"#/components/schemas/NodeChainResponseNodeItem" }, "type":"array" } }, "description":"The schema that defines information about a node chain included in the node chain response.", "type":"object" }, "NodeChainResponseNMItem":{ "required":[ "nmId", "nmName", "nmHost", "nmPort", "nodesCount" ], "properties":{ "nmId":{ "description":"The unique identifier of the node manager for this chain.", "type":"string" }, "nmName":{ "description":"Name of the node manager.", "type":"string" }, "nmHost":{ "description":"Hostname at which the node manager is deployed.", "type":"string" }, "nmPort":{ "description":"Port on which the node manager is listening.", "format":"int32", "type":"integer" }, "nodesCount":{ "description":"Number of nodes associated with this node manager.", "format":"int32", "type":"integer" } }, "description":"Schema defining node manager details associated with a node chain in the list node chains response.", "type":"object" }, "NodeChainResponseNodeItem":{ "required":[ "id", "displayName", "nodeType", "routes" ], "properties":{ "id":{ "description":"The identifier of the node.", "type":"string" }, "testId":{ "description":"Identifier of the test this node is part of.", "type":"string" }, "startState":{ "description":"Indicates whether the node is running.", "type":"boolean" }, "displayName":{ "description":"The display name of the node.", "type":"string" }, "nodeType":{ "allOf":[ { "$ref":"#/components/schemas/NodeChainResponseNodeTypeItem" } ], "description":"The node type details of the node.", "type":"object" }, "routes":{ "description":"The details for outgoing routes from the node.", "items":{ "$ref":"#/components/schemas/NodeChainResponseRouteAttrs" }, "type":"array" } }, "description":"The schema defining a node's information associated with a node chain which is part of list node chains response.", "type":"object" }, "NodeChainResponseNodeTypeItem":{ "required":[ "name", "context", "marketSegment", "type", "inputType", "outputType" ], "properties":{ "name":{ "description":"The name of the node.", "type":"string" }, "context":{ "description":"The context of the node.", "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "type":"string" }, "type":{ "description":"The type of the node, for example, EI, DC, etc.", "type":"string" }, "inputType":{ "description":"The input type of the node, for example, NAR, TEXT, NA, etc.", "type":"string" }, "outputType":{ "description":"The output type of the node, for example, NAR, TEXT, NA, etc.", "type":"string" } }, "description":"The schema defining node type information for a node associated with a node chain which is part of list node chains response.", "type":"object" }, "NodeChainResponseRouteAttrs":{ "required":[ "destNodeId", "destNmId", "routingFn", "isRemote" ], "properties":{ "destNodeId":{ "description":"The identifier of destination node.", "type":"string" }, "destNmId":{ "description":"The identifier destination node's Node Manager.", "type":"string" }, "routingFn":{ "description":"The routing function used for the channel.", "type":"string" }, "isRemote":{ "description":"The flag indicating if the route is remote.", "type":"boolean" } }, "description":"Schema defining a route's information associated with a node chain which is part of list node chains response", "type":"object" }, "NodeChainTestCreateRequest":{ "required":[ "nodeId" ], "properties":{ "nodeId":{ "description":"Identifier of the node.", "type":"string" }, "uploadId":{ "description":"Identifier of the file upload operation.", "type":"string" }, "action":{ "allOf":[ { "$ref":"#/components/schemas/NodeChainTestUpdateStatusEnum" } ], "description":"Action to perform on the test.", "type":"string" } }, "description":"Payload schema for creating a node chain test and starting all nodes in the chain.", "type":"object" }, "NodeChainTestOutputDirData":{ "required":[ "outputDir", "files" ], "properties":{ "outputDir":{ "description":"Output directory path.", "type":"string" }, "files":{ "description":"Output files contained in the directory.", "items":{ "$ref":"#/components/schemas/NodeChainTestOutputFileItem" }, "type":"array" } }, "description":"Schema defining files and records contained in a node's output directory during a node chain test.", "type":"object" }, "NodeChainTestOutputFileItem":{ "required":[ "filename", "outputType", "records" ], "properties":{ "filename":{ "description":"File that contains the output records.", "type":"string" }, "outputType":{ "description":"Output file type (for example, NAR, TEXT).", "type":"string" }, "records":{ "description":"Output records generated by the node.", "items":{ "items":{ "$ref":"#/components/schemas/NARAttribute" }, "type":"array" }, "type":"array" } }, "description":"Schema defining output records contained in a node's output file during a node chain test.", "type":"object" }, "NodeChainTestResponse":{ "required":[ "testId" ], "properties":{ "testId":{ "description":"Identifier of the node chain test", "type":"string" } }, "description":"Response payload to get the node chain test", "type":"object" }, "NodeChainTestStopMessageResponse":{ "required":[ "testId" ], "properties":{ "testId":{ "description":"Identifier of the node chain test", "type":"string" } }, "description":"Response Schema for Tests which are already in stopped state", "type":"object" }, "NodeChainTestUpdateRequest":{ "required":[ "action" ], "properties":{ "action":{ "allOf":[ { "$ref":"#/components/schemas/NodeChainTestUpdateStatusEnum" } ], "description":"Action to perform on the test", "type":"string" } }, "description":"Payload schema to create a node chain test and start all the nodes associated with node chain under test", "type":"object" }, "NodeChainTestUpdateStatusEnum":{ "enum":[ "START_TEST", "STOP_TEST" ], "type":"string" }, "NodeChainTestUploadResponse":{ "required":[ "uploadId", "inputType", "records" ], "properties":{ "uploadId":{ "description":"The identifier of the file upload operation.", "type":"string" }, "inputType":{ "description":"The input file type of the uploaded file, for example, NAR, TEXT, etc.", "type":"string" }, "records":{ "description":"File records part of the input file.", "items":{ "items":{ "$ref":"#/components/schemas/NARAttribute" }, "type":"array" }, "type":"array" } }, "description":"The response schema to get the node chain test upload operation's information.", "type":"object" }, "NodeConfigVariable":{ "required":[ "name", "value" ], "properties":{ "name":{ "description":"The key name of the configuration variable.", "example":"processedFileSuffix", "type":"string" }, "value":{ "description":"The value of the configuration variable for a key.", "example":"complete", "type":"string" } }, "description":"The schema defining configuration variable for a node.", "type":"object" }, "NodeCreateRequest":{ "required":[ "nodeManagerID", "nodeContext", "displayName", "ruleFileName", "dcNodeConfigData" ], "properties":{ "nodeManagerID":{ "description":"The identifier of the Node Manager.", "type":"string" }, "nodeContext":{ "description":"The context of the node.", "minLength":1, "type":"string" }, "displayName":{ "description":"The display name of the node.", "example":"CC Node 1", "type":"string" }, "ruleFileName":{ "description":"The selected rule file display name for the node.", "example":"ASCII_Sample.npl", "type":"string" }, "dcNodeConfigData":{ "allOf":[ { "$ref":"#/components/schemas/DCNodeConfigDataRSM" } ], "description":"The configuration data of the node.", "type":"object" } }, "description":"The payload schema to create add a node to a Node Manager.", "type":"object" }, "NodeManagerReplicationRequest":{ "required":[ "destinationNodeManagerId", "replicateCustomization", "restartEnabled" ], "properties":{ "destinationNodeManagerId":{ "description":"The identifier of the destination Node Manager to which data will be replicated.", "type":"string" }, "replicateCustomization":{ "description":"Flag indicating whether to replicate customizations as part of the replication process.", "type":"boolean" }, "restartEnabled":{ "description":"Flag specifying whether the destination Node Manager should be restarted after replication is completed.", "type":"boolean" } }, "description":"The schema defining reference for node manager replication request.", "type":"object" }, "NodeManagerResponse":{ "required":[ "id", "href", "name", "host", "port" ], "properties":{ "id":{ "description":"Identifier of the node manager", "example":"NM-z8kfsx-16it-l0qpcmee", "type":"string" }, "href":{ "description":"The reference to get the Node Manager's information.", "example":"http://server:port/api/v1/nodeManagers/NM-z8kfsx-16it-l0qpcmee", "format":"uri", "type":"string" }, "name":{ "description":"The name of the Node Manager.", "type":"string" }, "host":{ "description":"The host name where the Node Manager is hosted.", "type":"string" }, "port":{ "description":"The port where the Node Manager is hosted.", "format":"int32", "type":"integer" }, "statusMessage":{ "description":"Status of the node manager", "type":"string" }, "state":{ "description":"State of the node manager", "type":"string" }, "nodes":{ "description":"Nodes managed by the node manager", "items":{ "$ref":"#/components/schemas/NodeReference" }, "type":"array" }, "@type":{ "description":"Defines the sub-class entity when sub-classing.", "type":"string" } }, "description":"The response schema for getting details of a Node Manager.", "type":"object" }, "NodeManagerScaleDownRequest":{ "required":[ "preBackupCleanup" ], "properties":{ "preBackupCleanup":{ "type":"boolean" } }, "description":"The schema defining reference for node manager scaleDown request.", "type":"object" }, "NodeManagerUpdateRequest":{ "required":[ "name" ], "properties":{ "name":{ "description":"The name of the node manager.", "minLength":1, "type":"string" } }, "description":"The payload schema to update an existing node manager.", "type":"object" }, "NodeReference":{ "required":[ "href", "id" ], "properties":{ "href":{ "description":"The reference to get information about the node.", "format":"uri", "type":"string" }, "id":{ "description":"The identifier of the node.", "type":"string" } }, "description":"The schema defining reference to get a node's information.", "type":"object" }, "NodeReplicationRequest":{ "properties":{ "nodeManagerId":{ "type":"string" } }, "description":"The schema defining reference for node replication request.", "type":"object" }, "NodeResponse":{ "required":[ "nodeManagerID", "nodeId", "nodeLabel", "nodeContext", "startState", "displayName", "marketSegment", "ruleFileName", "ruleFileDisplayName", "NMhref" ], "properties":{ "nodeManagerID":{ "description":"The Node Manager identifier.", "type":"string" }, "nodeId":{ "description":"Identifier of the node", "example":"z8kfsx-16it-l0mbm95p", "type":"string" }, "nodeLabel":{ "description":"The node label", "example":"3", "type":"string" }, "nodeContext":{ "description":"The context of a node.", "type":"string" }, "startState":{ "description":"The starting state of the node.", "example":"STOPPED", "type":"boolean" }, "displayName":{ "description":"The display name of the node.", "example":"CC Node 1", "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "example":"CartridgeKit", "type":"string" }, "ruleFileName":{ "description":"The selected rule file name of the node.", "example":"ASCII_Sample.npl", "type":"string" }, "ruleFileDisplayName":{ "description":"The selected rule file display name of the node.", "type":"string" }, "NMhref":{ "description":"The reference to get Node Manager information.", "format":"uri", "type":"string" }, "dcNodeType":{ "allOf":[ { "$ref":"#/components/schemas/DCNodeTypeRSM" } ], "description":"The node type information of the node.", "type":"object" }, "dcNodeConfigData":{ "allOf":[ { "$ref":"#/components/schemas/DCNodeConfigDataRSM" } ], "description":"The configuration data of the node.", "type":"object" }, "destinationNode":{ "description":"The details of destination nodes for routes originating from the node.", "items":{ "$ref":"#/components/schemas/DestinationNodeConfig" }, "type":"array" }, "@type":{ "description":"Defines the sub-class entity name when sub-classing.", "type":"string" } }, "description":"The response schema for getting a node's information.", "type":"object" }, "NodeState":{ "description":"The action to be taken to start the node (START_NODES) or stop it (STOP_NODES).", "enum":[ "START_NODES", "STOP_NODES" ], "type":"string" }, "NodeStateRequest":{ "required":[ "actionState" ], "properties":{ "actionState":{ "$ref":"#/components/schemas/NodeState" }, "nodeIds":{ "items":{ "type":"string" }, "type":"array", "description":"The list of node IDs to start or stop.", "uniqueItems":true }, "nmIds":{ "items":{ "type":"string" }, "type":"array", "description":"The list of Node Manager IDs to start or stop.", "uniqueItems":true }, "includeRemoteNodes":{ "description":"The action to be taken to also include remote nodes in the action (true) or not (false).", "type":"boolean" } }, "type":"object" }, "NodeTypeResponse":{ "required":[ "id", "marketSegment", "type", "name", "metadata" ], "properties":{ "id":{ "description":"The context of the node.", "example":"Wireless#CC#RADIUS", "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "example":"Wireless", "type":"string" }, "type":{ "description":"The type of the node, for example, EP, DC, etc.", "example":"CC", "type":"string" }, "name":{ "description":"The node's name as defined in GUI template tree.", "example":"RADIUS", "type":"string" }, "metadata":{ "description":"The reference to get the metadata for the node type.", "example":"nodeTypes/Wireless#EI#RADIUS", "type":"string" } }, "description":"The response schema for getting node types information for all the node types.", "type":"object" }, "NodeUpdateRequest":{ "required":[ "displayName", "ruleFileName" ], "properties":{ "displayName":{ "description":"The display name of the node.", "example":"CC Node 1", "type":"string" }, "ruleFileName":{ "description":"The selected rule file name for the node.", "example":"ASCII_Sample.npl", "type":"string" }, "dcNodeConfigData":{ "allOf":[ { "$ref":"#/components/schemas/DCNodeConfigDataRSM" } ], "description":"The configuration data of the node.", "type":"object" } }, "description":"The payload schema to update an existing node.", "type":"object" }, "OperatorEnum":{ "enum":[ "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "IN_BETWEEN", "LIST_EQUALS", "LIST_NOT_EQUALS", "SUBSET_OF", "NOT_SUBSET_OF" ], "type":"string" }, "OperatorEnum1":{ "enum":[ "EQUALS", "NOT_EQUALS", "LESS_THAN", "GREATER_THAN", "IN_BETWEEN", "LIST_EQUALS", "LIST_NOT_EQUALS", "SUBSET_OF", "NOT_SUBSET_OF" ], "type":"string" }, "Payload_schema_to_add_a_node_manager_to_an_adminserver":{ "required":[ "name", "host", "port" ], "properties":{ "name":{ "description":"The name of the Node Manager.", "minLength":1, "type":"string" }, "host":{ "description":"The host name where the Node Manager is hosted.", "minLength":1, "type":"string" }, "port":{ "description":"The port where the Node Manager is hosted.", "format":"int32", "type":"integer" } }, "type":"object" }, "RSMStatusResponse":{ "required":[ "connectedToAdminServer" ], "properties":{ "connectedToAdminServer":{ "description":"The flag that indicates whether the RSM is currently connected to the Admin Server.", "example":true, "type":"boolean" } }, "description":"The response schema that indicates whether the RSM is connected to the Admin Server.", "type":"object" }, "RouteAttributesResponse":{ "required":[ "nodeId", "fields" ], "properties":{ "nodeId":{ "description":"The identifier of the node.", "type":"string" }, "fields":{ "description":"The output fields for a node defined in NPL.", "items":{ "$ref":"#/components/schemas/RoutingAttributesModel" }, "type":"array" } }, "description":"The response schema to get the output fields for a node.", "type":"object" }, "RouteCreateRequest":{ "required":[ "destinationNodeID", "routingFunction" ], "properties":{ "destinationNodeID":{ "description":"The identifier of the destination node.", "example":"z8kfsx-16it-3res21sew", "type":"string" }, "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum1" } ], "description":"The routing function used for the channel.", "example":"DIRECTED", "type":"string" }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" } ], "description":"Attributes against which routing fields are compared using various operations", "type":"object" } }, "description":"Payload schema to create a route between two nodes", "type":"object" }, "RouteParametersUpdateRequest":{ "properties":{ "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" } ], "description":"Attributes against which routing fields are compared using various operations", "type":"object" } }, "description":"The payload schema to PATCH update an existing route.", "type":"object" }, "RouteResponse":{ "required":[ "sourceNodeID", "destinationNodeID", "routingFunction" ], "properties":{ "sourceNodeID":{ "description":"Identifier of the source node", "example":"z8kfsx-16it-l0mbm95p", "type":"string" }, "destinationNodeID":{ "description":"The identifier of the destination node.", "example":"z8kfsx-16it-3res21sew", "type":"string" }, "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum" } ], "description":"The routing function used for the channel.", "example":"DIRECTED", "type":"string" }, "routingField":{ "description":"Field defined in NPL used for routing", "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RoutingAttributes" } ], "description":"The attributes against which routing fields are compared using various operations.", "type":"object" } }, "description":"The response schema to get a route's information.", "type":"object" }, "RouteUpdateRequest":{ "required":[ "routingFunction" ], "properties":{ "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum2" } ], "description":"The attributes against which routing fields are compared using various operations.", "example":"DIRECTED", "type":"string" }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" } ], "description":"The routing function used for the channel.", "type":"object" } }, "description":"The payload schema to PUT update an existing route.", "type":"object" }, "RouteUpdateRequestRoutingAttrs":{ "properties":{ "operand1":{ "description":"The values against which the operator acts on the routing field.", "items":{ "type":"string" }, "type":"array" }, "operand2":{ "description":"The values against which the operator acts on the routing field, two operands are required when an operator is used which requires 3 variables, for example, IN_BETWEEN operator.", "items":{ "type":"string" }, "type":"array" }, "operator":{ "allOf":[ { "$ref":"#/components/schemas/OperatorEnum" } ], "description":"The expression representing action to be performed on routing field.", "example":"EQUALS", "type":"string" } }, "description":"The schema defining routing attributes for a route update request.", "type":"object" }, "RoutingAttributes":{ "required":[ "operand1", "operator" ], "properties":{ "operand1":{ "description":"The values against which the operator acts on the routing field.", "items":{ "type":"string" }, "type":"array" }, "operand2":{ "description":"The values against which operator acts on the routing field, two operands are required when an operator is used which requires 3 variables. For example, IN_BETWEEN operator.", "items":{ "type":"string" }, "type":"array" }, "operator":{ "allOf":[ { "$ref":"#/components/schemas/OperatorEnum1" } ], "description":"The expression representing action to be performed on routing field.", "example":"EQUALS", "type":"string" } }, "description":"The schema defining routing attributes for a route.", "type":"object" }, "RoutingAttributesModel":{ "properties":{ "id":{ "description":"The identifier or the name of the field.", "type":"string" }, "type":{ "description":"The type of the field.", "format":"int32", "type":"integer" } }, "description":"The schema defining an output field's details for a route.", "type":"object" }, "RoutingFunctionEnum":{ "enum":[ "ROUND ROBIN", "MULTICAST", "MODULUS", "DIRECTED" ], "type":"string" }, "RoutingFunctionEnum1":{ "enum":[ "ROUND ROBIN", "MULTICAST", "MODULUS", "DIRECTED" ], "type":"string" }, "RoutingFunctionEnum2":{ "enum":[ "ROUND ROBIN", "MULTICAST", "MODULUS", "DIRECTED" ], "type":"string" }, "RoutingFunctionsResponse":{ "required":[ "nodeId", "algorithms" ], "properties":{ "nodeId":{ "description":"The identifier of the node.", "type":"string" }, "algorithms":{ "description":"The list of all possible routing functions for the node.", "type":"array", "items":{ } } }, "description":"Response schema defining available routing functions for a node", "type":"object" }, "SecondaryConfigData":{ "required":[ "fileName", "fileConfigVariables" ], "properties":{ "fileName":{ "description":"Secondary configuration data file name", "type":"string" }, "fileConfigVariables":{ "description":"List secondary configuration variables for the node", "items":{ "$ref":"#/components/schemas/NodeConfigVariable" }, "type":"array" } }, "description":"Schema defining secondary configuration data for a node", "type":"object" }, "Triplet":{ "required":[ "ip", "name", "port" ], "properties":{ "ip":{ "description":"IP address", "type":"string" }, "name":{ "description":"Name", "type":"string" }, "port":{ "description":"Port number", "format":"int32", "type":"integer" } }, "description":"Triplet class", "type":"object" } } }, "info":{ "title":"REST API Reference for Offline Mediation Controller", "version":"2026.01.26", "description":"Oracle Communications Offline Mediation Controller APIs provide mediation for data created by multiservice, IP, and mobile networks.", "x-summary":"Oracle Communications Offline Mediation Controller APIs provide mediation for data created by multiservice, IP, and mobile networks." }, "openapi":"3.0.3", "paths":{ "/actions/export":{ "post":{ "tags":[ "Actions" ], "description":"Exports the customization and configuration of a node.", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ExportRequest" } } } }, "responses":{ "200":{ "content":{ "application/octet-stream":{ } }, "description":"The customization was exported successfully." }, "400":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"The server cannot process the request due to a client error." }, "401":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"The client does not have the correct privileges." }, "403":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"The request was not authorized." }, "404":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"Requested resource cannot be found." }, "405":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"This method is not allowed." }, "409":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"The request could not be processed due to a conflict with the existing state of the resource." }, "500":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } }, "description":"The system has encountered an internal server error." } }, "summary":"Export Node Customization", "x-internal-id":"actions-export-post", "x-filename-id":"actions-export-post" } }, "/actions/nodes/state":{ "post":{ "tags":[ "Actions" ], "description":"Start or stop nodes in the specified node or Node Manager. You must provide the nodeIds, nmIds, or both fields in the request payload. If both fields are present, the nodeIds field is prioritized.

You specify whether to start or stop a node by setting the actionState field in the request payload to one of the following: