Versions Compared

Key

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

...

Field Name

Description

Label

required

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

API name

required

Users can select the appropriate API name to read the data.

Supported API's are: Assets, Lead Database

Default value: Assets

Object

required

The object related to the select API.  

This property is suggestible and will retrieve available object names during suggest values.

Default value: Not provided.

Operation

required

The operation related to the selected object.

This property is suggestible and will retrieve available operation names during suggest values.

Default value: Not provided.

Path parameters

Lets you define the path parameters. Suggestions also added to the Path Parameter(keys).

The path parameters(key and value) will be inserted into the URL.

Query parameters

Lets you define the query parameters. Suggestions also added to the Query Parameter keys.

The query parameters will be attached to the URL using the Http query parameter syntax, separated by & and added as key=value.

Note

The remaining properties are similar to the properties defined in Rest Get snap(Rest Snap Pack ).

Snap Execution

optional

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default value: Execute only