Synopsis

fcli ssc rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--no-transform] | -t=<expr>] ] [--store=_variableName _ ] [--to-file=<outputFile>_]] [-q=<SpEL _ _ expression>] [[--session=<sessionName>]] <uri>

Description

Options

-d, --data=<data>

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

--no-paging

By default, this command will load all pages of data from SSC (from the given offset if specified as a request parameter). Use this option to return only a single page.

--no-transform

By default, this command performs generic transformations on SSC REST responses, like only outputting the actual response data (contents of the 'data' property). Use this option to output the original response contents without transformations.

-q, --query=<SpEL expression>

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

-t, --transform=<expr>

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

-X, --request=<httpMethod>

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

Session options

--session=<sessionName>

Name of the SSC session to use for executing this command. Default value: default.

Output options

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

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[=<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options

--env-prefix=<envPrefix>

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

-h, --help

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

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

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

Relative URI to the REST API endpoint that you want to invoke.