Jump to

• Request
• Response

Create an overflow queue

post

/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues

Request

Path Parameters

• QueueId(required): integer(int64)
  The unique identifier of the queue.

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• ObjectId: integer (int64)
  Title: Resource Member ID

  The unique identifier of the overflow queue added as queue resource.
• Priority: integer
  Title: Priority

  The priority of the overflow queue resource.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the queue.
• QueueResourceId: integer (int64)
  Title: Queue Resource ID

  The unique identifier of the overflow queue resource.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
            }
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the overflow queue resource.",
            "nullable":false
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the overflow queue can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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