Review Workflow Rules

Review Workflow Rules: List

Retrieve the Review Workflow Rules configured for the account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
pageSize	integer <= 25 Default: 25 The maximum number of workflow rules to return. Defaults to 25.
pageToken	string If a response to a previous request contained the `nextPageToken` field, pass that field's value as the `pageToken` parameter to retrieve the next page of data.
filter	string CEL expression used to filter workflow rules. Filters can only be applied to `assignee`, `type`, and `enabled`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"workflowRules": [{"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
},
"name": "string",
"createTime": "string"
}
],
"nextPageToken": "string"
}
}

Review Workflow Rules: Create

Creates a Review Workflow Rule.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

assignee	string Resource name or email address of the user assigned to tasks created by this workflow rule. Set only one of `assignee` or `assigneeUserGroup`. External email addresses that don't correspond to a user are only supported when `ruleType` is `GENERATIVE_REVIEW_RESPONSE` and `autoPublishGenerativeResponse` is false. Format: `accounts/{accountId}/users/{userId}`
assigneeUserGroup	string Resource name of the user group assigned to tasks created by this workflow rule. When this is set, tasks are assigned to the user in the group with the fewest open tasks. Set only one of `assignee` or `assigneeUserGroup`. Format: `accounts/{accountId}/userGroups/{userGroup}`
displayName required	string The name of the workflow rule.
enabled	boolean Whether the workflow rule is enabled.
required	object Domain-specific configuration for the workflow rule. The supported keys depend on `ruleType`. Supported keys: `filterCriteria` `ruleApplication` `automaticResponseAssetIds` `autoPublishGenerativeResponse`
ruleType required	string Enum: "REVIEW_RESPONSE" "AUTOMATIC_REVIEW_RESPONSE" "GENERATIVE_REVIEW_RESPONSE" The type of workflow rule.
	object Relative due date applied to tasks created by the workflow rule.

Responses

Request samples

Payload

Content type

application/json

{"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
}
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
},
"name": "string",
"createTime": "string"
}
}

Review Workflow Rules: Get

Retrieve a specific Review Workflow Rule.

path Parameters

accountId required	string
workflowRuleId required	string ID of this Workflow Rule.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
},
"name": "string",
"createTime": "string"
}
}

Review Workflow Rules: Update

Updates a single Review Workflow Rule.

NOTE: Review Workflow Rules: Update only updates supplied fields. Omitted fields are not modified.

path Parameters

accountId required	string
workflowRuleId required	string ID of this Workflow Rule.

query Parameters

v required	string A date in `YYYYMMDD` format.
updateMask required	string Comma-separated list of fields to update on the workflow rule. Supported values: `assignee`, `assignee_user_group`, `display_name`, `enabled`, `domain_configuration`, `rule_type`, `due_date` Example: `display_name,enabled`

Request Body schema: application/json

assignee	string Resource name or email address of the user assigned to tasks created by this workflow rule. Set only one of `assignee` or `assigneeUserGroup`. External email addresses that don't correspond to a user are only supported when `ruleType` is `GENERATIVE_REVIEW_RESPONSE` and `autoPublishGenerativeResponse` is false. Format: `accounts/{accountId}/users/{userId}`
assigneeUserGroup	string Resource name of the user group assigned to tasks created by this workflow rule. When this is set, tasks are assigned to the user in the group with the fewest open tasks. Set only one of `assignee` or `assigneeUserGroup`. Format: `accounts/{accountId}/userGroups/{userGroup}`
displayName	string The name of the workflow rule.
enabled	boolean Whether the workflow rule is enabled.
	object Domain-specific configuration for the workflow rule. The supported keys depend on `ruleType`. Supported keys: `filterCriteria` `ruleApplication` `automaticResponseAssetIds` `autoPublishGenerativeResponse`
ruleType	string Enum: "REVIEW_RESPONSE" "AUTOMATIC_REVIEW_RESPONSE" "GENERATIVE_REVIEW_RESPONSE" The type of workflow rule.
	object Relative due date applied to tasks created by the workflow rule.
name	string Resource name of the workflow rule to update. Format: `accounts/{accountId}/workflowRules/{workflowRuleId}`

Responses

Request samples

Payload

Content type

application/json

{"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
},
"name": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"assignee": "string",
"assigneeUserGroup": "string",
"displayName": "string",
"enabled": true,
"domainConfiguration": {"filterCriteria": "string",
"ruleApplication": "NEW_REVIEWS",
"automaticResponseAssetIds": [0
],
"autoPublishGenerativeResponse": true
},
"ruleType": "REVIEW_RESPONSE",
"dueDate": {"value": 0,
"unit": "HOUR"
},
"name": "string",
"createTime": "string"
}
}

Review Workflow Rules: Delete

Deletes a Review Workflow Rule.

path Parameters

accountId required	string
workflowRuleId required	string ID of this Workflow Rule.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}