Navigation: Catalog: Actions > Schemas > Schema: Definitions > Tables

AutomationActionOutputFieldTypeDefinitionOptionssByAppId

Retrieve custom action definitionsRetrieve custom workflow action definitions by app ID.

Catalog: Actions

Schema: Definitions

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function AutomationActionOutputFieldTypeDefinitionOptionssByAppId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
after	string	☐	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
appId	int32	☑
archived	boolean	☐	Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function AutomationActionOutputFieldTypeDefinitionOptionssByAppId are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
actionUrl	string	Action (URL)	☐
archivedAt	int64	Archived at	☐
description_3	string		☐	A detailed explanation of the field's purpose and usage.
description	string	Description	☐	A description of the option.
displayOrder	int32	Display Order	☐	The position of the item relative to others in the list.
doubleData	decimal		☐	A numerical value associated with the option.
externalOptions	boolean	External Options	☐	Indicates whether the field's options are sourced externally.
externalOptionsReferenceType	string		☐	Specifies the type of external reference for options.
fieldType	string	Field Type	☐	Describes the field's type in the UI, with accepted values like booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea, unknown.
helpText	string		☐	Additional information or guidance about the field.
hidden	boolean	Hidden	☐	Whether the option is displayed in HubSpot's UI.
id	string	ID	☐
label_3	string		☐	The user-friendly label for the field.
label	string	Label	☐	A user-friendly label that identifies the option.
labels	string	Labels	☐
name	string	Name	☐	The unique identifier for the field.
optionsUrl	string		☐	A URL that provides options for the field.
published	boolean	Published	☐
readOnly	boolean		☐	Whether the option is read-only.
referencedObjectType	string	Referenced Object Type	☐	Indicates the type of object that the field references, with accepted values like OWNER.
revisionId	string	Revision ID	☐
schema_maximum	int32		☐	The maximum value allowed for the integer field.
schema_minimum	int32		☐	The minimum value allowed for the integer field.
schema_type	string		☐	The type of the field, which is set to INTEGER.
type	string	Type	☐	Specifies the data type of the field, with accepted values like bool, date, datetime, enumeration, json, number, object_coordinates, phone_number, string.
useChirp	boolean		☐	Specifies whether the field uses the Chirp feature.
value	string	Value	☐	The actual value of the option.

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

AutomationActionOutputFieldTypeDefinitionOptionssByAppId

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information