Approval Task Properties

Task Properties: Approval Task

Property	UI Field Name	Description	Specifications	Required	Patchable (Instance Only)
approvalCriteria	Approval Criteria	Specifies one or more approvers (Users or Groups) required for approval. Examples: XML XML <approvalCriteria> <criterion> <user>ops.admin</user> <userDisplayName>Administrator</userDisplayName> </criterion> <criterion> <group>Group1</group> </criterion> <logicalOperator>And</logicalOperator> </approvalCriteria> JSON JSON "approvalCriteria": { "criteria": [ { "type": "criterion", "user": "ops.admin", "userDisplayName": "Administrator" }, { "type": "criterion", "group": "Group1" } ], "logicalOperator": "And" },	See Approval Criteria properties, below.	Y	N
approvalDescription	Approval Description	Detailed description of what is being approved.		N	Y
approvalLinks	Approval Links / References	List of links or references to external information. Each link has a name and value pair. Examples: XML XML <approvalLinks> <approvalLink> <name>link1</name> <value>https://www.google.com/maps</value> </approvalLink> <approvalLink> <name>link2</name> <value>https://www.stonebranch.com/</value> </approvalLink> </approvalLinks> JSON JSON "approvalLinks": [ { "name": "link1", "value": "https://www.google.com/maps" }, { "name": "link2", "value": "https://www.stonebranch.com/" } ]		N	Y

Approval Task Properties - Approval Criteria

Property	UI Field Name	Description	Specifications	Required	Patchable (Instance Only)
criteria	n/a	Criteria list. An element in the list is of type criterion or criteria.	The following example represents a criteria list consisting of two elements: One element of type criterion. One element of type criteria. info In JSON, the two elements are wrapped in the "criteria":[] property.However, in XML, there is no additional <criteria></criteria> tag to wrap the two elements. XML XML <criterion> <user>ops.admin</user> <userDisplayName>Administrator</userDisplayName> </criterion> <criteria> <criterion> <user>user1</user> <userDisplayName>User 1</userDisplayName> </criterion> <criterion> <group>Group1</group> </criterion> <logicalOperator>Or</logicalOperator> </criteria> JSON JSON "criteria": [ { "type": "criterion", "user": "ops.admin", "userDisplayName": "Administrator" }, { "type": "criteria", "criteria": [ { "type": "criterion", "user": "user1", "userDisplayName": "User 1" }, { "type": "criterion", "group": "Group1" } ], "logicalOperator": "Or" } ] See Criteria properties, below.	Y	N
logicalOperator	Match All Match Any	Specifies that the Approval task instance should go to Approved status when ALL or ANY of the criteria are met.	Valid values: As String = And (case insensitive), and As Value = 1 As String = Or (case insensitive), As Value = 2 Default is And (1).	N	N

Approval Task Properties - Criteria

Property	UI Field Name	Description	Specifications	Required	Patchable (Instance Only)
type	n/a	Specifies the type of an element in the criteria list.	For JSON only. Valid values: As String = criterion As String = criteria Default is criterion. info In XML, the type is indicated by the XML tag (<criterion> or <criteria>)	Y	N
criterion	n/a	A single condition composed of an approver group or user and userDisplayName.	XML XML <criterion> <user>ops.admin</user> <userDisplayName>Administrator</userDisplayName> </criterion> JSON JSON { "type": "criterion", "user": "ops.admin", "userDisplayName": "Administrator" } See Criterion properties, below.	N	N
criteria	n/a	A condition composed of multiple criterion/criteria elements and a logicalOperator And or Or. An element can be a criterion or an inner criteria.	XML XML <criteria> <criterion> <user>user1</user> <userDisplayName>User 1</userDisplayName> </criterion> <criterion> <group>Group1</group> </criterion> <logicalOperator>Or</logicalOperator> </criteria> JSON JSON { "type": "criteria", "criteria": [ { "type": "criterion", "user": "user1", "userDisplayName": "User 1" }, { "type": "criterion", "group": "Group1" } ], "logicalOperator": "Or" } See Criterion properties, below.	N	N

Approval Task Properties - Criterion

Property	UI Field Name	Description	Specifications	Required	Patchable (Instance Only)
group	n/a	A Group that can approve the task instance.		Y (unless user is specified)	N
user	n/a	A User who can approve the task instance.		Y (unless group is specified)	N
userDisplayName	n/a	The display name of the User who can approve the task instance.		N	N

Task Instance Properties: Approval Task

Property	UI Field Name	Description	Specifications	Patchable (Instance Only)
approverStatus	Approver Status	A list of approvers and their corresponding approval status. Examples: XML XML <approverStatus> <approver> <type>User</type> <name>ops.admin</name> <displayName>Administrator</displayName> <status>Pending</status> <reviewedBy>-</reviewedBy> </approver> <approver> <type>Group</type> <name>Group1</name> <status>Pending</status> <reviewedBy /> </approver> </approverStatus> JSON JSON "approverStatus": [ { "type": "User", "name": "ops.admin", "displayName": "Administrator", "status": "Pending", "reviewedBy": "-" }, { "type": "Group", "name": "Group1", "status": "Pending", "reviewedBy": null } ],	See Approver Status properties, below.	N

Approval Task Instance Properties - Approver Status

Property	UI Field Name	Description	Patchable (Instance Only)
displayName	Approver Name	If type = User; the display name of the User who can approve the task instance.	N
name	n/a	The User or Group who can approve the task instance.	N
reviewedBy	n/a	If type = Group; the User who approved or rejected the task instance on behalf of the Group.	N
reviewedByDisplayName	Reviewed By	If type = Group; the display name of the User who approved or rejected the task instance on behalf of the Group.	N
status	Status	The approval status of the approver (Approved, Rejected, or Pending).	N
type	Type	The type of approver (User or Group).	N