REST API Reference for Offline Mediation Controller

Update a Node Manager Name

patch

/v1/nodeManagers/{id}

Updates the name of the specified Node Manager.

Request

Path Parameters

id(required): string

The Node Manager identifier.

Supported Media Types

application/json;charset=utf-8

Root Schema : schema

Type: object

The payload schema to update an existing Node Manager.

Show Source

name(required): string

The name of the Node Manager.

{
    "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"
}

Response

Supported Media Types

application/json

200 Response

The Node Manager has been updated successfully.

Root Schema : NodeManagerResponse

Type: object

The response schema for getting details of a Node Manager.

Show Source

@type: string

Defines the sub-class entity when sub-classing.
host(required): string

The host name where the Node Manager is hosted.
href(required): string (uri)

The reference to get the Node Manager's information.

Example: http://server:port/api/v1/nodeManagers/NM-z8kfsx-16it-l0qpcmee
id(required): string

The identifier of the Node Manager.

Example: NM-z8kfsx-16it-l0qpcmee
name(required): string

The name of the Node Manager.
nodes: array nodes

The list of nodes managed by the Node Manager.
port(required): integer (int32)

The port where the Node Manager is hosted.
state: string

The state of the Node Manager.
statusMessage: string

The status of the Node Manager.

{
    "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"
}

Nested Schema : nodes

Type: array

The list of nodes managed by the Node Manager.

Show Source

Array of: object NodeReference

The schema defining reference to get a node's information.

{
    "description":"The list of nodes managed by the Node Manager.",
    "items":{
        "$ref":"#/components/schemas/NodeReference"
    },
    "type":"array"
}

Nested Schema : NodeReference

Type: object

The schema defining reference to get a node's information.

Show Source

href(required): string (uri)

The reference to get information about a node.
id(required): string

The identifier of a node.

{
    "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"
}

400 Response

The server cannot process the request 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 could not be processed due to a conflict with 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

This example shows how to update a Node Manager 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/nodeManagers/NMGR-31eoeh-otm-ln3hrqc9' -d @sampleUpdateaNodeManager.json

Example of the Request Body

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

{
  "name": "nm-dc"
}

Example of the Response Body

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

{
  "host": "node-mgr-app",
  "href": "/nodemanagers/NMGR-31eoeh-otm-ln3hrqc9",
  "id": "NMGR-31eoeh-otm-ln3hrqc9",
  "name": "nodemgr1",
  "nodes": [
    {
      "href": "/nodes/31eoef-otm-lna53s09",
      "id": "31eoef-otm-lna53s09"
    },
    {
      "href": "/nodes/31eoef-otm-lna51qht",
      "id": "31eoef-otm-lna51qht"
    },
    {
      "href": "/nodes/31eoef-otm-lna4vku4",
      "id": "31eoef-otm-lna4vku4"
    },
    {
      "href": "/nodes/31eoep-otm-lnbhn159",
      "id": "31eoep-otm-lnbhn159"
    }
  ],
  "port": 32170,
  "statusMessage": "Informational - "
}