Update an overflow queue
patch
/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues/{QueueResourceId}
Request
Path Parameters
-
QueueId(required): integer(int64)
The unique identifier of the queue.
-
QueueResourceId(required): integer(int64)
The unique identifier of the overflow queue resource.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the overflow queue resource is enabled. If enabled, the value is Y, else the value is N. -
Priority: integer
Title:
Priority
The priority of the overflow queue resource. -
QueueResourceId: integer
(int64)
Title:
Queue Resource ID
The unique identifier of the overflow queue resource.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : queues-overflowQueues-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the overflow queue resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the overflow queue resource was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the overflow queue can be deleted. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the overflow queue resource is enabled. If enabled, the value is Y, else the value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the overflow queue resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the overflow queue resource. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login associated with the user who last updated the overflow queue resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Resource Member ID
The unique identifier of the overflow queue added as queue resource. -
ObjectTypeCd: string
Title:
Queue ResourceType
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_OVERFLOW_QUEUE
The code indicating whether the queue resource is an individual, a team, or an overflow queue. -
OverflowQueueId: integer
(int64)
Title:
Overflow Queue ID
Read Only:true
The unique identifier of the overflow queue associated with the queue. -
OverflowQueueName: string
Title:
Overflow Queue Name
Read Only:true
Maximum Length:400
The name of the overflow queue. -
OverflowQueueNumber: string
Title:
Overflow Queue Number
Read Only:true
Maximum Length:30
The public unique identifier of the overflow queue associated with the queue. -
OverflowQueueStripeCd: string
Title:
Overflow Queue Stripe Code
Read Only:true
Maximum Length:30
The code indicating the application context of the overflow queue. -
Priority: integer
Title:
Priority
The priority of the overflow queue resource. -
QueueId: integer
(int64)
Title:
Queue ID
The unique identifier of the queue. -
QueueName: string
Title:
Queue Name
Read Only:true
Maximum Length:400
The name of the queue to which this overflow queue is associated. -
QueueNumber: string
Title:
Queue Number
Read Only:true
Maximum Length:30
The public unique identifier of the queue to which this overflow queue is associated. -
QueueResourceId: integer
(int64)
Title:
Queue Resource ID
The unique identifier of the overflow queue resource. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the overflow queue can be updated. The default value is true.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ObjectTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_Q_RES_OBJ_TYPE_CD
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder: