Navigation: Catalog: Lists > Schemas

Lists

Catalog: Lists

Schema: Basic

Primary Keys: listId

Retrieve: true

Insert: true

Update: false

Delete: true

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Lists. 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	Default Value	Documentation
includeFilters		☐

Columns of Table Function

The columns of the table function Lists are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required	Documentation
createdAt	datetime	Created at	☐	The time when the list was created.
createdById	varchar2	Created by ID	☐	The ID of the user that created the list.
deletedAt	datetime	Deleted at	☐	The time when the list was deleted.
filterBranch_filterBranchOperator	varchar2		☐	The logical operator used to combine the filters within the branch (OR).
filterBranch_filterBranchType	varchar2		☐	The type of the filter branch (OR).
filtersUpdatedAt	datetime		☐	The time when the filters for this list were last updated.
listId	varchar2		☐	The ILS ID of the list.
listPermissions_teamsWithEditAccess	varchar2		☐
listPermissions_usersWithEditAccess	varchar2		☐
listVersion	int32		☐	The version of the list.
membershipSettings_includeUnassigned	char		☐	Indicates whether unassigned memberships should be included.
membershipSettings_membershipTeamId	int32		☐	The ID of the team associated with the membership.
name	varchar2	Name	☐	The name of the list.
objectTypeId	varchar2	Ojbect Type ID	☐	The object type of the list.
processingStatus	varchar2		☐	The processing status of the list.
processingType	varchar2		☐	The processing type of the list.
size	int64	Size	☐	Size of the list
updatedAt	datetime	Updated at	☐	The time the list was last updated.
updatedById	varchar2	Updated by ID	☐	The ID of the user that last updated the list.

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

Lists

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information