Jump to

• Request
• Response
• Examples

List or Find Products

get

/product

Lists products that match the specified query criteria. If no criteria is specified, all products are returned.

Request

Query Parameters

• billingAccount.id: string
  The ID of the associated billing account.
• cycleEndDate: string(date-time)
  The purchased product cycle end date in ISO-8601 date-time format.
• cycleStartDate: string(date-time)
  The purchased product cycle start date in ISO-8601 date-time format.
• description: string
  The resource's description.
• fields: string
  Specifies the comma-separated properties to include in the response.
• filter: string
  Specifies an advanced filter expression for nested fields, for example JSONPath.

  Examples

  Select an example Filter by primary contact Filter by post code Filter by phone number Filter by email address Filter by state or province Filter by country Filter by city Filter by street Filter by certificate number Filter by issuing jurisdiction Filter by validFor start date and time Filter by validFor end date and time Filter by reason Filter by tax exemption ID Filter by parent account relationship Filter by related party role Filter by secondary contact name Filter by certificate number and reason

• isBundle: boolean
  Wether the resource is a bundle.
• limit: integer
  Specifies the number of resources to include in the response.
• name: string
  The resource's name.
• offset: integer
  Specifies the index of the first resource to include in the response.
• productCharacteristic.id: string
  The ID of the associated product characteristic.
• productOffering.id: string
  The identifier of the associated product offering.
• productOffering.name: string
  The name of the associated product offering.
• purchaseEndDate: string(date-time)
  The purchased product purchase end date in ISO-8601 date-time format.
• purchaseStartDate: string(date-time)
  The purchased product purchase start date in ISO-8601 date-time format.
• quantity: integer
  The service quantity when creating a purchase product.
• realizingService.id: string
  The ID of the associated realizing service.
• specialRatingProfile.data.name: string
  The special rating profile data attribute name. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  dummy

• specialRatingProfile.data.name.eq: string
  Filters products whose special rating profile data name equals the specified value.

  Example:

  dummy

• specialRatingProfile.data.name.like: string
  Filters products whose special rating profile data name matches the specified wildcard pattern.

  Example:

  dum%

• specialRatingProfile.data.validFor.endDateTime: string(date-time)
  The end of the special rating profile data validity period. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  2031-05-01T00:00:00.00Z

• specialRatingProfile.data.validFor.endDateTime.eq: string(date-time)
  Filters products whose special rating profile data end time equals the specified date-time.

  Example:

  2031-05-01T00:00:00.00Z

• specialRatingProfile.data.validFor.endDateTime.gt: string(date-time)
  Filters products whose special rating profile data end time is after the specified date-time.

  Example:

  2031-04-30T00:00:00.00Z

• specialRatingProfile.data.validFor.endDateTime.gte: string(date-time)
  Filters products whose special rating profile data end time is after or equal to the specified date-time.

  Example:

  2031-05-01T00:00:00.00Z

• specialRatingProfile.data.validFor.endDateTime.lt: string(date-time)
  Filters products whose special rating profile data end time is before the specified date-time.

  Example:

  2031-05-02T00:00:00.00Z

• specialRatingProfile.data.validFor.endDateTime.lte: string(date-time)
  Filters products whose special rating profile data end time is before or equal to the specified date-time.

  Example:

  2031-05-01T00:00:00.00Z

• specialRatingProfile.data.validFor.startDateTime: string(date-time)
  The start of the special rating profile data validity period. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  2031-04-02T18:23:39.00Z

• specialRatingProfile.data.validFor.startDateTime.eq: string(date-time)
  Filters products whose special rating profile data start time equals the specified date-time.

  Example:

  2031-04-02T18:23:39.00Z

• specialRatingProfile.data.validFor.startDateTime.gt: string(date-time)
  Filters products whose special rating profile data start time is after the specified date-time.

  Example:

  2031-04-01T00:00:00.00Z

• specialRatingProfile.data.validFor.startDateTime.gte: string(date-time)
  Filters products whose special rating profile data start time is after or equal to the specified date-time.

  Example:

  2031-04-02T18:23:39.00Z

• specialRatingProfile.data.validFor.startDateTime.lt: string(date-time)
  Filters products whose special rating profile data start time is before the specified date-time.

  Example:

  2031-04-03T00:00:00.00Z

• specialRatingProfile.data.validFor.startDateTime.lte: string(date-time)
  Filters products whose special rating profile data start time is before or equal to the specified date-time.

  Example:

  2031-04-02T18:23:39.00Z

• specialRatingProfile.data.value: string
  The special rating profile data attribute value. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  0449335686849545

• specialRatingProfile.data.value.eq: string
  Filters products whose special rating profile data value equals the specified value.

  Example:

  0449335686849545

• specialRatingProfile.data.value.like: string
  Filters products whose special rating profile data value matches the specified wildcard pattern.

  Example:

  044%

• specialRatingProfile.id: string
  The identifier of the special rating profile. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  88-1ZVHQ4-044

• specialRatingProfile.id.eq: string
  Filters products whose special rating profile identifier equals the specified value.

  Example:

  88-1ZVHQ4-044

• specialRatingProfile.id.like: string
  Filters products whose special rating profile identifier matches the specified wildcard pattern.

  Example:

  88-1ZVHQ4-%

• specialRatingProfile.label: string
  The special rating profile label. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  Smart Calling up to 5 Numbers

• specialRatingProfile.label.eq: string
  Filters products whose special rating profile label equals the specified value.

  Example:

  Smart Calling up to 5 Numbers

• specialRatingProfile.label.like: string
  Filters products whose special rating profile label matches the specified wildcard pattern.

  Example:

  Smart%

• specialRatingProfile.name: string
  The special rating profile name. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  FRIENDS_FAMILY

• specialRatingProfile.name.eq: string
  Filters products whose special rating profile name equals the specified value.

  Example:

  FRIENDS_FAMILY

• specialRatingProfile.name.like: string
  Filters products whose special rating profile name matches the specified wildcard pattern.

  Example:

  FRIENDS%

• specialRatingProfile.referenceCount: integer
  The special rating profile reference count. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Example:

  1

• specialRatingProfile.referenceCount.eq: integer
  Filters products whose special rating profile reference count equals the specified value.

  Example:

  1

• specialRatingProfile.referenceCount.gt: integer
  Filters products whose special rating profile reference count is greater than the specified value.

  Example:

  0

• specialRatingProfile.referenceCount.gte: integer
  Filters products whose special rating profile reference count is greater than or equal to the specified value.

  Example:

  1

• specialRatingProfile.referenceCount.lt: integer
  Filters products whose special rating profile reference count is less than the specified value.

  Example:

  2

• specialRatingProfile.referenceCount.lte: integer
  Filters products whose special rating profile reference count is less than or equal to the specified value.

  Example:

  1

• specialRatingProfile.status: string
  The special rating profile provisioning status. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.

  Allowed Values: [ "noop", "provisioning", "provisioningFailed", "active", "unprovisioning", "unprovisioningFailed", "unprovisioned", "suspending", "suspendingFailed", "suspended" ]

  Example:

  active

• specialRatingProfile.status.eq: string
  Filters products whose special rating profile status equals the specified value.

  Example:

  active

• specialRatingProfile.status.gt: string
  Filters products whose special rating profile status follows the specified status in mapper enum order.

  Example:

  active

• specialRatingProfile.status.gte: string
  Filters products whose special rating profile status follows or equals the specified status in mapper enum order.

  Example:

  active

• specialRatingProfile.status.lt: string
  Filters products whose special rating profile status precedes the specified status in mapper enum order.

  Example:

  active

• specialRatingProfile.status.lte: string
  Filters products whose special rating profile status precedes or equals the specified status in mapper enum order.

  Example:

  active

• startDate: string(date-time)
  The resource start date. The expected ISO-8601 format: 2025-01-02T01:30:00Z.

  Example:

  2018-01-02T01:30:00Z

• status: string
  The resource's status.
• terminationDate: string(date-time)
  The resource termination date. The expected ISO-8601 format: 2025-01-02T01:30:00Z.

  Example:

  2025-01-02T01:30:00Z

• usageEndDate: string(date-time)
  The purchased product usage end date in ISO-8601 date-time format.
• usageStartDate: string(date-time)
  The purchased product usage start date in ISO-8601 date-time format.

There's no request body for this operation.

Back to Top

Response

200 Response

The request was successfully completed.

Headers

• X-Result-Count:
  The actual number of items returned in the response body.
• X-Total-Count:
  The total number of items that match the criteria.

Body ()

Root Schema : schema

Match One Schema

Show Source

• Product
• ProductOracle

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Product"
        },
        {
            "$ref":"#/components/schemas/ProductOracle"
        }
    ]
}

Nested Schema : Product

Match All

A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.

Show Source

• object allOf Entity
  Represents a base entity schema for TM Forum Open APIs.
• object Product-allOf[1]
  A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.",
            "properties":{
                "billingAccount":{
                    "$ref":"#/components/schemas/BillingAccountRef"
                },
                "description":{
                    "type":"string",
                    "description":"Describes the product. You can copy it from the product offering description."
                },
                "isBundle":{
                    "type":"boolean",
                    "description":"Indicates whether the product is a ProductBundle (<b>true</b>) or a ProductComponent (<b>false</b>)."
                },
                "name":{
                    "type":"string",
                    "description":"The product name; it can match the product offering name."
                },
                "productCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    }
                },
                "productOffering":{
                    "$ref":"#/components/schemas/ProductOfferingRef"
                },
                "product":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductRefOrValue"
                    }
                },
                "productPrice":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductPrice"
                    }
                },
                "productRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductRelationship"
                    }
                },
                "realizingService":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ServiceRef"
                    }
                },
                "startDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date the product starts."
                },
                "status":{
                    "$ref":"#/components/schemas/ProductStatusType"
                },
                "terminationDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date the product was terminated."
                }
            }
        }
    ]
}

Nested Schema : ProductOracle

Match All

A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.

Show Source

• allOf Product
• object ProductOracle-allOf[1]
  A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Product"
        },
        {
            "type":"object",
            "description":"A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.",
            "properties":{
                "productPrice":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductPriceOracle"
                    }
                },
                "productRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductRelationshipOracle"
                    }
                },
                "cycleStart":{
                    "$ref":"#/components/schemas/CycleStartRef"
                },
                "usageStart":{
                    "$ref":"#/components/schemas/UsageStartRef"
                },
                "purchaseStart":{
                    "$ref":"#/components/schemas/PurchaseStartRef"
                },
                "cycleEnd":{
                    "$ref":"#/components/schemas/CycleEndRef"
                },
                "usageEnd":{
                    "$ref":"#/components/schemas/UsageEndRef"
                },
                "purchaseEnd":{
                    "$ref":"#/components/schemas/PurchaseEndRef"
                },
                "cycleStartDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product cycle start date."
                },
                "cycleEndDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product cycle end date."
                },
                "purchaseStartDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product purchase start date."
                },
                "purchaseEndDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product purchase end date."
                },
                "usageStartDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product usage start date."
                },
                "usageEndDate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The purchased product usage end date."
                },
                "gracePeriod":{
                    "$ref":"#/components/schemas/GracePeriodRef"
                },
                "specialRatingProfile":{
                    "description":"Service extended rating profile linked to the product.",
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/SpecialRatingProfile"
                        }
                    ]
                },
                "quantity":{
                    "type":"integer",
                    "description":"Is the quantity of service while creation of a purchase product."
                }
            }
        }
    ]
}

Nested Schema : Entity

Type: object

Represents a base entity schema for TM Forum Open APIs.

Match All

Represents a base entity schema for TM Forum Open APIs.

Represents a base entity schema for TM Forum Open APIs.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.

{
    "type":"object",
    "description":"Represents a base entity schema for TM Forum Open APIs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : Product-allOf[1]

Type: object

A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.

Show Source

• billingAccount: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "BillingAccountRef":"#/components/schemas/BillingAccountRef" } }
• description: string
  Describes the product. You can copy it from the product offering description.
• isBundle: boolean
  Indicates whether the product is a ProductBundle (true) or a ProductComponent (false).
• name: string
  The product name; it can match the product offering name.
• product: array product
• productCharacteristic: array productCharacteristic
• productOffering: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef" } }
• productPrice: array productPrice
• productRelationship: array productRelationship
• realizingService: array realizingService
• startDate: string (date-time)
  The date the product starts.
• status: string
  Allowed Values: [ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted" ]

  The possible values for a product's status.
• terminationDate: string (date-time)
  The date the product was terminated.

{
    "type":"object",
    "description":"A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.",
    "properties":{
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "description":{
            "type":"string",
            "description":"Describes the product. You can copy it from the product offering description."
        },
        "isBundle":{
            "type":"boolean",
            "description":"Indicates whether the product is a ProductBundle (<b>true</b>) or a ProductComponent (<b>false</b>)."
        },
        "name":{
            "type":"string",
            "description":"The product name; it can match the product offering name."
        },
        "productCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "productOffering":{
            "$ref":"#/components/schemas/ProductOfferingRef"
        },
        "product":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRefOrValue"
            }
        },
        "productPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductPrice"
            }
        },
        "productRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRelationship"
            }
        },
        "realizingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceRef"
            }
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the product starts."
        },
        "status":{
            "$ref":"#/components/schemas/ProductStatusType"
        },
        "terminationDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date the product was terminated."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• BillingAccountRef

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Refers to the billing account. The billing account describes the bill structure.",
            "properties":{
                "ratingType":{
                    "type":"string",
                    "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingAccountRef":"#/components/schemas/BillingAccountRef"
        }
    }
}

Match All

Refers to the billing account. The billing account describes the bill structure.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef
• object Discriminator: @type-allOf[2]
  Refers to the billing account. The billing account describes the bill structure.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Refers to the billing account. The billing account describes the bill structure.",
            "properties":{
                "ratingType":{
                    "type":"string",
                    "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "BillingAccountRef":"#/components/schemas/BillingAccountRef"
        }
    }
}

Nested Schema : product

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Product":"#/components/schemas/Product", "ProductRef":"#/components/schemas/ProductRef", "ProductOracle":"#/components/schemas/ProductOracle" } }

  The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.

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

Nested Schema : productCharacteristic

Type: array

Show Source

• Array of: Characteristic

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOfferingRef

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Represents entities that are orderable from the catalog provider. This resource includes pricing information.",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"Version of the product offering"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef"
        }
    }
}

Match All

Represents entities that are orderable from the catalog provider. This resource includes pricing information.

Show Source

• allOf EntityRef
• object Discriminator: @type-allOf[1]
  Represents entities that are orderable from the catalog provider. This resource includes pricing information.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Represents entities that are orderable from the catalog provider. This resource includes pricing information.",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"Version of the product offering"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef"
        }
    }
}

Nested Schema : productPrice

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPrice" } }

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

Nested Schema : productRelationship

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationship" } }

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

Nested Schema : realizingService

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ServiceRef":"#/components/schemas/ServiceRef" } }

  The service reference used by other entities.

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

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.
• object EntityRef-allOf[2]
  Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : Discriminator: @type-allOf[2]

Type: object

Refers to the billing account. The billing account describes the bill structure.

Show Source

• ratingType: string
  Indicates if the account follows a specific payment option such as prepaid or postpaid.

{
    "type":"object",
    "description":"Refers to the billing account. The billing account describes the bill structure.",
    "properties":{
        "ratingType":{
            "type":"string",
            "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Product
• ProductRef
• ProductOracle

{
    "type":"object",
    "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Product"
        },
        {
            "$ref":"#/components/schemas/ProductRef"
        },
        {
            "$ref":"#/components/schemas/ProductOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Product":"#/components/schemas/Product",
            "ProductRef":"#/components/schemas/ProductRef",
            "ProductOracle":"#/components/schemas/ProductOracle"
        }
    }
}

The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.

Match One Schema

Show Source

• Product
• object ProductRef
  A product reference.
• ProductOracle

{
    "type":"object",
    "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Product"
        },
        {
            "$ref":"#/components/schemas/ProductRef"
        },
        {
            "$ref":"#/components/schemas/ProductOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Product":"#/components/schemas/Product",
            "ProductRef":"#/components/schemas/ProductRef",
            "ProductOracle":"#/components/schemas/ProductOracle"
        }
    }
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

A product reference.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : Characteristic

Match All

Describes a given characteristic of an object or entity through a name/value pair.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Characteristic-allOf[1]
  Describes a given characteristic of an object or entity through a name/value pair.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Describes a given characteristic of an object or entity through a name/value pair.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The characteristic's ID."
                },
                "name":{
                    "type":"string",
                    "description":"The characteristic's name."
                },
                "valueType":{
                    "type":"string",
                    "description":"The characteristic value's data type."
                },
                "characteristicRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CharacteristicRelationship"
                    }
                }
            }
        }
    ]
}

Nested Schema : Characteristic-allOf[1]

Type: object

Describes a given characteristic of an object or entity through a name/value pair.

Show Source

• characteristicRelationship: array characteristicRelationship
• id: string
  The characteristic's ID.
• name: string
  The characteristic's name.
• valueType: string
  The characteristic value's data type.

{
    "type":"object",
    "description":"Describes a given characteristic of an object or entity through a name/value pair.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The characteristic's ID."
        },
        "name":{
            "type":"string",
            "description":"The characteristic's name."
        },
        "valueType":{
            "type":"string",
            "description":"The characteristic value's data type."
        },
        "characteristicRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicRelationship"
            }
        }
    }
}

Nested Schema : characteristicRelationship

Type: array

Show Source

• Array of: CharacteristicRelationship

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

Nested Schema : CharacteristicRelationship

Match All

The related characteristic.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object CharacteristicRelationship-allOf[1]
  The related characteristic.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The related characteristic.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The characteristic's ID."
                },
                "relationshipType":{
                    "type":"string",
                    "description":"The relationship type."
                }
            }
        }
    ]
}

Nested Schema : CharacteristicRelationship-allOf[1]

Type: object

The related characteristic.

Show Source

• id: string
  The characteristic's ID.
• relationshipType: string
  The relationship type.

{
    "type":"object",
    "description":"The related characteristic.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The characteristic's ID."
        },
        "relationshipType":{
            "type":"string",
            "description":"The relationship type."
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

Represents entities that are orderable from the catalog provider. This resource includes pricing information.

Show Source

• version: string
  Version of the product offering

{
    "type":"object",
    "description":"Represents entities that are orderable from the catalog provider. This resource includes pricing information.",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductPrice

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Describes the price and any discount awarded.",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"A description of the product price."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the product price."
                },
                "productOfferingPrice":{
                    "$ref":"#/components/schemas/ProductOfferingPriceRef"
                },
                "recurringChargePeriod":{
                    "type":"string",
                    "description":"Indicates the period for a recurring charge (for example&colon; <b>month</b> or <b>week</b>)."
                },
                "unitOfMeasure":{
                    "type":"string",
                    "description":"Unit of measure if the price depends on it (for example&colon; <b>GB</b> or <b>SMS volume</b>)."
                },
                "price":{
                    "$ref":"#/components/schemas/Price"
                },
                "priceAlteration":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceAlteration"
                    }
                },
                "priceType":{
                    "type":"string",
                    "description":"Indicates whether the price is for a recurring or a non-recurring charge."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductPrice":"#/components/schemas/ProductPrice"
        }
    }
}

Match All

Describes the price and any discount awarded.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Discriminator: @type-allOf[1]
  Describes the price and any discount awarded.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Describes the price and any discount awarded.",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"A description of the product price."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the product price."
                },
                "productOfferingPrice":{
                    "$ref":"#/components/schemas/ProductOfferingPriceRef"
                },
                "recurringChargePeriod":{
                    "type":"string",
                    "description":"Indicates the period for a recurring charge (for example&colon; <b>month</b> or <b>week</b>)."
                },
                "unitOfMeasure":{
                    "type":"string",
                    "description":"Unit of measure if the price depends on it (for example&colon; <b>GB</b> or <b>SMS volume</b>)."
                },
                "price":{
                    "$ref":"#/components/schemas/Price"
                },
                "priceAlteration":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceAlteration"
                    }
                },
                "priceType":{
                    "type":"string",
                    "description":"Indicates whether the price is for a recurring or a non-recurring charge."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductPrice":"#/components/schemas/ProductPrice"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

Describes the price and any discount awarded.

Show Source

• description: string
  A description of the product price.
• name: string
  The name of the product price.
• price: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Price":"#/components/schemas/Price" } }
• priceAlteration: array priceAlteration
• priceType: string
  Indicates whether the price is for a recurring or a non-recurring charge.
• productOfferingPrice: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef" } }
• recurringChargePeriod: string
  Indicates the period for a recurring charge (for example: month or week).
• unitOfMeasure: string
  Unit of measure if the price depends on it (for example: GB or SMS volume).

{
    "type":"object",
    "description":"Describes the price and any discount awarded.",
    "properties":{
        "description":{
            "type":"string",
            "description":"A description of the product price."
        },
        "name":{
            "type":"string",
            "description":"The name of the product price."
        },
        "productOfferingPrice":{
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Indicates the period for a recurring charge (for example&colon; <b>month</b> or <b>week</b>)."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure if the price depends on it (for example&colon; <b>GB</b> or <b>SMS volume</b>)."
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        },
        "priceAlteration":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceAlteration"
            }
        },
        "priceType":{
            "type":"string",
            "description":"Indicates whether the price is for a recurring or a non-recurring charge."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Price

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.",
            "properties":{
                "dutyFreeAmount":{
                    "$ref":"#/components/schemas/Money"
                },
                "percentage":{
                    "type":"number",
                    "format":"float",
                    "description":"The percentage to apply to a product offering price alteration."
                },
                "taxIncludedAmount":{
                    "$ref":"#/components/schemas/Money"
                },
                "taxRate":{
                    "type":"number",
                    "format":"float",
                    "description":"The tax rate."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Price":"#/components/schemas/Price"
        }
    }
}

Match All

Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Discriminator: @type-allOf[1]
  Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.",
            "properties":{
                "dutyFreeAmount":{
                    "$ref":"#/components/schemas/Money"
                },
                "percentage":{
                    "type":"number",
                    "format":"float",
                    "description":"The percentage to apply to a product offering price alteration."
                },
                "taxIncludedAmount":{
                    "$ref":"#/components/schemas/Money"
                },
                "taxRate":{
                    "type":"number",
                    "format":"float",
                    "description":"The tax rate."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Price":"#/components/schemas/Price"
        }
    }
}

Nested Schema : priceAlteration

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlteration" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductOfferingPriceRef

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"The product offering price version."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef"
        }
    }
}

Match All

An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.

Show Source

• allOf EntityRef
• object Discriminator: @type-allOf[1]
  An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"The product offering price version."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.

Show Source

• dutyFreeAmount: object Money
  Represents a monetary amount.
• percentage: number (float)
  The percentage to apply to a product offering price alteration.
• taxIncludedAmount: object Money
  Represents a monetary amount.
• taxRate: number (float)
  The tax rate.

{
    "type":"object",
    "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.",
    "properties":{
        "dutyFreeAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "percentage":{
            "type":"number",
            "format":"float",
            "description":"The percentage to apply to a product offering price alteration."
        },
        "taxIncludedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "taxRate":{
            "type":"number",
            "format":"float",
            "description":"The tax rate."
        }
    }
}

Nested Schema : Money

Type: object

Represents a monetary amount.

Show Source

• unit: string
  The currency's ISO 4217 three-letter code.
• value: number (double)
  A signed floating-point number whose sign depends on the API context.

{
    "type":"object",
    "description":"Represents a monetary amount.",
    "properties":{
        "unit":{
            "type":"string",
            "nullable":true,
            "description":"The currency's ISO 4217 three-letter code."
        },
        "value":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "description":"A signed floating-point number whose sign depends on the API context."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• PriceAlteration

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"An amount, usually monetary, that modifies the price charged for an order item.",
            "properties":{
                "applicationDuration":{
                    "type":"integer",
                    "description":"The duration for which the alteration applies to the order item price (for example&colon; <b>2 months</b> free of charge for the recurring charge)."
                },
                "description":{
                    "type":"string",
                    "description":"Describes the semantics of this order item price alteration."
                },
                "name":{
                    "type":"string",
                    "description":"The order item price alteration name."
                },
                "productOfferingPrice":{
                    "$ref":"#/components/schemas/ProductOfferingPriceRef"
                },
                "priceType":{
                    "type":"string",
                    "description":"The price category (for example&colon; <b>recurring</b>, <b>one time</b>, or <b>usage</b>)."
                },
                "priority":{
                    "type":"integer",
                    "description":"The priority for applying this alteration among all defined alterations on the order item price."
                },
                "recurringChargePeriod":{
                    "type":"string",
                    "description":"Specifies the recurring charge period (for example&colon; <b>month</b> or <b>week</b>)."
                },
                "unitOfMeasure":{
                    "type":"string",
                    "description":"Specifies the unit of measure (for example&colon; <b>minutes</b> or <b>GB</b>)."
                },
                "price":{
                    "$ref":"#/components/schemas/Price"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PriceAlteration":"#/components/schemas/PriceAlteration"
        }
    }
}

Match All

An amount, usually monetary, that modifies the price charged for an order item.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Discriminator: @type-allOf[1]
  An amount, usually monetary, that modifies the price charged for an order item.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"An amount, usually monetary, that modifies the price charged for an order item.",
            "properties":{
                "applicationDuration":{
                    "type":"integer",
                    "description":"The duration for which the alteration applies to the order item price (for example&colon; <b>2 months</b> free of charge for the recurring charge)."
                },
                "description":{
                    "type":"string",
                    "description":"Describes the semantics of this order item price alteration."
                },
                "name":{
                    "type":"string",
                    "description":"The order item price alteration name."
                },
                "productOfferingPrice":{
                    "$ref":"#/components/schemas/ProductOfferingPriceRef"
                },
                "priceType":{
                    "type":"string",
                    "description":"The price category (for example&colon; <b>recurring</b>, <b>one time</b>, or <b>usage</b>)."
                },
                "priority":{
                    "type":"integer",
                    "description":"The priority for applying this alteration among all defined alterations on the order item price."
                },
                "recurringChargePeriod":{
                    "type":"string",
                    "description":"Specifies the recurring charge period (for example&colon; <b>month</b> or <b>week</b>)."
                },
                "unitOfMeasure":{
                    "type":"string",
                    "description":"Specifies the unit of measure (for example&colon; <b>minutes</b> or <b>GB</b>)."
                },
                "price":{
                    "$ref":"#/components/schemas/Price"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PriceAlteration":"#/components/schemas/PriceAlteration"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

An amount, usually monetary, that modifies the price charged for an order item.

Show Source

• applicationDuration: integer
  The duration for which the alteration applies to the order item price (for example: 2 months free of charge for the recurring charge).
• description: string
  Describes the semantics of this order item price alteration.
• name: string
  The order item price alteration name.
• price: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Price":"#/components/schemas/Price" } }
• priceType: string
  The price category (for example: recurring, one time, or usage).
• priority: integer
  The priority for applying this alteration among all defined alterations on the order item price.
• productOfferingPrice: Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef" } }
• recurringChargePeriod: string
  Specifies the recurring charge period (for example: month or week).
• unitOfMeasure: string
  Specifies the unit of measure (for example: minutes or GB).

{
    "type":"object",
    "description":"An amount, usually monetary, that modifies the price charged for an order item.",
    "properties":{
        "applicationDuration":{
            "type":"integer",
            "description":"The duration for which the alteration applies to the order item price (for example&colon; <b>2 months</b> free of charge for the recurring charge)."
        },
        "description":{
            "type":"string",
            "description":"Describes the semantics of this order item price alteration."
        },
        "name":{
            "type":"string",
            "description":"The order item price alteration name."
        },
        "productOfferingPrice":{
            "$ref":"#/components/schemas/ProductOfferingPriceRef"
        },
        "priceType":{
            "type":"string",
            "description":"The price category (for example&colon; <b>recurring</b>, <b>one time</b>, or <b>usage</b>)."
        },
        "priority":{
            "type":"integer",
            "description":"The priority for applying this alteration among all defined alterations on the order item price."
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Specifies the recurring charge period (for example&colon; <b>month</b> or <b>week</b>)."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Specifies the unit of measure (for example&colon; <b>minutes</b> or <b>GB</b>)."
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.

Show Source

• version: string
  The product offering price version.

{
    "type":"object",
    "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.",
    "properties":{
        "version":{
            "type":"string",
            "description":"The product offering price version."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductRelationship

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Describes the relationship between products.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The related product's ID."
                },
                "relationshipType":{
                    "type":"string",
                    "description":"Specifies the relationship type (for example&colon; <b>bundledBy</b>, <b>bundles</b>, <b>tiedDiscount</b>, or <b>tiedProduct</b>)."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductRelationship":"#/components/schemas/ProductRelationship"
        }
    }
}

Match All

Describes the relationship between products.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef
• object Discriminator: @type-allOf[2]
  Describes the relationship between products.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        },
        {
            "type":"object",
            "description":"Describes the relationship between products.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The related product's ID."
                },
                "relationshipType":{
                    "type":"string",
                    "description":"Specifies the relationship type (for example&colon; <b>bundledBy</b>, <b>bundles</b>, <b>tiedDiscount</b>, or <b>tiedProduct</b>)."
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductRelationship":"#/components/schemas/ProductRelationship"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[2]

Type: object

Describes the relationship between products.

Show Source

• id: string
  The related product's ID.
• relationshipType: string
  Specifies the relationship type (for example: bundledBy, bundles, tiedDiscount, or tiedProduct).

{
    "type":"object",
    "description":"Describes the relationship between products.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The related product's ID."
        },
        "relationshipType":{
            "type":"string",
            "description":"Specifies the relationship type (for example&colon; <b>bundledBy</b>, <b>bundles</b>, <b>tiedDiscount</b>, or <b>tiedProduct</b>)."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ServiceRef

{
    "type":"object",
    "description":"The service reference used by other entities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceRef":"#/components/schemas/ServiceRef"
        }
    }
}

The service reference used by other entities.

Match All

The service reference used by other entities.

The service reference used by other entities.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef

{
    "type":"object",
    "description":"The service reference used by other entities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceRef":"#/components/schemas/ServiceRef"
        }
    }
}

Nested Schema : ProductOracle-allOf[1]

Type: object

A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.

Show Source

• cycleEnd: CycleEndRef
• cycleEndDate: string (date-time)
  The purchased product cycle end date.
• cycleStart: CycleStartRef
• cycleStartDate: string (date-time)
  The purchased product cycle start date.
• gracePeriod: GracePeriodRef
• productPrice: array productPrice
• productRelationship: array productRelationship
• purchaseEnd: PurchaseEndRef
• purchaseEndDate: string (date-time)
  The purchased product purchase end date.
• purchaseStart: PurchaseStartRef
• purchaseStartDate: string (date-time)
  The purchased product purchase start date.
• quantity: integer
  Is the quantity of service while creation of a purchase product.
• specialRatingProfile: specialRatingProfile
  Service extended rating profile linked to the product.
• usageEnd: UsageEndRef
• usageEndDate: string (date-time)
  The purchased product usage end date.
• usageStart: UsageStartRef
• usageStartDate: string (date-time)
  The purchased product usage start date.

{
    "type":"object",
    "description":"A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.",
    "properties":{
        "productPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductPriceOracle"
            }
        },
        "productRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRelationshipOracle"
            }
        },
        "cycleStart":{
            "$ref":"#/components/schemas/CycleStartRef"
        },
        "usageStart":{
            "$ref":"#/components/schemas/UsageStartRef"
        },
        "purchaseStart":{
            "$ref":"#/components/schemas/PurchaseStartRef"
        },
        "cycleEnd":{
            "$ref":"#/components/schemas/CycleEndRef"
        },
        "usageEnd":{
            "$ref":"#/components/schemas/UsageEndRef"
        },
        "purchaseEnd":{
            "$ref":"#/components/schemas/PurchaseEndRef"
        },
        "cycleStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product cycle start date."
        },
        "cycleEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product cycle end date."
        },
        "purchaseStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product purchase start date."
        },
        "purchaseEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product purchase end date."
        },
        "usageStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product usage start date."
        },
        "usageEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The purchased product usage end date."
        },
        "gracePeriod":{
            "$ref":"#/components/schemas/GracePeriodRef"
        },
        "specialRatingProfile":{
            "description":"Service extended rating profile linked to the product.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/SpecialRatingProfile"
                }
            ]
        },
        "quantity":{
            "type":"integer",
            "description":"Is the quantity of service while creation of a purchase product."
        }
    }
}

Nested Schema : CycleEndRef

Match All

CycleEnd reference. A CycleEnd contains details regarding cycle end date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object CycleEndRef-allOf[1]
  CycleEnd reference. A CycleEnd contains details regarding cycle end date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"CycleEnd reference. A CycleEnd contains details regarding cycle end date for purchased product."
        }
    ]
}

Nested Schema : CycleStartRef

Match All

CycleStart reference. A CycleStart contains details regarding cycle start date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object CycleStartRef-allOf[1]
  CycleStart reference. A CycleStart contains details regarding cycle start date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"CycleStart reference. A CycleStart contains details regarding cycle start date for purchased product."
        }
    ]
}

Nested Schema : GracePeriodRef

Match All

GracePeriod reference. A GracePeriod contains details regarding grace period date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object GracePeriodRef-allOf[1]
  GracePeriod reference. A GracePeriod contains details regarding grace period date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"GracePeriod reference. A GracePeriod contains details regarding grace period date for purchased product."
        }
    ]
}

Nested Schema : productPrice

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPriceOracle" } }

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

Nested Schema : productRelationship

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationshipOracle" } }

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

Nested Schema : PurchaseEndRef

Match All

PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object PurchaseEndRef-allOf[1]
  PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product."
        }
    ]
}

Nested Schema : PurchaseStartRef

Match All

PurchaseStart reference. A PurchaseStart contains details regarding purchase start date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object PurchaseStartRef-allOf[1]
  PurchaseStart reference. A PurchaseStart contains details regarding purchase start date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"PurchaseStart reference. A PurchaseStart contains details regarding purchase start date for purchased product."
        }
    ]
}

Nested Schema : specialRatingProfile

Service extended rating profile linked to the product.

Match All

Service extended rating profile linked to the product.

Show Source

• object allOf SpecialRatingProfile
  Represents a product-linked special rating profile instance for BRM service extended rating.

{
    "description":"Service extended rating profile linked to the product.",
    "allOf":[
        {
            "$ref":"#/components/schemas/SpecialRatingProfile"
        }
    ]
}

Nested Schema : UsageEndRef

Match All

UsageEnd reference. A UsageEnd contains details regarding usage end date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object UsageEndRef-allOf[1]
  UsageEnd reference. A UsageEnd contains details regarding usage end date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"UsageEnd reference. A UsageEnd contains details regarding usage end date for purchased product."
        }
    ]
}

Nested Schema : UsageStartRef

Match All

UsageStart reference. A UsageStart contains details regarding usage start date for purchased product.

Show Source

• object CPUDatesExtension_FVO
  Contains the CPU extension dates' common properties.
• object UsageStartRef-allOf[1]
  UsageStart reference. A UsageStart contains details regarding usage start date for purchased product.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CPUDatesExtension_FVO"
        },
        {
            "type":"object",
            "description":"UsageStart reference. A UsageStart contains details regarding usage start date for purchased product."
        }
    ]
}

Nested Schema : CPUDatesExtension_FVO

Type: object

Contains the CPU extension dates' common properties.

Show Source

• amount(required): integer
  Indicates the amount of time of a given unit.
• unit(required): string
  Allowed Values: [ "seconds", "minutes", "hours", "days", "months", "acct_cycles", "first_usage", "absolute" ]

  Indicates the unit of time for the CPU extension date. Can be "seconds", "minutes", "hours", "days", "months", "acct_cycles", "first_usage" and "absolute".

{
    "type":"object",
    "description":"Contains the CPU extension dates' common properties.",
    "properties":{
        "amount":{
            "type":"integer",
            "description":"Indicates the amount of time of a given unit."
        },
        "unit":{
            "type":"string",
            "description":"Indicates the unit of time for the CPU extension date. Can be \"seconds\", \"minutes\", \"hours\", \"days\", \"months\", \"acct_cycles\", \"first_usage\" and \"absolute\".",
            "enum":[
                "seconds",
                "minutes",
                "hours",
                "days",
                "months",
                "acct_cycles",
                "first_usage",
                "absolute"
            ]
        }
    },
    "required":[
        "amount",
        "unit"
    ]
}

Nested Schema : CycleEndRef-allOf[1]

Type: object

CycleEnd reference. A CycleEnd contains details regarding cycle end date for purchased product.

Nested Schema : CycleStartRef-allOf[1]

Type: object

CycleStart reference. A CycleStart contains details regarding cycle start date for purchased product.

Nested Schema : GracePeriodRef-allOf[1]

Type: object

GracePeriod reference. A GracePeriod contains details regarding grace period date for purchased product.

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductPrice

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductPrice"
        },
        {
            "type":"object",
            "description":"A description of the price and discount awarded.",
            "properties":{
                "priceAlteration":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceAlterationOracle"
                    }
                },
                "priceType":{
                    "type":"string",
                    "description":"The price type&colon; <b>one-time</b> or <b>recurring</b>.",
                    "enum":[
                        "oneTime",
                        "recurring"
                    ]
                }
            },
            "required":[
                "priceType",
                "priceAlteration"
            ]
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductPrice":"#/components/schemas/ProductPriceOracle"
        }
    }
}

Match All

A description of the price and discount awarded.

Show Source

• object allOf Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPrice" } }
• object Discriminator: @type-allOf[1]
  A description of the price and discount awarded.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductPrice"
        },
        {
            "type":"object",
            "description":"A description of the price and discount awarded.",
            "properties":{
                "priceAlteration":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PriceAlterationOracle"
                    }
                },
                "priceType":{
                    "type":"string",
                    "description":"The price type&colon; <b>one-time</b> or <b>recurring</b>.",
                    "enum":[
                        "oneTime",
                        "recurring"
                    ]
                }
            },
            "required":[
                "priceType",
                "priceAlteration"
            ]
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductPrice":"#/components/schemas/ProductPriceOracle"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

A description of the price and discount awarded.

Show Source

• priceAlteration(required): array priceAlteration
• priceType(required): string
  Allowed Values: [ "oneTime", "recurring" ]

  The price type: one-time or recurring.

{
    "type":"object",
    "description":"A description of the price and discount awarded.",
    "properties":{
        "priceAlteration":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceAlterationOracle"
            }
        },
        "priceType":{
            "type":"string",
            "description":"The price type&colon; <b>one-time</b> or <b>recurring</b>.",
            "enum":[
                "oneTime",
                "recurring"
            ]
        }
    },
    "required":[
        "priceType",
        "priceAlteration"
    ]
}

Nested Schema : priceAlteration

Type: array

Show Source

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlterationOracle" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• PriceAlteration

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PriceAlteration"
        },
        {
            "type":"object",
            "description":"Is an amount, usually of money, that modifies the price charged for an order item.",
            "properties":{
                "priceType":{
                    "type":"string",
                    "description":"A category that describes the price, such as <b>AmountOverride</b>, <b>DiscountPercentageOverride</b>, or <b>DiscountAmountOverride</b>.",
                    "enum":[
                        "AmountOverride",
                        "DiscountPercentageOverride",
                        "DiscountAmountOverride"
                    ]
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PriceAlteration":"#/components/schemas/PriceAlterationOracle"
        }
    }
}

Match All

Is an amount, usually of money, that modifies the price charged for an order item.

Show Source

• object allOf Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlteration" } }
• object Discriminator: @type-allOf[1]
  Is an amount, usually of money, that modifies the price charged for an order item.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PriceAlteration"
        },
        {
            "type":"object",
            "description":"Is an amount, usually of money, that modifies the price charged for an order item.",
            "properties":{
                "priceType":{
                    "type":"string",
                    "description":"A category that describes the price, such as <b>AmountOverride</b>, <b>DiscountPercentageOverride</b>, or <b>DiscountAmountOverride</b>.",
                    "enum":[
                        "AmountOverride",
                        "DiscountPercentageOverride",
                        "DiscountAmountOverride"
                    ]
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PriceAlteration":"#/components/schemas/PriceAlterationOracle"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

Is an amount, usually of money, that modifies the price charged for an order item.

Show Source

• priceType: string
  Allowed Values: [ "AmountOverride", "DiscountPercentageOverride", "DiscountAmountOverride" ]

  A category that describes the price, such as AmountOverride, DiscountPercentageOverride, or DiscountAmountOverride.

{
    "type":"object",
    "description":"Is an amount, usually of money, that modifies the price charged for an order item.",
    "properties":{
        "priceType":{
            "type":"string",
            "description":"A category that describes the price, such as <b>AmountOverride</b>, <b>DiscountPercentageOverride</b>, or <b>DiscountAmountOverride</b>.",
            "enum":[
                "AmountOverride",
                "DiscountPercentageOverride",
                "DiscountAmountOverride"
            ]
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• ProductRelationship

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductRelationship"
        },
        {
            "type":"object",
            "description":"Used to describe the relationship between products.",
            "properties":{
                "relationshipType":{
                    "type":"string",
                    "description":"The relationship type&colon; <b>bundles</b>, <b>bundledBy</b>, <b>tiedDiscount</b>, <b>tiedProduct</b>.",
                    "enum":[
                        "bundles",
                        "bundledBy",
                        "tiedDiscount",
                        "tiedProduct"
                    ]
                }
            },
            "required":[
                "id",
                "relationshipType"
            ]
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductRelationship":"#/components/schemas/ProductRelationshipOracle"
        }
    }
}

Match All

Used to describe the relationship between products.

Show Source

• object allOf Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationship" } }
• object Discriminator: @type-allOf[1]
  Used to describe the relationship between products.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductRelationship"
        },
        {
            "type":"object",
            "description":"Used to describe the relationship between products.",
            "properties":{
                "relationshipType":{
                    "type":"string",
                    "description":"The relationship type&colon; <b>bundles</b>, <b>bundledBy</b>, <b>tiedDiscount</b>, <b>tiedProduct</b>.",
                    "enum":[
                        "bundles",
                        "bundledBy",
                        "tiedDiscount",
                        "tiedProduct"
                    ]
                }
            },
            "required":[
                "id",
                "relationshipType"
            ]
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductRelationship":"#/components/schemas/ProductRelationshipOracle"
        }
    }
}

Nested Schema : Discriminator: @type-allOf[1]

Type: object

Used to describe the relationship between products.

Show Source

• relationshipType(required): string
  Allowed Values: [ "bundles", "bundledBy", "tiedDiscount", "tiedProduct" ]

  The relationship type: bundles, bundledBy, tiedDiscount, tiedProduct.

{
    "type":"object",
    "description":"Used to describe the relationship between products.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The relationship type&colon; <b>bundles</b>, <b>bundledBy</b>, <b>tiedDiscount</b>, <b>tiedProduct</b>.",
            "enum":[
                "bundles",
                "bundledBy",
                "tiedDiscount",
                "tiedProduct"
            ]
        }
    },
    "required":[
        "id",
        "relationshipType"
    ]
}

Nested Schema : PurchaseEndRef-allOf[1]

Type: object

PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product.

Nested Schema : PurchaseStartRef-allOf[1]

Type: object

PurchaseStart reference. A PurchaseStart contains details regarding purchase start date for purchased product.

Nested Schema : SpecialRatingProfile

Type: object

Represents a product-linked special rating profile instance for BRM service extended rating.

Show Source

• @type: string
  Identifies the service extended rating profile type.
• data: array data
  The rating attribute values used by rating.
• id: string
  The profile identifier.
• label: string
  The label used to identify the special rating profile in rating rules.
• name: string
  The special rating profile name.
• referenceCount: integer
  The special rating profile reference count.
• status: string
  Allowed Values: [ "noop", "provisioning", "provisioningFailed", "active", "unprovisioning", "unprovisioningFailed", "unprovisioned", "suspending", "suspendingFailed", "suspended" ]

  The special rating profile provisioning status.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object"
        }
    ],
    "description":"Represents a product-linked special rating profile instance for BRM service extended rating.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The profile identifier."
        },
        "@type":{
            "type":"string",
            "description":"Identifies the service extended rating profile type."
        },
        "name":{
            "type":"string",
            "description":"The special rating profile name."
        },
        "label":{
            "type":"string",
            "description":"The label used to identify the special rating profile in rating rules."
        },
        "status":{
            "type":"string",
            "enum":[
                "noop",
                "provisioning",
                "provisioningFailed",
                "active",
                "unprovisioning",
                "unprovisioningFailed",
                "unprovisioned",
                "suspending",
                "suspendingFailed",
                "suspended"
            ],
            "description":"The special rating profile provisioning status."
        },
        "referenceCount":{
            "type":"integer",
            "description":"The special rating profile reference count."
        },
        "data":{
            "type":"array",
            "description":"The rating attribute values used by rating.",
            "items":{
                "$ref":"#/components/schemas/SpecialRatingProfileData"
            }
        }
    }
}

Match All

Represents a product-linked special rating profile instance for BRM service extended rating.

Represents a product-linked special rating profile instance for BRM service extended rating.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object SpecialRatingProfile-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object"
        }
    ],
    "description":"Represents a product-linked special rating profile instance for BRM service extended rating.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The profile identifier."
        },
        "@type":{
            "type":"string",
            "description":"Identifies the service extended rating profile type."
        },
        "name":{
            "type":"string",
            "description":"The special rating profile name."
        },
        "label":{
            "type":"string",
            "description":"The label used to identify the special rating profile in rating rules."
        },
        "status":{
            "type":"string",
            "enum":[
                "noop",
                "provisioning",
                "provisioningFailed",
                "active",
                "unprovisioning",
                "unprovisioningFailed",
                "unprovisioned",
                "suspending",
                "suspendingFailed",
                "suspended"
            ],
            "description":"The special rating profile provisioning status."
        },
        "referenceCount":{
            "type":"integer",
            "description":"The special rating profile reference count."
        },
        "data":{
            "type":"array",
            "description":"The rating attribute values used by rating.",
            "items":{
                "$ref":"#/components/schemas/SpecialRatingProfileData"
            }
        }
    }
}

Nested Schema : SpecialRatingProfile-allOf[1]

Type: object

Nested Schema : UsageEndRef-allOf[1]

Type: object

UsageEnd reference. A UsageEnd contains details regarding usage end date for purchased product.

Nested Schema : UsageStartRef-allOf[1]

Type: object

UsageStart reference. A UsageStart contains details regarding usage start date for purchased product.

Examples

Select an example RetrieveProductByList RetrieveProductByListwithFieldsSelection

400 Response

The server received a bad request.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The request is unauthorized.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request is forbidden.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The resource is not found.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

The method is not allowed.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The server encountered an internal error.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

501 Response

The server does not implement this operation.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

503 Response

The service is unavailable.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

Examples

• Example 1: Get Product by isBundle

• Example 2: Get Product by Description

• Example 3: Get Product by Start Date

• Example 4: Get a Product by its productOffering name

• Example 5: Get A Product by its ProductCharacteristic name

• Example 6: Get A Product by its productCharacteristic valueType

• Example 7: Get A Product List That Skips the First Two Results

• Example 8: Get A Product by its productCharacteristic Value

• Example 9: Filter a Product by its Billing Account ID

• Example 10: Filter A Product by its Realizing Service ID

• Example 11: GET purchased product by specialRatingProfile.id

• Example 12: Filtering by specialRatingProfile.name

• Example 13: GET purchased product by specialRatingProfile.id: Custom

• Example 14: Filtering Products by Offset Dates

Example 1: Get Product by isBundle

This example shows how to retrieve products 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/brm/productInventory/v5/product?isBundle=true'

Response Body

If successful, the response code 200 is returned with the following response body.

[
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "product": [
            {
                "isBundle": false,
                "name": "Voice Over IP ",
                "@type": "Product",
                "description": "Test description",
                "terminationDate": "2020-01-04T08:00:00.00Z",
                "productOffering": {
                    "id": "0.0.0.1+-product+174600",
                    "name": "Teen Telephony C4B0",
                    "@type": "ProductOffering"
                },
                "id": "0.0.0.1+-purchased_product+174363",
                "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+174363",
                "status": "active",
                "quantity": 1,
                "billingAccount": {
                    "id": "0.0.0.1+-account+172465",
                    "name": "Junior Walter",
                    "@type": "BillingAccount"
                },
                "realizingService": [
                    {
                        "id": "0.0.0.1+-service-telco-gsm-telephony+173083",
                        "@type": "RealizingService"
                    }
                ],
                "startDate": "2020-01-03T08:00:00.00Z",
                "cycleStartDate": "2020-01-03T08:00:00.00Z",
                "purchaseStartDate": "2020-01-03T08:00:00.00Z",
                "usageStartDate": "2020-01-03T08:00:00.00Z",
                "cycleEndDate": "2020-01-04T08:00:00.00Z",
                "purchaseEndDate": "2020-01-04T08:00:00.00Z",
                "usageEndDate": "2020-01-04T08:00:00.00Z"
            }
        ],
        "description": "Test description",
        "terminationDate": "2020-01-04T08:00:00.00Z",
        "productOffering": {
            "id": "0.0.0.1+-product+174600",
            "name": "Teen Telephony C4B0",
            "@type": "ProductOffering"
        },
        "productCharacteristic": [
            {
                "id": "",
                "name": "IMEI",
                "valueType": "string",
                "value": "IMEI_FlatTelco",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "MSISDN",
                "valueType": "string",
                "value": "90121391291",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "ServiceType",
                "valueType": "string",
                "value": "/service/telco/gsm/telephony",
                "@type": "StringCharacteristic"
            }
        ],
        "id": "0.0.0.1+-purchased_product+173595",
        "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+173595",
        "status": "active",
        "quantity": 1,
        "billingAccount": {
            "id": "0.0.0.1+-account+172465",
            "name": "Junior Walter",
            "@type": "BillingAccount"
        },
        "realizingService": [
            {
                "id": "0.0.0.1+-service-telco-gsm-telephony+173083",
                "@type": "RealizingService"
            }
        ],
        "startDate": "2020-01-03T08:00:00.00Z",
        "cycleStartDate": "2020-01-03T08:00:00.00Z",
        "purchaseStartDate": "2020-01-03T08:00:00.00Z",
        "usageStartDate": "2020-01-03T08:00:00.00Z",
        "cycleEndDate": "2020-01-04T08:00:00.00Z",
        "purchaseEndDate": "2020-01-04T08:00:00.00Z",
        "usageEndDate": "2020-01-04T08:00:00.00Z"
    },
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "product": [
            {
                "isBundle": false,
                "name": "Voice Over IP ",
                "@type": "Product",
                "description": "Test description",
                "terminationDate": "2020-01-04T08:00:00.00Z",
                "productOffering": {
                    "id": "0.0.0.1+-product+174600",
                    "name": "Teen Telephony C4B0",
                    "@type": "ProductOffering"
                },
                "id": "0.0.0.1+-purchased_product+175914",
                "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+175914",
                "status": "active",
                "quantity": 1,
                "billingAccount": {
                    "id": "0.0.0.1+-account+169803",
                    "name": "Junior Walter",
                    "@type": "BillingAccount"
                },
                "realizingService": [
                    {
                        "id": "0.0.0.1+-service-telco-gsm-telephony+174634",
                        "@type": "RealizingService"
                    }
                ],
                "startDate": "2020-01-03T08:00:00.00Z",
                "cycleStartDate": "2020-01-03T08:00:00.00Z",
                "purchaseStartDate": "2020-01-03T08:00:00.00Z",
                "usageStartDate": "2020-01-03T08:00:00.00Z",
                "cycleEndDate": "2020-01-04T08:00:00.00Z",
                "purchaseEndDate": "2020-01-04T08:00:00.00Z",
                "usageEndDate": "2020-01-04T08:00:00.00Z"
            }
        ],
        "description": "Test description",
        "terminationDate": "2020-01-04T08:00:00.00Z",
        "productOffering": {
            "id": "0.0.0.1+-product+174600",
            "name": "Teen Telephony C4B0",
            "@type": "ProductOffering"
        },
        "productCharacteristic": [
            {
                "id": "",
                "name": "IMEI",
                "valueType": "string",
                "value": "IMEI_FlatTelco",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "MSISDN",
                "valueType": "string",
                "value": "90121391291",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "ServiceType",
                "valueType": "string",
                "value": "/service/telco/gsm/telephony",
                "@type": "StringCharacteristic"
            }
        ],
        "id": "0.0.0.1+-purchased_product+174378",
        "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+174378",
        "status": "active",
        "quantity": 1,
        "billingAccount": {
            "id": "0.0.0.1+-account+169803",
            "name": "Junior Walter",
            "@type": "BillingAccount"
        },
        "realizingService": [
            {
                "id": "0.0.0.1+-service-telco-gsm-telephony+174634",
                "@type": "RealizingService"
            }
        ],
        "startDate": "2020-01-03T08:00:00.00Z",
        "cycleStartDate": "2020-01-03T08:00:00.00Z",
        "purchaseStartDate": "2020-01-03T08:00:00.00Z",
        "usageStartDate": "2020-01-03T08:00:00.00Z",
        "cycleEndDate": "2020-01-04T08:00:00.00Z",
        "purchaseEndDate": "2020-01-04T08:00:00.00Z",
        "usageEndDate": "2020-01-04T08:00:00.00Z"
    }
]

Example 2: Get Product by Description

This example shows how to retrieve products 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/brm/productInventory/v5/product?description=DBE_Product_DESCRIPTION'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "DBE_Product_DESCRIPTION",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+884459",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+884459",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  }
]

Example 3: Get Product by Start Date

This example shows how to retrieve products 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/brm/productInventory/v5/product?startDate=2018-01-01T08:00:00.00Z'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+168427",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+168427",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  }
]

Example 4: Get a Product by its productOffering name

This example shows how to retrieve products 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/brm/productInventory/v5/0.0.0.1+-product+168011'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+168427",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+168427",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170347",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170347",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170603",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+175689",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+175689",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+175177",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 5: Get A Product by its ProductCharacteristic name

This example shows how to retrieve products 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/brm/productInventory/v5/product?filter=$[?@.productCharacteristic[?@.name==MSISDN]]'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+168427",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+168427",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170345",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170345",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170601",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 6: Get A Product by its productCharacteristic valueType

This example shows how to retrieve products 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/brm/productInventory/v5/product?filter=$[?@.productCharacteristic[?@.valueType==string]]'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": true,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "IMEI-006",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+167961",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+167961",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168937",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 7: Get A Product List That Skips the First Two Results

This example shows how to retrieve products 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/brm/productInventory/v5/product?offset=2'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+168427",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+168427",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170345",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170345",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170601",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170347",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170347",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170603",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 8: Get A Product by its productCharacteristic Value

This example shows how to retrieve products 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/brm/productInventory/v5/product?filter=$[?@.productCharacteristic[?@.value==flattened_characteristic_007]]'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": true,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "IMEI-006",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+167961",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+167961",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168937",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2018-01-01T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+168427",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+168427",
    "status": "cancelled",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+169803",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+168683",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2018-01-01T08:00:00.00Z",
    "purchaseEndDate": "2018-01-01T08:00:00.00Z",
    "usageEndDate": "2018-01-01T08:00:00.00Z"
  }
]

Example 9: Filter a Product by its Billing Account ID

This example shows how to retrieve products 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/brm/productInventory/v5/product?billingAccount.id=0.0.0.1+-account+172465'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170345",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170345",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170601",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": true,
    "name": "Voice Over IP ",
    "@type": "Product",
    "product": [
      {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "description": "Test description",
        "terminationDate": "2020-01-04T08:00:00.00Z",
        "productOffering": {
          "id": "0.0.0.1+-product+174600",
          "name": "Teen Telephony C4B0",
          "@type": "ProductOffering"
        },
        "id": "0.0.0.1+-purchased_product+174363",
        "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+174363",
        "status": "active",
        "quantity": 1,
        "billingAccount": {
          "id": "0.0.0.1+-account+172465",
          "name": "Junior Walter",
          "@type": "BillingAccount"
        },
        "realizingService": [
          {
            "id": "0.0.0.1+-service-telco-gsm-telephony+173083",
            "@type": "RealizingService"
          }
        ],
        "startDate": "2020-01-03T08:00:00.00Z",
        "cycleStartDate": "2020-01-03T08:00:00.00Z",
        "purchaseStartDate": "2020-01-03T08:00:00.00Z",
        "usageStartDate": "2020-01-03T08:00:00.00Z",
        "cycleEndDate": "2020-01-04T08:00:00.00Z",
        "purchaseEndDate": "2020-01-04T08:00:00.00Z",
        "usageEndDate": "2020-01-04T08:00:00.00Z"
      }
    ],
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+173595",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+173595",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+173083",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+168011",
      "name": "Teen Telephony C4B",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+175689",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+175689",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+175177",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  },
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "id": "0.0.0.1+-purchased_product+174363",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+174363",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+173083",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 10: Filter A Product by its Realizing Service ID

This example shows how to retrieve products 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/brm/productInventory/v5/product?realizingService.id=0.0.0.1+-service-telco-gsm-telephony+170601'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "isBundle": false,
    "name": "Voice Over IP ",
    "@type": "Product",
    "description": "Test description",
    "terminationDate": "2020-01-04T08:00:00.00Z",
    "productOffering": {
      "id": "0.0.0.1+-product+174600",
      "name": "Teen Telephony C4B0",
      "@type": "ProductOffering"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "IMEI",
        "valueType": "string",
        "value": "IMEI_FlatTelco",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "MSISDN",
        "valueType": "string",
        "value": "90121391291",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "id": "0.0.0.1+-purchased_product+170345",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+170345",
    "status": "active",
    "quantity": 1,
    "billingAccount": {
      "id": "0.0.0.1+-account+172465",
      "name": "Junior Walter",
      "@type": "BillingAccount"
    },
    "realizingService": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+170601",
        "@type": "RealizingService"
      }
    ],
    "startDate": "2020-01-03T08:00:00.00Z",
    "cycleStartDate": "2020-01-03T08:00:00.00Z",
    "purchaseStartDate": "2020-01-03T08:00:00.00Z",
    "usageStartDate": "2020-01-03T08:00:00.00Z",
    "cycleEndDate": "2020-01-04T08:00:00.00Z",
    "purchaseEndDate": "2020-01-04T08:00:00.00Z",
    "usageEndDate": "2020-01-04T08:00:00.00Z"
  }
]

Example 11: GET purchased product by specialRatingProfile.id

This example shows how to retrieve products 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/brm/productInventory/v5/product?specialRatingProfile.id=0.0.0.1+-profile-serv_extrating+884466'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "productRelationship": [
      {
        "id": "0.0.0.1+-purchased_product+504455",
        "relationshipType": "bundledBy",
        "@type": "ProductRelationshipOracle"
      }
    ],
    "@type": "ProductOracle",
    "terminationDate": "2020-01-02T08:00:00.00Z",
    "status": "active",
    "id": "0.0.0.1+-purchased_product+364887",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+364887",
    "billingAccount": {
      "id": "0.0.0.1+-account+734874",
      "name": "Junior Walter",
      "@type": "BillingAccountRef"
    },
    "realizingService": [
      {
        "id": "",
        "@type": "ServiceRef"
      }
    ],
    "isBundle": false,
    "name": "Voice Over IP",
    "specialRatingProfile": {
      "id": "0.0.0.1+-profile-serv_extrating+884466",
      "data": [
        {
          "validFor": {
            "endDateTime": "",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335686849545"
        },
        {
          "validFor": {
            "endDateTime": "2031-05-01T00:00:00.00Z",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335873473632"
        }
      ],
      "name": "FRIENDS_FAMILY",
      "label": "Smart Calling up to 5 Numbers",
      "@type": "SpecialRatingProfile",
      "status": "noop",
      "referenceCount": 1
    },
    "description": "Child product inside bundle",
    "productOffering": {
      "id": "",
      "@type": "ProductOfferingRef"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceId",
        "valueType": "string",
        "value": "BundledChildService_046",
        "@type": "StringCharacteristic"
      }
    ],
    "quantity": 1,
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2020-01-02T08:00:00.00Z",
    "purchaseEndDate": "2020-01-02T08:00:00.00Z",
    "usageEndDate": "2020-01-02T08:00:00.00Z"
  }
]

Example 12: Filtering by specialRatingProfile.name

This example shows how to retrieve products 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/brm/productInventory/v5/product?specialRatingProfile.name=FRIENDS_FAMILY'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "productRelationship": [
      {
        "id": "0.0.0.1+-purchased_product+364887",
        "relationshipType": "bundles",
        "@type": "ProductRelationshipOracle"
      }
    ],
    "@type": "ProductOracle",
    "terminationDate": "2020-01-02T08:00:00.00Z",
    "status": "active",
    "id": "0.0.0.1+-purchased_product+504455",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+504455",
    "billingAccount": {
      "id": "0.0.0.1+-account+734874",
      "name": "Junior Walter",
      "@type": "BillingAccountRef"
    },
    "realizingService": [
      {
        "id": "",
        "@type": "ServiceRef"
      }
    ],
    "isBundle": true,
    "name": "Voice Over IP",
    "specialRatingProfile": {
      "id": "0.0.0.1+-profile-serv_extrating+663797",
      "data": [
        {
          "validFor": {
            "endDateTime": "",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335686849545"
        },
        {
          "validFor": {
            "endDateTime": "2031-05-01T00:00:00.00Z",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335873473632"
        }
      ],
      "name": "FRIENDS_FAMILY",
      "label": "Smart Calling up to 5 Numbers",
      "@type": "SpecialRatingProfile",
      "status": "noop",
      "referenceCount": 1
    },
    "description": "Bundle product for Teen Telephony C4B",
    "productOffering": {
      "id": "",
      "@type": "ProductOfferingRef"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "ServiceId",
        "valueType": "string",
        "value": "BundleService_046",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      }
    ],
    "quantity": 1,
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2020-01-02T08:00:00.00Z",
    "purchaseEndDate": "2020-01-02T08:00:00.00Z",
    "usageEndDate": "2020-01-02T08:00:00.00Z"
  },
  {
    "productRelationship": [
      {
        "id": "0.0.0.1+-purchased_product+504455",
        "relationshipType": "bundledBy",
        "@type": "ProductRelationshipOracle"
      }
    ],
    "@type": "ProductOracle",
    "terminationDate": "2020-01-02T08:00:00.00Z",
    "status": "active",
    "id": "0.0.0.1+-purchased_product+364887",
    "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+364887",
    "billingAccount": {
      "id": "0.0.0.1+-account+734874",
      "name": "Junior Walter",
      "@type": "BillingAccountRef"
    },
    "realizingService": [
      {
        "id": "",
        "@type": "ServiceRef"
      }
    ],
    "isBundle": false,
    "name": "Voice Over IP",
    "specialRatingProfile": {
      "id": "0.0.0.1+-profile-serv_extrating+884466",
      "data": [
        {
          "validFor": {
            "endDateTime": "",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335686849545"
        },
        {
          "validFor": {
            "endDateTime": "2031-05-01T00:00:00.00Z",
            "startDateTime": "2031-04-02T18:23:39.00Z"
          },
          "name": "dummy",
          "value": "0039335873473632"
        }
      ],
      "name": "FRIENDS_FAMILY",
      "label": "Smart Calling up to 5 Numbers",
      "@type": "SpecialRatingProfile",
      "status": "noop",
      "referenceCount": 1
    },
    "description": "Child product inside bundle",
    "productOffering": {
      "id": "",
      "@type": "ProductOfferingRef"
    },
    "productCharacteristic": [
      {
        "id": "",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      },
      {
        "id": "",
        "name": "ServiceId",
        "valueType": "string",
        "value": "BundledChildService_046",
        "@type": "StringCharacteristic"
      }
    ],
    "quantity": 1,
    "startDate": "2018-01-01T08:00:00.00Z",
    "cycleStartDate": "2018-01-01T08:00:00.00Z",
    "purchaseStartDate": "2018-01-01T08:00:00.00Z",
    "usageStartDate": "2018-01-01T08:00:00.00Z",
    "cycleEndDate": "2020-01-02T08:00:00.00Z",
    "purchaseEndDate": "2020-01-02T08:00:00.00Z",
    "usageEndDate": "2020-01-02T08:00:00.00Z"
  }
]

Example 13: GET purchased product by specialRatingProfile.id: Custom

This example shows how to retrieve products 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/brm/productInventory/v5/product?specialRatingProfile.id=88-1ZVHQ4-044'

Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "@type": "Product",
    "cycleStart": {
      "unit": "absolute",
      "amount": 0
    },
    "purchaseStart": {
      "unit": "absolute",
      "amount": 0
    },
    "terminationDate": "2020-01-02T08:00:00.00Z",
    "gracePeriod": {
      "unit": "absolute",
      "amount": 0
    },
    "purchaseEnd": {
      "unit": "absolute",
      "amount": 0
    },
    "status": "active",
    "id": "ERA_PROD_DBE_p040",
    "href": "https://localhost:9998/brm/productInventory/v5/product/ERA_PROD_DBE_p040",
    "billingAccount": {
      "id": "cuke4brm-rsm-customer-actno-new70",
      "name": "Junior Walter",
      "@type": "BillingAccountRef"
    },
    "realizingService": [
      {
        "id": "one_product_characteristic-C044f",
        "@type": "ServiceRef"
      }
    ],
    "usageEnd": {
      "unit": "absolute",
      "amount": 0
    },
    "isBundle": false,
    "name": "Voice Over IP",
    "specialRatingProfile": {
      "id": "88-1ZVHQ4-044",
      "@type": "SpecialRatingProfile",
      "name": "FRIENDS_FAMILY",
      "label": "Smart Calling up to 5 Numbers",
      "status": "noop",
      "referenceCount": 1,
      "data": [
        {
          "name": "dummy",
          "value": "0449335686849545",
          "validFor": {
            "startDateTime": "2031-04-02T18:23:39.00Z"
          }
        },
        {
          "name": "dummy",
          "value": "0449335873473632",
          "validFor": {
            "startDateTime": "2031-04-02T18:23:39.00Z",
            "endDateTime": "2031-05-01T00:00:00.00Z"
          }
        },
        {
          "name": "dummy",
          "value": "0409335686849555",
          "validFor": {
            "startDateTime": "2031-04-02T18:23:39.00Z",
            "endDateTime": "2031-05-01T00:00:00.00Z"
          }
        }
      ]
    },
    "description": "Child product inside bundle",
    "productOffering": {
      "id": "",
      "@type": "ProductOfferingRef",
      "name": ""
    },
    "productCharacteristic": [
      {
        "id": "PC_BundledChild_TeenTelephony_044_1f",
        "name": "ServiceType",
        "valueType": "string",
        "value": "/service/telco/gsm/telephony",
        "@type": "StringCharacteristic"
      },
      {
        "id": "PC_BundledChild_TeenTelephony_044_2f",
        "name": "ServiceId",
        "valueType": "string",
        "value": "BundledChildService_044ff",
        "@type": "StringCharacteristic"
      }
    ],
    "usageStart": {
      "unit": "absolute",
      "amount": 0
    },
    "cycleEnd": {
      "unit": "absolute",
      "amount": 0
    },
    "quantity": 1,
    "startDate": "2018-01-01T08:00:00.00Z"
  }
]

Example 14: Filtering Products by Offset Dates

Note:

Filtering by offset dates is supported for the following fields: cycleStartDate, purchaseStartDate, usageStartDate, cycleEndDate, purchaseEndDate, and usageEndDate.

This example shows how to retrieve products 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/brm/productInventory/v5/purchaseStartDate=2018-01-11T08:00:00.00Z&cycleEndDate=2018-03-11T08:00:00.00Z'

Response Body

If successful, the response code 200 is returned with the following response body.

 [
    {
        "cycleEndDate": "2018-03-11T08:00:00.00Z",
        "@type": "Product",
        "terminationDate": "2018-03-11T08:00:00.00Z",
        "gracePeriod": {
            "unit": "days",
            "amount": 1
        },
        "id": "0.0.0.1+-purchased_product+219251",
        "href": "https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+219251",
        "status": "active",
        "purchaseStartDate": "2018-01-11T08:00:00.00Z",
        "usageStartDate": "2018-01-11T08:00:00.00Z",
        "cycleStartDate": "2018-01-11T08:00:00.00Z",
        "billingAccount": {
            "id": "0.0.0.1+-account+211178",
            "name": "child-billunit ",
            "@type": "BillingAccountRef"
        },
        "purchaseEndDate": "2018-03-11T08:00:00.00Z",
        "realizingService": [
            {
                "id": "0.0.0.1+-service-ip+220083",
                "@type": "ServiceRef"
            }
        ],
        "isBundle": true,
        "name": "Voice Over IP12",
        "description": "Test description",
        "productOffering": {
            "id": "0.0.0.1+-product+47039",
            "name": "Product 1a - Internet Access",
            "@type": "ProductOfferingRef"
        },
        "productCharacteristic": [
            {
                "id": "",
                "name": "ServiceType",
                "valueType": "string",
                "value": "/service/ip",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "ServicePassword",
                "valueType": "string",
                "value": "Cgbu1234#",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "ServiceLogin",
                "valueType": "string",
                "value": "OotbNewServiceLoginIpCPUDates_0001",
                "@type": "StringCharacteristic"
            }
        ],
        "quantity": 2,
        "startDate": "2018-01-11T08:00:00.00Z",
        "usageEndDate": "2018-03-11T08:00:00.00Z"
    }
]

Back to Top