Get all overflow queues
get
/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues
Request
Path Parameters
-
QueueId(required): integer(int64)
The unique identifier of the queue.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds an overflow queue by the specificied primary key.
Finder Variables:- QueueResourceId; integer; The unique identifier of the overflow queue resource.
- QueueOverflowAltKeyFinder: Finds the overflow queue with the given public unique identifier but only if it is associated with the queue identified by the given public unique identifier.
Finder Variables:- OverflowQueueNumber; string.
- QueueNumber; string.
- PrimaryKey: Finds an overflow queue by the specificied primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the overflow queue resource.
- CreationDate; string; The date and time when the overflow queue resource was created.
- EnabledFlag; boolean; Indicates whether the overflow queue resource is enabled. If enabled, the value is Y, else the value is N.
- LastUpdateDate; string; The date and time when the overflow queue resource was last updated.
- LastUpdateLogin; string; The application login associated with the user who last updated the overflow queue resource.
- LastUpdatedBy; string; The user who last updated the overflow queue resource.
- ObjectId; integer; The unique identifier of the overflow queue added as queue resource.
- ObjectTypeCd; string; The code indicating whether the queue resource is an individual, a team, or an overflow queue.
- OverflowQueueId; integer; The unique identifier of the overflow queue associated with the queue.
- OverflowQueueName; string; The name of the overflow queue.
- OverflowQueueNumber; string; The public unique identifier of the overflow queue associated with the queue.
- OverflowQueueStripeCd; string; The code indicating the application context of the overflow queue.
- Priority; integer; The priority of the overflow queue resource.
- QueueId; integer; The unique identifier of the queue.
- QueueName; string; The name of the queue to which this overflow queue is associated.
- QueueNumber; string; The public unique identifier of the queue to which this overflow queue is associated.
- QueueResourceId; integer; The unique identifier of the overflow queue resource.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.