Jump to

• Request
• Response

Get an overflow queue

get

/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.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : queues-overflowQueues-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the overflow queue resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the overflow queue resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the overflow queue resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverflowQueueStripeCd":{
            "title":"Overflow Queue Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application context of the overflow queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Resource Member ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue added as queue resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the overflow queue resource.",
            "nullable":false,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverflowQueueName":{
            "title":"Overflow Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the overflow queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverflowQueueNumber":{
            "title":"Overflow Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the overflow queue associated with the queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the overflow queue can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the overflow queue can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the queue to which this overflow queue is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Queue ResourceType",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the queue resource is an individual, a team, or an overflow queue.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OVERFLOW_QUEUE",
            "x-queryable":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OverflowQueueId":{
            "title":"Overflow Queue ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue associated with the queue.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the overflow queue resource is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue to which this overflow queue is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the overflow queue resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The application login associated with the user who last updated the overflow queue resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ObjectTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

Back to Top