Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(1)
Bucket Intervals
Downloads: This chapterpdf (PDF - 428.0KB) The complete bookPDF (PDF - 1.09MB) | Feedback

Bucket Intervals

Bucket Intervals

You can use the Bucket Intervals API to add new Bucket Intervals, edit the name of an existing Bucket Interval, get a list of all of the configured Bucket Intervals, and delete existing Bucket Intervals.

This API is represented on the User Interface by the Bucket Intervals Gadget.

This section explains the five supported API operations for Bucket Intervals and their parameters.

Bucket Intervals list

Retrieves a list of Bucket Intervals.

Syntax

URL: https://<server>/unifiedconfig/config/bucketinterval

HTTP Method: GET

XML request payload

<results>
<pageInfo>
....
</pageInfo>
<bucketIntervals>
<bucketInterval>...</bucketInterval>
<bucketInterval>...</bucketInterval>
</bucketIntervals>
</results>

Note


The example above does not show all of the data for pagination.

See Pagination.

See General Usage.


Bucket Intervals create

Creates a Bucket Interval to be stored in the database.

Syntax

URL: https://<server>/unifiedconfig/config/bucketinterval

HTTP Method: POST

Input/Output format

xml

Response

In the response, the Location header has a URL link to the newly created Bucket Interval, if successful.

See also General Usage.

Table 1 Parameters
Bucket Interval parameters Data type Description

name

String

The name of the Bucket Interval. Must be unique. The name is the only field that can be modified.

upperBound1

Integer

The first Bucket Interval value.

upperBound2

Integer

The next Bucket Interval value. Must be greater than upperBound1.

upperBound3

Integer

The next Bucket Interval value. Must be greater than upperBound2.

upperBound4

Integer

The next Bucket Interval value. Must be greater than upperBound3.

upperBound5

Integer

The next Bucket Interval value. Must be greater than upperBound4.

upperBound6

Integer

The next Bucket Interval value. Must be greater than upperBound5.

upperBound7

Integer

The next Bucket Interval value. Must be greater than upperBound6.

upperBound8

Integer

The next Bucket Interval value. Must be greater than upperBound7.

upperBound9

Integer

The next Bucket Interval value. Must be greater than upperBound8.

changeStamp

Integer

The change stamp of the Bucket Interval record, which is returned in GET.

override

True/False

If this is set to true, then remove Call Type references and mark Bucket Interval as deleted.

Operation validation

Name

  • Required field.
  • Max length of 32 characters allowed.
  • Valid characters are period (.), underscore (_), and alphanumeric. The first character must be alphanumeric.
  • Does not allow internationalized characters.

upperBound1

  • Required field.
  • Must be greater than zero.
  • Absolute value of integer must range from 0 to 2147483647.

upperBound2

  • Optional field.
  • Must be greater than the previous upperBound field or be left blank. Once one upperBound field is left blank, all remaining upperBound fields must also be blank.
  • Absolute value of integer must range from 0 to 2147483647.

Note


The upperBound fields 3-9 have the same restrictions as upperBound2, above.


XML request payload

<bucketInterval>
    <name>test</name>
    <upperBound1>10</upperBound1>
    <upperBound2>20</upperBound2>
    <upperBound3>30</upperBound3>
    <upperBound4>40</upperBound4>
    <upperBound5>50</upperBound5>
    <upperBound6>60</upperBound6>
    <upperBound7>70</upperBound7>
    <upperBound8>80</upperBound8>
    <upperBound9>90</upperBound9>
  </bucketInterval>

Bucket Intervals get

Returns one Bucket Interval from the database.

Syntax

URL: https://<server>/unifiedconfig/config/bucketinterval/<id>

HTTP Method: GET

Response

See General Usage.

Bucket Intervals update

Updates one Bucket Interval in the database.


Note


You can only change the Bucket Interval's name.


Syntax

URL: https://<server>/unifiedconfig/config/bucketinterval/<id>

HTTP Method: PUT

Input/Output format

xml

Response

See also General Usage.

Table 2 Parameters
Bucket Interval parameters Data type Description

name

String

The name of the Bucket Interval. Must be unique. The name is the only field that can be modified.

upperBound1

Integer

The first Bucket Interval value.

upperBound2

Integer

The next Bucket Interval value. Must be greater than upperBound1.

upperBound3

Integer

The next Bucket Interval value. Must be greater than upperBound2.

upperBound4

Integer

The next Bucket Interval value. Must be greater than upperBound3.

upperBound5

Integer

The next Bucket Interval value. Must be greater than upperBound4.

upperBound6

Integer

The next Bucket Interval value. Must be greater than upperBound5.

upperBound7

Integer

The next Bucket Interval value. Must be greater than upperBound6.

upperBound8

Integer

The next Bucket Interval value. Must be greater than upperBound7.

upperBound9

Integer

The next Bucket Interval value. Must be greater than upperBound8.

changeStamp

Integer

The change stamp of the Bucket Interval record, which is returned in GET.

override

True/False

If this is set to true, then remove Call Type references and mark Bucket Interval as deleted.

Operation validation

Name

  • Optional field.
  • Max length of 32 characters allowed.
  • Valid characters are period (.), underscore (_), and alphanumeric. The first character must be alphanumeric.
  • Does not allow internationalized characters.

Note


In the Update operation, Name is the only field that you can edit. The upperBound fields 1-9 are not editable.


changeStamp

  • Required field.

XML request payload

<bucketInterval>
    <name>test</name>
    <changeStamp>0</changeStamp>
</bucketInterval>

Bucket Intervals delete

Deletes one Bucket Interval from the database. If the Bucket Interval is referenced by a Call Type, then an API Warning will be returned. You can override this warning by passing an override=true query parameter. By default this is set to false.

If override is set to true, then all Call Type references to the record will be unlinked first, then the Bucket Interval will be marked as deleted.


Note


The above setting only marks the record for deletion, it does not permanently delete the Bucket Interval.


Syntax

URL: https://<server>/unifiedconfig/config/bucketinterval/<id>/

HTTP Method: DELETE

Response

If override=true, see General Usage.

If override=false or if override is not passed and there are Call Type references: see General Usage.

Table 3 Parameters
Bucket Interval parameters Data type Description

name

String

The name of the Bucket Interval. Must be unique. The name is the only field that can be modified.

upperBound1

Integer

The first Bucket Interval value.

upperBound2

Integer

The next Bucket Interval value. Must be greater than upperBound1.

upperBound3

Integer

The next Bucket Interval value. Must be greater than upperBound2.

upperBound4

Integer

The next Bucket Interval value. Must be greater than upperBound3.

upperBound5

Integer

The next Bucket Interval value. Must be greater than upperBound4.

upperBound6

Integer

The next Bucket Interval value. Must be greater than upperBound5.

upperBound7

Integer

The next Bucket Interval value. Must be greater than upperBound6.

upperBound8

Integer

The next Bucket Interval value. Must be greater than upperBound7.

upperBound9

Integer

The next Bucket Interval value. Must be greater than upperBound8.

changeStamp

Integer

The change stamp of the Bucket Interval record, which is returned in GET.

override

True/False

If this is set to true, then remove Call Type references and mark Bucket Interval as deleted.