Synopsis

fcli ssc rest call [-d=<data>] [-X=<httpMethod>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] ] [--store=_variableName[=<propertyNames>]] [--output-to-file=<outputFile>]] [--session=<sessionName>] <uri>

Description

Options

-X, --request=<httpMethod>

HTTP request type. (eg: GET, POST, PUT, DELETE)

-d, --data=<data>

This option will read data from a file for your request.

Session options:

--session=<sessionName>

Session name to use

Output options:

-o, --output=format[=<options>]

Output format: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'json-properties' format ignores any options. The 'expr' output format takes a string containing '{<propertyPath>}' placeholders, other output formats take an optional, comma-separated list of property paths. Use '-o json-properties' on the current command to see available '<prop>' values.

--store=variableName[=<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli config variable' command, and can be referenced using {?variableName:property} on any subsequent command. Most commands that return a single record (get, start, create, …​) also support '?' to store the record identifier in a predefined variable, which can later be referenced using '?' on options/parameters that take the id of such records as input.

--output-to-file=<outputFile>

Write results to the specified files in the given output format. By default, results will be written to stdout

Generic fcli options:

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

--log-file=<logFile>

File where logging data will be written. If not specified, no logging data will be written.

--log-level=<logLevel>

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR

Arguments

<uri>

The uri to the REST API function that you want to invoke