REST Services Manager API for Billing and Revenue Management

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.
description: string

The description of the resource.
fields: string

The comma-separated properties to be provided in response.
filter: string
The advanced filter expression for querying nested fields (for example, JSONPath).

Examples
isBundle: boolean

Wether the resource is a bundle.
limit: integer

The requested number of resources to be provided in response.
name: string

The name of the resource.
offset: integer

The requested index for start of resources to be provided in 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.
quantity: integer

The service quantity when creating a purchase product.
realizingService.id: string

The ID of the associated realizing service.
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
```

There's no request body for this operation.

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 matching criteria.

Root Schema : schema

Match One Schema

Show Source

object Product

A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
ProductOracle

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

Nested Schema : Product

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(s) and / or resource(s).

Show Source

@type: string

This defines the sub-class entity name when sub-classing.
id(required): string

Unique identifier of the product.
ownerAccount: object OwnerAccount

Provides unique identifier of the owner account.
productCharacteristic: array productCharacteristic
productTerm: array productTerm
serviceAccount: object ServiceAccount

Provides unique identifier of the service account.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product."
        },
        "productCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "productTerm":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductTerm"
            }
        },
        "ownerAccount":{
            "$ref":"#/components/schemas/OwnerAccount"
        },
        "serviceAccount":{
            "$ref":"#/components/schemas/ServiceAccount"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "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(s) and / or resource(s)."
}

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

object Product

A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
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"
                },
                "gracePeriod":{
                    "$ref":"#/components/schemas/GracePeriodRef"
                },
                "quantity":{
                    "type":"integer",
                    "description":"Is the quantity of service while creation of a purchase product."
                }
            }
        }
    ]
}

Nested Schema : OwnerAccount

Type: object

Provides unique identifier of the owner account.

Show Source

@baseType: string

Title: Base Type

The superclass of the object.
@referredType: string

Title: Referred Type

The type of the object, in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The subclass of the object.
href: string

Title: Owner Account Href

The href of the owner account reference.
id: string

Title: Owner Account ID

Unique identifier of the owner.
name: string

Title: Owner Account Name

The name of the owner account reference.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Owner Account ID",
            "description":"Unique identifier of the owner."
        },
        "href":{
            "type":"string",
            "title":"Owner Account Href",
            "description":"The href of the owner account reference."
        },
        "name":{
            "type":"string",
            "title":"Owner Account Name",
            "description":"The name of the owner account reference."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The superclass of the object."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The subclass of the object."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The type of the object, in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"Provides unique identifier of the owner account."
}

Nested Schema : productCharacteristic

Type: array

Show Source

Array of: Characteristic

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

Nested Schema : productTerm

Type: array

Show Source

Array of: object ProductTerm

Description of a product term linked to this product. This represents a commitment with a duration.

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

Nested Schema : ServiceAccount

Type: object

Provides unique identifier of the service account.

Show Source

@baseType: string

Title: Base Type

The superclass of the object.
@referredType: string

Title: Referred Type

The type of the object in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The subclass of the object.
href: string

Title: Service Account Href

The href of the service account reference.
id: string

Title: Service Account ID

Unique identifier of the service.
name: string

Title: Service Account Name

The name of the service account reference.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Service Account ID",
            "description":"Unique identifier of the service."
        },
        "href":{
            "type":"string",
            "title":"Service Account Href",
            "description":"The href of the service account reference."
        },
        "name":{
            "type":"string",
            "title":"Service Account Name",
            "description":"The name of the service account reference."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The superclass of the object."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The subclass of the object."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The type of the object in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"Provides unique identifier of the service account."
}

Nested Schema : Characteristic

Match All

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

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Characteristic-allOf[1]

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

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

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Characteristic-allOf[1]

Type: object

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

Show Source

characteristicRelationship: array characteristicRelationship
id: string

The unique identifier of the characteristic.
name: string

The name of the characteristic.
valueType: string

The data type of the value of the characteristic.

{
    "type":"object",
    "description":"The given characteristic of an object or entity through a name/value pair.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the characteristic."
        },
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type of the value of the characteristic."
        },
        "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 characteristic that is related to the current Characteristic.

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object CharacteristicRelationship-allOf[1]

The characteristic that is related to the current Characteristic.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"The characteristic that is related to the current Characteristic.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The unique identifier of the characteristic."
                },
                "relationshipType":{
                    "type":"string",
                    "description":"The type of relationship."
                }
            }
        }
    ]
}

Nested Schema : CharacteristicRelationship-allOf[1]

Type: object

The characteristic that is related to the current Characteristic.

Show Source

id: string

The unique identifier of the characteristic.
relationshipType: string

The type of relationship.

{
    "type":"object",
    "description":"The characteristic that is related to the current Characteristic.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier of the characteristic."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship."
        }
    }
}

Nested Schema : ProductTerm

Type: object

Description of a product term linked to this product. This represents a commitment with a duration.

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

This defines the sub-class entity name when sub-classing.
commitmentType: string

Commitment type of the product term.
description: string

Description of the product term.
duration: object Quantity

The amount in a given unit.
name: string

Name of the product term.

{
    "type":"object",
    "description":"Description of a product term linked to this product. This represents a commitment with a duration.",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the product term."
        },
        "name":{
            "type":"string",
            "description":"Name of the product term."
        },
        "commitmentType":{
            "type":"string",
            "description":"Commitment type of the product term."
        },
        "duration":{
            "$ref":"#/components/schemas/Quantity"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    }
}

Nested Schema : Quantity

Type: object

The amount in a given unit.

Show Source

amount: number (float)

Default Value: 1

The numeric value in a given unit.
units: string

The unit.

{
    "type":"object",
    "description":"The amount in a given unit.",
    "properties":{
        "amount":{
            "type":"number",
            "format":"float",
            "default":1,
            "description":"The numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"The unit."
        }
    }
}

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
cycleStart: CycleStartRef
gracePeriod: GracePeriodRef
productPrice: array productPrice
productRelationship: array productRelationship
purchaseEnd: PurchaseEndRef
purchaseStart: PurchaseStartRef
quantity: integer

Is the quantity of service while creation of a purchase product.
usageEnd: UsageEndRef
usageStart: UsageStartRef

{
    "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"
        },
        "gracePeriod":{
            "$ref":"#/components/schemas/GracePeriodRef"
        },
        "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 : 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

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

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @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: object Price

Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
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-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 : Price

Type: object

Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.

Show Source

@type: string

This defines the sub-class entity name when sub-classing.
dutyFreeAmount: object Money

The base / value business entity used to represent money.
percentage: number (float)
taxAmount: object Money

The base / value business entity used to represent money.
taxIncludedAmount: object Money

The base / value business entity used to represent money.

{
    "type":"object",
    "description":"Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.",
    "properties":{
        "percentage":{
            "type":"number",
            "format":"float"
        },
        "taxIncludedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "dutyFreeAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "taxAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    }
}

Nested Schema : priceAlteration

Type: array

Show Source

Array of: object PriceAlteration

The object is an amount, usually of money, that modifies the price charged for an order item.

{
    "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 : Money

Type: object

The base / value business entity used to represent money.

Show Source

unit: string

The currency (ISO4217 norm uses 3 letters to define the currency).
value: number (float)

The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type

{
    "type":"object",
    "description":"The base / value business entity used to represent money.",
    "properties":{
        "unit":{
            "type":"string",
            "description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
        },
        "value":{
            "type":"number",
            "format":"float",
            "description":"The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type"
        }
    }
}

Nested Schema : PriceAlteration

Type: object

The object is an amount, usually of money, that modifies the price charged for an order item.

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type: string

This defines the sub-class entity name when sub-classing.
description: string

A narrative that explains in detail the semantics of this order item price alteration.
name: string

Name of the order item price alteration.
price(required): object Price

Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
priceType(required): string

A category that describes the price such as recurring, one time and usage.
priority: integer

It is a priority level for applying this alteration among all the defined alterations on the order item price.
recurringChargePeriod: string

Refers to a timeline, like month, week, etc.
unitOfMeasure: string

Refers to a unit of measurement like minutes, GB, etc.

{
    "type":"object",
    "description":"The object is an amount, usually of money, that modifies the price charged for an order item.",
    "required":[
        "price",
        "priceType"
    ],
    "properties":{
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail the semantics of this order item price alteration."
        },
        "name":{
            "type":"string",
            "description":"Name of the order item price alteration."
        },
        "priceType":{
            "type":"string",
            "description":"A category that describes the price such as recurring, one time and usage."
        },
        "priority":{
            "type":"integer",
            "description":"It is a priority level for applying this alteration among all the defined alterations on the order item price."
        },
        "recurringChargePeriod":{
            "type":"string",
            "description":"Refers to a timeline, like <b>month, week, etc</b>."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Refers to a unit of measurement like <b>minutes, GB, etc</b>."
        },
        "price":{
            "$ref":"#/components/schemas/Price"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    }
}

Nested Schema : EntityRef

Match All

The entity reference schema to be use for all entityRef class.

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Addressable

The base schema for adressable entities.
object EntityRef-allOf[2]

The entity reference schema to be use for all entityRef class.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"The entity reference schema to be use for all entityRef class.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the referred entity."
                },
                "@referredType":{
                    "type":"string",
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Addressable

Type: object

The base schema for adressable entities.

Show Source

href: string

The hyperlink reference.
id: string

The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

The entity reference schema to be use for all entityRef class.

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 name of the referred entity.

{
    "type":"object",
    "description":"The entity reference schema to be use for all entityRef class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "description":"The name of the referred entity."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

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 : 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 PriceAlteration

The object is an amount, usually of money, that modifies the price charged for an order item.
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

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

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @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-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 : 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

400 Response

The server received a bad request.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

401 Response

The request was not authorized.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

403 Response

The request was forbidden.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

404 Response

The requested resource cannot be found.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

405 Response

The method is not allowed.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

500 Response

THe system has encountered an internal server error.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

501 Response

The request was not implemented.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

503 Response

The service is unavailable.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

Examples

Example 1: Get Product by isBundle

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

curl -X GET 'http://host:port/brm/productInventory/version/product?isBundle=true'

Example of the Response Body

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

[
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "product": [
            {
                "isBundle": false,
                "name": "Voice Over IP ",
                "@type": "Product",
                "cycleStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "description": "Test description",
                "terminationDate": "2020-01-04T08:00:00.00Z",
                "productOffering": {
                    "id": "0.0.0.1+-product+174600",
                    "name": "Teen Telephony C4B0",
                    "@type": "ProductOffering"
                },
                "usageStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "gracePeriod": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "cycleEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "id": "0.0.0.1+-purchased_product+174363",
                "href": "https://localhost:9998/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",
                "usageEnd": {
                    "unit": "absolute",
                    "amount": 0
                }
            }
        ],
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+173595",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "product": [
            {
                "isBundle": false,
                "name": "Voice Over IP ",
                "@type": "Product",
                "cycleStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "description": "Test description",
                "terminationDate": "2020-01-04T08:00:00.00Z",
                "productOffering": {
                    "id": "0.0.0.1+-product+174600",
                    "name": "Teen Telephony C4B0",
                    "@type": "ProductOffering"
                },
                "usageStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "gracePeriod": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "cycleEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "id": "0.0.0.1+-purchased_product+175914",
                "href": "https://localhost:9998/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",
                "usageEnd": {
                    "unit": "absolute",
                    "amount": 0
                }
            }
        ],
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+174378",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 2: Get Product by Description

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

curl -X GET 'http://host:port/brm/productInventory/version/product?description=DBE_Product_DESCRIPTION'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+884459",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 3: Get Product By Start Date

The following example shows how to get a purchased product by its start date by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?startDate=2018-01-01T08:00:00.00Z'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+168427",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 4: Get A Product by its productOffering

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

curl -X GET 'http://host:port/brm/productInventory/version/product?productOffering.name=Teen%20Telephony%20C4B'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+168427",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170347",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+175689",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 5: Get A Product by its ProductCharacteristic

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

curl -X GET 'http://host:port/brm/productInventory/version/product?filter=$[?@.productCharacteristic[?@.name==MSISDN]]

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+168427",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170345",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 6: Get A Product by its productCharacteristic valueType

The following example shows how to get a purchased product by its productCharacteristic valueType by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?filter=$[?@.productCharacteristic[?@.valueType==string]'

Example of the Response Body

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

[
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+167961",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+167961",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

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

The following example shows how to get a get a product list that skips the first two results by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?offset=2'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+168427",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170345",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170347",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 8: Get A Product by its productCharacteristic value

The following example shows how to get a purchased product by its productCharacteristic value by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?filter=$[?@.productCharacteristic[?@.value==flattened_characteristic_007]]'

Example of the Response Body

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

[
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+167961",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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": "flattened_characteristic_007",
                "@type": "StringCharacteristic"
            },
            {
                "id": "",
                "name": "ServiceType",
                "valueType": "string",
                "value": "/service/telco/gsm/telephony",
                "@type": "StringCharacteristic"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+168427",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 9: Filter a Product By Its Billing Account ID

The following example shows how to filter a product by it's billing account ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?billingAccount.id=0.0.0.1+-account+172465'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170345",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    },
    {
        "isBundle": true,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "product": [
            {
                "isBundle": false,
                "name": "Voice Over IP ",
                "@type": "Product",
                "cycleStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "description": "Test description",
                "terminationDate": "2020-01-04T08:00:00.00Z",
                "productOffering": {
                    "id": "0.0.0.1+-product+174600",
                    "name": "Teen Telephony C4B0",
                    "@type": "ProductOffering"
                },
                "usageStart": {
                    "unit": "absolute",
                    "amount": 0
                },
                "gracePeriod": {
                    "unit": "absolute",
                    "amount": 0
                },
                "purchaseEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "cycleEnd": {
                    "unit": "absolute",
                    "amount": 0
                },
                "id": "0.0.0.1+-purchased_product+174363",
                "href": "https://localhost:9998/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",
                "usageEnd": {
                    "unit": "absolute",
                    "amount": 0
                }
            }
        ],
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+173595",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]

Example 10: Filter A Product By Its Realizing Service ID

The following example shows how to filter a product by its realizing service ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/productInventory/version/product?realizingService.id=0.0.0.1+-service-telco-gsm-telephony+170601'

Example of the Response Body

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

[
    {
        "isBundle": false,
        "name": "Voice Over IP ",
        "@type": "Product",
        "cycleStart": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseStart": {
            "unit": "absolute",
            "amount": 0
        },
        "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"
            }
        ],
        "usageStart": {
            "unit": "absolute",
            "amount": 0
        },
        "gracePeriod": {
            "unit": "absolute",
            "amount": 0
        },
        "purchaseEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "cycleEnd": {
            "unit": "absolute",
            "amount": 0
        },
        "id": "0.0.0.1+-purchased_product+170345",
        "href": "https://localhost:9998/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",
        "usageEnd": {
            "unit": "absolute",
            "amount": 0
        }
    }
]