Jump to

• Request
• Response
• Examples

Update a Node Manager

patch

/nodeManagers/{id}

Updates a specified Node Manager.

Request

Path Parameters

• id(required): string

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

Payload schema to update an existing node manager

Show Source

• name(required): string
  Name of the node manager

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Name of the node manager",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Payload schema to update an existing node manager",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The Node Manager has been updated successfully.

Body ()

Root Schema : NodeManagerResponse

Type: object

Response schema for getting details of a node manager.

Show Source

• @type: string
  Defines the sub-class entity when sub-classing. name
• host(required): string
  Hostname where the node manager is hosted.
• href(required): string (uri)
  Reference to get the node manager's information.

  Example: http://server:port/api/v1/nodeManagers/NM-z8kfsx-16it-l0qpcmee
• id(required): string
  Identifier of the node manager.

  Example: NM-z8kfsx-16it-l0qpcmee
• name(required): string
  Name of the node manager.
• nodes: array nodes
  Nodes managed by the node manager.
• port(required): integer (int32)
  Port where the node manager is hosted.
• state: string
  State of the node manager.
• statusMessage: string
  Status of the node manager.

{
    "required":[
        "host",
        "href",
        "id",
        "name",
        "port"
    ],
    "properties":{
        "@type":{
            "description":"Defines the sub-class entity when sub-classing. name",
            "type":"string"
        },
        "host":{
            "description":"Hostname where the node manager is hosted.",
            "nullable":false,
            "type":"string"
        },
        "href":{
            "description":"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":"Identifier of the node manager.",
            "example":"NM-z8kfsx-16it-l0qpcmee",
            "nullable":false,
            "type":"string"
        },
        "name":{
            "description":"Name of the node manager.",
            "nullable":false,
            "type":"string"
        },
        "nodes":{
            "description":"Nodes managed by the node manager.",
            "items":{
                "$ref":"#/components/schemas/NodeReference"
            },
            "type":"array"
        },
        "port":{
            "description":"Port where the node manager is hosted.",
            "format":"int32",
            "nullable":false,
            "type":"integer"
        },
        "state":{
            "description":"State of the node manager.",
            "type":"string"
        },
        "statusMessage":{
            "description":"Status of the node manager.",
            "type":"string"
        }
    },
    "description":"Response schema for getting details of a node manager.",
    "type":"object"
}

Nested Schema : nodes

Type: array

Nodes managed by the node manager.

Show Source

• Array of: object NodeReference
  Schema defining reference to get a node's information.

{
    "description":"Nodes managed by the node manager.",
    "items":{
        "$ref":"#/components/schemas/NodeReference"
    },
    "type":"array"
}

Nested Schema : NodeReference

Type: object

Schema defining reference to get a node's information.

Show Source

• href(required): string (uri)
  Reference to get information about a node.
• id(required): string
  Identifier of a node.

{
    "required":[
        "href",
        "id"
    ],
    "properties":{
        "href":{
            "description":"Reference to get information about a node.",
            "format":"uri",
            "nullable":false,
            "type":"string"
        },
        "id":{
            "description":"Identifier of a node.",
            "nullable":false,
            "type":"string"
        }
    },
    "description":"Schema defining reference to get a node's information.",
    "type":"object"
}

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

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

• @type: string
  Defines the sub-class entity when sub-classing.
• cause: string
  Cause of the exception
• code(required): string
  Application relevant details defined in the API or a common list.
• message: string
  Details and corrective actions related to the error which is shown to a client user.
• reason(required): string
  The reason for the error, shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error Code describiing the error.

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

Back to Top

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'

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

Back to Top