Versions Compared

Old Version 10

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 11

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes the commands endpoint, which can be used to trigger commands defined in catalogs. 

Excerpt Include
Commands
Commands
nopaneltrue
 

The REST resource must be called with HTTP 

Mgnl post
.

Table of Contents

Request URLs

The endpoint recognizes URLs with or without a catalog parameter.

<TODO: check:

Which command is taken, if the request does not contain the catalogName param??? >


Mgnl post
  /commands/v2/{catalogName}/{commandName}

Mgnl post
  /commands/v2/{commandName}

Parameters

Advanced Tables - Table Plus
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
enableHighlightingfalse


Parameter

Description

Parameter type

Data type

commandName

required

Command definition

pathString

catalogName

optional

Command catalog

path

String

body

required

Request body in JSON or XML format; it contains the parameters required to execute the command.

body

String


Example

<TODO: Find an example of a command which is not related to publishing. Note that new publishing is not yet supporting commands (wrapping the new operations.)>