| Tip |
|---|
| Excerpt |
|---|
This method returns the usage service catalogs that are allowed to be used in the system. Multiple usage service catalogs are returned by each call |
...
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:
| currency_identifier (optional) | Currency Identifier | The identifier of the currency of the retrieved Usage Service Catalog. The available currency identifier fields are the following:
Tip | | ||||||||||||
| 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 |
...