Send Requests

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

URL Structure

Here's the URL structure for the requests:

https://hostname:port/pdc/resourcePath
where:
  • hostname is the URL for the PDC REST API server.
  • port is the port for the PDC REST API server.
  • resourcePath is the path to the endpoint, such as pricing.
For example, the URL for creating a pricing object is: 
https://hostname:port/pdc/pricing

Supported Methods

You can perform create and read operations on a resource using standard HTTP/HTTPS method requests. This table shows the supported methods.

HTTP Method Description
GET Retrieve information about the resource.
POST Create the resource.
DELETE Delete the resource.
PUT Update the entire resource, replacing the original.
PATCH Update a specific part of the resource.

Media Types

The PDC REST API supports the following media types:

  • application/json

Supported Headers

The PDC 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

If the system contains more than 14 usage consumption report objects, the response includes objects 10 through 14 and displays the values of 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 consist of five results from the first schema followed by five from the second schema.