The Event Management API provides a standardized client interface to the enterprise event management system.
swagger: '2.0'
info:
title: Event Streaming API
description: The Event Management API provides a standardized client interface to the enterprise event management system.
version: 4.0.0
host: serverRoot
basePath: /tmf-api/event/v4/
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/json;charset=utf-8
securityDefinitions:
basicAuth:
type: basic
ApiKeyAuth:
type: apiKey
name: X-API-Key
in: header
security:
- ApiKeyAuth: []
- basicAuth: []
tags:
- name: event
- name: topic
- name: hub
- name: notification listeners (client side)
- name: events subscription
paths:
/topic/{topicId}/event:
get:
operationId: listEvent
summary: List or find Event objects
description: This operation list or find Event entities
tags:
- event
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: fields
description: Comma-separated properties to be provided in response
required: false
in: query
type: string
- name: offset
description: Requested index for start of resources to be provided in response
required: false
in: query
type: integer
- name: limit
description: Requested number of resources to be provided in response
required: false
in: query
type: integer
responses:
'200':
description: Success
headers:
X-Result-Count:
description: Actual number of items returned in the response body
type: integer
X-Total-Count:
description: Total number of items matching criteria
type: integer
schema:
type: array
items:
$ref: '#/definitions/Event'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
post:
operationId: createEvent
summary: Creates a Event
description: This operation creates a Event entity.
tags:
- event
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: event
description: The Event to be created
required: true
schema:
$ref: '#/definitions/Event_Create'
in: body
responses:
'201':
description: Created
schema:
$ref: '#/definitions/Event'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/topic/{topicId}/event/{id}:
get:
operationId: retrieveEvent
summary: Retrieves a Event by ID
description: This operation retrieves a Event entity. Attribute selection is enabled for all first level attributes.
tags:
- event
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: id
description: Identifier of the Event
required: true
type: string
in: path
- name: fields
description: Comma-separated properties to provide in response
required: false
type: string
in: query
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Event'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/topic:
get:
operationId: listTopic
summary: List or find Topic objects
description: This operation list or find Topic entities
tags:
- topic
parameters:
- name: fields
description: Comma-separated properties to be provided in response
required: false
in: query
type: string
- name: offset
description: Requested index for start of resources to be provided in response
required: false
in: query
type: integer
- name: limit
description: Requested number of resources to be provided in response
required: false
in: query
type: integer
responses:
'200':
description: Success
headers:
X-Result-Count:
description: Actual number of items returned in the response body
type: integer
X-Total-Count:
description: Total number of items matching criteria
type: integer
schema:
type: array
items:
$ref: '#/definitions/Topic'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
post:
operationId: createTopic
summary: Creates a Topic
description: This operation creates a Topic entity.
tags:
- topic
parameters:
- name: topic
description: The Topic to be created
required: true
schema:
$ref: '#/definitions/Topic_Create'
in: body
responses:
'201':
description: Created
schema:
$ref: '#/definitions/Topic'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/topic/{id}:
get:
operationId: retrieveTopic
summary: Retrieves a Topic by ID
description: This operation retrieves a Topic entity. Attribute selection is enabled for all first level attributes.
tags:
- topic
parameters:
- name: id
description: Identifier of the Topic
required: true
type: string
in: path
- name: fields
description: Comma-separated properties to provide in response
required: false
type: string
in: query
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Topic'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
delete:
operationId: deleteTopic
summary: Deletes a Topic
description: This operation deletes a Topic entity.
tags:
- topic
parameters:
- name: id
description: Identifier of the Topic
required: true
type: string
in: path
responses:
'204':
description: Deleted
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/topic/{topicId}/hub:
get:
operationId: listHub
summary: List or find Hub objects
description: This operation list or find Hub entities
tags:
- hub
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: fields
description: Comma-separated properties to be provided in response
required: false
in: query
type: string
- name: offset
description: Requested index for start of resources to be provided in response
required: false
in: query
type: integer
- name: limit
description: Requested number of resources to be provided in response
required: false
in: query
type: integer
responses:
'200':
description: Success
headers:
X-Result-Count:
description: Actual number of items returned in the response body
type: integer
X-Total-Count:
description: Total number of items matching criteria
type: integer
schema:
type: array
items:
$ref: '#/definitions/Hub'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
post:
operationId: createHub
summary: Creates a Hub
description: This operation creates a Hub entity.
tags:
- hub
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: hub
description: The Hub to be created
required: true
schema:
$ref: '#/definitions/Hub_Create'
in: body
responses:
'201':
description: Created
schema:
$ref: '#/definitions/Hub'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/topic/{topicId}/hub/{id}:
get:
operationId: retrieveHub
summary: Retrieves a Hub by ID
description: This operation retrieves a Hub entity. Attribute selection is enabled for all first level attributes.
tags:
- hub
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: id
description: Identifier of the Hub
required: true
type: string
in: path
- name: fields
description: Comma-separated properties to provide in response
required: false
type: string
in: query
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Hub'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
delete:
operationId: deleteHub
summary: Deletes a Hub
description: This operation deletes a Hub entity.
tags:
- hub
parameters:
- name: topicId
description: Identifier of the parent Topic entity
required: true
type: string
in: path
- name: id
description: Identifier of the Hub
required: true
type: string
in: path
responses:
'204':
description: Deleted
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/hub:
post:
operationId: registerListener
summary: Register a listener
description: Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
tags:
- events subscription
parameters:
- name: data
schema:
$ref: '#/definitions/EventSubscriptionInput'
required: true
in: body
description: Data containing the callback endpoint to deliver the information
responses:
'201':
description: Subscribed
schema:
$ref: '#/definitions/EventSubscription'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/hub/{id}:
delete:
operationId: unregisterListener
summary: Unregister a listener
description: Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
tags:
- events subscription
parameters:
- name: id
type: string
required: true
in: path
description: The id of the registered listener
responses:
'204':
description: Deleted
'400':
description: Bad request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method not allowed
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/listener/topicCreateEvent:
post:
operationId: listenToTopicCreateEvent
summary: Client listener for entity TopicCreateEvent
description: Example of a client listener for receiving the notification TopicCreateEvent
tags:
- notification listeners (client side)
parameters:
- name: data
required: true
in: body
description: The event data
schema:
$ref: '#/definitions/TopicCreateEvent'
responses:
'201':
description: Notified
schema:
$ref: '#/definitions/EventSubscription'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/listener/topicChangeEvent:
post:
operationId: listenToTopicChangeEvent
summary: Client listener for entity TopicChangeEvent
description: Example of a client listener for receiving the notification TopicChangeEvent
tags:
- notification listeners (client side)
parameters:
- name: sourceIdentifier
required: false
in: query
description: source system details for routing purpose
type: string
- name: data
required: true
in: body
description: The event data
schema:
$ref: '#/definitions/TopicChangeEvent'
responses:
'201':
description: Notified
schema:
$ref: '#/definitions/EventSubscription'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
/listener/topicDeleteEvent:
post:
operationId: listenToTopicDeleteEvent
summary: Client listener for entity TopicDeleteEvent
description: Example of a client listener for receiving the notification TopicDeleteEvent
tags:
- notification listeners (client side)
parameters:
- name: data
required: true
in: body
description: The event data
schema:
$ref: '#/definitions/TopicDeleteEvent'
responses:
'201':
description: Notified
schema:
$ref: '#/definitions/EventSubscription'
'400':
description: Bad Request
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'403':
description: Forbidden
schema:
$ref: '#/definitions/Error'
'404':
description: Not Found
schema:
$ref: '#/definitions/Error'
'405':
description: Method Not allowed
schema:
$ref: '#/definitions/Error'
'409':
description: Conflict
schema:
$ref: '#/definitions/Error'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Error'
definitions:
Any: {}
BillStructure:
type: object
description: The bill structure that associated to the customer.
properties:
cycleSpecification:
description: The bill cycle that associated to the customer.
$ref: '#/definitions/CycleSpecification'
format:
type: array
description: The bill invoice format.
items:
$ref: '#/definitions/Format'
CycleSpecification:
type: object
description: The customer bill cycle.
properties:
name:
type: string
description: Schedule Name, SV_MAPPING:Cust_Acct.InvoiceCycle_R
preferredCurrency:
type: string
description: Preferred Currency, SV_MAPPING:Cust_Acct.Currency_R
x-refdata-source: CM-Currency
reportLevel:
type: string
description: Report Level, SV_MAPPING:Cust_Acct.ReportLevel_R
x-refdata-source: RT-REPORT_LEVEL
suppressBilling:
type: string
description: Suppress Billing Flag, SV_MAPPING:Cust_Acct.SuppressBilling_B, Possible value 1 and 0
suppressCycles:
type: string
description: Suppress for number of Cycles, SV_MAPPING:Cust_Acct.SuppressCycles_I
suppressUntilDate:
type: string
description: Bill suppress date, SV_MAPPING:Cust_Acct.SuppressDate_T
transferredAccountNumber:
type: string
description: Transferred account number. SV_MAPPING:Cust_Acct.TransferAccountNumber_X
billEndDate:
type: string
description: Bill End Date. Describes the Bill cycle end date
CreditProfile:
type: object
description: Credit profile for the party.
required:
- creditProfileDate
- validFor
properties:
creditProfileDate:
type: string
format: date-time
description: The date the profile was established
creditRiskRating:
type: string
description: Credit rating, SV_MAPPING:Cust_Acct.CreditRating_R
x-refdata-source: RT-TREATMENT_CREDIT_CLASS
creditLimit:
type: string
description: CREDIT_LIMIT, SV_MAPPING:Cust_Acct.CreditLimit_C
creditLimitCurrency:
type: string
description: Credit limit Currency, SV_MAPPING:Cust_Acct.CreditLimitCurrency_R
x-refdata-source: CM-Currency
expectedRevenue:
type: string
description: Expected revenue, SV_MAPPING:Cust_Acct.ExptRevAmt_C
expRevCurrency:
type: string
description: Expected revenue currency, SV_MAPPING:Cust_Acct.ExptRevCurrency_R
x-refdata-source: CM-Currency
creditComments:
type: string
description: Credit comments, SV_MAPPING:Cust_Acct.CreditComments_X
taxClass:
type: string
description: Tax class, SV_MAPPING:Cust_Acct.TaxClass_R
x-refdata-source: RT-TAX_CLASS
creditScore:
type: string
description: Credit score, SV_MAPPING:Cust_Acct.CreditScore_X
validFor:
$ref: '#/definitions/TimePeriod'
description: The period for which the profile is valid
Format:
type: object
description: The bill invoice format.
properties:
name:
type: string
description: Invoice formate name, SV_MAPPING:CustAcctInvoiceFormat.InvoiceFormat_R
x-refdata-source: CM-InvoiceFormat
presentationMedia:
description: The bill invoice presentation media.
$ref: '#/definitions/PresentationMedia'
characteristic:
type: array
description: 'Characteristic name supported: sendInvoiceTo | contactId | itemized | addressChoice | invoiceLanguage | op | seqnr.Characteristic value supported: CustAcctInvoiceFormat.Contact_R, CustAcctInvoiceFormat.InvoiceItemised_R, CustAcctInvoiceFormat.AddressChoice_R, CustAcctInvoiceFormat.InvoiceLanguage_R, perestapi.OPERATION (op) and CustAcctInvoiceFormat.SequenceNum_I.Characteristic value type supported: string. For PATCH request, the combination of op and seqnr characteristics are mandatory values.They indicate the type of action (add/replace/remove) to perform on an identified invoice format entity, as well as all other attribute values under the format attribute object e.g.: name, presentationMedia and the list of other characteristic values.For GET request, the op characteristic will not be returned.For POST request, the op and seqnr characteristics will not be used.'
items:
$ref: '#/definitions/Characteristic'
x-refdata-source: '||RT-INVXML.INVOICE_ITEMISED|RT-ADDRESS_CHOICE,RT-INVXML.EMAIL_ADDRESS_CHOICE|RT-INVXML.INVOICE_LANGUAGE|RT-perestapi.OPERATION|'
PresentationMedia:
type: object
description: The bill invoice presentation media.
properties:
name:
type: string
description: Invoice Delivery, SV_MAPPING:CustAcctInvoiceFormat.InvoiceDelivery_R
x-refdata-source: AT-invxml.InvoiceDelivery
Characteristic:
type: array
description: Describes a given characteristic of an object or entity through a name/value pair.
items:
properties:
id:
type: string
description: Unique identifier of the characteristic
name:
type: string
description: Name of the characteristic
value:
type: string
description: Value of the characteristic
valueType:
type: string
description: Data type of the value of the characteristic
ContactMedium:
type: array
description: Indicates the contact medium that could be used to contact the party.
items:
properties:
mediumType:
type: string
description: 'Type of the contact medium i.e.: PostalAddress | SiteAddress |HomeNumber | WorkNumber | MobileNumber. SV_MAPPING: perestapi.MEDIUM_TYPE RT'
characteristic:
$ref: '#/definitions/MediumCharacteristic'
CustomerOrder:
type: object
description: details of product order
properties:
account:
type: array
items:
properties:
accountNumber:
type: string
description: Primary account number or prepaid account number
example: "900140314"
accountBalance:
type: string
description: ACCOUNT BALANCE
example: "0"
accountType:
type: string
description: Account type
example: "POSTPAID"
availableCredit:
type: string
description: available Credit limit
example: "5000"
billStructure:
description: The bill structure that associated to the account
$ref: '#/definitions/BillStructure'
creditLimit:
type: string
description: credit limit
example: "5000"
id:
type: string
description: id
example: "140314"
paymentPlan:
type: object
properties:
autoPay:
type: string
description: if autopay enabled
example: "Yes"
paymentMethod:
type: string
description: payment Method
example: "Auto-Debit"
characteristic:
$ref: '#/definitions/Characteristic'
contactMedium:
$ref: '#/definitions/ContactMedium'
creditProfile:
$ref: '#/definitions/CreditProfile'
defaultDisplayAccount:
type: string
description: default display account
example: "140314"
engagedParty:
$ref: '#/definitions/PartyRef'
href:
type: string
description: URL
example: "http://cptlxd106:8460/trerest_in/api/v1/billingAccount/140306"
id:
type: string
description: id
example: "140306"
name:
type: string
description: name
example: "900140306"
paymentMethod:
type: array
items:
properties:
"@type":
type: string
description: ty
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mtn-group/refs/heads/main/openapi/mtn-group-tmf688-event-management.yml