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.

Supported SOAP API Calls

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

Supported REST API HTTP Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

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

Fields

Field Name Description
ApiVersion Type<br> double <br> Properties <br> Filter, Nillable, Sort <br> Description <br> The API version is automatically generated and set to the current API version when the view definition is created.
Content Type<br> textarea <br> Properties <br> Nillable <br> Description <br> A string representation of ViewDefinition that contains the definition's metadata.
Description Type<br> textarea <br> Properties <br> Filter, Group, Nillable, Sort <br> Description <br> The view definition's description.
DeveloperName Type<br> string <br> Properties <br> Filter, Group, Sort <br> Description <br> 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.
FullName Type<br> string <br> Properties <br> Create, Group, Nillable <br> Description <br> 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.
IsDeleted Type<br> boolean <br> Properties <br> Nillable <br> Description <br> Indicates whether the view definition is deleted (true) or not (false).
IsProtected Type<br> boolean <br> Properties <br> Defaulted on create, Filter, Group, Nillable, Sort <br> Description <br> 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.
Language Type<br> picklist <br> Properties <br> Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort <br> Description <br> The language associated with the Slack app. For example, en_US for English and es for Spanish.
ManageableState Type<br> ManageableState enumerated list <br> Properties <br> Filter, Group, Nillable, Restricted picklist, Sort <br> Description <br> Indicates the manageable state of the specified component that is contained in a package: <br> - beta <br> - deleted <br> - deprecated <br> - deprecatedEditable <br> - installed <br> - installedEditable <br> - released <br> - unmanaged
MasterLabel Type<br> picklist <br> Properties <br> Filter, Group, Restricted picklist,Sort <br> Description <br> Specifies where the view can be used. Valid value is slack.