The identity and technical contract details declared by the specification.
Attachment
Complements the description of an element (for instance a product) through video, pictures...
AttachmentRef
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
AttachmentRefOrValue
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
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
7 properties
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
5 properties
EntityRef
Base entityRef schema for use in TMForum Open-APIs
LogicalResource
Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in t…
LogicalResource_Create
Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in t…
LogicalResource_Update
Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in t…
Note
Extra information about a given entity
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.
PhysicalResource_Create
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…
PhysicalResource_Update
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…
Place
Place reference. Place defines the places where the products are sold or delivered.
PlaceRef
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
Quantity
object
An amount in a given unit
2 properties
RelatedParty
Related Entity reference. A related party defines party or party role linked to a specific entity.
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
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.
Resource_Create
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. Skipped pro…
Resource_Update
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. Skipped pro…
ResourceAdministrativeStateType
string
ResourceAdministrativeStateType enumerations
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations
ResourceSpecificationRef
Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.
ResourceStatusType
string
ResourceStatusType enumerations
ResourceUsageStateType
string
ResourceUsageStateType enumerations
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties
1 required
ResourceCreateEvent
The notification data structure
ResourceCreateEventPayload
object
The event data structure
1 property
ResourceAttributeValueChangeEvent
The notification data structure
ResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceStateChangeEvent
The notification data structure
ResourceStateChangeEventPayload
object
The event data structure
1 property
ResourceDeleteEvent
The notification data structure
ResourceDeleteEventPayload
object
The event data structure
1 property
PhysicalResourceCreateEvent
The notification data structure
PhysicalResourceCreateEventPayload
object
The event data structure
1 property
PhysicalResourceAttributeValueChangeEvent
The notification data structure
PhysicalResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
PhysicalResourceStateChangeEvent
The notification data structure
PhysicalResourceStateChangeEventPayload
object
The event data structure
1 property
PhysicalResourceDeleteEvent
The notification data structure
PhysicalResourceDeleteEventPayload
object
The event data structure
1 property
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
BellErrorRepresentation
Bell specialized version of the TMF Error. Used to store the native error representation
BellGenericResource
Bell version of the TMF Resource
BellGenericResource_Create
Bell version of the TMF ResourceCreate
BellGenericResource_Update
Bell version of the TMF Resource
BellResourceType
string
Allow for the differentiation of physical and logical resource when the information is known.
BellRelatedPartyWithValue
Related Entity reference embedding the party itself (value of the refOrValue pattern)
Party
Generic Party structure used to define commonalities between sub concepts of Individual and Organization.
Individual
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
BellIndividual
A Bell extension to an Individual
Organization
Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the compl…
BellOrganization
A Bell extension to an Organization
ContactMedium
Indicates the contact medium that could be used to contact the party.
LanguageAbility
Ability of an individual to understand or converse in a language.
MediumCharacteristic
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
GeographicAddress
Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to…
GeographicLocationRefOrValue
object
A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highw…
5 properties
GeographicLocation
A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highw…
GeographicSubAddress
Representation of a GeographicSubAddress It is used for addressing within a property in an urban area (country properties are often defined differently). It ma…
BellGeographicAddress
A custom Geographic Address to add addressLines.
BellOnSiteSubAddress
A custom SubAddress. Note: type, externalId, sourceSystemId are deprecated.
PlaceRefOrValue
object
A place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the pl…
5 properties
BellGeographicSite
A Bell extension to a Geographic Site.
ExternalReference
External reference of the individual or reference in other system
BellExternalReference
Describes a given characteristic of an object or entity through a name/value pair.
JsonPathPatchOperation
object
A JsonPath operation to be applied to a json element
4 properties
1 required
StringCharacteristic
Standard TMF string characteristic. Describes a given characteristic of an object or entity through a name/value pair.
BooleanCharacteristic
Standard TMF boolean characteristic. Describes a given characteristic of an object or entity through a name/value pair.
FloatCharacteristic
Standard TMF float characteristic. Describes a given characteristic of an object or entity through a name/value pair.
IntegerCharacteristic
Standard TMF integer characteristic. Describes a given characteristic of an object or entity through a name/value pair.
DateTimeCharacteristic
Standard TMF datetime characteristic. Describes a given characteristic of an object or entity through a name/value pair.
ObjectCharacteristic
Standard TMF object characteristic. Describes a given characteristic of an object or entity through a name/value pair.
ObjectArrayCharacteristic
Standard TMF objectarray characteristic. Describes a given characteristic of an object or entity through a name/value pair.
StringArrayCharacteristic
Standard TMF stringarray characteristic. Describes a given characteristic of an object or entity through a name/value pair.
GroupCharacteristic
Standard TMF group characteristic. Describes a given characteristic of an object or entity through a name/value pair.
Entity
object
Base entity schema for use in TMForum Open-APIs
3 properties
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.…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bell Canada publishes across the network.