Get Product Offerings

get

http://host:port/productCatalogManagement/v4/productOffering

Retrieves the list of product offering in promoted status.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of product offering was retrieved successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ProductOfferingOracle
Type: object
Title: ProductOfferingOracle
Match All
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOffering":"#/components/schemas/ProductOffering", "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
    Represents entities that are orderable from the provider of the catalog. This resource includes pricing information.
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Represents entities that are orderable from the provider of the catalog. This resource includes pricing information.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source

400 Response

The server cannot process the request due to a client error.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

401 Response

The user's authentication credentials for the target resource are invalid.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

404 Response

The requested resource was not found, but it could be accessible in the future. Subsequent client requests are permitted.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

405 Response

The requested resource does not support the particular request method.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

500 Response

When an unexpected condition is identified and no specific message is appropriate, this generic error message is displayed.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source
Back to Top

Examples

The following example shows how to get details of a product offering by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

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

where:

  • hostname is the URL for the PDC REST server.

  • port is the port for the PDC REST server.

Example of the Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "ValidityNT1",
        "href": "/productCatalogManagement/v4/productOffering/ValidityNT1",
        "id": "ValidityNT1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "ValidityNT1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/ValidityNT1Pop1",
                "id": "ValidityNT1Pop1",
                "name": "ValidityNT1Pop1"
            },
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/ValidityNT1Pop2",
                "id": "ValidityNT1Pop2",
                "name": "ValidityNT1Pop2"
            },
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/ValidityNT1Pop3",
                "id": "ValidityNT1Pop3",
                "name": "ValidityNT1Pop3"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "validFor": {
            "startDateTime": "2023-01-26T23:33:58Z"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test1",
        "id": "test1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/testCrp",
                "id": "testCrp",
                "name": "testCrp"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test2",
        "id": "test2",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test2",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/testcrp2",
                "id": "testcrp2",
                "name": "testcrp2"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "ValidityTiered1",
        "href": "/productCatalogManagement/v4/productOffering/ValidityTiered1",
        "id": "ValidityTiered1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "ValidityTiered1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/ValidityTiered1Pop1",
                "id": "ValidityTiered1Pop1",
                "name": "ValidityTiered1Pop1"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "Rollover_Test",
        "href": "/productCatalogManagement/v4/productOffering/Rollover_Test",
        "id": "Rollover_Test",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "Rollover_Test",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Rollover_charge",
                "id": "Rollover_charge",
                "name": "Rollover_charge"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/Usage",
        "id": "Usage",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "Usage",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Usage_POP",
                "id": "Usage_POP",
                "name": "Usage_POP"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "test-1",
        "href": "/productCatalogManagement/v4/productOffering/test-1",
        "id": "test-1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test-1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/charge-1",
                "id": "charge-1",
                "name": "charge-1"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "rec_offer",
        "href": "/productCatalogManagement/v4/productOffering/rec_offer",
        "id": "rec_offer",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "rec_offer",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/rec_charge",
                "id": "rec_charge",
                "name": "rec_charge"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "Description of Test16_OOO. Random UUID: 77a1f973-da76-4339-b7e4-aca2472454f9",
        "href": "/productCatalogManagement/v4/productOffering/Test16_OOO",
        "id": "Test16_OOO",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "Test16_OOO",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/popOOO_1_Test16_OOO",
                "id": "popOOO_1_Test16_OOO",
                "name": "popOOO_1_Test16_OOO"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "validFor": {
            "endDateTime": "2024-02-01T08:53:13Z",
            "startDateTime": "2023-02-01T08:48:13Z"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "usage_offer",
        "href": "/productCatalogManagement/v4/productOffering/usage_offer",
        "id": "usage_offer",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "usage_offer",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/usg_charge",
                "id": "usg_charge",
                "name": "usg_charge"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test_offers",
        "id": "test_offers",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test_offers",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/charge_OT",
                "id": "charge_OT",
                "name": "charge_OT"
            },
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Charge_REC",
                "id": "Charge_REC",
                "name": "Charge_REC"
            },
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Charge_Usage",
                "id": "Charge_Usage",
                "name": "Charge_Usage"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test_OT",
        "id": "test_OT",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test_OT",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/test_OT_Charge",
                "id": "test_OT_Charge",
                "name": "test_OT_Charge"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test_pricing_Offer",
        "id": "test_pricing_Offer",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test_pricing_Offer",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Pricing_Offer_Charge",
                "id": "Pricing_Offer_Charge",
                "name": "Pricing_Offer_Charge"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "href": "/productCatalogManagement/v4/productOffering/test_pricing_Offer2",
        "id": "test_pricing_Offer2",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "test_pricing_Offer2",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/Pricing_Offer_Charge2",
                "id": "Pricing_Offer_Charge2",
                "name": "Pricing_Offer_Charge2"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "ot_charge",
        "href": "/productCatalogManagement/v4/productOffering/ot_charge_1",
        "id": "ot_charge_1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "ot_charge_1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferingPriceRef",
                "href": "/productCatalogManagement/v4/productOfferingPrice/ot-1",
                "id": "ot-1",
                "name": "ot-1"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "version": "1.0"
    },
    {
        "atBaseType": "ProductOffering",
        "atType": "ProductOfferingOracle",
        "description": "DiscValidityNT1",
        "href": "/productCatalogManagement/v4/productOffering/DiscValidityNT1",
        "id": "DiscValidityNT1",
        "isBundle": false,
        "isSellable": false,
        "lifecycleStatus": "In design",
        "name": "DiscValidityNT1",
        "productOfferingPrice": [
            {
                "atType": "ProductOfferPriceAlteration",
                "href": "/productCatalogManagement/v4/productOfferingPrice/DiscValidityNT1Pop1",
                "id": "DiscValidityNT1Pop1",
                "name": "DiscValidityNT1Pop1"
            },
            {
                "atType": "ProductOfferPriceAlteration",
                "href": "/productCatalogManagement/v4/productOfferingPrice/DiscValidityNT1Pop2",
                "id": "DiscValidityNT1Pop2",
                "name": "DiscValidityNT1Pop2"
            },
            {
                "atType": "ProductOfferPriceAlteration",
                "href": "/productCatalogManagement/v4/productOfferingPrice/DiscValidityNT1Pop3",
                "id": "DiscValidityNT1Pop3",
                "name": "DiscValidityNT1Pop3"
            }
        ],
        "serviceCandidate": {
            "atReferredType": "ServiceCandidate",
            "atType": "ServiceCandidateRef",
            "id": "TelcoGsm",
            "name": "TelcoGsm"
        },
        "validFor": {
            "endDateTime": "2023-01-28T01:06:39Z",
            "startDateTime": "2023-01-27T01:06:34Z"
        },
        "version": "1.0"
    }
]
Back to Top