Versions Compared

Old Version 31

changes.mady.by.user PIPEFORCE

Saved on

compared with

New Version Current

changes.mady.by.user PIPEFORCE

Saved on

Key

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

...

  • Replace HUB by the hub host name of your instance (for example hub-mycompany.pipeforce.net).

  • Replace <command.name> by the name of the command you would like to execute.

  • Replace <param1>,<value1> and <paramN>,<valueN> by the optional parameters of your command.

HTTP GET​

Info

Calling a command via HTTP GET:

  • Sets all request parameters → command parameters.

  • Sets the command body to null.

Here is an example to execute the log command as HTTP GET request, and set its message parameter to a string value using a HTTP request parameter:

...

  • Authentication is not considered here for simplicity reasons.

  • Replace http://hub-trial.pipeforce.org by the url of your target system.

  • In case you would like to use special characters like spaces, umlauts, ? or = for example in your parameter value, you need to URL encode the URL as you would do with any such HTTP request. See Wikipedia for details: https://en.wikipedia.org/wiki/Percent-encoding

See HTTP Execution Reference for an summary of all supported HTTP options hereAlso see PIPEFORCE HTTP API.

HTTP POST​

Info

Calling a command via HTTP POST (default behaviour):

  • Sets all request parameters → command parameters.

  • Sets the request body → command input body.

Since

Status
colourBlue
titleVersion 10
: When passing the optional request parameter ?params=body:

  • If the request body contains a JSON or YAML → This will be applied as command parameters.

  • Sets the command body to null.

Here is an example to execute a single command as HTTP POST request, and set the message parameter to a log command using a HTTP POST data body in curl:

...

  • Authentication is done here by using basic authentication in the Authorization header. See Authorization and the -u switch of the curl terminal command for details.

  • Replace http://hub-trial.pipeforce.org by the url of your target system.

See HTTP Execution Reference for an summary of all supported HTTP options hereAlso see PIPEFORCE HTTP API.

CLI​

You can also use the PIPEFORCE CLI in order to execute a single Command. Here is an example to call the log command and set the message parameter accordingly:

...