Jump to

• Request
• Response

notification acknowledgement

post

https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4/eventAcknowledge

This operation enables a client listener to acknowledge service specification event.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The event acknowledgement data structure

Show Source

• eventId: string
  The identifier of the notification.
• eventType: string
  The type of the notification.
• message: string
  The optional message for the event acknowledgement.
• projectId: string
  The identifier of the project.
• projectItemsStatus: array projectItemsStatus
  List of project item statuses for each CFS
• status: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  The status of the event acknowledgement.

{
    "type":"object",
    "properties":{
        "projectItemsStatus":{
            "type":"array",
            "description":"List of project item statuses for each CFS",
            "items":{
                "$ref":"#/components/schemas/ProjectItemStatus"
            }
        },
        "eventId":{
            "type":"string",
            "description":"The identifier of the notification."
        },
        "eventType":{
            "type":"string",
            "description":"The type of the notification."
        },
        "projectId":{
            "type":"string",
            "description":"The identifier of the project."
        },
        "message":{
            "type":"string",
            "description":"The optional message for the event acknowledgement."
        },
        "status":{
            "type":"string",
            "description":"The status of the event acknowledgement.",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        }
    },
    "description":"The event acknowledgement data structure"
}

Nested Schema : projectItemsStatus

Type: array

List of project item statuses for each CFS

Show Source

• Array of: object ProjectItemStatus
  When sub-classing, this defines the super-class

{
    "type":"array",
    "description":"List of project item statuses for each CFS",
    "items":{
        "$ref":"#/components/schemas/ProjectItemStatus"
    }
}

Nested Schema : ProjectItemStatus

Type: object

When sub-classing, this defines the super-class

Show Source

• @baseType: string
• @type: string
  When sub-classing, this defines the sub-class Extensible name
• id: string
  The identifier of the project item.
• message: string
  The optional message for the project item.
• status: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  The status of the event acknowledgement.
• version: string
  The version of the project item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the project item."
        },
        "version":{
            "type":"string",
            "description":"The version of the project item."
        },
        "status":{
            "type":"string",
            "description":"The status of the event acknowledgement.",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        },
        "message":{
            "type":"string",
            "description":"The optional message for the project item."
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string"
        }
    },
    "description":"When sub-classing, this defines the super-class"
}

Back to Top

Response

200 Response

Success

400 Response

Bad Request: Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

401 Response

Unauthorized: Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

403 Response

Forbidden: You don't have authorization to perform this request.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

404 Response

Not Found: Your request includes a resource URI that doesn't exist.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

405 Response

Method Not Allowed: HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

409 Response

Conflict: The request can't be completed due to a conflict with the current state of the resource.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

500 Response

Internal Server Error: The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : Error

Title: Error

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)

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

Show Source

• object Extensible
  Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Show Source

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

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error"
        }
    },
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error."
        }
    }
}

Nested Schema : Extensible

Type: object

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
  When sub-classing, this defines the super-class
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name

{
    "type":"object",
    "description":"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":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

Back to Top