Update queue properties.
Input
Encoding
application/jsondescription
string
Optional
Optional description of the queue
enabled
boolean
Optional
Enable or disable the queue
name
string
Optional
New display name for the queue
queueId
integer
Required
ID of the queue to update
recommendedLabels
array
Optional
Labels to recommend for this queue and use as fallback appeal routing mappings
recommendedPolicies
array
Optional
Policy keys to recommend when actioning reports in this queue
Output
Encoding
application/jsonqueue
reftools.ozone.queue.defs#queueView
Required
No description available.
Errors
InvalidRecommendedPolicies
One or more recommended policy keys do not exist in the configured policy list ConflictingQueue
The queue configuration conflicts with an existing queue Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Update queue properties.",
"errors": [
{
"description": "One or more recommended policy keys do not exist in the configured policy list",
"name": "InvalidRecommendedPolicies"
},
{
"description": "The queue configuration conflicts with an existing queue",
"name": "ConflictingQueue"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"description": {
"description": "Optional description of the queue",
"type": "string"
},
"enabled": {
"description": "Enable or disable the queue",
"type": "boolean"
},
"name": {
"description": "New display name for the queue",
"type": "string"
},
"queueId": {
"description": "ID of the queue to update",
"type": "integer"
},
"recommendedLabels": {
"description": "Labels to recommend for this queue and use as fallback appeal routing mappings",
"items": {
"type": "string"
},
"type": "array"
},
"recommendedPolicies": {
"description": "Policy keys to recommend when actioning reports in this queue",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"queueId"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"queue": {
"ref": "tools.ozone.queue.defs#queueView",
"type": "ref"
}
},
"required": [
"queue"
],
"type": "object"
}
},
"type": "procedure"
}