REST API Reference for Offline Mediation Controller

Start or Stop Nodes by IDs

post

/v1/actions/nodes/state

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:

START_NODES to start the node.
STOP_NODES to stop the node.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

The details about the action to perform.

Show Source

actionState(required): string

Allowed Values: [ "START_NODES", "STOP_NODES" ]

The action to be taken to start the node (START_NODES) or stop it (STOP_NODES).
includeRemoteNodes: boolean

The action to be taken to also include remote nodes in the action (true) or not (false).
nmIds: array nmIds

Unique Items Required: true

The list of Node Manager IDs to start or stop.
nodeIds: array nodeIds

Unique Items Required: true

The list of node IDs to start or stop.

{
    "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 (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean"
        }
    },
    "type":"object",
    "description":"The details about the action to perform."
}

Nested Schema : nmIds

Type: array

Unique Items Required: true

The list of Node Manager IDs to start or stop.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"The list of Node Manager IDs to start or stop.",
    "uniqueItems":true
}

Nested Schema : nodeIds

Type: array

Unique Items Required: true

The list of node IDs to start or stop.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"The list of node IDs to start or stop.",
    "uniqueItems":true
}

Response

Supported Media Types

application/json

200 Response

The node has been started or stopped successfully.

207 Response

The node has been started or stopped successfully, but there are multiple status codes.

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

400 Response

The request cannot be processed 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"
}

413 Response

The request payload is too large.

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

415 Response

The media type is not supported.

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

The following example shows how to start nodes by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://hostname:port/V1/actions/nodes/state' -d @sampleStartNodes.json

Example of Request Body

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

{
  "actionState": "START_NODES",
  "nodeIds": [],
  "nmIds": [
    "NMGR-31eoeh-otm-ln3hrqc9"
  ],
  "includeRemoteNodes": true
}

Example of the Response Body

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