Send Requests

Use these guidelines when sending requests using the PDC TMF 620 REST API.

URL Structure

Here's the URL structure for the requests:

https://hostnameport:/apiType/version/resourcePath

where:

• hostname is the URL for the PDC TMF 620 REST API server.
• port is the port for the PDC TMF 620 REST API server.
• apiType and version are the type and version of the API. For PDC TMF 620 REST API, they are productCatalogManagement and Version 4.
• resourcePath is the path to the endpoint.

For example, the URL for updating the product offering price is:

http://hostname:port/productCatalogManagement/v4/productOfferingPrice/{id}

Supported Methods

You can perform create and read operations on a resource by using standard HTTP/HTTPS method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieve information about the resource.
POST	Create the resource.
DELETE	Delete the resource.
PATCH	Partially update the resource.

Media Types

The following media types are supported by the PDC TMF 620 REST API:

• application/json

Supported Headers

The PDC TMF 620 REST API supports the following headers that may be passed in the header section of the HTTP/HTTPS request or response:

Header	Description	Example
Content-Type	Media type of the request body. This is required for POST and PUT requests.	Content-Type: application/json

Common Query Parameters

You can use the following common query parameters to limit the results returned by PDC TMF 620 REST API GET requests:

• fields: The properties to show values for in the response. Used in all GET requests. The possible values for this parameter depend on the resource being requested. All properties of the resource will still appear in the response, but their values will be null. Depending on the endpoint, values for some required properties, such as IDs, will appear regardless of this parameter.

For example, a cURL request submitted to the Get Product Offering endpoint using all three of the above query parameters would look like this:

curl -X GET 'http://host:port/productCatalogManagement/v4/productOffering/OnetimeOfferRef'

If there were more than 14 usage consumption report objects in the system, the response would include objects 10 through 14, and show the values for the id and href fields.

Note:

If you submit a request to a multischema BRM system, the response includes results from each schema. In the example above, in a two-schema system, the response would include five results from the first schema followed by five from the second schema.