Quick Start

Set up your environment and then use the PDC TMF 620 REST API to make your first API call by performing these tasks:

Prerequisites

Prerequisite	More Information
Install Pricing Design Center	"Installing Pricing Design Center" in PDC Installation Guide
Install cURL	Use cURL

Send a Request

After you set up your REST client, you can send a request to ensure that your connection works. For example, to retrieve all product specifications in your system, you can use the following request:

curl -X GET 'http://hostname:port/productCatalogManagement/v4/productSpecification'

where:

• hostname is the URL for the PDC REST server.

• port is the port for the PDC REST server.

If the request is successful, you should receive response code 200 along with a response body similar to the following:

{
    "atType": "ProductSpecificationOracle",
    "href": "/productCatalogManagement/v4/productSpecification/Charge-offer-PSC-Template",
    "id": "Charge-offer-PSC-Template",
    "lastUpdate": "2023-06-05T15:29:23.136+05:30",
    "lifecycleStatus": "Active",
    "name": "Charge-offer-PSC-Template",
    "pricingType": "CHARGE_OFFERING",
    "productSpecCharacteristic": [
        {
            "atType": "ProductSpecificationCharacteristicsOracle",
            "cardinality": "MULTIPLE",
            "name": "Type",
            "productSpecCharacteristicValue": [
                {
                    "values": "Max"
                },
                {
                    "values": "Basic"
                }
            ],
            "valueType": "ANY"
        },
        {
            "atType": "ProductSpecificationCharacteristicsOracle",
            "cardinality": "SINGLE",
            "name": "Effective Date",
            "valueType": "DATE"
        },
        {
            "atType": "ProductSpecificationCharacteristicsOracle",
            "cardinality": "MULTIPLE",
            "name": "Allowed Locations",
            "productSpecCharacteristicValue": [
                {
                    "values": "ASIA"
                },
                {
                    "values": "USA"
                },
                {
                    "values": "Africa"
                },
                {
                    "values": "Pakistan"
                }
            ],
            "valueType": "ANY"
        }
    ]
},
{
    "@type": "ProductSpecificationOracle",
    "description": "ProductSpecDetails",
    "id":"Charge-offer-PSC-Template",
    "name": "Charge-offer-PSC-Template",
    "href":"/productCatalogManagement/v4/productSpecification/Charge-offer-PSC-Template",
    "lifecycleStatus":"Active",
    "lastUpdate": "2023-06-05T14:10:23.696+05:30",
    "pricingType": "ALTERATION_OFFERING",
    "productSpecCharacteristic": [
        {
            "@type": "ProductSpecificationCharacteristicOracle",
            "name": "Type",
            "valueType": "ANY",
            "productSpecCharacteristicValue": [
                {
                    "values": "Max"
                },
                {
                    "values": "Basic"
                }
            ],
            "cardinality": "MULTIPLE"
        },
        {
            "@type": "ProductSpecificationCharacteristicOracle",
            "name": "Effective Date",
            "valueType": "DATE",
            "productSpecCharacteristicValue": [
                  
            ],
            "cardinality": "SINGLE"
        },
        {
            "@type": "ProductSpecificationCharacteristicOracle",
            "name": "Allowed Locations",
            "valueType": "ANY",
            "productSpecCharacteristicValue": [
                {
                    "values": "ASIA"
                },
                {
                    "values": "USA"
                },
                {
                    "values": "Africa"
                },
                {
                    "values":"Pakistan"
                }
            ],
            "cardinality": "MULTIPLE"
        }
    ]
}