Bucket Intervals - Cisco Bucket Intervals...

download Bucket Intervals - Cisco Bucket Intervals YoucanusetheBucketIntervalsAPItoaddnewBucketIntervals,editthenameofanexistingBucket

of 8

  • date post

    19-Feb-2020
  • Category

    Documents

  • view

    4
  • download

    0

Embed Size (px)

Transcript of Bucket Intervals - Cisco 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, 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:///unifiedconfig/config/bucketinterval

    HTTP Method: GET

    XML Request Payload

    ....

    ... ...

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

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

    See Pagination.

    See General Usage.

    Note

    Bucket Intervals Create Creates a Bucket Interval to be stored in the database.

    Syntax

    URL: https:///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 than upperBound1.

    IntegerupperBound2

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

    IntegerupperBound3

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

    IntegerupperBound4

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

    IntegerupperBound5

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

    IntegerupperBound6

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

    Bucket Intervals Bucket Intervals Create

    UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_8 UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7 UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7

  • DescriptionData typeBucket Interval parameters

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

    IntegerupperBound7

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

    IntegerupperBound8

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

    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 references and 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 left blank, 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

    test

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

    Bucket Intervals Bucket Intervals Create

  • 10 20 30 40 50 60 70 80 90

    Bucket Intervals Get Returns one Bucket Interval from the database.

    Syntax

    URL: https:///unifiedconfig/config/bucketinterval/

    HTTP Method: GET

    Response

    See General Usage.

    Bucket Intervals Update Updates one Bucket Interval in the database.

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

    Syntax

    URL: https:///unifiedconfig/config/bucketinterval/

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

    UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7 UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7

  • DescriptionData typeBucket Interval parameters

    The first Bucket Interval value.IntegerupperBound1

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

    IntegerupperBound2

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

    IntegerupperBound3

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

    IntegerupperBound4

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

    IntegerupperBound5

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

    IntegerupperBound6

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

    IntegerupperBound7

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

    IntegerupperBound8

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

    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 references and 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 not editable.

    Note

    changeStamp

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

    Bucket Intervals Bucket Intervals Update

  • • Required field.

    XML Request Payload

    test 0

    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.

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

    Syntax

    URL: https:///unifiedconfig/config/bucketinterval//

    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 than upperBound1.

    IntegerupperBound2

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

    IntegerupperBound3

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

    IntegerupperBound4

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

    Bucket Intervals Bucket Intervals Delete

    UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7 UCCE_BK_CC46AA7C_00_developers-guide_chapter_00.pdf#unique_7

  • DescriptionData typeBucket Interval parameters

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

    IntegerupperBound5

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

    IntegerupperBound6

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

    IntegerupperBound7

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

    IntegerupperBound8

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

    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 references and mark Bucket Interval as deleted.

    True/Falseoverride

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

    Bucket Intervals Bucket Intervals Delete

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

    Bucket Intervals Bucket Intervals Delete

    Bucket Intervals Bucket