Jump to

• Request
• Response
• Examples

Fetch Data from Cache

post

/data/fetch

Retrieves the specified data from your data set and sends it to the client.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• FetchRequest

{
    "description":"Input request parameters",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "required_data"
            ],
            "properties":{
                "required_data":{
                    "description":"Specifies the data to retrieve.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "additional_data":{
                    "description":"Provides additional criteria used to filter the data.",
                    "type":"object"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "FetchRequest":"#/components/schemas/FetchRequest"
        }
    }
}

Input request parameters

Match All

Input request parameters

Input request parameters

Show Source

• object Extensible
  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

{
    "description":"Input request parameters",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "required_data"
            ],
            "properties":{
                "required_data":{
                    "description":"Specifies the data to retrieve.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "additional_data":{
                    "description":"Provides additional criteria used to filter the data.",
                    "type":"object"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "FetchRequest":"#/components/schemas/FetchRequest"
        }
    }
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : type

Type: object

Show Source

• additional_data: object additional_data
  Provides additional criteria used to filter the data.
• required_data(required): array required_data
  Specifies the data to retrieve.

{
    "type":"object",
    "required":[
        "required_data"
    ],
    "properties":{
        "required_data":{
            "description":"Specifies the data to retrieve.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "additional_data":{
            "description":"Provides additional criteria used to filter the data.",
            "type":"object"
        }
    }
}

Nested Schema : additional_data

Type: object

Provides additional criteria used to filter the data.

Nested Schema : required_data

Type: array

Specifies the data to retrieve.

Show Source

• Array of: string

{
    "description":"Specifies the data to retrieve.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example FetchRequest

Back to Top

Response

200 Response

The request was completed successfully. If the system throws a runtime error, the response code 200 is returned alongside the error message in the response body.

Body ()

Root Schema : schema

Type: array

Show Source

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

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• FetchResponse

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Specifies the output returned by the operation.",
            "required":[
                "data"
            ],
            "properties":{
                "data":{
                    "description":"Returns the data retrieved from storage.",
                    "type":"object"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "FetchResponse":"#/components/schemas/FetchResponse"
        }
    }
}

Match All

Specifies the output returned by the operation.

Show Source

• object Extensible
  Base extensible schema for use with TM Forum Open APIs. When used in a schema, the entity must be extended by specifying `@type`.
• object Discriminator: @type-allOf[1]
  Specifies the output returned by the operation.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "description":"Specifies the output returned by the operation.",
            "required":[
                "data"
            ],
            "properties":{
                "data":{
                    "description":"Returns the data retrieved from storage.",
                    "type":"object"
                }
            }
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "FetchResponse":"#/components/schemas/FetchResponse"
        }
    }
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

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

Type: object

Specifies the output returned by the operation.

Show Source

• data(required): object data
  Returns the data retrieved from storage.

{
    "type":"object",
    "description":"Specifies the output returned by the operation.",
    "required":[
        "data"
    ],
    "properties":{
        "data":{
            "description":"Returns the data retrieved from storage.",
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Returns the data retrieved from storage.

400 Response

The server received a bad request.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

401 Response

The request is not authorized.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

403 Response

The request is forbidden.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

404 Response

The resource was not found.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

405 Response

The method is not allowed.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

409 Response

The server received a conflict.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

500 Response

The system has received an Internal Server Error.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

501 Response

The service was not implemented.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

503 Response

The service is not available.

Body ()

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

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

Match All

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

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

Show Source

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

{
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "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."
                }
            }
        }
    ],
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
}

Nested Schema : Extensible

Type: object

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
  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."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Discriminator: @type-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
  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."
        }
    }
}

Back to Top

Examples

This example shows the cURL command for sending a Fetch Data request:

curl -X POST 'http://hostname:port/data/fetch' -H 'Content-Type: application/json' -d @file.json

where:

• hostname is the host name of the application server.

• port is the port for the application server.

• file.json is the JSON file that specifies the data to fetch.

Example of the Request Body

The following sample shows the contents of the file.json file sent as the request body.

{
  "@type": "FetchRequest",
  "required_data": [
    "account_data",
    "over_usage_data",
    "deal_data",
    "purchased_product_data"
  ],
  "additional_data": {
    "account_id": "2479678",
    "sample": true
  }
}

Example of the Response Body

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

{
  "@type": "FetchResponse",
  "data": {
    "data": [
      {
        "account_data": {
          "account_id": "2479678"
        },
        "over_usage_data": [],
        "deal_data": [],
        "purchased_product_data": []
      }
    ],
    "status": "Successful"
  }
}

Back to Top