REST API for Oracle Communications Service Catalog and Design

Create a Resource Specification

post

https://{hostname}:{port}/scd/tmf-api/resourceCatalogManagement/v5/resourceSpecification

This operation creates a Resource Specification entity.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : ResourceSpecificationOracle

Title: ResourceSpecificationOracle

Match All

Show Source

object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "ResourceSpecification":"#/components/schemas/ResourceSpecification", "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle" } }

Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components. A ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.
object properties

{
    "title":"ResourceSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceSpecification"
        },
        {
            "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"
                },
                "relatedPlaceRefOrValue":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
                    }
                },
                "serviceSpecRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ServiceSpecRelationship"
                    }
                },
                "specificationType":{
                    "type":"string",
                    "description":"type of resource specification",
                    "enum":[
                        "CONNECTIVITY_SPECIFICATION_STRUCTURE",
                        "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE",
                        "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE",
                        "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE",
                        "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE",
                        "FLOW_INTERFACE_SPECIFICATION_STRUCTURE",
                        "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                        "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                        "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE",
                        "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE",
                        "MEDIA_STREAM_SPECIFICATION_STRUCTURE",
                        "NETWORK_SPECIFICATION_STRUCTURE",
                        "OTHER_RESOURCE",
                        "PIPE_SPECIFICATION_STRUCTURE",
                        "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE"
                    ]
                }
            },
            "required":[
                "name",
                "project",
                "@type"
            ]
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "type":"object",
    "description":"Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ResourceSpecification":"#/components/schemas/ResourceSpecification",
            "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of this REST resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to this REST resource"
        },
        "category":{
            "type":"string",
            "description":"Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on."
        },
        "description":{
            "type":"string",
            "description":"Description of this REST resource"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicates that if this resource specification is a bundled specification (true) or single (false)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update of this REST resource"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification.",
            "enum":[
                "In design",
                "In test",
                "Launched",
                "Active",
                "Rejected",
                "Retired",
                "Obsolete",
                "Ready to publish",
                "Awaiting retirement",
                "Awaiting obsolete"
            ]
        },
        "name":{
            "type":"string",
            "description":"Name given to this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Resource Specification version"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            },
            "description":"Complements the description of an element (for instance a resource) through video, pictures ..."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A related party defines party or party role linked to a specific entity."
        },
        "resourceSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"A characteristic quality or distinctive feature of a ResourceSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process."
        },
        "resourceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRelationship"
            },
            "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications."
        },
        "targetResourceSchema":{
            "$ref":"#/components/schemas/TargetResourceSchema",
            "description":"A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which this REST resource is valid"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "intentSpecification":{
            "$ref":"#/components/schemas/IntentSpecificationRef"
        },
        "externalIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalIdentifier"
            }
        }
    }
}

Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components. A ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.

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 entity name
attachment: array attachment

Complements the description of an element (for instance a resource) through video, pictures ...
category: string

Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on.
description: string

Description of this REST resource
externalIdentifier: array externalIdentifier
featureSpecification: array featureSpecification

A list of Features for this specification.
href: string

Hyperlink reference to this REST resource
id: string

Unique identifier of this REST resource
intentSpecification: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "IntentSpecificationRef":"#/components/schemas/IntentSpecificationRef" } }
isBundle: boolean

A flag indicates that if this resource specification is a bundled specification (true) or single (false).
lastUpdate: string (date-time)

Date and time of the last update of this REST resource
lifecycleStatus: string

Allowed Values: [ "In design", "In test", "Launched", "Active", "Rejected", "Retired", "Obsolete", "Ready to publish", "Awaiting retirement", "Awaiting obsolete" ]

A string. Used to indicate the current lifecycle status of the service specification.
name(required): string

Name given to this REST resource
relatedParty: array relatedParty

A related party defines party or party role linked to a specific entity.
resourceSpecCharacteristic: array resourceSpecCharacteristic

A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.
resourceSpecRelationship: array resourceSpecRelationship

A migration, substitution, dependency or exclusivity relationship between/among resource specifications.
targetResourceSchema: object TargetResourceSchema

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

Title: TimePeriod

The period for which the productOffering is valid
version: string

Resource Specification version

{
    "type":"object",
    "description":"Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ResourceSpecification":"#/components/schemas/ResourceSpecification",
            "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of this REST resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to this REST resource"
        },
        "category":{
            "type":"string",
            "description":"Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on."
        },
        "description":{
            "type":"string",
            "description":"Description of this REST resource"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicates that if this resource specification is a bundled specification (true) or single (false)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update of this REST resource"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification.",
            "enum":[
                "In design",
                "In test",
                "Launched",
                "Active",
                "Rejected",
                "Retired",
                "Obsolete",
                "Ready to publish",
                "Awaiting retirement",
                "Awaiting obsolete"
            ]
        },
        "name":{
            "type":"string",
            "description":"Name given to this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Resource Specification version"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            },
            "description":"Complements the description of an element (for instance a resource) through video, pictures ..."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A related party defines party or party role linked to a specific entity."
        },
        "resourceSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"A characteristic quality or distinctive feature of a ResourceSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process."
        },
        "resourceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRelationship"
            },
            "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications."
        },
        "targetResourceSchema":{
            "$ref":"#/components/schemas/TargetResourceSchema",
            "description":"A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which this REST resource is valid"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "intentSpecification":{
            "$ref":"#/components/schemas/IntentSpecificationRef"
        },
        "externalIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalIdentifier"
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

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.
relatedPlaceRefOrValue: array relatedPlaceRefOrValue
serviceSpecRelationship: array serviceSpecRelationship
specificationType: string

Allowed Values: [ "CONNECTIVITY_SPECIFICATION_STRUCTURE", "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE", "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE", "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE", "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE", "FLOW_INTERFACE_SPECIFICATION_STRUCTURE", "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE", "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE", "MEDIA_STREAM_SPECIFICATION_STRUCTURE", "NETWORK_SPECIFICATION_STRUCTURE", "OTHER_RESOURCE", "PIPE_SPECIFICATION_STRUCTURE", "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE" ]

type of resource specification

{
    "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"
        },
        "relatedPlaceRefOrValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "specificationType":{
            "type":"string",
            "description":"type of resource specification",
            "enum":[
                "CONNECTIVITY_SPECIFICATION_STRUCTURE",
                "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE",
                "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE",
                "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE",
                "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE",
                "FLOW_INTERFACE_SPECIFICATION_STRUCTURE",
                "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE",
                "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE",
                "MEDIA_STREAM_SPECIFICATION_STRUCTURE",
                "NETWORK_SPECIFICATION_STRUCTURE",
                "OTHER_RESOURCE",
                "PIPE_SPECIFICATION_STRUCTURE",
                "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE"
            ]
        }
    },
    "required":[
        "name",
        "project",
        "@type"
    ]
}

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

Nested Schema : relatedPlaceRefOrValue

Type: array

Show Source

Array of: object RelatedPlaceRefOrValue

Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself

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

Nested Schema : serviceSpecRelationship

Type: array

Show Source

Array of: object ServiceSpecRelationship

Title: ServiceSpecRelationship

A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.

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

Nested Schema : RelatedPlaceRefOrValue

Type: object

Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself

Show Source

@baseType: string

When sub-classing, this defines the super-class
@referredType: string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class Extensible name
href: string

Unique reference of the place
id: string

Unique identifier of the place
name: string

A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
role: string

{
    "type":"object",
    "description":"Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the place"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the place"
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]"
        },
        "role":{
            "type":"string"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

Nested Schema : ServiceSpecRelationship

Type: object

Title: ServiceSpecRelationship

A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.

Show Source

@baseType: string

The immediate base class type of the service specification relationship
@referredType(required): string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string

A link to the schema describing this service specification relationship entity
@type: string

the class type of the service specification relationship
href: string

A string. Reference of the target serviceSpecification.
id(required): string

A string. Unique identifier of the target serviceSpecification.
name: string

A string. The name given to the target service specification instance.
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

A string. Type of relationship such as migration, substitution, dependency, exclusivity.
role: string

A string. The association role for this service specification.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "type":"object",
    "title":"ServiceSpecRelationship",
    "description":"A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the target serviceSpecification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the target serviceSpecification."
        },
        "name":{
            "type":"string",
            "description":"A string. The name given to the target service specification instance."
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "role":{
            "type":"string",
            "description":"A string. The association role for this service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the service specification relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the service specification relationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this service specification relationship entity"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "relationshipType",
        "@referredType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Created: Your request is successful and a new resource has been created.

Root Schema : ResourceSpecificationOracle

Title: ResourceSpecificationOracle

Match All

Show Source

object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "ResourceSpecification":"#/components/schemas/ResourceSpecification", "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle" } }

Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components. A ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.
object properties

{
    "title":"ResourceSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceSpecification"
        },
        {
            "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"
                },
                "relatedPlaceRefOrValue":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
                    }
                },
                "serviceSpecRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ServiceSpecRelationship"
                    }
                },
                "specificationType":{
                    "type":"string",
                    "description":"type of resource specification",
                    "enum":[
                        "CONNECTIVITY_SPECIFICATION_STRUCTURE",
                        "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE",
                        "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE",
                        "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE",
                        "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE",
                        "FLOW_INTERFACE_SPECIFICATION_STRUCTURE",
                        "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                        "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                        "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE",
                        "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE",
                        "MEDIA_STREAM_SPECIFICATION_STRUCTURE",
                        "NETWORK_SPECIFICATION_STRUCTURE",
                        "OTHER_RESOURCE",
                        "PIPE_SPECIFICATION_STRUCTURE",
                        "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE"
                    ]
                }
            },
            "required":[
                "name",
                "project",
                "@type"
            ]
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

ResourceSpecification
ResourceSpecificationOracle

{
    "type":"object",
    "description":"Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ResourceSpecification":"#/components/schemas/ResourceSpecification",
            "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of this REST resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to this REST resource"
        },
        "category":{
            "type":"string",
            "description":"Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on."
        },
        "description":{
            "type":"string",
            "description":"Description of this REST resource"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicates that if this resource specification is a bundled specification (true) or single (false)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update of this REST resource"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification.",
            "enum":[
                "In design",
                "In test",
                "Launched",
                "Active",
                "Rejected",
                "Retired",
                "Obsolete",
                "Ready to publish",
                "Awaiting retirement",
                "Awaiting obsolete"
            ]
        },
        "name":{
            "type":"string",
            "description":"Name given to this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Resource Specification version"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            },
            "description":"Complements the description of an element (for instance a resource) through video, pictures ..."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A related party defines party or party role linked to a specific entity."
        },
        "resourceSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"A characteristic quality or distinctive feature of a ResourceSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process."
        },
        "resourceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRelationship"
            },
            "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications."
        },
        "targetResourceSchema":{
            "$ref":"#/components/schemas/TargetResourceSchema",
            "description":"A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which this REST resource is valid"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "intentSpecification":{
            "$ref":"#/components/schemas/IntentSpecificationRef"
        },
        "externalIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalIdentifier"
            }
        }
    }
}

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 entity name
attachment: array attachment

Complements the description of an element (for instance a resource) through video, pictures ...
category: string

Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on.
description: string

Description of this REST resource
externalIdentifier: array externalIdentifier
featureSpecification: array featureSpecification

A list of Features for this specification.
href: string

Hyperlink reference to this REST resource
id: string

Unique identifier of this REST resource
intentSpecification: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "IntentSpecificationRef":"#/components/schemas/IntentSpecificationRef" } }
isBundle: boolean

A flag indicates that if this resource specification is a bundled specification (true) or single (false).
lastUpdate: string (date-time)

Date and time of the last update of this REST resource
lifecycleStatus: string

Allowed Values: [ "In design", "In test", "Launched", "Active", "Rejected", "Retired", "Obsolete", "Ready to publish", "Awaiting retirement", "Awaiting obsolete" ]

A string. Used to indicate the current lifecycle status of the service specification.
name(required): string

Name given to this REST resource
relatedParty: array relatedParty

A related party defines party or party role linked to a specific entity.
resourceSpecCharacteristic: array resourceSpecCharacteristic

A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.
resourceSpecRelationship: array resourceSpecRelationship

A migration, substitution, dependency or exclusivity relationship between/among resource specifications.
targetResourceSchema: object TargetResourceSchema

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

Title: TimePeriod

The period for which the productOffering is valid
version: string

Resource Specification version

{
    "type":"object",
    "description":"Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components.\nA ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.",
    "x-implements":[
        "oracle.communications.psr.service.tmf.api.Specification"
    ],
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ResourceSpecification":"#/components/schemas/ResourceSpecification",
            "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of this REST resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to this REST resource"
        },
        "category":{
            "type":"string",
            "description":"Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on."
        },
        "description":{
            "type":"string",
            "description":"Description of this REST resource"
        },
        "isBundle":{
            "type":"boolean",
            "description":"A flag indicates that if this resource specification is a bundled specification (true) or single (false)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update of this REST resource"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification.",
            "enum":[
                "In design",
                "In test",
                "Launched",
                "Active",
                "Rejected",
                "Retired",
                "Obsolete",
                "Ready to publish",
                "Awaiting retirement",
                "Awaiting obsolete"
            ]
        },
        "name":{
            "type":"string",
            "description":"Name given to this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Resource Specification version"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRefOrValue"
            },
            "description":"Complements the description of an element (for instance a resource) through video, pictures ..."
        },
        "featureSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureSpecification"
            },
            "description":"A list of Features for this specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A related party defines party or party role linked to a specific entity."
        },
        "resourceSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicSpecification"
            },
            "description":"A characteristic quality or distinctive feature of a ResourceSpecification.  The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process."
        },
        "resourceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRelationship"
            },
            "description":"A migration, substitution, dependency or exclusivity relationship between/among resource specifications."
        },
        "targetResourceSchema":{
            "$ref":"#/components/schemas/TargetResourceSchema",
            "description":"A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which this REST resource is valid"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "intentSpecification":{
            "$ref":"#/components/schemas/IntentSpecificationRef"
        },
        "externalIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalIdentifier"
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

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.
relatedPlaceRefOrValue: array relatedPlaceRefOrValue
serviceSpecRelationship: array serviceSpecRelationship
specificationType: string

Allowed Values: [ "CONNECTIVITY_SPECIFICATION_STRUCTURE", "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE", "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE", "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE", "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE", "FLOW_INTERFACE_SPECIFICATION_STRUCTURE", "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE", "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE", "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE", "MEDIA_STREAM_SPECIFICATION_STRUCTURE", "NETWORK_SPECIFICATION_STRUCTURE", "OTHER_RESOURCE", "PIPE_SPECIFICATION_STRUCTURE", "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE" ]

type of resource specification

{
    "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"
        },
        "relatedPlaceRefOrValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "specificationType":{
            "type":"string",
            "description":"type of resource specification",
            "enum":[
                "CONNECTIVITY_SPECIFICATION_STRUCTURE",
                "CUSTOM_NETWORK_ADDRESS_SPECIFICATION_STRUCTURE",
                "CUSTOM_OBJECT_SPECIFICATION_STRUCTURE",
                "DEVICE_INTERFACE_SPECIFICATION_STRUCTURE",
                "FLOW_IDENTIFIER_SPECIFICATION_STRUCTURE",
                "FLOW_INTERFACE_SPECIFICATION_STRUCTURE",
                "IPV4ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                "IPV6ADDRESS_RESOURCE_EXTENSION_STRUCTURE",
                "LOGICAL_DEVICE_ACCOUNT_SPECIFICATION_STRUCTURE",
                "LOGICAL_DEVICE_SPECIFICATION_STRUCTURE",
                "MEDIA_STREAM_SPECIFICATION_STRUCTURE",
                "NETWORK_SPECIFICATION_STRUCTURE",
                "OTHER_RESOURCE",
                "PIPE_SPECIFICATION_STRUCTURE",
                "TELEPHONE_NUMBER_SPECIFICATION_STRUCTURE"
            ]
        }
    },
    "required":[
        "name",
        "project",
        "@type"
    ]
}

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

Nested Schema : relatedPlaceRefOrValue

Type: array

Show Source

Array of: object RelatedPlaceRefOrValue

Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself

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

Nested Schema : serviceSpecRelationship

Type: array

Show Source

Array of: object ServiceSpecRelationship

Title: ServiceSpecRelationship

A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.

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

Nested Schema : RelatedPlaceRefOrValue

Type: object

Show Source

@baseType: string

When sub-classing, this defines the super-class
@referredType: string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class Extensible name
href: string

Unique reference of the place
id: string

Unique identifier of the place
name: string

A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
role: string

{
    "type":"object",
    "description":"Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the place"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the place"
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]"
        },
        "role":{
            "type":"string"
        },
        "@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"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

Nested Schema : ServiceSpecRelationship

Type: object

Title: ServiceSpecRelationship

Show Source

@baseType: string

The immediate base class type of the service specification relationship
@referredType(required): string

The actual type of the target instance when needed for disambiguation.
@schemaLocation: string

A link to the schema describing this service specification relationship entity
@type: string

the class type of the service specification relationship
href: string

A string. Reference of the target serviceSpecification.
id(required): string

A string. Unique identifier of the target serviceSpecification.
name: string

A string. The name given to the target service specification instance.
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

A string. Type of relationship such as migration, substitution, dependency, exclusivity.
role: string

A string. The association role for this service specification.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "type":"object",
    "title":"ServiceSpecRelationship",
    "description":"A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, For example, migration, substitution, dependency, or exclusivity relationship.",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the target serviceSpecification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the target serviceSpecification."
        },
        "name":{
            "type":"string",
            "description":"A string. The name given to the target service specification instance."
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "role":{
            "type":"string",
            "description":"A string. The association role for this service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the service specification relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the service specification relationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this service specification relationship entity"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "relationshipType",
        "@referredType"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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