Get Transition Types
get
/bcws/webresources/v1.0/subscriptions/transitiontypes
Gets the list of transition types.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The list of transition types was returned successfully.
Root Schema : configurations
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
flags(required): array
flags
A flag.
-
keyvals(required): array
keyvals
A set of key-value pairs.
-
mapping(required): array
mapping
A mapping.
-
thresholds(required): array
thresholds
A threshold. The minimum required parameters are: key and value.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : keyvals
Type:
array
A set of key-value pairs.
Show Source
-
Array of:
object Keyvals
A set of key-value pairs.
Nested Schema : thresholds
Type:
array
A threshold. The minimum required parameters are: key and value.
Show Source
-
Array of:
object Thresholds
A threshold. The minimum required parameters are: key and value.
Nested Schema : Flags
Type:
object
A flag.
Show Source
-
desc(required): string
A description of the flag.
-
key(required): string
The name of the flag.
-
value: boolean
The value associated with the flag, which can be true or false.
-
version: string
The version of the flag.
Nested Schema : Keyvals
Type:
object
A set of key-value pairs.
Show Source
-
desc(required): string
The key-value pair's description.
-
key(required): string
The key name.
-
value(required): string
The value.
-
version: string
The version of the key-value pair.
Nested Schema : Mapping
Type:
object
A mapping.
Show Source
-
desc(required): string
The mapping's description.
-
key(required): string
The mapping's key.
-
map(required): array
map
A map.
-
version: string
The version of the mapping.
Nested Schema : Map
Type:
object
A map.
Show Source
-
id(required): string
The map ID.
-
key(required): string
The key.
Nested Schema : Thresholds
Type:
object
A threshold. The minimum required parameters are: key and value.
Show Source
-
desc(required): string
The description of the threshold.
-
key(required): string
Unique name for configuration acting as an upper limit for pagination size, number of records to fetch, timeouts, etc.
-
value: integer
(int32)
The threshold value.
-
version: string
The version of the threshold.
500 Response
An internal server error occurred.
Examples
This example shows how to get the transition types by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/subscriptions/transitiontypes'
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"extension": null,
"keyvals": [
{
"key": "1",
"value": "Upgrade",
"desc": "Add services and a bundle.",
"version": "1.0"
},
{
"key": "2",
"value": "Downgrade",
"desc": "Downgrade to a package that is less expensive and has fewer features.",
"version": "1.0"
},
],
"flags": [],
"thresholds": [],
"mapping": []
}