---
schema_version: "1"
id: c0b2fd7c74137bc982a7b14b85377565a7131dd955451c97a7dda16cef024ab1
title: Action.InputParameter Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_Invocable_Action_InputParameter.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 813776168e5f6701999cb1faad6ac157ef843191fac557fc392f2516f0ccf76e
description: Contains methods to get metadata about input parameters for invocable actions.Gets a list of additional attributes for an invocable action input parameter.Gets the Apex class name of an input parameter for an invocable action.Gets the maximum byte length of an input parameter of an invocable action.Indicates whether an input parameter of an invocable action is a configuration parameter.Gets the default value for an input parameter of an invocable action.>Gets the description of an input parameter of an invocable action.Gets the label of an input parameter of an invocable action.Gets the maximum number of occurrences for an input parameter of an invocable action.Gets the name of an input parameter of an invocable action.Gets a list of picklist values for an input parameter of an invocable action.Gets the placeholder text of an input parameter of an invocable action.Indicates whether an input parameter of an invocable action is required.Gets the sObject type of an input parameter of an invocable action.Gets the setup reference types of an input parameter of an invocable action.Gets the tooling type of and input parameter of an invocable action.Gets the data type of an input parameter of an invocable action.
---
# Action.InputParameter Class

Contains methods to get metadata about input parameters for invocable actions.

## Namespace

[Invocable](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Invocable.htm "The Invocable namespace provides classes for calling invocable actions from Apex.")

## Example

Invocable.Action action = Invocable.Action.createStandardAction('otherActionName');
List<Invocable.Action.DescribeResult> results = action.getDescribe();

for (Invocable.Action.DescribeResult result : results) {
    for (Invocable.Action.InputParameter input : result.getInputs()) {
        List<Invocable.Action.AdditionalAttribute> attrs = input.getAdditionalAttributes();
        if (attrs != null) {
            for (Invocable.Action.AdditionalAttribute attr : attrs) {
                System.debug('Attribute: ' + attr.getName());
                System.debug('Data Type: ' + attr.getDataType());

                // Handle collection vs single value
                if (attr.getIsCollection()) {
                    if (attr.getDataType() == 'STRING') {
                        List<String> stringValues = attr.getValueAsStringList();
                        System.debug('String Values: ' + stringValues);
                    }
                } else {
                    System.debug('Value: ' + attr.getValue());
                }
            }
        }
    }
}

- **[Action.InputParameter Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_methods)**

## Action.InputParameter Methods

The following are methods for Action.InputParameter.

- **[getAdditionalAttributes()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getAdditionalAttributes)**  
    Gets a list of additional attributes for an invocable action input parameter.
- **[getApexClass()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getApexClass)**  
    Gets the Apex class name of an input parameter for an invocable action.
- **[getByteLength()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getByteLength)**  
    Gets the maximum byte length of an input parameter of an invocable action.
- **[getConfiguration()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getConfiguration)**  
    Indicates whether an input parameter of an invocable action is a configuration parameter.
- **[getDefaultValue()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getDefaultValue)**  
    Gets the default value for an input parameter of an invocable action.
- **[getDescription()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getDescription)**  
    \>Gets the description of an input parameter of an invocable action.
- **[getLabel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getLabel)**  
    Gets the label of an input parameter of an invocable action.
- **[getMaxOccurs()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getMaxOccurs)**  
    Gets the maximum number of occurrences for an input parameter of an invocable action.
- **[getName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getName)**  
    Gets the name of an input parameter of an invocable action.
- **[getPicklistValues()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getPicklistValues)**  
    Gets a list of picklist values for an input parameter of an invocable action.
- **[getPlaceholderText()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getPlaceholderText)**  
    Gets the placeholder text of an input parameter of an invocable action.
- **[getRequired()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getRequired)**  
    Indicates whether an input parameter of an invocable action is required.
- **[getSObjectType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getSObjectType)**  
    Gets the sObject type of an input parameter of an invocable action.
- **[getSetupReferenceType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getSetupReferenceType)**  
    Gets the setup reference types of an input parameter of an invocable action.
- **[getToolingType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getToolingType)**  
    Gets the tooling type of and input parameter of an invocable action.
- **[getType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_InputParameter.htm#apex_Invocable_Action_InputParameter_getType)**  
    Gets the data type of an input parameter of an invocable action.

### getAdditionalAttributes()

Gets a list of additional attributes for an invocable action input parameter.

#### Signature

public List<Invocable.Action.AdditionalAttribute> getAdditionalAttributes()

#### Return Value

Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Invocable.Action.AdditionalAttribute](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_AdditionalAttribute.htm#apex_class_Invocable_Action_AdditionalAttribute "Contains methods to get metadata about attributes associated with invocable action parameters.")\>

### getApexClass()

Gets the Apex class name of an input parameter for an invocable action.

#### Signature

public String getApexClass()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Apex class name of the input parameter of the invocable action.

### getByteLength()

Gets the maximum byte length of an input parameter of an invocable action.

#### Signature

public Integer getByteLength()

#### Return Value

Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.")

Maximum byte length of the input parameter of the invocable action.

### getConfiguration()

Indicates whether an input parameter of an invocable action is a configuration parameter.

#### Signature

public Boolean getConfiguration()

#### Return Value

Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.")

This method returns true if the input parameter of the invocable action is a configuration parameter.

### getDefaultValue()

Gets the default value for an input parameter of an invocable action.

#### Signature

public Object getDefaultValue()

#### Return Value

Type: Object

The default value, or null if no default is defined.

### getDescription()

\>Gets the description of an input parameter of an invocable action.

#### Signature

public String getDescription()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Description of the input parameter of the invocable action.

### getLabel()

Gets the label of an input parameter of an invocable action.

#### Signature

public String getLabel()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Label of the input parameter of the invocable action.

### getMaxOccurs()

Gets the maximum number of occurrences for an input parameter of an invocable action.

#### Signature

public Integer getMaxOccurs()

#### Return Value

Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.")

Maximum number of occurrences for the input parameter of the invocable action. If occurrences are unbounded, returns -1.

### getName()

Gets the name of an input parameter of an invocable action.

#### Signature

public String getName()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Name of the input parameter of the invocable action.

### getPicklistValues()

Gets a list of picklist values for an input parameter of an invocable action.

#### Signature

public List<Invocable.Action.PicklistValue> getPicklistValues()

#### Return Value

Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Invocable.Action.PicklistValue](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Invocable_Action_PicklistValue.htm#apex_class_Invocable_Action_PicklistValue "Contains methods to get metadata about a single value in a picklist used by invocable action parameters.")\>

### getPlaceholderText()

Gets the placeholder text of an input parameter of an invocable action.

#### Signature

public String getPlaceholderText()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Placeholder text of the input parameter of the invocable action.

### getRequired()

Indicates whether an input parameter of an invocable action is required.

#### Signature

public Boolean getRequired()

#### Return Value

Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.")

This method returns true if the input parameter of the invocable action is required.

### getSObjectType()

Gets the sObject type of an input parameter of an invocable action.

#### Signature

public String getSObjectType()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

SObject type of the input parameter of the invocable action.

### getSetupReferenceType()

Gets the setup reference types of an input parameter of an invocable action.

#### Signature

public List<String> getSetupReferenceType()

#### Return Value

Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\>

List of setup reference type identifiers of the input parameter of the invocable action.

### getToolingType()

Gets the tooling type of and input parameter of an invocable action.

#### Signature

public String getToolingType()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Tooling type of the input parameter of the invocable action.

### getType()

Gets the data type of an input parameter of an invocable action.

#### Signature

public String getType()

#### Return Value

Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")

Data type of the input parameter of the invocable action.