Jump to

• Request
• Response
• Examples

Get Predictions

post

/recommend/predict

Creates a prediction for an account using the specified algorithm.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Specifies the input parameters for the request.

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object type
  Specifies the input parameters for the request.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Specifies the input parameters for the request.",
            "properties":{
                "account_id":{
                    "description":"Specifies the customer account ID.",
                    "type":"string",
                    "minLength":1
                },
                "msisdn":{
                    "description":"Specifies the customer's MSISDN.",
                    "type":"string",
                    "minLength":1
                },
                "algorithms":{
                    "description":"Lists the algorithms to use for the prediction service&colon; <b>knn</b>, <b>dnn</b>, or <b>cosine</b>.",
                    "type":"array",
                    "items":{
                        "type":"string",
                        "enum":[
                            "knn",
                            "dnn",
                            "cosine"
                        ]
                    },
                    "minItems":1,
                    "uniqueItems":true
                }
            },
            "required":[
                "algorithms"
            ],
            "oneOf":[
                {
                    "required":[
                        "account_id"
                    ]
                },
                {
                    "required":[
                        "msisdn"
                    ]
                }
            ]
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : type

Type: object

Specifies the input parameters for the request.

Show Source

• account_id: string
  Minimum Length: 1

  Specifies the customer account ID.
• algorithms(required): array algorithms
  Minimum Number of Items: 1

  Unique Items Required: true

  Lists the algorithms to use for the prediction service: knn, dnn, or cosine.
• msisdn: string
  Minimum Length: 1

  Specifies the customer's MSISDN.

{
    "type":"object",
    "description":"Specifies the input parameters for the request.",
    "properties":{
        "account_id":{
            "description":"Specifies the customer account ID.",
            "type":"string",
            "minLength":1
        },
        "msisdn":{
            "description":"Specifies the customer's MSISDN.",
            "type":"string",
            "minLength":1
        },
        "algorithms":{
            "description":"Lists the algorithms to use for the prediction service&colon; <b>knn</b>, <b>dnn</b>, or <b>cosine</b>.",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "knn",
                    "dnn",
                    "cosine"
                ]
            },
            "minItems":1,
            "uniqueItems":true
        }
    },
    "required":[
        "algorithms"
    ],
    "oneOf":[
        {
            "required":[
                "account_id"
            ]
        },
        {
            "required":[
                "msisdn"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "description":"Specifies the input parameters for the request.",
    "properties":{
        "account_id":{
            "description":"Specifies the customer account ID.",
            "type":"string",
            "minLength":1
        },
        "msisdn":{
            "description":"Specifies the customer's MSISDN.",
            "type":"string",
            "minLength":1
        },
        "algorithms":{
            "description":"Lists the algorithms to use for the prediction service&colon; <b>knn</b>, <b>dnn</b>, or <b>cosine</b>.",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "knn",
                    "dnn",
                    "cosine"
                ]
            },
            "minItems":1,
            "uniqueItems":true
        }
    },
    "required":[
        "algorithms"
    ],
    "oneOf":[
        {
            "required":[
                "account_id"
            ]
        },
        {
            "required":[
                "msisdn"
            ]
        }
    ]
}

Nested Schema : algorithms

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Lists the algorithms to use for the prediction service: knn, dnn, or cosine.

Show Source

• Array of: string
  Allowed Values: [ "knn", "dnn", "cosine" ]

{
    "description":"Lists the algorithms to use for the prediction service&colon; <b>knn</b>, <b>dnn</b>, or <b>cosine</b>.",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "knn",
            "dnn",
            "cosine"
        ]
    },
    "minItems":1,
    "uniqueItems":true
}

Examples

Select an example RecommendRequestWithAccountId RecommendRequestWithMSISDN

Back to Top

Response

200 Response

The request was completed successfully.

Body ()

Root Schema : RecommendResponse

Match All

Returns the result output.

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object RecommendResponse-allOf[1]
  Returns the result output.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Returns the result output.",
            "required":[
                "status",
                "recommendations"
            ],
            "properties":{
                "status":{
                    "description":"Indicates the current status of the service.",
                    "type":"string"
                },
                "recommendations":{
                    "description":"Recommendations returned by each algorithm.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RecommendationDetails"
                    }
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : RecommendResponse-allOf[1]

Type: object

Returns the result output.

Show Source

• recommendations(required): array recommendations
  Recommendations returned by each algorithm.
• status(required): string
  Indicates the current status of the service.

{
    "type":"object",
    "description":"Returns the result output.",
    "required":[
        "status",
        "recommendations"
    ],
    "properties":{
        "status":{
            "description":"Indicates the current status of the service.",
            "type":"string"
        },
        "recommendations":{
            "description":"Recommendations returned by each algorithm.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RecommendationDetails"
            }
        }
    }
}

Nested Schema : recommendations

Type: array

Recommendations returned by each algorithm.

Show Source

• Array of: RecommendationDetails

{
    "description":"Recommendations returned by each algorithm.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RecommendationDetails"
    }
}

Nested Schema : RecommendationDetails

Match All

Provides the details for a recommendation.

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object RecommendationDetails-allOf[1]
  Provides the details for a recommendation.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Provides the details for a recommendation.",
            "required":[
                "algorithm",
                "account_id",
                "present_deal",
                "top_results"
            ],
            "properties":{
                "algorithm":{
                    "description":"Specifies the algorithm used to generate the recommendation.",
                    "type":"string",
                    "enum":[
                        "knn",
                        "dnn",
                        "cosine"
                    ]
                },
                "account_id":{
                    "description":"Specifies the user account ID.",
                    "type":"string"
                },
                "present_deal":{
                    "description":"Specifies the current deal to which the user is subscribed.",
                    "type":"string"
                },
                "top_results":{
                    "description":"Lists the recommendation results.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PredictDetails"
                    }
                }
            }
        }
    ]
}

Nested Schema : RecommendationDetails-allOf[1]

Type: object

Provides the details for a recommendation.

Show Source

• account_id(required): string
  Specifies the user account ID.
• algorithm(required): string
  Allowed Values: [ "knn", "dnn", "cosine" ]

  Specifies the algorithm used to generate the recommendation.
• present_deal(required): string
  Specifies the current deal to which the user is subscribed.
• top_results(required): array top_results
  Lists the recommendation results.

{
    "type":"object",
    "description":"Provides the details for a recommendation.",
    "required":[
        "algorithm",
        "account_id",
        "present_deal",
        "top_results"
    ],
    "properties":{
        "algorithm":{
            "description":"Specifies the algorithm used to generate the recommendation.",
            "type":"string",
            "enum":[
                "knn",
                "dnn",
                "cosine"
            ]
        },
        "account_id":{
            "description":"Specifies the user account ID.",
            "type":"string"
        },
        "present_deal":{
            "description":"Specifies the current deal to which the user is subscribed.",
            "type":"string"
        },
        "top_results":{
            "description":"Lists the recommendation results.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PredictDetails"
            }
        }
    }
}

Nested Schema : top_results

Type: array

Lists the recommendation results.

Show Source

• Array of: PredictDetails

{
    "description":"Lists the recommendation results.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PredictDetails"
    }
}

Nested Schema : PredictDetails

Match All

Lists the predicted outcomes.

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object PredictDetails-allOf[1]
  Lists the predicted outcomes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Lists the predicted outcomes.",
            "required":[
                "prediction",
                "probability_or_distance"
            ],
            "properties":{
                "prediction":{
                    "description":"Returns the next best offer.",
                    "type":"string"
                },
                "probability_or_distance":{
                    "description":"Indicates the confidence score or distance for the recommendation.",
                    "type":"number"
                }
            }
        }
    ]
}

Nested Schema : PredictDetails-allOf[1]

Type: object

Lists the predicted outcomes.

Show Source

• prediction(required): string
  Returns the next best offer.
• probability_or_distance(required): number
  Indicates the confidence score or distance for the recommendation.

{
    "type":"object",
    "description":"Lists the predicted outcomes.",
    "required":[
        "prediction",
        "probability_or_distance"
    ],
    "properties":{
        "prediction":{
            "description":"Returns the next best offer.",
            "type":"string"
        },
        "probability_or_distance":{
            "description":"Indicates the confidence score or distance for the recommendation.",
            "type":"number"
        }
    }
}

Examples

Select an example RecommendResponseExample

400 Response

The request could not be processed because it contains missing or invalid information.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

401 Response

The request is not authorized.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

403 Response

The user does not have authorization to perform this request.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

404 Response

The requested resource cannot be found.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

405 Response

The method is not allowed.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

409 Response

The request could not be processed due to a conflict with the existing state of the resource.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

500 Response

The system has encountered an internal server error.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

501 Response

The request was not implemented.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

503 Response

The service is unavailable.

Body ()

Root Schema : Error

Match All

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "CacheRequest":"#/components/schemas/CacheRequest", "FetchRequest":"#/components/schemas/FetchRequest", "CollectRequest":"#/components/schemas/CollectRequest", "QueryBuilder":"#/components/schemas/QueryBuilder", "QueryList":"#/components/schemas/QueryList", "JoinConditions":"#/components/schemas/JoinConditions", "StorageDetails":"#/components/schemas/StorageDetails", "CollectResponse":"#/components/schemas/CollectResponse", "FetchResponse":"#/components/schemas/FetchResponse", "CacheResponse":"#/components/schemas/CacheResponse", "Error":"#/components/schemas/Error" } }

  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Error-allOf[1]
  Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Provides application-specific details, as defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Provides an explanation of the error to display to the client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides additional error details and recommended corrective actions to display to the client user."
                },
                "status":{
                    "type":"string",
                    "description":"Specifies the extended HTTP error code."
                },
                "referenceError":{
                    "type":"string",
                    "description":"Provides a URI to documentation that describes the error.",
                    "format":"uri"
                }
            }
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• CacheRequest
• FetchRequest
• CollectRequest
• QueryBuilder
• QueryList
• JoinConditions
• StorageDetails
• CollectResponse
• FetchResponse
• CacheResponse
• Error

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.

Show Source

• @baseType: string
  Specifies the superclass while subclassing.
• @schemaLocation: string (uri)
  Provides a URI to the JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  When subclassing, specifies the extensible name of the subclass.

{
    "type":"object",
    "description":"Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.",
    "properties":{
        "@type":{
            "type":"string",
            "description":"When subclassing, specifies the extensible name of the subclass."
        },
        "@baseType":{
            "type":"string",
            "description":"Specifies the superclass while subclassing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Provides a URI to the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CacheRequest":"#/components/schemas/CacheRequest",
            "FetchRequest":"#/components/schemas/FetchRequest",
            "CollectRequest":"#/components/schemas/CollectRequest",
            "QueryBuilder":"#/components/schemas/QueryBuilder",
            "QueryList":"#/components/schemas/QueryList",
            "JoinConditions":"#/components/schemas/JoinConditions",
            "StorageDetails":"#/components/schemas/StorageDetails",
            "CollectResponse":"#/components/schemas/CollectResponse",
            "FetchResponse":"#/components/schemas/FetchResponse",
            "CacheResponse":"#/components/schemas/CacheResponse",
            "Error":"#/components/schemas/Error"
        }
    }
}

Nested Schema : Error-allOf[1]

Type: object

Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).

Show Source

• code(required): string
  Provides application-specific details, as defined by the API or a common list.
• message: string
  Provides additional error details and recommended corrective actions to display to the client user.
• reason(required): string
  Provides an explanation of the error to display to the client user.
• referenceError: string (uri)
  Provides a URI to documentation that describes the error.
• status: string
  Specifies the extended HTTP error code.

{
    "type":"object",
    "description":"Indicates an error response from the API, usually accompanied by an HTTP status code (3xx, 4xx, or 5xx).",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Provides application-specific details, as defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Provides an explanation of the error to display to the client user."
        },
        "message":{
            "type":"string",
            "description":"Provides additional error details and recommended corrective actions to display to the client user."
        },
        "status":{
            "type":"string",
            "description":"Specifies the extended HTTP error code."
        },
        "referenceError":{
            "type":"string",
            "description":"Provides a URI to documentation that describes the error.",
            "format":"uri"
        }
    }
}

Back to Top

Examples

This example shows the cURL command for sending a Create a Prediction request:

curl -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json" -X POST -d @file.json 'http://hostname:port/recommend/predict'

where:

• your_token is your client application's OAuth 2.0 access token.

• file.json is the JSON file that specifies the details of the data to collect.

• hostname is the host name for the application server.

• port is the port for the application server.

Example of Request Body

Following is a sample request body.

{
  "@type": "RecommendRequest",
  "account_id": "2824533",
  "algorithms": [
    "knn",
    "dnn"
  ]
}

Example of Response Body

If successful, the response code 200 is returned with a response body. For example:

{
  "@type": "RecommendResponse",
  "status": "Success",
  "recommendations": [
    {
      "@type": "RecommendationDetails",
      "algorithm": "knn",
      "account_id": "2824533",
      "present_deal": "Deal 10 - Data Storm",
      "top_results": [
        {
          "@type": "PredictDetails",
          "prediction": "Deal 12 - Data Mini",
          "probability_or_distance": 0.0
        },
        {
          "@type": "PredictDetails",
          "prediction": "Deal 4 - SMS Special",
          "probability_or_distance": 0.0
        },
        {
          "@type": "PredictDetails",
          "prediction": "Deal 3 - CO for Voice 40",
          "probability_or_distance": 0.0
        }
      ]
    },
    {
      "@type": "RecommendationDetails",
      "algorithm": "dnn",
      "account_id": "2824533",
      "present_deal": "Deal 10 - Data Storm",
      "top_results": [
        {
          "@type": "PredictDetails",
          "prediction": "Deal 1 - Data 30",
          "probability_or_distance": 0.11470177
        },
        {
          "@type": "PredictDetails",
          "prediction": "Deal 11 - Data Blaze",
          "probability_or_distance": 0.11470167
        },
        {
          "@type": "PredictDetails",
          "prediction": "Deal 10 - Data Storm",
          "probability_or_distance": 0.11470162
        }
      ]
    }
  ]
}

Back to Top