1. REST API Reference for Offline Mediation Controller
  2. Tasks
  3. Nodes

Update a Node

patch

/v1/nodes/{id}

Updates a node with a specified ID.

Request

Path Parameters
Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : schema
Type: object
The payload schema to update an existing node.
Show Source
Nested Schema : dcNodeConfigData
Match All
The configuration data of the node.
Show Source
Nested Schema : DCNodeConfigDataRSM
Type: object
The schema defining node configuration data for a node.
Show Source
Nested Schema : configRules
Type: array
The secondary configuration data of the node.
Show Source
Nested Schema : nodeConfigVariables
Type: array
The general configuration data of the node.
Show Source
Nested Schema : SecondaryConfigData
Type: object
The schema defining secondary configuration data for a node.
Show Source
Nested Schema : fileConfigVariables
Type: array
The list of secondary configuration variables for the node.
Show Source
Nested Schema : NodeConfigVariable
Type: object
The schema defining configuration variable for a node.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The node was updated successfully.
Body ()
Root Schema : NodeResponse
Type: object
The response schema for getting a node's information.
Show Source
Nested Schema : dcNodeConfigData
Match All
The configuration data of the node.
Show Source
Nested Schema : dcNodeType
Match All
The node type information of the node.
Show Source
  • DCNodeTypeRSM
    The schema defining node type information for a node.
  • The node type information of the node.
Nested Schema : destinationNode
Type: array
The details of destination nodes for routes originating from the node.
Show Source
Nested Schema : DCNodeConfigDataRSM
Type: object
The schema defining node configuration data for a node.
Show Source
Nested Schema : configRules
Type: array
The secondary configuration data of the node.
Show Source
Nested Schema : nodeConfigVariables
Type: array
The general configuration data of the node.
Show Source
Nested Schema : SecondaryConfigData
Type: object
The schema defining secondary configuration data for a node.
Show Source
Nested Schema : fileConfigVariables
Type: array
The list of secondary configuration variables for the node.
Show Source
Nested Schema : NodeConfigVariable
Type: object
The schema defining configuration variable for a node.
Show Source
Nested Schema : DCNodeTypeRSM
Type: object
The schema defining node type information for a node.
Show Source
Nested Schema : DestinationNodeConfig
Type: object
The schema defining destination node's reference for a route.
Show Source

400 Response

The server cannot process the request due to a client error.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

The client does not have the correct privileges.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

The request was not authorized.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

The requested resource cannot be found.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

The request could not be processed due to a conflict with the existing state of the resource.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

The system has encountered an internal server error.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

This example shows how to update a node's details by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH 'http://hostname:port/nodes/31eoef-otm-lna53s09'

Example of the Response Body

If successful, the response code 200 is returned with the following response body.

{
  "dcNodeConfigData": {
    "nodeConfigVariables": [
    {
        "name": "narbackup",
        "value": "false"
      },
      {
        "name": "fileleveltransaction",
        "value": "false"
      },
      {
        "name": "mtCheck",
        "value": "false"
      },
      {
        "name": "recordStatistics",
        "value": "false"
      }
 
    ],
    "configRules" : [
 
    ]
  },
  "displayName": "Node-7",
  "ruleFileDisplayName": "NewFile2",
  "ruleFileName": "NewFile2.npl"
  }
Back to Top