Jump to

• Request
• Response

Get a Service Specification

get

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

This operation retrieves a Service Specification entity.

Request

Path Parameters

• id(required): string
  The unique identifier of the Service Specification.

  Examples

  Select an example Service Specification ID

Query Parameters

• fields: string
  The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a product specification, service specification, or a resource specification.
• specificationType: string
  The specification type, which can be either CFS or RFS.
• version: string
  The current version of the product, the service or the resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : ServiceSpecificationOracle

Type: object

Title: ServiceSpecificationOracle

Match All

Show Source

• object ServiceSpecification
  Title: ServiceSpecification

  Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }

  ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
• object properties

{
    "title":"ServiceSpecificationOracle",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecification"
        },
        {
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"Code to service specification."
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation."
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created."
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated."
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                }
            },
            "required":[
                "project"
            ]
        }
    ]
}

Nested Schema : ServiceSpecification

Type: object

Title: ServiceSpecification

Discriminator: @type

Discriminator Values

• ServiceSpecification
• ServiceSpecificationOracle

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "required":[
        "name"
    ],
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        },
        "constraint":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConstraintRef"
            },
            "description":"This is a list of constraint references applied to this specification."
        },
        "entitySpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitySpecificationRelationship"
            },
            "description":"Relationship to another specification."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "specCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"List of characteristics that the entity can take."
        },
        "targetEntitySchema":{
            "$ref":"#/components/schemas/TargetEntitySchema",
            "description":"Pointer to a schema that defines the target entity."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification."
        }
    }
}

ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.

Show Source

• @baseType: string
  Immediate base (class) type of the Service Specification.
• @schemaLocation: string
  A link to the schema describing this Service Specification.
• @type: string
  Class type of the Service Specification.
• attachment: array attachment
• constraint: array constraint
  This is a list of constraint references applied to this specification.
• description: string
  A string. A narrative that explains in detail what the service specification is.
• entitySpecRelationship: array entitySpecRelationship
  Relationship to another specification.
• featureSpecification: array featureSpecification
  A list of Features for this specification.
• href: string
  A string. Reference of the service specification.
• id: string
  Maximum Length: 30

  A string. Unique identifier of the service specification.
• isBundle: boolean
  A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true).
• lastUpdate: string (date-time)
  A date time (DateTime). Date and time of the last update of the service specification.
• lifecycleStatus: string
  A string. Used to indicate the current lifecycle status of the service specification.
• name(required): string
  A string. Name of the service specification.
• relatedParty: array relatedParty
• resourceSpecification: array resourceSpecification
• serviceLevelSpecification: array serviceLevelSpecification
• serviceSpecRelationship: array serviceSpecRelationship
• specCharacteristic: array specCharacteristic
  List of characteristics that the entity can take.
• targetEntitySchema: object TargetEntitySchema
  The reference object to the schema and type of target entity which is described by a specification.
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid.
• version: string
  A string. Service specification version.

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "required":[
        "name"
    ],
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        },
        "constraint":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConstraintRef"
            },
            "description":"This is a list of constraint references applied to this specification."
        },
        "entitySpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitySpecificationRelationship"
            },
            "description":"Relationship to another specification."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "specCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"List of characteristics that the entity can take."
        },
        "targetEntitySchema":{
            "$ref":"#/components/schemas/TargetEntitySchema",
            "description":"Pointer to a schema that defines the target entity."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification."
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification."
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• created: string (date-time)
  Date and time of creation.
• createdBy: string
  name of the person who created.
• lastUpdatedBy: string
  name of the person who updated.
• 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.
• serviceCode: string
  Code to service specification.

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

Nested Schema : ProjectRef

Type: object

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.

Show Source

• href: string
  Unique reference of the project or initiative.
• id: string
  Unique identifier of the project or initiative.
• name: string
  Name of the project or initiative. It is required to create a new project.
• version: string
  Version of the project or 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 or initiative."
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project or initiative."
        },
        "name":{
            "type":"string",
            "description":"Name of the project or initiative. It is required to create a new project."
        },
        "version":{
            "type":"string",
            "description":"Version of the project or initiative."
        }
    }
}

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

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

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