The identity and technical contract details declared by the specification.
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductSpecificationAttributeValueChangeEventPayload
object
ProductSpecificationAttributeValueChangeEventPayload generic structure
1 property
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
PartyRef
object
A Party reference
BundledGroupProductOffering
ProductOfferingPriceCreateEvent
ProductOfferingPriceAttributeValueChangeEvent
ProductSpecificationDeleteEventPayload
object
ProductSpecificationDeleteEventPayload generic structure
1 property
ProductCatalogStateChangeEventPayload
object
ProductCatalogStateChangeEventPayload generic structure
1 property
Extensible
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
3 properties
1 required
CharacteristicSpecification
ImportJobStateChangeEvent
CategoryCreateEventPayload
object
CategoryCreateEventPayload generic structure
1 property
ProductOfferingDeleteEventPayload
object
ProductOfferingDeleteEventPayload generic structure
1 property
ProductOfferingPriceStateChangeEventPayload
object
ProductOfferingPriceStateChangeEventPayload generic structure
1 property
CharacteristicSpecificationRelationship
ProductOfferingDeleteEvent
PartyRefOrPartyRoleRef
object
ProductOfferingPriceDeleteEvent
ProductOfferingCreateEventPayload
object
ProductOfferingCreateEventPayload generic structure
1 property
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
ProductCatalogAttributeValueChangeEvent
ProductOfferingPriceCreateEventPayload
object
ProductOfferingPriceCreateEventPayload generic structure
1 property
ExportJobStateChangeEvent
ProductSpecificationCharacteristicValueUse
ProductOfferingStateChangeEvent
CategoryAttributeValueChangeEventPayload
object
CategoryAttributeValueChangeEventPayload generic structure
1 property
ProductOfferingRelationship
ProductOfferingPriceAttributeValueChangeEventPayload
object
ProductOfferingPriceAttributeValueChangeEventPayload generic structure
1 property
BundledProductSpecification
Duration
object
A time interval in a given unit of time
2 properties
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
ProductSpecificationStateChangeEventPayload
object
ProductSpecificationStateChangeEventPayload generic structure
1 property
MarketSegmentRef
object
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels…
IntentSpecificationRef
object
ImportJobCreateEventPayload
object
ImportJobCreateEventPayload generic structure
1 property
CharacteristicRelationship
CharacteristicValueSpecification
ProductCatalogStateChangeEvent
ExportJobStateChangeEventPayload
object
ExportJobStateChangeEventPayload generic structure
1 property
ProductSpecificationDeleteEvent
ProductSpecificationCreateEventPayload
object
ProductSpecificationCreateEventPayload generic structure
1 property
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
ImportJobStateChangeEventPayload
object
ImportJobStateChangeEventPayload generic structure
1 property
ProductOfferingAttributeValueChangeEventPayload
object
ProductOfferingAttributeValueChangeEventPayload generic structure
1 property
ProductOfferingAttributeValueChangeEvent
Money
object
A base / value business entity used to represent money
2 properties
ProductSpecificationStateChangeEvent
BundledProductOfferingOption
ExportJobCreateEventPayload
object
ExportJobCreateEventPayload generic structure
1 property
ProductOfferingStateChangeEventPayload
object
ProductOfferingStateChangeEventPayload generic structure
1 property
CategoryStateChangeEventPayload
object
CategoryStateChangeEventPayload generic structure
1 property
BundledProductOfferingPriceRelationship
ProductOfferingPriceDeleteEventPayload
object
ProductOfferingPriceDeleteEventPayload generic structure
1 property
PlaceRef
object
Place reference.
Quantity
object
An amount in a given unit
2 properties
ProductOfferingPriceStateChangeEvent
ProductOfferingPriceRelationship
ProductCatalogCreateEvent
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
2 properties
SLARef
object
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties desig…
AttachmentRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself
ProductOfferingPriceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the ProductOfferingPrice entity and not the ProductOfferingPriceRefOrValue cla…
ProductSpecificationCreateEvent
BundledGroupProductOfferingOption
ProductCatalogDeleteEventPayload
object
ProductCatalogDeleteEventPayload generic structure
1 property
Addressable
object
Base schema for adressable entities
2 properties
RelatedPartyRefOrPartyRoleRef
ProductSpecificationAttributeValueChangeEvent
CategoryAttributeValueChangeEvent
ProductSpecificationRelationship
CategoryDeleteEventPayload
object
CategoryDeleteEventPayload generic structure
1 property
JobStateType
string
Valid values for the state of a batch job (e.g. catalog import)
ProductCatalogAttributeValueChangeEventPayload
object
ProductCatalogAttributeValueChangeEventPayload generic structure
1 property
ProductCatalogDeleteEvent
ProductCatalogCreateEventPayload
object
ProductCatalogCreateEventPayload generic structure
1 property
ProductOfferingCreateEvent
TroubleTicketStatusChangeEvent
TroubleTicketSpecificationAttributeValueChangeEvent
TroubleTicketSpecificationDeleteEventPayload
object
TroubleTicketSpecificationDeleteEventPayload generic structure
1 property
TroubleTicketResolvedEvent
CharacteristicValueSpecification_2
TroubleTicketSpecificationCreateEventPayload
object
TroubleTicketSpecificationCreateEventPayload generic structure
1 property
TroubleTicketSpecification
TroubleTicketSpecificationStatusChangeEventPayload
object
TroubleTicketSpecificationStatusChangeEventPayload generic structure
1 property
TroubleTicketSpecificationStatusChangeEvent
TroubleTicketSpecificationRef
TroubleTicketAttributeValueChangeEventPayload
object
TroubleTicketAttributeValueChangeEventPayload generic structure
1 property
TroubleTicketStatusType
string
Possible values for the status of the trouble ticket
TroubleTicketSpecificationCreateEvent
CharacteristicSpecification_2
TroubleTicketDeleteEventPayload
object
TroubleTicketDeleteEventPayload generic structure
1 property
TroubleTicketSpecificationDeleteEvent
TroubleTicketStatusChangeEventPayload
object
TroubleTicketStatusChangeEventPayload generic structure
1 property
Addressable_2
object
Base schema for addressable entities
2 properties
TroubleTicketResolvedEventPayload
object
TroubleTicketResolvedEventPayload generic structure
1 property
TroubleTicketAttributeValueChangeEvent
TroubleTicketRelationship
TroubleTicketInformationRequiredEventPayload
object
TroubleTicketInformationRequiredEventPayload generic structure
2 properties
JsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties
2 required
TroubleTicketSpecificationAttributeValueChangeEventPayload
object
TroubleTicketSpecificationAttributeValueChangeEventPayload generic structure
1 property
TroubleTicketRef
object
reference to an TroubleTicket object
TroubleTicketInformationRequiredEvent
TroubleTicketCreateEventPayload
object
TroubleTicketCreateEventPayload generic structure
1 property
ProductOrderAttributeValueChangeEvent
ProductOrderErrorMessagePayload
object
ProductOrderErrorMessagePayload generic structure
1 property
ProductOrderStateChangeEvent
PartyRoleSpecificationRef
object
Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.
ExpressionLanguageEnum
string
Possible values for the serialized Expression language of an intent or Intent report
CancelProductOrderStateChangeEvent
CancelProductOrderCreateEvent
ProductOrderItemStateType
string
Possible values for the state of the product order item
ProductOrderInformationRequiredEventPayload
object
ProductOrderInformationRequiredEventPayload generic structure
2 properties
OrganizationParentRelationship
ResourceRef
object
Resource reference, for when Resource is used by other entities.
ProductOrderStateType
string
Possible values for the state of the order
IntentRefOrValue
object
Intent Ref (if Intent already exists) or Value (if Intent be created or its details be presented)
CancelProductOrderInformationRequiredEvent
ProductOrderAttributeValueChangePayload
object
ProductOrderAttributeValueChangePayload generic structure
1 property
ProductOrderMilestoneEvent
OtherNameIndividual
object
Keeps track of other names, for example the old name of a woman before marriage or an artist name.
12 properties
PaymentRef
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
ProductOrderStateChangeEventPayload
object
ProductOrderStateChangeEventPayload generic structure
1 property
TaskStateType
string
Possible values for the state of a task
IndividualStateType
string
Valid values for the lifecycle state of the individual
EntityRelationship
object
A uni-directionmal relationship from this entity to a target entity instance
11 properties
CancelProductOrderStateChangeEventPayload
object
CancelProductOrderStateChangeEventPayload generic structure
1 property
ProductOrderErrorMessageEvent
ProductOrderJeopardyAlertEvent
BusinessPartner
object
When business partner is the BusinessPartner
CancelProductOrderCreateEventPayload
object
CancelProductOrderCreateEventPayload
1 property
OrganizationIdentification
IntentRef
object
Intent reference, for when Intent is used by other entities
ProductStatusType
string
Possible values for the status of the product
ProductOrderDeleteEventPayload
object
ProductOrder Delete
1 property
OrganizationChildRelationship
ServiceRef
object
Service reference, for when Service is used by other entities.
ProductOrderMilestonePayload
object
ProductOrderMilestonePayload generic structure
1 property
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
Supplier
object
When business partner is the Supplier
InitialProductOrderStateType
string
Possible values for the requested initial state of the order from client- by default acknowledged is considered
ProductOrderJeopardyAlert
ItemActionType
string
action to be performed on the entity managed by the item
ProductOrderRef
object
A reference to an existing Product Order.
Skill
object
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
5 properties
GeographicSiteRelationship
ProductRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Product entity and not the ProductRefOrValue class itself
ProductOrderCreateEventPayload
object
ProductOrderCreateEventPayload
1 property
ProductOrderInformationRequiredEvent
QuoteRef
object
Quote reference. It's a Quote that has been executed previously.
ProductOfferingQualificationItemRef
PlaceRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself
OrganizationStateType
string
Valid values for the lifecycle state of the organization
CancelProductOrderRef
object
A reference to an existing Product Order Cancel request
ProductOfferingQualificationRef
object
A productOfferingQualification that has been executed previously
ProductOrderJeopardyAlertPayload
object
ProductOrderJeopardyAlertPayload generic structure
1 property
GeographicLocationRefOrValue
object
The polymorphic attributes @type, @schemaLocation & @referredType are related to the GeographicLocation entity and not the GeographicLocationRefOrValue class i…
Place
object
Place reference.
AccountRef
object
Account reference. A account may be a party account or a financial account.
Disability
object
Lack or inadequate strength or ability.
3 properties
ProductRef
object
A Product reference
LanguageAbility
object
Ability of an individual to understand or converse in a language.
8 properties
CancelProductOrderInformationRequiredEventPayload
object
CancelProductOrderInformationRequiredEventPayload generic structure
2 properties
GeographicLocationRef
object
CustomerAttributeValueChangeEvent
CustomerCreateEventPayload
object
The event data structure
1 property
Addressable_3
object
Base schema for addressable entities
2 properties
AgreementRef_2
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
CustomerStateChangeEventPayload
object
The event data structure
1 property
CustomerAttributeValueChangeEventPayload
object
The event data structure
1 property
PartyOrPartyRole_2
object
CustomerDeleteEventPayload
object
The event data structure
1 property
IndividualAttributeValueChangeEvent
OrganizationAttributeValueChangeEventPayload
object
OrganizationAttributeValueChangeEventPayload generic structure
1 property
OrganizationAttributeValueChangeEvent
OrganizationCreateEventPayload
object
OrganizationCreateEventPayload generic structure
1 property
OrganizationStateChangeEvent
OrganizationDeleteEventPayload
object
OrganizationDeleteEventPayload generic structure
1 property
IndividualDeleteEventPayload
object
IndividualDeleteEventPayload generic structure
1 property
IndividualAttributeValueChangeEventPayload
object
IndividualAttributeValueChangeEventPayload generic structure
1 property
IndividualStateChangeEvent
IndividualStateChangeEventPayload
object
IndividualStateChangeEventPayload generic structure
1 property
OrganizationStateChangeEventPayload
object
OrganizationStateChangeEventPayload generic structure
1 property
IndividualCreateEventPayload
object
IndividualCreateEventPayload generic structure
1 property
ProductStateChangeEventPayload
object
ProductStateChangeEventPayload generic structure
1 property
ProductCreateEventPayload
object
ProductCreateEventPayload
1 property
ProductAttributeValueChangePayload
object
ProductAttributeValueChangePayload generic structure
1 property
ProductAttributeValueChangeEvent
ProductBatchEventPayload
object
ProductBatchEventPayload
1 property
ProductDeleteEventPayload
object
Product Delete
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs TM Forum publishes across the network.