Jump to

• Request
• Response
• Examples

Get Product Offerings

get

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

Retrieves the list of product offering in promoted status.

Request

Query Parameters

• fields: string
  Specifies the attributes that need to be returned inside the resource item.
• href: string
  Defines the where clause on href field. The resource collection will be queried with a CONTAINS search. For example, ?href=url'.
• id: string
  A unique ID that identifies resources.
• lastUpdate: string
  The value for the last update query parameter.
• lifecycleStatus: string
  The value for the lifecycle Status query parameter.
• limit: integer
  Restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, the framework will return the available resources.
• name: string
  Defines the where clause on name field. The resource collection will be queried with a CONTAINS search. For example, ?name=RecordName'.
• offset: integer
  The starting index for the resources have to be provided in response requested by client.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of product offering was retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ProductOfferingOracle
  Title: ProductOfferingOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingOracle"
    }
}

Nested Schema : ProductOfferingOracle

Type: object

Title: ProductOfferingOracle

Match All

Show Source

• object 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.
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }

{
    "type":"object",
    "title":"ProductOfferingOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOffering"
        },
        {
            "properties":{
                "priceTag":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceTag"
                    }
                },
                "productSpecCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductSpecificationCharacteristicOracle"
                    }
                },
                "popEventMap":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PopEventMapRef"
                    }
                },
                "validityRounding":{
                    "type":"string",
                    "description":"A string providing complementary information on the value of the validity rounding attribute.",
                    "enum":[
                        "NOT_SET",
                        "ON",
                        "OFF"
                    ]
                },
                "scaleRounding":{
                    "type":"string",
                    "description":"A string providing complementary information on the value of the scale rounding attribute.",
                    "enum":[
                        "NOT_SET",
                        "ON",
                        "OFF"
                    ]
                }
            },
            "discriminator":{
                "propertyName":"@type",
                "mapping":{
                    "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOffering
• ProductOfferingOracle

{
    "type":"object",
    "description":"Represents entities that are orderable from the provider of the catalog. This resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique ID of the product offering."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL of the product offering."
        },
        "description":{
            "type":"string",
            "description":"Description of the product offering."
        },
        "isBundle":{
            "type":"boolean",
            "description":"Whether a product specification represents a single offering (<b>true</b>) or multiple offerings (<b>false</b>)."
        },
        "isSellable":{
            "type":"boolean",
            "description":"A flag that indicates if the product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status."
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering."
        },
        "statusReason":{
            "type":"string",
            "description":"A string that provides complementary information on the value of the lifecycle status attribute."
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering."
        },
        "bundledProductOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOffering"
            },
            "description":"A type of product offering that belongs to a grouping of product offerings made available to the market. It inherits the attributes of a product offering."
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            },
            "description":"Product offering uses the product specification characteristic value to add additional attributes to override properties of similar values contained in the product specification characteristic value. The corresponding characteristics addressed by this object must exist in the corresponding product specification. The available characteristic values for a product specification characteristic in a product specification can be modified at the product offering level. For example, <b>a characteristic 'Color' might have values White, Blue, Green and Red. The list of values can be restricted to White and Blue in an associated product offering.</b> The list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics."
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRefOrValue"
            },
            "description":"An amount, usually of money, that is asked for or allowed when a product offering is bought, rented or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer."
        },
        "productOfferingRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRelationship"
            },
            "description":"Relates between the product offering and other product offerings."
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingTerm"
            },
            "description":"A condition which makes the product offering available to customers. For instance, a product offering can be offered with multiple commitment periods."
        },
        "productSpecification":{
            "$ref":"#/components/schemas/ProductSpecificationRef",
            "description":"Describes a tangible or intangible object made available externally in the form of a product offering to customers or other parties playing a party role."
        },
        "serviceCandidate":{
            "$ref":"#/components/schemas/ServiceCandidateRef",
            "description":"An entity that makes a service specification available to a catalog."
        },
        "eventCandidate":{
            "$ref":"#/components/schemas/EventCandidateRef",
            "description":"An entity that makes an event specification available to a catalog."
        },
        "serviceLevelAgreement":{
            "$ref":"#/components/schemas/SLARef",
            "description":"A type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, etc. The service level agreement is a set of appropriate procedures and targets formally or informally agreed between parties to achieve and maintain specified quality of service."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the product offering is valid."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class extensible name while sub-classing."
        }
    },
    "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.

Show Source

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class extensible name while sub-classing.
• bundledProductOffering: array bundledProductOffering
  A type of product offering that belongs to a grouping of product offerings made available to the market. It inherits the attributes of a product offering.
• description: string
  Description of the product offering.
• eventCandidate: object EventCandidateRef
  An entity that makes an event specification available to a catalog.
• href: string
  The unique resource URL of the product offering.
• id: string
  The unique ID of the product offering.
• isBundle: boolean
  Whether a product specification represents a single offering (true) or multiple offerings (false).
• isSellable: boolean
  A flag that indicates if the product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle.
• lastUpdate: string (date-time)
  Date and time of the last update.
• lifecycleStatus: string
  Indicates the current lifecycle status.
• name: string
  Name of the product offering.
• prodSpecCharValueUse: array prodSpecCharValueUse
  Product offering uses the product specification characteristic value to add additional attributes to override properties of similar values contained in the product specification characteristic value. The corresponding characteristics addressed by this object must exist in the corresponding product specification. The available characteristic values for a product specification characteristic in a product specification can be modified at the product offering level. For example, a characteristic 'Color' might have values White, Blue, Green and Red. The list of values can be restricted to White and Blue in an associated product offering. The list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
• productOfferingPrice: array productOfferingPrice
  An amount, usually of money, that is asked for or allowed when a product offering is bought, rented or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.
• productOfferingRelationship: array productOfferingRelationship
  Relates between the product offering and other product offerings.
• productOfferingTerm: array productOfferingTerm
  A condition which makes the product offering available to customers. For instance, a product offering can be offered with multiple commitment periods.
• productSpecification: object ProductSpecificationRef
  A detailed description of a tangible or intangible object made available externally in the form of a product offering to customers or other parties playing a party role.
• serviceCandidate: object ServiceCandidateRef
  An entity that makes a service specification available to a catalog.
• serviceLevelAgreement: object SLARef
  A type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified quality of service.
• statusReason: string
  A string that provides complementary information on the value of the lifecycle status attribute.
• validFor: object TimePeriod
  A period of time, either as a deadline (endDateTime only), a startDateTime only, or both.
• version: string
  Version of the product offering.

{
    "type":"object",
    "description":"Represents entities that are orderable from the provider of the catalog. This resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique ID of the product offering."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL of the product offering."
        },
        "description":{
            "type":"string",
            "description":"Description of the product offering."
        },
        "isBundle":{
            "type":"boolean",
            "description":"Whether a product specification represents a single offering (<b>true</b>) or multiple offerings (<b>false</b>)."
        },
        "isSellable":{
            "type":"boolean",
            "description":"A flag that indicates if the product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status."
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering."
        },
        "statusReason":{
            "type":"string",
            "description":"A string that provides complementary information on the value of the lifecycle status attribute."
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering."
        },
        "bundledProductOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductOffering"
            },
            "description":"A type of product offering that belongs to a grouping of product offerings made available to the market. It inherits the attributes of a product offering."
        },
        "prodSpecCharValueUse":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
            },
            "description":"Product offering uses the product specification characteristic value to add additional attributes to override properties of similar values contained in the product specification characteristic value. The corresponding characteristics addressed by this object must exist in the corresponding product specification. The available characteristic values for a product specification characteristic in a product specification can be modified at the product offering level. For example, <b>a characteristic 'Color' might have values White, Blue, Green and Red. The list of values can be restricted to White and Blue in an associated product offering.</b> The list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics."
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRefOrValue"
            },
            "description":"An amount, usually of money, that is asked for or allowed when a product offering is bought, rented or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer."
        },
        "productOfferingRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRelationship"
            },
            "description":"Relates between the product offering and other product offerings."
        },
        "productOfferingTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingTerm"
            },
            "description":"A condition which makes the product offering available to customers. For instance, a product offering can be offered with multiple commitment periods."
        },
        "productSpecification":{
            "$ref":"#/components/schemas/ProductSpecificationRef",
            "description":"Describes a tangible or intangible object made available externally in the form of a product offering to customers or other parties playing a party role."
        },
        "serviceCandidate":{
            "$ref":"#/components/schemas/ServiceCandidateRef",
            "description":"An entity that makes a service specification available to a catalog."
        },
        "eventCandidate":{
            "$ref":"#/components/schemas/EventCandidateRef",
            "description":"An entity that makes an event specification available to a catalog."
        },
        "serviceLevelAgreement":{
            "$ref":"#/components/schemas/SLARef",
            "description":"A type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, etc. The service level agreement is a set of appropriate procedures and targets formally or informally agreed between parties to achieve and maintain specified quality of service."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the product offering is valid."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class extensible name while sub-classing."
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOffering":"#/components/schemas/ProductOffering",
            "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOfferingOracle

{
    "properties":{
        "priceTag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTag"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicOracle"
            }
        },
        "popEventMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PopEventMapRef"
            }
        },
        "validityRounding":{
            "type":"string",
            "description":"A string providing complementary information on the value of the validity rounding attribute.",
            "enum":[
                "NOT_SET",
                "ON",
                "OFF"
            ]
        },
        "scaleRounding":{
            "type":"string",
            "description":"A string providing complementary information on the value of the scale rounding attribute.",
            "enum":[
                "NOT_SET",
                "ON",
                "OFF"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle"
        }
    }
}

Show Source

• popEventMap: array popEventMap
• priceTag: array priceTag
• productSpecCharacteristic: array productSpecCharacteristic
• scaleRounding: string
  Allowed Values: [ "NOT_SET", "ON", "OFF" ]

  A string providing complementary information on the value of the scale rounding attribute.
• validityRounding: string
  Allowed Values: [ "NOT_SET", "ON", "OFF" ]

  A string providing complementary information on the value of the validity rounding attribute.

{
    "properties":{
        "priceTag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTag"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationCharacteristicOracle"
            }
        },
        "popEventMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PopEventMapRef"
            }
        },
        "validityRounding":{
            "type":"string",
            "description":"A string providing complementary information on the value of the validity rounding attribute.",
            "enum":[
                "NOT_SET",
                "ON",
                "OFF"
            ]
        },
        "scaleRounding":{
            "type":"string",
            "description":"A string providing complementary information on the value of the scale rounding attribute.",
            "enum":[
                "NOT_SET",
                "ON",
                "OFF"
            ]
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle"
        }
    }
}

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

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class entity name while sub-classing.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP error code extension.

{
    "description":"Used when an API throws an error, typically with an HTTP error response-code.",
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "format":"uri",
            "description":"URI of documentation describing the error."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class entity name while sub-classing."
        }
    }
}

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

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class entity name while sub-classing.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP error code extension.

{
    "description":"Used when an API throws an error, typically with an HTTP error response-code.",
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "format":"uri",
            "description":"URI of documentation describing the error."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class entity name while sub-classing."
        }
    }
}

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

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class entity name while sub-classing.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP error code extension.

{
    "description":"Used when an API throws an error, typically with an HTTP error response-code.",
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "format":"uri",
            "description":"URI of documentation describing the error."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class entity name while sub-classing."
        }
    }
}

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

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class entity name while sub-classing.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP error code extension.

{
    "description":"Used when an API throws an error, typically with an HTTP error response-code.",
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "format":"uri",
            "description":"URI of documentation describing the error."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class entity name while sub-classing."
        }
    }
}

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

• @baseType: string
  Defines the super-class while sub-classing.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  Defines the sub-class entity name while sub-classing.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP error code extension.

{
    "description":"Used when an API throws an error, typically with an HTTP error response-code.",
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "format":"uri",
            "description":"URI of documentation describing the error."
        },
        "@baseType":{
            "type":"string",
            "description":"Defines the super-class while sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"Defines the sub-class entity name while sub-classing."
        }
    }
}

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