The approval workflow object supports routing certain core network service tasks submitted by an admin group to another approval. You can add an admin group to an approval workflow and define the group as a submitter or an approver group. You can also define when and to whom e-mail notifications must be sent, and configure options such as whether the submitters or approvers must enter a comment or a ticket number when they submit tasks for approval. Approval workflows are useful when you want to control tasks that require reviews.
References to approvalworkflow are object references.
The name part of the approval workflow object reference has the following components:
- Submitter group name
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): approval_group, submitter_group.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| approval_group | |
| submitter_group |
The approval administration group.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The approval_group is part of the base object.
The destination for approval task notifications.
Type
String.
Create
The default value is BOTH.
Search
The field is not available for search.
The destination for approved task notifications.
Type
String.
Create
The default value is BOTH.
Search
The field is not available for search.
The requirement for the comment when an approver approves a submitted task.
Type
String.
Create
The default value is UNUSED.
Search
The field is not available for search.
Determines whether approval task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether approved task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether failed task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether e-mail notifications to admin group’s e-mail address are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether e-mail notifications to an admin member’s e-mail address are enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines whether rejected task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether rescheduled task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines whether succeeded task notifications are enabled.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The destination for failed task notifications.
Type
String.
Create
The default value is BOTH.
Search
The field is not available for search.
The destination for rejected task notifications.
Type
String.
Create
The default value is BOTH.
Search
The field is not available for search.
The destination for rescheduled task notifications.
Type
String.
Create
The default value is BOTH.
Search
The field is not available for search.
The requirement for the comment when a submitter submits a task for approval.
Type
String.
Create
The default value is UNUSED.
Search
The field is not available for search.
The submitter admininstration group.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The submitter_group is part of the base object.
The submitter_group cannot be updated.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| approval_group | String | Y | N | Y | = |
| approval_notify_to | String | N | N | N | N/A |
| approved_notify_to | String | N | N | N | N/A |
| approver_comment | String | N | N | N | N/A |
| enable_approval_notify | Bool | N | N | N | N/A |
| enable_approved_notify | Bool | N | N | N | N/A |
| enable_failed_notify | Bool | N | N | N | N/A |
| enable_notify_group | Bool | N | N | N | N/A |
| enable_notify_user | Bool | N | N | N | N/A |
| enable_rejected_notify | Bool | N | N | N | N/A |
| enable_rescheduled_notify | Bool | N | N | N | N/A |
| enable_succeeded_notify | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| failed_notify_to | String | N | N | N | N/A |
| rejected_notify_to | String | N | N | N | N/A |
| rescheduled_notify_to | String | N | N | N | N/A |
| submitter_comment | String | N | N | N | N/A |
| submitter_group | String | Y | N | Y | = |
| succeeded_notify_to | String | N | N | N | N/A |
| ticket_number | String | N | N | N | N/A |
allrpzrecords : DNS All RPZ Records object.
