{ "servers":[ { "url":"/v1" } ], "tags":[ { "name":"Actions" }, { "name":"NPL" }, { "name":"Node Chains" }, { "name":"Node Managers" }, { "name":"Node Types" }, { "name":"Nodes" } ], "components":{ "schemas":{ "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", "description":"The details about the action to perform." }, "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" }, "Payload_schema_to_add_a_node_manager_to_an_adminserver":{ "required":[ "host", "name", "port" ], "properties":{ "host":{ "description":"The host name where the Node Manager is hosted.", "nullable":false, "type":"string" }, "name":{ "description":"The name of the Node Manager.", "nullable":false, "type":"string" }, "port":{ "description":"The port where the Node Manager is hosted.", "format":"int32", "nullable":false, "type":"integer" } }, "type":"object" }, "NodeManagerResponse":{ "required":[ "host", "href", "id", "name", "port" ], "properties":{ "@type":{ "description":"Defines the sub-class entity when sub-classing.", "type":"string" }, "host":{ "description":"The host name where the Node Manager is hosted.", "nullable":false, "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", "nullable":false, "type":"string" }, "id":{ "description":"The identifier of the Node Manager.", "example":"NM-z8kfsx-16it-l0qpcmee", "nullable":false, "type":"string" }, "name":{ "description":"The name of the Node Manager.", "nullable":false, "type":"string" }, "nodes":{ "description":"The list of nodes managed by the Node Manager.", "items":{ "$ref":"#/components/schemas/NodeReference" }, "type":"array" }, "port":{ "description":"The port where the Node Manager is hosted.", "format":"int32", "nullable":false, "type":"integer" }, "state":{ "description":"The state of the Node Manager.", "type":"string" }, "statusMessage":{ "description":"The status of the Node Manager.", "type":"string" } }, "description":"The response schema for getting details of a Node Manager.", "type":"object" }, "NodeReference":{ "required":[ "href", "id" ], "properties":{ "href":{ "description":"The reference to get information about a node.", "format":"uri", "nullable":false, "type":"string" }, "id":{ "description":"The identifier of a node.", "nullable":false, "type":"string" } }, "description":"The schema defining reference to get a node's information.", "type":"object" }, "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" }, "NodeResponse":{ "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" }, "DCNodeConfigDataRSM":{ "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" }, "DCNodeTypeRSM":{ "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" }, "DestinationNodeConfig":{ "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" }, "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.", "items":{ }, "type":"array" } }, "description":"Response schema defining available routing functions for a node.", "type":"object" }, "SecondaryConfigData":{ "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" }, "NodeConfigVariable":{ "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" }, "NodeManagerUpdateRequest":{ "required":[ "name" ], "properties":{ "name":{ "description":"The name of the Node Manager.", "nullable":false, "type":"string" } }, "description":"The payload schema to update an existing Node Manager.", "type":"object" }, "NodeTypeResponse":{ "required":[ "id", "marketSegment", "metadata", "name", "type" ], "properties":{ "id":{ "description":"The context of the node.", "example":"Wireless#CC#RADIUS", "nullable":false, "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "example":"Wireless", "nullable":false, "type":"string" }, "metadata":{ "description":"The reference to get the metadata for the node type.", "example":"nodeTypes/Wireless#EI#RADIUS", "nullable":false, "type":"string" }, "name":{ "description":"The node's name as defined in GUI template tree.", "example":"RADIUS", "nullable":false, "type":"string" }, "type":{ "description":"The type of the node, for example, EP, DC, etc.", "example":"CC", "nullable":false, "type":"string" } }, "description":"The response schema for getting node types information for all the node types.", "type":"object" }, "ExportRequest":{ "required":[ "exportNodeChain", "nodeIDsToExport", "nodeManagersToExport" ], "properties":{ "exportNodeChain":{ "description":"The flag indicating whether to export node chain associated with nodes, identifiers for which are mentioned in nodeIDsToExport.", "example":"true", "nullable":false, "type":"boolean" }, "fileName":{ "description":"The exported data's file name.", "example":"export", "type":"string" }, "nodeIDsToExport":{ "description":"The list of identifiers of the nodes to export.", "example":"[]", "items":{ "type":"string" }, "nullable":false, "type":"array" }, "nodeManagersToExport":{ "description":"The list of Node Managers to export.", "example":"[]", "items":{ "type":"string" }, "nullable":false, "type":"array" } }, "description":"The payload schema to export nodes and Node Managers data to a file.", "type":"object" }, "NodeChainResponse":{ "required":[ "nodeChains", "nodeManagers", "queryNmId" ], "properties":{ "nodeChains":{ "description":"The details of the node chains.", "items":{ "$ref":"#/components/schemas/NodeChainResponseChainItem" }, "nullable":false, "type":"array" }, "nodeManagers":{ "description":"The Node Managers associated with nodes that are part of the node chain.", "items":{ "$ref":"#/components/schemas/NodeChainResponseNMItem" }, "nullable":false, "type":"array" }, "queryNmId":{ "description":"The identifier of the queried Node Manager.", "nullable":false, "type":"string" } }, "description":"The response schema for getting list of node chains associated with the queried Node Manager.", "type":"object" }, "NodeChainResponseChainItem":{ "required":[ "nmId", "nodes" ], "properties":{ "nmId":{ "description":"The identifier of the Node Manager.", "nullable":false, "type":"string" }, "nodes":{ "description":"The details for nodes that are part of the node chain.", "items":{ "$ref":"#/components/schemas/NodeChainResponseNodeItem" }, "nullable":false, "type":"array" } }, "description":"The schema defining a node chain's information which is part of list node chains response.", "type":"object" }, "NodeChainResponseNMItem":{ "required":[ "nmHost", "nmId", "nmName", "nmPort", "nodesCount" ], "properties":{ "nmHost":{ "description":"The host name at which Node Manager is hosted.", "nullable":false, "type":"string" }, "nmId":{ "description":"The identifier of the Node Manager.", "nullable":false, "type":"string" }, "nmName":{ "description":"THe name of the Node Manager.", "nullable":false, "type":"string" }, "nmPort":{ "description":"The port at which Node Manager is hosted.", "format":"int32", "nullable":false, "type":"integer" }, "nodesCount":{ "description":"The number of nodes associated with the Node Manager.", "format":"int32", "nullable":false, "type":"integer" } }, "description":"THe schema defining a Node Manager's information associated with a node chain which is part of list node chains response.", "type":"object" }, "NodeChainResponseNodeItem":{ "required":[ "displayName", "id", "nodeType", "routes" ], "properties":{ "displayName":{ "description":"The display name of the node.", "nullable":false, "type":"string" }, "id":{ "description":"The identifier of the node.", "nullable":false, "type":"string" }, "nodeType":{ "allOf":[ { "$ref":"#/components/schemas/NodeChainResponseNodeTypeItem" }, { "description":"The node type details of the node.", "nullable":false } ] }, "routes":{ "description":"The details for outgoing routes from the node.", "items":{ "$ref":"#/components/schemas/NodeChainResponseRouteAttrs" }, "nullable":false, "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":[ "context", "marketSegment", "name", "type" ], "properties":{ "context":{ "description":"The context of the node.", "nullable":false, "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "nullable":false, "type":"string" }, "name":{ "description":"The name of the node.", "nullable":false, "type":"string" }, "type":{ "description":"The type of the node, for example, EI, DC, etc.", "nullable":false, "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":[ "destNmId", "destNodeId", "isRemote", "routingFn" ], "properties":{ "destNmId":{ "description":"The identifier destination node's Node Manager.", "nullable":false, "type":"string" }, "destNodeId":{ "description":"The identifier of destination node.", "nullable":false, "type":"string" }, "isRemote":{ "description":"The flag indicating if the route is remote.", "nullable":false, "type":"boolean" }, "routingFn":{ "description":"The routing function used for the channel.", "nullable":false, "type":"string" } }, "description":"The schema defining a route's information associated with a node chain which is part of list node chains response.", "type":"object" }, "NodeCreateRequest":{ "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" }, "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":"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", "nullable":false, "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" }, { "description":"The attributes against which routing fields are compared using various operations." } ] }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum" }, { "description":"The routing function used for the channel.", "example":"DIRECTED", "nullable":false } ] } }, "description":"The payload schema to create a route between two nodes.", "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" } ] } }, "description":"The schema defining routing attributes for a route update request.", "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":"Schema defining an output field's details for a route", "type":"object" }, "RoutingFunctionEnum":{ "enum":[ "DIRECTED", "MODULUS", "MULTICAST", "ROUND_ROBIN" ], "type":"string" }, "OperatorEnum":{ "enum":[ "EQUALS", "GREATER_THAN", "IN_BETWEEN", "LESS_THAN", "LIST_EQUALS", "LIST_NOT_EQUALS", "NOT_EQUALS", "NOT_SUBSET_OF", "SUBSET_OF" ], "type":"string" }, "RouteResponse":{ "required":[ "destinationNodeID", "routingFunction", "sourceNodeID" ], "properties":{ "destinationNodeID":{ "description":"The identifier of the destination node.", "example":"z8kfsx-16it-3res21sew", "nullable":false, "type":"string" }, "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RoutingAttributes" }, { "description":"The attributes against which routing fields are compared using various operations." } ] }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum1" }, { "description":"The routing function used for the channel.", "example":"DIRECTED", "nullable":false } ] }, "sourceNodeID":{ "description":"The identifier of the source node.", "example":"z8kfsx-16it-l0mbm95p", "nullable":false, "type":"string" } }, "description":"The response schema to get a route's information.", "type":"object" }, "RoutingAttributes":{ "required":[ "operand1", "operator" ], "properties":{ "operand1":{ "description":"The values against which the operator acts on the routing field.", "items":{ "type":"string" }, "nullable":false, "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", "nullable":false } ] } }, "description":"The schema defining routing attributes for a route.", "type":"object" }, "RoutingFunctionEnum1":{ "enum":[ "DIRECTED", "MODULUS", "MULTICAST", "ROUND_ROBIN" ], "type":"string" }, "OperatorEnum1":{ "enum":[ "EQUALS", "GREATER_THAN", "IN_BETWEEN", "LESS_THAN", "LIST_EQUALS", "LIST_NOT_EQUALS", "NOT_EQUALS", "NOT_SUBSET_OF", "SUBSET_OF" ], "type":"string" }, "NodeUpdateRequest":{ "required":[ "displayName", "ruleFileDisplayName", "ruleFileName" ], "properties":{ "dcNodeConfigData":{ "allOf":[ { "$ref":"#/components/schemas/DCNodeConfigDataRSM" }, { "description":"The configuration data of the node." } ] }, "displayName":{ "description":"The display name of the node.", "example":"CC Node 1", "type":"string" }, "ruleFileDisplayName":{ "description":"The selected rule file display name for the node.", "type":"string" }, "ruleFileName":{ "description":"The selected rule file name for the node.", "example":"ASCII_Sample.npl", "type":"string" } }, "description":"The payload schema to update an existing node.", "type":"object" }, "RouteUpdateRequest":{ "required":[ "routingFunction" ], "properties":{ "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" }, { "description":"The attributes against which routing fields are compared using various operations." } ] }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" }, "routingFunction":{ "allOf":[ { "$ref":"#/components/schemas/RoutingFunctionEnum2" }, { "description":"The routing function used for the channel.", "example":"DIRECTED", "nullable":false } ] } }, "description":"The payload schema to PUT update an existing route.", "type":"object" }, "RoutingFunctionEnum2":{ "enum":[ "DIRECTED", "MODULUS", "MULTICAST", "ROUND_ROBIN" ], "type":"string" }, "RouteParametersUpdateRequest":{ "properties":{ "routingAttrs":{ "allOf":[ { "$ref":"#/components/schemas/RouteUpdateRequestRoutingAttrs" }, { "description":"The attributes against which routing fields are compared using various operations." } ] }, "routingField":{ "description":"The field defined in NPL used for routing.", "type":"string" } }, "description":"The payload schema to PATCH update an existing route.", "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 NPL file name.", "example":"TestFile.npl", "type":"string" }, "content":{ "description":"The NPL content.", "example":"//npl code", "type":"string" }, "marketSegment":{ "description":"The market segment of the node.", "example":"CatridgeKit", "type":"string" }, "majorType":{ "description":"The major type of the node.", "example":"EI", "type":"string" }, "minorType":{ "description":"The minor type of the node.", "example":"FileEI", "type":"string" } }, "description":"Response schema to get 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":"The flag indicating if rule file is a OOTB system rule file.", "example":true, "type":"boolean" } }, "description":"The schema defining available NPLs for a node.", "type":"object" }, "NPLRequest":{ "required":[ "Action", "nodeContext", "nplContent", "ruleFileName" ], "properties":{ "Action":{ "allOf":[ { "$ref":"#/components/schemas/Actiontype" }, { "description":"The action to be performed on the rule file, either COMPILE, SAVE, or both.", "example":"Action", "nullable":false } ] }, "nodeContext":{ "description":"The context of the node.", "example":"nodeContext", "nullable":false, "type":"string" }, "nplContent":{ "description":"The NPL content.", "example":"NPL Content", "nullable":false, "type":"string" }, "ruleFileName":{ "description":"The rule file name.", "example":"ruleFileName", "type":"string" } }, "description":"The payload schema to perform an action on a node's NPL.", "type":"object" }, "Actiontype":{ "enum":[ "COMPILE", "SAVE" ], "type":"string" }, "NPLResponse":{ "required":[ "nodeContext", "Response", "ruleFileName" ], "properties":{ "nodeContext":{ "description":"The context of the node.", "example":"nodeContext", "nullable":false, "type":"string" }, "Response":{ "description":"The response message for action performed on the NPL.", "example":"Response", "nullable":false, "type":"string" }, "ruleFileName":{ "description":"The name of the rule file.", "example":"ruleFileName", "nullable":false, "type":"string" } }, "description":"The response schema to get the update for an action performed on a node's NPL.", "type":"object" } } }, "info":{ "title":"REST API Reference for Offline Mediation Controller", "version":"2025.04.25", "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.0", "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: