• Array of: ProductSpecificationOracle
  Title: ProductSpecificationOracle

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

• object ProductSpecification
  Title: ProductSpecification

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }
• object properties

{
    "title":"ProductSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductSpecification"
        },
        {
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                }
            },
            "required":[
                "name",
                "project",
                "lastUpdate",
                "lifecycleStatus"
            ]
        }
    ]
}

Discriminator Values

• ProductSpecification
• ProductSpecificationOracle

{
    "title":"ProductSpecification",
    "type":"object",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductSpecification":"#/components/schemas/ProductSpecification",
            "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the product specification"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the product specification is"
        },
        "brand":{
            "type":"string",
            "description":"The manufacturer or trademark of the specification"
        },
        "isBundle":{
            "type":"boolean",
            "description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "productNumber":{
            "type":"string",
            "description":"An identification number assigned to uniquely identity the specification"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "version":{
            "type":"string",
            "description":"Product specification version"
        },
        "@type":{
            "type":"string",
            "description":"class type of the product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the product specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            }
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "productSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationRelationship"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attachment"
            }
        },
        "bundledProductSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductSpecification"
            }
        }
    },
    "required":[
        "name",
        "lastUpdate",
        "lifecycleStatus"
    ]
}

• @baseType: string
  base class type (immediate parent) of the product specification
• @schemaLocation: string
  hyperlink reference to schema describing this object
• @type: string
  class type of the product specification
• attachment: array attachment
• brand: string
  The manufacturer or trademark of the specification
• bundledProductSpecification: array bundledProductSpecification
• description: string
  A narrative that explains in detail what the product specification is
• href: string
  Reference of the product specification
• id: string
  Maximum Length: 30

  Unique identifier of the product specification
• isBundle: boolean
  isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true).
• lastUpdate(required): string (date-time)
  Date and time of the last update
• lifecycleStatus(required): string
  Used to indicate the current lifecycle status
• name(required): string
  Name of the product specification
• productNumber: string
  An identification number assigned to uniquely identity the specification
• productSpecCharacteristic: array productSpecCharacteristic
• productSpecificationRelationship: array productSpecificationRelationship
• relatedParty: array relatedParty
• resourceSpecification: array resourceSpecification
• serviceSpecification: array serviceSpecification
• targetProductSchema: object TargetProductSchema
  Title: TargetProductSchema

  The reference object to the schema and type of target product which is described by product specification
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  Product specification version

{
    "title":"ProductSpecification",
    "type":"object",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductSpecification":"#/components/schemas/ProductSpecification",
            "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the product specification"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the product specification is"
        },
        "brand":{
            "type":"string",
            "description":"The manufacturer or trademark of the specification"
        },
        "isBundle":{
            "type":"boolean",
            "description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "productNumber":{
            "type":"string",
            "description":"An identification number assigned to uniquely identity the specification"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "version":{
            "type":"string",
            "description":"Product specification version"
        },
        "@type":{
            "type":"string",
            "description":"class type of the product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the product specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            }
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "productSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationRelationship"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Attachment"
            }
        },
        "bundledProductSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductSpecification"
            }
        }
    },
    "required":[
        "name",
        "lastUpdate",
        "lifecycleStatus"
    ]
}

• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• lastUpdatedBy: string
  name of the person who updated item
• project(required): object ProjectRef
  Title: ProjectRef

  The existing project is retrieved by ID or name. If the project doesn't exist, a new project is created with the specified name and ID.

{
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        }
    },
    "required":[
        "name",
        "project",
        "lastUpdate",
        "lifecycleStatus"
    ]
}

• href: string
  Unique reference of the project/initiative
• id: string
  Unique identifier of the project/initiative
• name: string
  Name of the project/initiative. It is required to create a new project
• version: string
  Version of the project/initiative

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The existing project is retrieved by ID or name. If the project doesn't exist, a new project is created with the specified name and ID.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project/initiative"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project/initiative"
        },
        "name":{
            "type":"string",
            "description":"Name of the project/initiative. It is required to create a new project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project/initiative"
        }
    }
}

• 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)"
}

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."
        }
    }
}

• 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."
        }
    }
}

• @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"
    ]
}

• 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)"
}

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."
        }
    }
}

• 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."
        }
    }
}

• @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"
    ]
}

• 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)"
}

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."
        }
    }
}

• 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."
        }
    }
}

• @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"
    ]
}

• 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)"
}

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."
        }
    }
}

• 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."
        }
    }
}

• @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"
    ]
}

• 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)"
}

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."
        }
    }
}

• 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."
        }
    }
}

• @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"
    ]
}