The identity and technical contract details declared by the specification.
AttachmentRefOrValue
object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
5 properties
BellChangeRequestFailureEvent
The notification data structure
ChangeRequestStatusType
string
Possible values for the state of the change request
RelatedParty
Related Entity reference. A related party defines party or party role linked to a specific entity.
ChangeRequestRelationship
AttachmentRef
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
ChangeRequestRef
Reference to a Change Request
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
Record
A record in a worklog.
Entity
object
Base entity schema for use in TMForum Open-APIs
3 properties
RelatedEntity
A reference to an entity, where the type of the entity is not known in advance.
ImpactEntity
A reference to an imapcted entity
ChangeRequestRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
5 properties
ChangeRequestApprovalRequiredEvent
The notification data structure
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
7 properties
Attachment
Complements the description of an element (for instance a product) through video, pictures...
BellChangeRequestFailureEventPayload
object
The event data structure
2 properties
BellErrorRepresentation
Bell specialized version of the TMF Error. Used to store the native error representation
Task
A step or task along in the process of implementation a Change Request.
ChangeRequest
Change Request is a type of request which can be used for the management and control of Change Management process -within a service provider organisation or -b…
ChangeRequestDeleteEvent
The notification data structure
ChangeRequestCreateEvent
The notification data structure
Resolution
The way one or more change request has been implementation through a direct remedy or task
ChangeRequestStatusChangeEvent
The notification data structure
Quantity
object
An amount in a given unit
2 properties
ChangeRequestApprovalRequiredEventPayload
object
The event data structure
1 property
Place
Place reference. Place defines the places where the products are sold or delivered.
ChangeRequestAttributeValueChangeEventPayload
object
The event data structure
1 property
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
5 properties
ExternalReference
External reference of the individual or reference in other system
ChangeRequestAttributeValueChangeEvent
The notification data structure
ChangeRequestDeleteEventPayload
object
The event data structure
1 property
ChangeRequestStatusChangeEventPayload
object
The event data structure
1 property
WorkLog
A record of the work performed on the change request during the investigation and resolution process.
Note
Extra information about a given entity
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
EntitySpecificationRef
reference to an EntitySpecification object
RelatedPlaceRefOrValue
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, @sc…
6 properties
TroubleTicketRef
TroubleTicket reference, for when a Trouble Ticket is used by other entities
Money
object
A base / value business entity used to represent money
2 properties
PlaceRef
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
Event
Event with common fields. This is an abstract base definition for all events that are produced by TMF APIs. It must be used as a template for specific events.…
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ChangeRequestCreateEventPayload
object
The event data structure
1 property
EntityRef
Base entityRef schema for use in TMForum Open-APIs
SLARef
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
AttachmentRefOrValue_2
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
5 properties
ResourceSpecificationRef
Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.
ResourceDeleteEvent
The notification data structure
RelatedParty_2
Related Entity reference. A related party defines party or party role linked to a specific entity.
PhysicalResourceCreateEventPayload
object
The event data structure
1 property
AttachmentRef_2
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
ResourceAttributeValueChangeEvent
The notification data structure
PhysicalResourceDeleteEvent
The notification data structure
PhysicalResourceStateChangeEvent
The notification data structure
ResourceDeleteEventPayload
object
The event data structure
1 property
ResourceStatusType
string
ResourceStatusType enumerations
PhysicalResourceStateChangeEventPayload
object
The event data structure
1 property
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations
ResourceStateChangeEvent
The notification data structure
Attachment_2
Complements the description of an element (for instance a product) through video, pictures...
ResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceCreateEvent
The notification data structure
ResourceAdministrativeStateType
string
ResourceAdministrativeStateType enumerations
PhysicalResourceDeleteEventPayload
object
The event data structure
1 property
ResourceUsageStateType
string
ResourceUsageStateType enumerations
PhysicalResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceCreateEventPayload
object
The event data structure
1 property
PhysicalResourceCreateEvent
The notification data structure
Note_2
Extra information about a given entity
TimePeriod_2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ResourceStateChangeEventPayload
object
The event data structure
1 property
PhysicalResource
Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.
PhysicalResourceAttributeValueChangeEvent
The notification data structure
Resource
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.
OrderItemActionType
string
action to be performed on the product
RelatedParty_3
Related Party reference. A related party defines party or party role linked to a specific entity.
ConstraintRef
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
ServiceOrderMilestone
ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.
FeatureRelationship
object
Configuration feature
4 properties
2 required
ServiceOrderRelationship
Linked service order to the one containing this attribute
BellServiceOrderFailureEventPayload
object
The event data structure
2 properties
CancelServiceOrderCreateEvent
The notification data structure
ServiceSpecificationRef
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
ServiceOrderCreateEvent
The notification data structure
ServiceOrderDeleteEventPayload
object
The event data structure
1 property
CancelServiceOrder
Request for cancellation an existing Service order
Service
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
ServiceOrderRef
Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory
CancelServiceOrderStateChangeEvent
The notification data structure
ServiceOrderStateChangeEventPayload
object
The event data structure
1 property
ServiceOrderDeleteEvent
The notification data structure
CancelServiceOrderCreateEventPayload
object
The event data structure
1 property
BellServiceOrderFailureEvent
The notification data structure
ServiceRef
Service reference, for when Service is used by other entities
ServiceOrderAttributeValueChangeEvent
The notification data structure
ServiceOrderStateType
string
Possible values for the state of the order
ServiceOrderCreateEventPayload
object
The event data structure
1 property
ServiceOrderItemRelationship
Linked service order item to the one containing this attribute
RelatedServiceOrderItem
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
ServiceOrderJeopardyAlert
A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
ServiceOrderJeopardyEvent
object
The notification data structure
10 properties
TaskStateType
string
Possible values for the state of a task
ServiceOrderAttributeValueChangeEventPayload
object
The event data structure
1 property
CancelServiceOrderInformationRequiredEvent
The notification data structure
ServiceOrderInformationRequiredEventPayload
object
The event data structure
1 property
ServiceOrderStateChangeEvent
The notification data structure
ServiceOrderItemErrorMessage
AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
CancelServiceOrderStateChangeEventPayload
object
The event data structure
1 property
ServiceOrderJeopardyEventPayload
object
The event data structure
1 property
Feature
object
Configuration feature.
7 properties
2 required
ServiceStateType
string
Valid values for the lifecycle state of the service
ServiceOrderMilestoneEvent
The notification data structure
ErrorMessage
represents an Error
Note_3
Extra information about a given entity
ServiceOrderMilestoneEventPayload
object
The event data structure
1 property
AppointmentRef
Refers an appointment, such as a Customer presentation or internal meeting or site visit
ServiceRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
5 properties
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
6 properties
ServiceOrderItemStateType
string
Possible values for the state of the order item
CancelServiceOrderInformationRequiredEventPayload
object
The event data structure
1 property
ServiceOrderErrorMessage
A ServiceOrderErrorMessage represents an error that causes a status change in a service order.
ServiceOrderInformationRequiredEvent
The notification data structure
AttachmentRefOrValue_3
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
RelatedParty_4
Related Entity reference. A related party defines party or party role linked to a specific entity.
AttachmentRef_3
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
RelatedEntity_2
A reference to an entity, where the type of the entity is not known in advance.
Characteristic_2
Describes a given characteristic of an object or entity through a name/value pair.
Attachment_3
Complements the description of an element (for instance a product) through video, pictures...
TroubleTicketCreateEventPayload
object
The event data structure
1 property
TroubleTicketInformationRequiredEvent
The notification data structure
TroubleTicketStatusChangeEvent
The notification data structure
TroubleTicketAttributeValueChangeEvent
The notification data structure
TroubleTicketStatusChangeEventPayload
object
The event data structure
1 property
TroubleTicketResolvedEventPayload
object
The event data structure
1 property
ChannelRef
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
TroubleTicketResolvedEvent
The notification data structure
TroubleTicketCreateEvent
The notification data structure
Note_4
Extra information about a given entity
TroubleTicketInformationRequiredEventPayload
object
The event data structure
1 property
StatusChange
Holds the status notification reasons and associated date the status changed, populated by the server
TroubleTicketStatusType
string
Possible values for the status of the trouble ticket
TroubleTicketAttributeValueChangeEventPayload
object
The event data structure
1 property
TroubleTicketDeleteEventPayload
object
The event data structure
1 property
TimePeriod_3
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
TroubleTicketRelationship
Represents a relationship between trouble Trouble Tickets
TroubleTicketDeleteEvent
The notification data structure
TroubleTicket
A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bell Canada publishes across the network.