Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R8.0.0

From CRM.COM R14.0.0, by each call all versions that are related with the usage service catalog will be updated and the response will retrieve the current version that is canceled

Deprecated from CRM.COM R15.0.0


Excerpt

This method is used to cancel a specific usage service catalog. This method is applicable only on draft, effective or not effective usage service catalogs, having no related usage detail records which are posted, billable and still not billed. Only one usage service catalog can be cancelled on each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:

Include Page
V4:usage_service_catalog_identifier
V4:usage_service_catalog_identifier

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "token":"A379559ECE1E49EFA893754C5322E8F3",
        "usage_service_catalog_identifier":{"name":"Api Test"}
} 

 

 



Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "provisioning_provider":
        {
            "provisioning_protocol": "EXSET_SMS_SERVICES",
            "id": "1007A2DB26CF47E396E210FE85EFF839",
            "name": "Exset",
            "description": "Exset
Oracle XE 10.2",
            "alternative_code": "XE"
        },
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_date_1": "2015-05-05T15:49:59",
        "udf_float_3": 30,
        "udf_date_2": "2015-06-05T15:49:59",
        "udf_float_4": 40,
        "udf_date_3": "2015-07-05T15:49:59",
        "udf_date_4": "2015-08-05T15:49:59",
        "name": "Api Test",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "log_information":
        {
            "updated_date": "2015-09-21T10:44:41",
            "created_date": "2015-09-21T09:10:38",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "validity_set":
        [
            {
                "id": "B0877AAA6DC445D4A2AD2B6859D6E819",
                "valid_from": "2015-10-01T15:49:59",
                "valid_to": null
            },
            {
                "id": "2F7C5A2305984D1A89D2BA6518896523",
                "valid_from": "2015-09-19T15:49:59",
                "valid_to": "2015-09-30T15:49:59"
            }
        ],
        "life_cycle_state": "CANCELLED",
        "id": "9F9CF9074DB2406B994DD34EEAF44BA5",
        "description": "Test Update From Api",
        "alternative_code": "A_T"
    }
} 


...