REST Services Manager API for Billing and Revenue Management

Retrieve Endpoint Metadata

You can retrieve the metadata for a BRM REST Services Manager endpoint by using the describe API.

The following sections show some sample describe requests that you can submit to retrieve metadata for an endpoint in each TMF API.

Note:

Security is not enabled for describe endpoints because it returns only the specification information.

To retrieve the specifications, use a browser to send this HTTP/HTTPS request:

https://hostname:port/brm/apiType/version/resourceType/describe?@type=baseOrExtendedType

where:

hostname and port are the URL and port for your BRM REST Services Manager server.
apiType, version, and resourceType are the specific to each API:
- For Account Management (TMF666), use accountManagement/v4/billingAccount.
- For Customer Bill Management (TMF678), use customerBillManagement/v4/customerBill.
- For Payment Management (TMF676), use payment/v4/payment.
- For Payment Method Management (TMF670), use paymentMethods/v1/paymentMethod.
- For Prepay Balance Management (TMF654), use prepayBalanceManagement/v4/accumulatedBalance.
- For Usage Management (TMF635), use usageManagement/v4/usage.
- For Billing Fulfillment, use orderBillFulfillment/v1/createFulfillBilling.
baseOrExtendedType determines whether you retrieve the base TMF specification, or the extended Oracle TMF specification. Use the following values:
- For Account Management, use BillingAccount or BillingAccountOracle.
- For Customer Bill Management, use CustomerBill or CustomerBillOracle.
- For Payment Management, use Payment or PaymentOracle.
- For Payment Method Management, use PaymentMethod or PaymentMethodOracle.
- For Prepay Balance Management, use AccumulatedBalance or AccumulatedBalanceOracle.
- For Usage Management, use Usage UsageOracle.
If you submit the request without the @type parameter, the base TMF specification is returned.

For example, the following request retrieves the extended Oracle TMF specification for the Prepay Balance Management API:

https://hostname:port/brm/prepayBalanceManagement/v4/accumulatedBalance/describe?@type=AccumulatedBalanceOracle