8
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, page 1 Bucket Intervals Create, page 2 Bucket Intervals Get, page 4 Bucket Intervals Update, page 4 Bucket Intervals Delete, page 6 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> Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x) 0 1

Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

  • Upload
    others

  • View
    14

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

Bucket Intervals

You can use the Bucket Intervals API to add new Bucket Intervals, edit the name of an existing BucketInterval, 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, page 1

• Bucket Intervals Create, page 2

• Bucket Intervals Get, page 4

• Bucket Intervals Update, page 4

• Bucket Intervals Delete, page 6

Bucket Intervals ListRetrieves 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>

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x) 0 1

Page 2: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

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

See Pagination.

See General Usage.

Note

Bucket Intervals CreateCreates 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

DescriptionData typeBucket Interval parameters

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

Stringname

The first Bucket Interval value.IntegerupperBound1

The next Bucket Interval value. Must be greater thanupperBound1.

IntegerupperBound2

The next Bucket Interval value. Must be greater thanupperBound2.

IntegerupperBound3

The next Bucket Interval value. Must be greater thanupperBound3.

IntegerupperBound4

The next Bucket Interval value. Must be greater thanupperBound4.

IntegerupperBound5

The next Bucket Interval value. Must be greater thanupperBound5.

IntegerupperBound6

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x)2 0

Bucket IntervalsBucket Intervals Create

Page 3: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

DescriptionData typeBucket Interval parameters

The next Bucket Interval value. Must be greater thanupperBound6.

IntegerupperBound7

The next Bucket Interval value. Must be greater thanupperBound7.

IntegerupperBound8

The next Bucket Interval value. Must be greater thanupperBound8.

IntegerupperBound9

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

IntegerchangeStamp

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

True/Falseoverride

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 leftblank, all remaining upperBound fields must also be blank.

• Absolute value of integer must range from 0 to 2147483647.

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

XML Request Payload

<bucketInterval><name>test</name>

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x) 0 3

Bucket IntervalsBucket Intervals Create

Page 4: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

<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 GetReturns one Bucket Interval from the database.

Syntax

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

HTTP Method: GET

Response

See General Usage.

Bucket Intervals UpdateUpdates one Bucket Interval in the database.

You can only change the Bucket Interval's name.Note

Syntax

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

HTTP Method: PUT

Input/Output Format

xml

Response

See also General Usage.

Table 2: Parameters

DescriptionData typeBucket Interval parameters

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

Stringname

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x)4 0

Bucket IntervalsBucket Intervals Get

Page 5: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

DescriptionData typeBucket Interval parameters

The first Bucket Interval value.IntegerupperBound1

The next Bucket Interval value. Must be greater thanupperBound1.

IntegerupperBound2

The next Bucket Interval value. Must be greater thanupperBound2.

IntegerupperBound3

The next Bucket Interval value. Must be greater thanupperBound3.

IntegerupperBound4

The next Bucket Interval value. Must be greater thanupperBound4.

IntegerupperBound5

The next Bucket Interval value. Must be greater thanupperBound5.

IntegerupperBound6

The next Bucket Interval value. Must be greater thanupperBound6.

IntegerupperBound7

The next Bucket Interval value. Must be greater thanupperBound7.

IntegerupperBound8

The next Bucket Interval value. Must be greater thanupperBound8.

IntegerupperBound9

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

IntegerchangeStamp

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

True/Falseoverride

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.

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

Note

changeStamp

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x) 0 5

Bucket IntervalsBucket Intervals Update

Page 6: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

• Required field.

XML Request Payload

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

</bucketInterval>

Bucket Intervals DeleteDeletes one Bucket Interval from the database. If the Bucket Interval is referenced by a Call Type, then anAPI 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 BucketInterval will be marked as deleted.

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

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

DescriptionData typeBucket Interval parameters

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

Stringname

The first Bucket Interval value.IntegerupperBound1

The next Bucket Interval value. Must be greater thanupperBound1.

IntegerupperBound2

The next Bucket Interval value. Must be greater thanupperBound2.

IntegerupperBound3

The next Bucket Interval value. Must be greater thanupperBound3.

IntegerupperBound4

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x)6 0

Bucket IntervalsBucket Intervals Delete

Page 7: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

DescriptionData typeBucket Interval parameters

The next Bucket Interval value. Must be greater thanupperBound4.

IntegerupperBound5

The next Bucket Interval value. Must be greater thanupperBound5.

IntegerupperBound6

The next Bucket Interval value. Must be greater thanupperBound6.

IntegerupperBound7

The next Bucket Interval value. Must be greater thanupperBound7.

IntegerupperBound8

The next Bucket Interval value. Must be greater thanupperBound8.

IntegerupperBound9

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

IntegerchangeStamp

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

True/Falseoverride

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x) 0 7

Bucket IntervalsBucket Intervals Delete

Page 8: Bucket Intervals - Cisco · Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket Interval,getalistofalloftheconfiguredBucketIntervals

Cisco Unified Contact Center Enterprise Developers Guide Release 9.0(x)8 0

Bucket IntervalsBucket Intervals Delete