Open APIs

Expand all | Collapse all

Info required on EVENT BODY in TMF 641 publish event to listener

  • 1.  Info required on EVENT BODY in TMF 641 publish event to listener

    TM Forum Member
    Posted Mar 23, 2020 08:07
    Hi,

    I need help to understand what are the possible EVENT BODY In below  publish event to listener in TMF641 Release 18.5.1.

    I am looking for a scenario where the service order can listen to external events which can have array objects in the EVENT BODY but want to be clear if there is any recommendation from TMF for this functionality.

    POST /client/listener Accept: application/json

    { "event": { EVENT BODY }, "eventType": "EVENT_TYPE" }

    I am not able to see any mention of EVENT BODY in the TMF 641 service order management API Rest spec hence reaching out to community.

    Thanks
    Pradeep

    ------------------------------
    pradeep godara
    Sigma Systems
    ------------------------------


  • 2.  RE: Info required on EVENT BODY in TMF 641 publish event to listener

    TM Forum Member
    Posted 27 days ago
    Hi Pradeep

    Have you had any responses to your query.?

    Regards
    Lance

    ------------------------------
    Lancy Mendonca
    ------------------------------



  • 3.  RE: Info required on EVENT BODY in TMF 641 publish event to listener

    TM Forum Member
    Posted 24 days ago
    Hi all
    At least for all recently published APIs (look for version 4.0.0), the generated swagger contains event structures for each of the events expected to be raised by an API implementation. For example for TMF641 (in the Open API table) you will see the following (for the SO Create event).
    Hope it helps.

    "ServiceOrderCreateEvent": {
    "type": "object",
    "description": "The notification data structure",
    "properties": {
    "event": {
    "description": "The event payload linked to the involved resource object",
    "$ref": "#/definitions/ServiceOrderCreateEventPayload"
    },
    "eventId": {
    "type": "string",
    "description": "The identifier of the notification."
    },
    "eventTime": {
    "type": "string",
    "format": "date-time",
    "description": "Time of the event occurrence."
    },
    "eventType": {
    "type": "string",
    "description": "The type of the notification."
    },
    "correlationId": {
    "type": "string",
    "description": "The correlation id for this event."
    },
    "domain": {
    "type": "string",
    "description": "The domain of the event."
    },
    "title": {
    "type": "string",
    "description": "The title of the event."
    },
    "description": {
    "type": "string",
    "description": "An explnatory of the event."
    },
    "priority": {
    "type": "string",
    "description": "A priority."
    },
    "timeOcurred": {
    "type": "string",
    "format": "date-time",
    "description": "The time the event occured."
    }
    }
    },
    "ServiceOrderCreateEventPayload": {
    "type": "object",
    "description": "The event data structure",
    "properties": {
    "serviceOrder": {
    "description": "The involved resource data for the event",
    "$ref": "#/definitions/ServiceOrder"
    }
    }
    },


    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------