Jump to

• Request
• Response

Update a Bucket Threshold for an Account

put

/bucket/adjustThreshold/{accountId}

Updates a bucket threshold for the specified account.

Request

Path Parameters

• accountId(required): string
  The ID or account number of the billing account to adjust the threshold for.

  Examples

  Select an example accountId=0.0.0.1+-account+102879

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : Adjust Threshold

Type: object

Title: Adjust Threshold

A threshold adjustment.

Show Source

• @type: string
  Title: Type

  The object's subclass.
• accountId(required): string
  Title: Account Id

  The ID or account number of the billing account to adjust the threshold for.
• bucket: object Bucket Ref
  Title: Bucket Ref

  A reference to a bucket.
• product: object Product Ref
  Title: Product Ref

  A reference to a product.
• resourceType: string
  Title: Resource Type

  The resource type of the balance element with the adjusted threshold.
• thresholds: array thresholds
  The new threshold amount.

{
    "required":[
        "accountId"
    ],
    "title":"Adjust Threshold",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "title":"Account Id",
            "description":"The ID or account number of the billing account to adjust the threshold for."
        },
        "bucket":{
            "description":"The bucket to adjust the threshold for.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "product":{
            "description":"A product associated with the bucket being adjusted.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "resourceType":{
            "type":"string",
            "title":"Resource Type",
            "description":"The resource type of the balance element with the adjusted threshold."
        },
        "thresholds":{
            "type":"array",
            "description":"The new threshold amount.",
            "items":{
                "$ref":"#/components/schemas/Quantity"
            }
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"A threshold adjustment."
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

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

  The object's subclass.
• href: string (uri)
  The bucket's href.
• id(required): string
  Title: Bucket ID

  The bucket's ID.
• name: string
  Title: Bucket Name

  The bucket's name.
• usageType: string
  The bucket's usage type.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

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

  The object's subclass.
• href: string
  Title: Product Href

  The product's href.
• id(required): string
  Title: Product ID

  The product's ID.
• name: string
  Title: Product Name

  The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Product Href",
            "description":"The product's href."
        },
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        }
    }
}

Nested Schema : thresholds

Type: array

The new threshold amount.

Show Source

• Array of: object Quantity
  The amount in a given unit.

{
    "type":"array",
    "description":"The new threshold amount.",
    "items":{
        "$ref":"#/components/schemas/Quantity"
    }
}

Nested Schema : Quantity

Type: object

The amount in a given unit.

Show Source

• amount: number (float)
  Default Value: 1

  The numeric value in a given unit.
• units: string
  The unit.

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

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The bucket threshold was updated successfully.

400 Response

The request isn't valid.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

405 Response

This method is not allowed.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

409 Response

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

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

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

Match All

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

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

Show Source

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

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

Nested Schema : Extensible

Type: object

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

Show Source

• @baseType: string
  The defines the super-class when sub-classing.
• @schemaLocation: string
  The URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  The definition of the sub-class extensible name, when sub-classing.

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

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application relevant detail, defined in the API or a common list.
• message: string
  The details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  The explanation of the reason for the error which can be shown to a client user.
• referenceError: string
  The URI of documentation describing the error.
• status: string
  The HTTP Error code extension

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

Back to Top