TM Forum notification listeners (client side) API
The notification listeners (client side) API from TM Forum — 62 operation(s) for notification listeners (client side).
TM Forum notification listeners (client side) API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include notification listeners (client side). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 62 operations across 62 paths, and defines 276 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.
Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.
62 operations
62 paths
276 schemas
62 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 62
Across 62 paths, the API surfaces 62 operations — 62 POST. Each is listed below with its method, path, parameters, and response codes.
notification listeners (client side) 62
POST
/listener/serviceCatalogCreateEvent
Client listener for entity ServiceCatalogCreateEvent
POST
/listener/serviceCatalogChangeEvent
Client listener for entity ServiceCatalogChangeEvent
POST
/listener/serviceCatalogBatchEvent
Client listener for entity ServiceCatalogBatchEvent
POST
/listener/serviceCatalogDeleteEvent
Client listener for entity ServiceCatalogDeleteEvent
POST
/listener/serviceCategoryCreateEvent
Client listener for entity ServiceCategoryCreateEvent
POST
/listener/serviceCategoryChangeEvent
Client listener for entity ServiceCategoryChangeEvent
POST
/listener/serviceCategoryDeleteEvent
Client listener for entity ServiceCategoryDeleteEvent
POST
/listener/serviceCandidateCreateEvent
Client listener for entity ServiceCandidateCreateEvent
POST
/listener/serviceCandidateChangeEvent
Client listener for entity ServiceCandidateChangeEvent
POST
/listener/serviceCandidateDeleteEvent
Client listener for entity ServiceCandidateDeleteEvent
POST
/listener/serviceSpecificationCreateEvent
Client listener for entity ServiceSpecificationCreateEvent
POST
/listener/serviceSpecificationChangeEvent
Client listener for entity ServiceSpecificationChangeEvent
POST
/listener/serviceSpecificationDeleteEvent
Client listener for entity ServiceSpecificationDeleteEvent
POST
/listener/resourceCatalogCreateEvent
Client listener for entity ResourceCatalogCreateEvent
POST
/listener/resourceCatalogChangeEvent
Client listener for entity ResourceCatalogChangeEvent
POST
/listener/resourceCatalogDeleteEvent
Client listener for entity ResourceCatalogDeleteEvent
POST
/listener/resourceCategoryCreateEvent
Client listener for entity ResourceCategoryCreateEvent
POST
/listener/resourceCategoryChangeEvent
Client listener for entity ResourceCategoryChangeEvent
POST
/listener/resourceCategoryDeleteEvent
Client listener for entity ResourceCategoryDeleteEvent
POST
/listener/resourceCandidateCreateEvent
Client listener for entity ResourceCandidateCreateEvent
POST
/listener/resourceCandidateChangeEvent
Client listener for entity ResourceCandidateChangeEvent
POST
/listener/resourceCandidateDeleteEvent
Client listener for entity ResourceCandidateDeleteEvent
POST
/listener/resourceSpecificationCreateEvent
Client listener for entity ResourceSpecificationCreateEvent
POST
/listener/resourceSpecificationChangeEvent
Client listener for entity ResourceSpecificationChangeEvent
POST
/listener/resourceSpecificationDeleteEvent
Client listener for entity ResourceSpecificationDeleteEvent
POST
/listener/importJobCreateEvent
Client listener for entity ImportJobCreateEvent
POST
/listener/importJobStateChangeEvent
Client listener for entity ImportJobStateChangeEvent
POST
/listener/exportJobCreateEvent
Client listener for entity ExportJobCreateEvent
POST
/listener/exportJobStateChangeEvent
Client listener for entity ExportJobStateChangeEvent
POST
/listener/serviceOrderCreateEvent
Client listener for entity ServiceOrderCreateEvent
POST
/listener/serviceOrderAttributeValueChangeEvent
Client listener for entity ServiceOrderAttributeValueChangeEvent
POST
/listener/serviceOrderStateChangeEvent
Client listener for entity ServiceOrderStateChangeEvent
POST
/listener/serviceOrderDeleteEvent
Client listener for entity ServiceOrderDeleteEvent
POST
/listener/serviceOrderInformationRequiredEvent
Client listener for entity ServiceOrderInformationRequiredEvent
POST
/listener/serviceOrderMilestoneEvent
Client listener for entity ServiceOrderMilestoneEvent
POST
/listener/serviceOrderJeopardyEvent
Client listener for entity ServiceOrderJeopardyEvent
POST
/listener/cancelServiceOrderCreateEvent
Client listener for entity CancelServiceOrderCreateEvent
POST
/listener/cancelServiceOrderStateChangeEvent
Client listener for entity CancelServiceOrderStateChangeEvent
POST
/listener/cancelServiceOrderInformationRequiredEvent
Client listener for entity CancelServiceOrderInformationRequiredEvent
POST
/listener/quoteCreateEvent
Client listener for entity QuoteCreateEvent
POST
/listener/quoteStateChangeEvent
Client listener for entity QuoteStateChangeEvent
POST
/listener/quoteDeleteEvent
Client listener for entity QuoteDeleteEvent
POST
/listener/quoteInformationRequiredEvent
Client listener for entity QuoteInformationRequiredEvent
POST
/listener/quoteAttributeValueChangeEvent
Client listener for entity QuoteAttributeValueChangeEvent
POST
/listener/agreementCreateEvent
Client listener for entity AgreementCreateEvent
POST
/listener/agreementAttributeValueChangeEvent
Client listener for entity AgreementAttributeValueChangeEvent
POST
/listener/agreementStateChangeEvent
Client listener for entity AgreementStateChangeEvent
POST
/listener/agreementDeleteEvent
Client listener for entity AgreementDeleteEvent
POST
/listener/agreementSpecificationCreateEvent
Client listener for entity AgreementSpecificationCreateEvent
POST
/listener/agreementSpecificationAttributeValueChangeEvent
Client listener for entity AgreementSpecificationAttributeValueChangeEvent
POST
/listener/agreementSpecificationStateChangeEvent
Client listener for entity AgreementSpecificationStateChangeEvent
POST
/listener/agreementSpecificationDeleteEvent
Client listener for entity AgreementSpecificationDeleteEvent
POST
/listener/partyAccountAttributeValueChangeEvent
Client listener for entity PartyAccountAttributeValueChangeEvent
POST
/listener/partyAccountStateChangeEvent
Client listener for entity PartyAccountStateChangeEvent
POST
/listener/billingAccountAttributeValueChangeEvent
Client listener for entity BillingAccountAttributeValueChangeEvent
POST
/listener/billingAccountStateChangeEvent
Client listener for entity BillingAccountStateChangeEvent
POST
/listener/settlementAccountAttributeValueChangeEvent
Client listener for entity SettlementAccountAttributeValueChangeEvent
POST
/listener/settlementAccountStateChangeEvent
Client listener for entity SettlementAccountStateChangeEvent
POST
/listener/financialAccountCreateEvent
Client listener for entity FinancialAccountCreateEvent
POST
/listener/financialAccountAttributeValueChangeEvent
Client listener for entity FinancialAccountAttributeValueChangeEvent
POST
/listener/financialAccountStateChangeEvent
Client listener for entity FinancialAccountStateChangeEvent
POST
/listener/financialAccountDeleteEvent
Client listener for entity FinancialAccountDeleteEvent
Schemas 276
The contract defines 276 schemas that model the data the API accepts and returns. The most detailed are ServiceRefOrValue (30 properties), ProductRefOrValue (29 properties), ServiceOrder (27 properties), Quote (26 properties). Each schema is shown below with its type and property counts.
AgreementCreateEvent
object
The notification data structure
12 properties
ServiceCatalog
object
The root entity for service catalog management. A service catalog is a group of service specifications made available through service candidates that an organi…
13 properties
ResourceSpecificationDeleteEventPayload
object
The event data structure
1 property
AttachmentRefOrValue_3
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
AgreementSpecificationRelationship
object
A relationship between agreement specifications. Typical relationships are substitution and dependency.
9 properties
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…
14 properties
CancelServiceOrderStateChangeEventPayload
object
The event data structure
1 property
ServiceOrderMilestoneEvent
object
The notification data structure
10 properties
AgreementSpecCharacteristic
object
A characteristic quality or distinctive feature of an agreement.
9 properties
AppointmentRef_2
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
7 properties
1 required
ResourceCategory
object
The (resource) category resource is used to group resource candidates in logical containers. Categories can contain other categories.
16 properties
ResourceCategoryCreateEvent
object
The notification data structure
12 properties
ServiceSpecRelationship
object
A dependency, substitution or exclusivity relationship between/among service specifications.
10 properties
1 required
AgreementCreateEventPayload
object
The event data structure
1 property
ServiceOrderErrorMessage
object
A ServiceOrderErrorMessage represents an error that causes a status change in a service order.
10 properties
ResourceCandidateDeleteEventPayload
object
The event data structure
1 property
FeatureSpecificationCharacteristic_2
object
Configuration feature characteristic specification.
15 properties
1 required
BillingAccountAttributeValueChangeEvent
object
The notification data structure
11 properties
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
7 properties
ServiceOrderItemStateType
string
Possible values for the state of the order item
ServiceOrderItemErrorMessage
object
AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
9 properties
FinancialAccountCreateEvent
object
The notification data structure
12 properties
CancelServiceOrderInformationRequiredEvent
object
The notification data structure
11 properties
TimePeriod_5
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductPrice
object
An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defin…
12 properties
2 required
FeatureSpecificationRelationship_2
object
Configuration feature
9 properties
2 required
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
7 properties
1 required
ServiceCatalogBatchEvent
object
The notification data structure
10 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties
1 required
ServiceOrderCreateEventPayload
object
The event data structure
1 property
AgreementSpecCharacteristicValue
object
A number or text that can be assigned to an agreement specification characteristic.
10 properties
ResourceCandidate
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
13 properties
TimePeriod_2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ResourceSpecificationRef_2
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties
1 required
QuoteCreateEventPayload
object
The event data structure
1 property
ResourceCandidateCreateEventPayload
object
The event data structure
1 property
ServiceCatalogDeleteEvent
object
The notification data structure
10 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
14 properties
PartyAccountStateChangeEventPayload
object
The event data structure
1 property
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…
7 properties
1 required
PartyAccountAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceSpecification
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
19 properties
QuoteItemRelationship
object
Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions
5 properties
ResourceSpecificationCreateEventPayload
object
The event data structure
1 property
RelatedParty_5
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
3 required
ServiceOrderRelationship
object
Linked service order to the one containing this attribute
7 properties
2 required
ServiceOrderStateChangeEventPayload
object
The event data structure
1 property
Any
BillFormatRefOrValue
object
An attachment by value or by reference.
9 properties
2 required
PartyAccountStateChangeEvent
object
The notification data structure
12 properties
RelatedServiceOrderItem
object
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
11 properties
SettlementAccountAttributeValueChangeEvent
object
The notification data structure
11 properties
ServiceOrderAttributeValueChangeEvent
object
The notification data structure
11 properties
ServiceCategoryCreateEventPayload
object
The event data structure
1 property
BillPresentationMediaRefOrValue
object
An attachment by value or by reference.
9 properties
2 required
SettlementAccountStateChangeEventPayload
object
The event data structure
1 property
ResourceSpecificationDeleteEvent
object
The notification data structure
12 properties
AccountTaxExemption
object
Proof of freedom from taxes imposed by a taxing jurisdiction
7 properties
2 required
Agreement
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
21 properties
4 required
AgreementSpecificationCreateEvent
object
The notification data structure
12 properties
BillingAccountAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceCategoryChangeEventPayload
object
The event data structure
1 property
CancelServiceOrderInformationRequiredEventPayload
object
The event data structure
1 property
QuotePrice
object
Description of price and discount awarded
11 properties
ResourceCandidateChangeEvent
object
The notification data structure
12 properties
ServiceCatalogCreateEvent
object
The notification data structure
10 properties
ConstraintRef_2
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties
1 required
ProductSpecificationRef
object
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a…
9 properties
1 required
JobStateType
string
Valid values for the state of a batch job (e.g. catalog import)
ImportJob
object
Represents a task used to import resources from a file
12 properties
ResourceCatalog
object
The root entity for resource catalog management. A resource catalog is a group of resource specifications made available through resource candidates that an or…
13 properties
ServiceRef
object
Service reference, for when Service is used by other entities
7 properties
1 required
ServiceOrderDeleteEventPayload
object
The event data structure
1 property
ServiceCatalogBatchEventPayload
object
The event data structure
1 property
ServiceCategoryChangeEventPayload
object
The event data structure
1 property
ImportJobCreateEventPayload
object
The event data structure
1 property
ServiceSpecification
object
ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instant…
22 properties
ServiceOrderCreateEvent
object
The notification data structure
10 properties
FinancialAccount
object
An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable accou…
16 properties
1 required
QuoteDeleteEventPayload
object
The event data structure
1 property
ServiceCandidateDeleteEventPayload
object
The event data structure
1 property
ServiceCategoryCreateEvent
object
The notification data structure
10 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
ServiceOrderStateType
string
Possible values for the state of the order
CancelServiceOrderCreateEventPayload
object
The event data structure
1 property
ServiceOrderRef
object
Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory
7 properties
1 required
ResourceCatalogChangeEvent
object
The notification data structure
12 properties
AgreementSpecificationDeleteEventPayload
object
The event data structure
1 property
RelatedParty_2
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
AgreementSpecificationStateChangeEventPayload
object
The event data structure
1 property
TargetProductSchema
object
The reference object to the schema and type of target product which is described by product specification
3 properties
2 required
QuoteStateChangeEventPayload
object
The event data structure
1 property
AgreementTermOrCondition
object
Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitor…
6 properties
ResourceCatalogCreateEventPayload
object
The event data structure
1 property
FinancialAccountCreateEventPayload
object
The event data structure
1 property
AccountRelationship
object
Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.
6 properties
2 required
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…
30 properties
ExportJob
object
Represents a task used to export resources to a file
13 properties
AgreementSpecificationCreateEventPayload
object
The event data structure
1 property
ServiceOrderInformationRequiredEvent
object
The notification data structure
11 properties
ServiceStateType
string
Valid values for the lifecycle state of the service
ExportJobStateChangeEventPayload
object
The event data structure
1 property
ImportJobCreateEvent
object
The notification data structure
12 properties
FeatureRelationship
object
Configuration feature
4 properties
2 required
ServiceCatalogCreateEventPayload
object
The event data structure
1 property
ServiceOrderAttributeValueChangeEventPayload
object
The event data structure
1 property
BillingAccountStateChangeEvent
object
The notification data structure
12 properties
ResourceCategoryCreateEventPayload
object
The event data structure
1 property
AgreementSpecificationAttributeValueChangeEvent
object
The notification data structure
11 properties
SettlementAccountStateChangeEvent
object
The notification data structure
12 properties
ServiceCategoryRef
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.
8 properties
1 required
QuoteAttributeValueChangeEventPayload
object
The event data structure
1 property
ProductOfferingPriceRef
object
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
7 properties
1 required
BillingCycleSpecificationRefOrValue
object
An attachment by value or by reference.
18 properties
2 required
Money
object
A base / value business entity used to represent money
2 properties
ServiceCatalogDeleteEventPayload
object
The event data structure
1 property
TargetEntitySchema
object
The reference object to the schema and type of target entity which is described by a specification
2 properties
2 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties
2 required
ResourceCategoryChangeEvent
object
The notification data structure
12 properties
AgreementItem
object
A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.
6 properties
SettlementAccount
object
A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specia…
21 properties
2 required
ServiceCandidateRef
object
ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.
8 properties
1 required
ServiceSpecificationCreateEventPayload
object
The event data structure
1 property
FinancialAccountAttributeValueChangeEventPayload
object
The event data structure
1 property
AgreementSpecificationRef
object
AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.
8 properties
1 required
CategoryRef
object
The category for grouping recommendations
8 properties
1 required
CancelServiceOrder
object
Request for cancellation an existing Service order
12 properties
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing informati…
7 properties
1 required
ResourceSpecificationRef
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties
1 required
FinancialAccountDeleteEvent
object
The notification data structure
12 properties
FeatureSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.
7 properties
ResourceCandidateCreateEvent
object
The notification data structure
12 properties
QuoteInformationRequiredEvent
object
The notification data structure
11 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
ResourceCatalogDeleteEvent
object
The notification data structure
12 properties
ServiceCandidate
object
ServiceCandidate is an entity that makes a service specification available to a catalog. A ServiceCandidate and its associated service specification may be pub…
13 properties
AgreementSpecificationDeleteEvent
object
The notification data structure
12 properties
ExternalReference
object
External reference of the individual or reference in other system
7 properties
1 required
ResourceSpecificationCharacteristicRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among ResourceSpecificationCharacteristics. The specification character…
9 properties
RelatedPlaceRefOrValue_2
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…
8 properties
1 required
Quote
object
Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a…
26 properties
1 required
ResourceSpecificationRelationship
object
A migration, substitution, dependency or exclusivity relationship between/among resource specifications.
13 properties
AgreementDeleteEventPayload
object
The event data structure
1 property
ServiceOrderItemRef
object
7 properties
1 required
EntitySpecificationRelationship
object
A migration, substitution, dependency or exclusivity relationship between/among entity specifications.
11 properties
1 required
CharacteristicSpecificationRelationship
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic i…
6 properties
Authorization
object
If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.
9 properties
ProductRef
object
7 properties
1 required
ResourceCatalogCreateEvent
object
The notification data structure
12 properties
AgreementSpecificationAttributeValueChangeEventPayload
object
The event data structure
1 property
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…
8 properties
1 required
Quantity
object
An amount in a given unit
2 properties
ResourceSpecificationChangeEventPayload
object
The event data structure
1 property
ResourceCategoryDeleteEventPayload
object
The event data structure
1 property
ResourceRef_2
object
8 properties
1 required
AgreementStateChangeEventPayload
object
The event data structure
1 property
Characteristic_2
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties
2 required
ResourceCandidateRef
object
ResourceCandidate is an entity that makes a resource specification available to a catalog. A ResourceCandidate and its associated resource specification may be…
8 properties
1 required
ImportJobStateChangeEvent
object
The notification data structure
12 properties
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
PartyAccount
object
Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
21 properties
2 required
ResourceSpecificationCharacteristic
object
This class defines the characteristic features of a resource specification. Every ResourceSpecification has a variety of important attributes, methods, constra…
17 properties
ServiceCandidateChangeEvent
object
The notification data structure
10 properties
Price
object
Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
7 properties
ServiceCategory
object
The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.
15 properties
ServiceOrderItem
object
12 properties
3 required
Feature
object
Configuration feature.
7 properties
2 required
TimePeriod_3
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
PaymentPlan
object
Defines a plan for payment (when a party wants to spread his payments)
11 properties
FinancialAccountStateChangeEvent
object
The notification data structure
12 properties
AgreementItemRef
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…
8 properties
1 required
AgreementStateChangeEvent
object
The notification data structure
12 properties
ServiceSpecificationDeleteEventPayload
object
The event data structure
1 property
RelatedParty_6
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
3 required
ExportJobStateChangeEvent
object
The notification data structure
12 properties
ServiceOrderJeopardyEventPayload
object
The event data structure
1 property
TargetResourceSchema
object
The reference object to the schema and type of target resource which is described by resource specification
3 properties
2 required
BillingAccountRef
object
BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
7 properties
1 required
AccountRef
object
Account reference. A account may be a party account or a financial account.
8 properties
1 required
AgreementDeleteEvent
object
The notification data structure
12 properties
AgreementAuthorization
object
A business participant that is responsible for approving the agreement.
6 properties
AgreementSpecification
object
A template of an agreement that can be used when establishing partnerships
17 properties
2 required
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.
14 properties
ProductStatusType
string
Possible values for the status of the product
RelatedParty_3
object
Related Party reference. A related party defines party or party role linked to a specific entity.
8 properties
3 required
ServiceOrderStateChangeEvent
object
The notification data structure
10 properties
ResourceCandidateDeleteEvent
object
The notification data structure
12 properties
ServiceCategoryDeleteEvent
object
The notification data structure
10 properties
BillingAccount
object
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specializ…
21 properties
2 required
ServiceLevelSpecificationRef
object
A Service Level Specification represents a pre-defined or negotiated set of Service Level Objectives. In addition, certain consequences are associated with not…
7 properties
1 required
RelatedProductOrderItem
object
RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.
9 properties
2 required
AppointmentRef
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
7 properties
1 required
ServiceCatalogChangeEvent
object
The notification data structure
10 properties
AgreementAttributeValueChangeEventPayload
object
The event data structure
1 property
CharacteristicValueSpecification
object
specification of a value (number or text or an object) that can be assigned to a Characteristic.
12 properties
FinancialAccountStateChangeEventPayload
object
The event data structure
1 property
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
ResourceCatalogDeleteEventPayload
object
The event data structure
1 property
ServiceCategoryDeleteEventPayload
object
The event data structure
1 property
AttachmentRefOrValue_4
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.
14 properties
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
8 properties
1 required
AgreementSpecificationStateChangeEvent
object
The notification data structure
12 properties
SettlementAccountAttributeValueChangeEventPayload
object
The event data structure
1 property
TaskStateType
string
Possible values for the state of a task
ServiceCandidateChangeEventPayload
object
The event data structure
1 property
ResourceRef
object
7 properties
1 required
ServiceCandidateCreateEventPayload
object
The event data structure
1 property
Characteristic_3
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties
2 required
FeatureSpecification_2
object
Specification for applicable configuration features for a resource specification.
12 properties
ServiceOrderJeopardyAlert
object
A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
10 properties
ResourceSpecificationChangeEvent
object
The notification data structure
12 properties
FeatureSpecificationRelationship
object
Relationship between feature specifications
6 properties
2 required
PriceAlteration
object
Is an amount, usually of money, that modifies the price charged for an order item.
12 properties
2 required
ResourceCandidateChangeEventPayload
object
The event data structure
1 property
AssociationSpecificationRef
object
reference to an AssociationSpecification object
7 properties
1 required
ExportJobCreateEventPayload
object
The event data structure
1 property
FinancialAccountDeleteEventPayload
object
The event data structure
1 property
AccountBalance
object
Balances linked to the account
6 properties
3 required
ContactMedium_2
object
Indicates the contact medium that could be used to contact the party.
7 properties
ProductOfferingQualificationItemRef
object
It's a productOfferingQualification item that has been executed previously.
10 properties
2 required
FeatureSpecification
object
Specification for resource, service or product features
9 properties
TimePeriod_4
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
FinancialAccountRef
object
AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An accou…
8 properties
1 required
FeatureSpecificationCharacteristicValue
object
A number or text that can be assigned to a FeatureSpecificationCharacteristic.
12 properties
1 required
CancelServiceOrderStateChangeEvent
object
The notification data structure
10 properties
AgreementAttributeValueChangeEvent
object
The notification data structure
11 properties
QuoteItem
object
A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.
18 properties
ServiceSpecificationCreateEvent
object
The notification data structure
10 properties
ProductRelationship
object
Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesO…
5 properties
2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
FinancialAccountAttributeValueChangeEvent
object
The notification data structure
11 properties
ServiceOrderDeleteEvent
object
The notification data structure
10 properties
ServiceOrder
object
27 properties
ServiceOrderMilestone
object
ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.
10 properties
ServiceOrderJeopardyEvent
object
The notification data structure
10 properties
QuoteDeleteEvent
object
The notification data structure
12 properties
ServiceCandidateDeleteEvent
object
The notification data structure
10 properties
ImportJobStateChangeEventPayload
object
The event data structure
1 property
Note_2
object
Extra information about a given entity
7 properties
2 required
ServiceRelationship
object
8 properties
1 required
ErrorMessage
object
represents an Error
8 properties
RelatedParty_4
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
QuoteCreateEvent
object
The notification data structure
12 properties
ResourceCatalogChangeEventPayload
object
The event data structure
1 property
ResourceCategoryRef
object
The (resource) category resource is used to group resource candidates in logical containers. Categories can contain other categories.
8 properties
1 required
ProductTerm
object
Description of a productTerm linked to this product. This represent a commitment with a duration
7 properties
Note
object
Extra information about a given entity
7 properties
1 required
QuoteInformationRequiredEventPayload
object
The event data structure
1 property
ProductRefOrValue
object
A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
29 properties
CancelServiceOrderCreateEvent
object
The notification data structure
10 properties
ResourceSpecificationCreateEvent
object
The notification data structure
12 properties
ServiceOrderMilestoneEventPayload
object
The event data structure
1 property
ServiceOrderItemRelationship
object
Linked service order item to the one containing this attribute
5 properties
BillingAccountStateChangeEventPayload
object
The event data structure
1 property
ServiceSpecificationChangeEventPayload
object
The event data structure
1 property
Contact
object
An individual or an organization used as a contact point for a given account and accessed via some contact medium.
9 properties
2 required
ServiceCategoryChangeEvent
object
The notification data structure
10 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…
8 properties
1 required
ServiceCandidateCreateEvent
object
The notification data structure
10 properties
ResourceSpecificationCharacteristicValue
object
A number or text that can be assigned to a ResourceSpecCharacteristic.
12 properties
QuoteStateChangeEvent
object
The notification data structure
12 properties
FeatureSpecificationCharacteristic
object
Configuration feature characteristic specification.
17 properties
1 required
OrderItemActionType
string
action to be performed on the product
ServiceSpecificationDeleteEvent
object
The notification data structure
10 properties
QuoteAttributeValueChangeEvent
object
The notification data structure
11 properties
PartyAccountAttributeValueChangeEvent
object
The notification data structure
11 properties
ExportJobCreateEvent
object
The notification data structure
12 properties
CharacteristicSpecification
object
This class defines a characteristic specification.
17 properties
ProductOfferingQualificationRef
object
It's a productOfferingQualification that has been executed previously
7 properties
1 required
BillStructure
object
The structure of the bill for party accounts (billing or settlement).
6 properties
ResourceCategoryDeleteEvent
object
The notification data structure
12 properties
ServiceSpecificationChangeEvent
object
The notification data structure
10 properties
ServiceOrderInformationRequiredEventPayload
object
The event data structure
1 property
QuoteStateType
string
Possible values for the state of the quote
FeatureSpecificationCharacteristicRelationship_2
object
An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics.
10 properties
ServiceCatalogChangeEventPayload
object
The event data structure
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TM Forum 12
Other APIs TM Forum publishes across the network.
TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum cancelServiceOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
#notification listeners (client side)