ViewDefinition

Represents a view definition on a Slack app. Includes access to the associated ViewDefinition object in the Metadata API. Available in API version 53.0 and later.

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

DELETE, GET, HEAD, PATCH, POST, Query

To use this object, your org must have Slack capabilities and packaging enabled.

Field NameDescription
ApiVersionType
double
Properties
Filter, Nillable, Sort
Description
The API version is automatically generated and set to the current API version when the view definition is created.
ContentType
textarea
Properties
Nillable
Description
A string representation of ViewDefinition that contains the definition's metadata.
DescriptionType
textarea
Properties
Filter, Group, Nillable, Sort
Description
The view definition's description.
DeveloperNameType
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.
FullNameType
string
Properties
Create, Group, Nillable
Description
The full name of the associated ViewDefinition object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsDeletedType
boolean
Properties
Nillable
Description
Indicates whether the view definition is deleted (true) or not (false).
IsProtectedType
boolean
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
Indicates whether the view definition is protected (true) or not (false). If true, only this package can reference the view definition directly. The default value is false.
LanguageType
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language associated with the Slack app. For example, en_US for English and es for Spanish.
ManageableStateType
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged
MasterLabelType
picklist
Properties
Filter, Group, Restricted picklist,Sort
Description
Specifies where the view can be used. Valid value is slack.