Versions Compared

Key

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


NameType Description
idStringThe ID of the retrieved usage service catalog
nameStringThe Name of the retrieved usage service catalog
alternative_codeStringThe Alternative Code of the retrieved usage service catalog
descriptionStringThe Description of the retrieved usage service catalog
termed_service_requirementsString

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
Tip

Available from CRM.COM R13.0.0

From CRM.COM R14.0.0, DOES_NOT_REQ_TERMED_SERVICE value is not supported

Deprecated from CRM.COM R15.0.0


installed_item_requirementsString

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
Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R15.0.0


life_cycle_stateString

The life cycle state of the retrieved usage service catalog. The supported life cycle states are the following:

DRAFT, EFFECTIVE, NOT_EFFECTIVE, CANCELLED

Tip

From CRM.COM R15.0.0, CANCELLED is deprecated


effective_date



Date

The Effective Date of the retrieved usage service catalog

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0


expiration_dateDate

The Expiration Date of the retrieved usage service catalog

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0


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

provisioning_providerProvisioning Provider Object

The provisioning provider related with the retrieved usage service catalog

Tip

Deprecated from CRM.COM R15.0.0


log_informationLog Information ObjectThe log information of the retrieved usage service catalog
validity_setSet of Usage Service Catalog Validity ObjectsThe  time periods during which the retrieved usage service catalog is available to be used.
validity_period_setSet of Usage Service Catalog Validity Period Objects

The  time periods during which the retrieved usage service catalog is available to be used

Tip

Available from CRM.COM R17.0.0


Anchor
usage service catalog type referred objects
usage service catalog type referred objects
Referred Objects Response Data

...

Include Page
log_information_short
log_information_short

Include Page
usage_service_catalog_validity_short
usage_service_catalog_validity_short

Include Page
usage_service_catalog_validity_period_short
usage_service_catalog_validity_period_short