| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
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:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
life_cycle_state (optional) | String | If specified then only usage service catalogs having a life cycle state equal to the specified value will be retrieved. The supported values are DRAFT, EFFECTIVE, NOT_EFFECTIVE or CANCELLED | ||||||
valid_as_of_date (optional) | Date | If specified then only usage service catalogs which are valid on that date will be retrieved. | ||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage service catalog. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage service catalog. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
valid_as_of_date (mandatory) | Date | If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. | ||||||
usage_service_catalog_identifier (optional) | Usage Service Catalog Identifier | If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:
| ||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
valid_as_of_date (mandatory) | Date | If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. | ||||||
usage_service_identifier (semi-optional) | Usage Service Identifier | If specified then only usage services rates related with the specified usage service will be retrieved. The allowed usage service identifier fields are the following:
| ||||||
usage_service_catalog_identifier (semi-optional) | Usage Service Catalog Identifier | If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:
| ||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
| ||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...
Parameters
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name (mandatory) | String | The Name of the usage service catalog | ||||||
alternative_code (mandatory) | String | The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name | ||||||
description (optional) | String | The Description of the usage service catalog | ||||||
termed_service_requirements (mandatory) | String | Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:
| ||||||
create_as_draft (optional) | Boolean | If set to true then the usage service catalog will be created as draft. If set to false or not specified at all, then the usage service catalog will be created as effective | ||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | The provisioning provider related with the usage service catalog that will be created. The allowed provisioning provider identifier fields are the following:
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
(optional) | Set of Usage Service Catalog Validity Objects | The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available | ||||||
(mandatory) | Set of Usage Service Catalog Usage Services | The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified. |
...
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
usage_service_catalog_identifier (mandatory) | Usage Service Catalog Identifier | The usage service catalog that will be updated. The allowed usage service catalog identifier fields are the following:
| ||||||
name (optional) | String | The Name of the usage service catalog | ||||||
alternative_code (optional) | String | The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name | ||||||
description (optional) | String | The Description of the usage service catalog | ||||||
termed_service_requirements (mandatory) | String | Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:
| ||||||
| Boolean | If set to true then the usage service catalog will be updated as draft. If set to false or not specified at all, then the usage service catalog will be updated as effective. This is applicable only if the usage service catalog that will be updated is in draft life cycle state | |||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | The provisioning provider related with the usage service catalog that will be updated. The allowed provisioning provider identifier fields are the following:
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
(optional) | Set of Usage Service Catalog Validity Objects | The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available
| ||||||
(mandatory) | Set of Usage Service Catalog Usage Services | The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified.
Note that usage services already included in a usage service catalog can be removed only if the usage service catalog is still draft, or if the usage service catalog is effective or not effective and there are no usage subscription services which are posted, billable and still not billed |
...
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:
| ||||||
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 |
...
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:
| ||||||
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 |
...
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:
| ||||||
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 |
...