Skip to main content

Get Key Value from Dictionary

Sophie avatar
Written by Sophie
Updated over a week ago

Definition and Usage

Get a value of a specific key from the dictionary. This command allows you to retrieve values stored in dictionary objects by specifying the key you want to access. You can also define behavior for cases when the key is not found in the dictionary.


Parameter Values

Input parameters

Parameter

Description

Possible Values

Required

Options / Notes

Dictionary

Select or enter the dictionary variable from which you want to get the key value

Any dictionary variable

Yes

The variable must be a valid dictionary object

Key

Enter the key to get its value from the given dictionary

Any valid key string

Yes

Case-sensitive depending on the dictionary implementation

If key absent

Specify what to do if the key is not found in the dictionary

Error, Return the default value

Yes

Controls error handling behavior when key doesn't exist

Default value

Set a default value for the key

Any valid value

Only if "Return the default value" is selected

This value will be returned when the key is not found

Error handling

Parameter Name

Description

Throw error & stop

When an error occurs, the action will trigger an error and stop the execution of the entire app.

Retry command

If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process.

Ignore error & continue

When an error occurs, the action will be ignored, and the workflow will continue without interruption.

Variables produced

The action produces a variable that stores the retrieved value from the dictionary based on the specified key.


Using Variables in Conditions

You can use the variable icon {x} to insert previously created variables into parameter fields. This is particularly useful when:

  • The dictionary parameter can be a variable containing a dictionary object

  • The key parameter can be a dynamic value stored in a variable

  • The output variable can be used in subsequent steps of your workflow


Notes

  • The dictionary must be properly initialized before using this command

  • Keys in dictionaries are typically case-sensitive; ensure you're using the exact key name

  • If you select "Error" for the "If key absent" parameter and the key is not found, the action will throw an error

  • If you select "Return the default value" option, make sure to provide an appropriate default value that matches the expected data type

Did this answer your question?