Newer Version Available

This content describes an older version of this product. View Latest

WorkflowTask

Represents a workflow task that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.

Available from API version 32.0 or later.

Supported SOAP Calls

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

Supported REST HTTP Methods

Query, DELETE, GET, PATCH, POST

Fields

Field Name Details
EntityDefinition
Type
EntityDefinition
Properties
Filter, Group, Sort.
Description
Required. The entity definition for the object associated with the validation rule.
EntityDefinitionId
Type
string
Properties
Filter, Group, Sort
Description
The ID of the entity containing the workflow task.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the associated metadata 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.
ManageableState
Type
ManageableState enumerated list
Properties
Create, Filter, Update
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • installed
  • released
  • unmanaged
Metadata
Type
mns:WorkflowTask
Properties
Create, Nillable, Update
Description
Workflow task metadata.
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.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace of the package containing the workflow task object.
Priority
Type
picklist
Properties
Filter, Group, Sort
Description
The task’s priority. Values are:
  • High
  • Normal
  • Low
Status
Type
picklist
Properties
Filter, Group, Sort
Description
The task’s status. Values are:
  • Not Started
  • In Progress
  • Completed
  • Waiting on someone else
  • Deferred
Subject
Type
string
Properties
Filter, Group, idLookup, Sort
Description
A subject for the workflow task. It is used if an email notification is sent when the task is assigned.