5.2.16 /api/v1/playmacro

Executes a macro on a given M&C.

Supported HTTP methods: POST, HEAD, OPTIONS

POST /api/v1/playmacro/{mncName}

Executes the referenced macro. Expects the macro to play as a Macro body, delegates the request to the M&C.

Parameters:

Parameter Description
mncName The name of the M&C at which the macro shall be loaded and executed.

Return Codes:

Code Description
200 OK, returns the Macro containing the executed macro.
401 not logged in. In this case a ApiError document is returned, describing details of the error.
404 the M&C with the given name does nit exist. In this case a ApiError document is returned, describing details of the error.

POST /api/v1/playmacro/{mncName}/{macroName}

Executes the referenced macro. Expects no request body, simply delegates the request to the M&C.

Parameters:

Parameter Description
mncName The name of the M&C at which the macro shall be loaded and executed.
macroName The name of the macro to execute.

Return Codes:

Code Description
200 OK, returns the Macro containing the executed macro.
401 not logged in. In this case a ApiError document is returned, describing details of the error.
404 either M&C with the given name exists or at the known M&C there exists no macro with the requested name. In this case a ApiError document is returned, describing details of the error.