You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 11
Next »
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved usage service catalog |
| name | String | The Name of the retrieved usage service catalog |
| alternative_code | String | The Alternative Code of the retrieved usage service catalog |
| description | String | The Description of the retrieved usage service catalog |
| termed_service_requirements | String | The settings related to whether a termed service will be required when adding a Usage Service on a Subscription. The supported values are the following: - REQ_EFFECTIVE_TERMED_SERVICE
- REQ_EFF_NOT_EFF_TERMED_SERVICE
- DOES_NOT_REQ_TERMED_SERVICE
|
| installed_item_requirements | String | The settings related to whether an installed item will be required when adding a Usage Service on a Subscription. The supported values are the following: - REQUIRES_INSTALLED_ITEM
- DOES_NOT_REQ_INSTALLED_ITEM
|
| life_cycle_state | String | The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED |
| effective_date | Date | The Effective Date of the retrieved usage service catalog
|
| expiration_date | Date | The Expiration Date of the retrieved usage service catalog |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| currency | Currency Object | The currency of the retrieved usage service catalog |
| provisioning_provider | Provisioning Provider Object | The provisioning provider related with the retrieved usage service catalog |
| log_information | Log Information Object | The log information of the retrieved usage service catalog |
| validity_set | Set of Usage Service Catalog Validity Objects | The time periods during which the retrieved usage service catalog is available to be used. |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
provisioning_provider object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved provisioning provider |
name | String | The name of the retrieved provisioning provider |
alternative_code | String | The alternative code of the retrieved provisioning provider |
| description | String | The description of the retrieved provisioning providers |
| provisioning_protocol | String | The provisioning protocol used by the provisioning provider |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
usage_service_catalog_validity object data response
| Name | Type | Description |
|---|
| id | String | The id of the usage service catalog validity entry |
valid_from | Date | The date that the usage service catalog should become valid |
| valid_to | Date | The date that the usage service catalog should become invalid. This is optional as a usage service catalog can be valid for ever, starting from a specific date |