Skip to main content

soap

soap [request]

Runs a query against a soap API.

arguments:

args

JSON containing the arguments to pass to the soap method. (type: string)

examples:

Query

soap '{"intA": 1, "intB": 2}' --method "Add" --wsdl "http://www.dneonline.com/calculator.asmx?wsdl"

Results after soap stage:

AddResult
3

flags:

--appendStage

Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)

--cache

A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.

--checkpoint

Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Not encrypted. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$

--filter

A filter to run on the command results before completing the command. If not provided, no filter is run on the results.

--guid

Adds a populated random guid column.

--labelStage

Used to label a stage with a user provided label.

--method

Method to run against wsdl.

--pagination.argIndex

The index of the argument (must be JSON) to replace with the pagination token.

--pagination.argKey

The key in the JSON argument to replace with the pagination token.

--pagination.done

The value of pagination.next thats indicates that pagination is complete.

--pagination.max

Maximum number of pages visited.

--pagination.next

The location within the results set describing the location of the next set of results. Use with pagination.argKey and pagination.argIndex to replace the value in the argument.

--randomizeHash

Randomizes the stage hash, even if args and flags are the same.

--security.basic.password

Password for basic auth.

--security.basic.username

Username for basic auth.

--security.bearer

Bearer token for bearer auth.

--security.ws.actor

Actor for ws auth.

--security.ws.mustunderstand

Must understand for ws auth.

--security.ws.nonce

Nonce for ws auth.

--security.ws.password

Password for ws auth.

--security.ws.passwordtype

Password type for ws auth.

--security.ws.username

Username for ws auth.

--stats

Controls if a stats calculation is run on a stage after it completes.

--table

A comma separated list of columns to include in the command results. If not provided, all columns will be included.

--type

Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.

--variable

Format: "{VARIABLE NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a variable in other stages. Can be accessed using $VARIABLES.{VARIABLE NAME}$. Stored as an encrypted secret. Not stored across queries.

--wsdl

Name of uploaded wsdl file OR url where wsdl can be found.

support

AMI_ENTERPRISE AMI_FREE AMI_PRO BINARY_ENTERPRISE BINARY_FREE BINARY_PRO DESKTOP_ENTERPRISE DESKTOP_FREE DESKTOP_PRO DOCKER_ENTERPRISE DOCKER_FREE DOCKER_PRO