TM Forum Community

 View Only

  • 1.  TMF 621 Version 5 Conformance Document

    Posted Apr 12, 2024 04:17

    TMF 621 version 5 specification document has 2 resources, TroubleTicket , TroubleTicket Specification. And we are going through TMF 621 version 5 conformance document. It does not have any information regarding what are the mandatory API that are required for certification. 

    We are specifically looking for what are the mandatory fields , APIs GET, POST, PATCH, DELETE for  TroubleTicket/TroubleTicket Specification ,
    Is TroubleTicket Specification mandatory for certification in version 5 ? 

    We went through the CTK conformance.CHANGE_ME.json the file does not seems to be of TroubleTicket, it says customer management.

    {
    "url": "http://localhost:8629/tmf-api/customerManagement/v5/",
    "headers": {
    "Accept": "application/json",
    "Content-Type": "application/json"
    },
    "payloads": {
    "Customer": {
    "POST": {
    "payload": {
    "@type": "Customer",
    "name": "Mary Doe",
    "engagedParty": {
    "@type": "PartyRef",
    "href": "https://host:port/tmf-api/partyManagement/v5/organization/502",
    "id": "502",
    "name": "Another Travellers",
    "@referredType": "Organization"
    }
    }
    },
    "PATCH": {
    "payload": {
    "@type": "Customer",
    "name": "John Doe",
    "engagedParty": {
    "@type": "PartyRef",
    "href": "https://host:port/tmf-api/partyManagement/v5/organization/500",
    "id": "500",
    "name": "Happy Travellers",
    "@referredType": "Organization"
    }
    }
    }
    }
    }
    }
     
    And in Conformance document we see some URLs like 
    * POST /troubleTicket?fields=...&{filtering}
    *PATCH /troubleTicket/{id}?fields=...&{filtering}
    We want to understand more on how is filtering and field applicable for Post and Patch request. 
    Please help us with the relevant details 

    Thanks,
    Vaibhav 

    #General

    ------------------------------
    Vaibhav V Pawar
    Salesforce
    ------------------------------


  • 2.  RE: TMF 621 Version 5 Conformance Document

    Posted Apr 14, 2024 02:18

    Hi Vaibhav

    Referring to your questions:

    • According to the published Conformance Profile document, TroubleTicket itself is a mandatory entity, while TT Specification is not mandatory for a conforming implementation
    • The mandatory operations for conformance are GET, POST, DELETE, again as specified in the published document. PATCH is not considered mandatory.
    • The contents of CHANGE_ME look to be incorrect, I'll see if I can open a defect report
    • Looking at the conformance document, I don't see the fields parameter that you mention, please clarify

    Hope it helps



    ------------------------------
    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.
    ------------------------------



  • 3.  RE: TMF 621 Version 5 Conformance Document

    Posted Apr 15, 2024 01:13
    Edited by Vaibhav V Pawar Apr 15, 2024 01:14
      |   view attached

    Hi Jonathan, 

    Thanks for responding, We have few follow up doubts

    > With respective to conformance document GET, POST, DELETE are mandatory, we want to understand is there any specific reason why DELETE is made mandatory. We are in an understanding that User creates Case and want to track the progress of the ticket, and once created user retrieves all the Cases the he has created. Please let us know if our understand is correct. Here are we allowing the users to delete the cases that he created ?

    > Uploading the conformance document that was downloaded from TMForum website. In that document page number 8 it has an example of how post is been used it has POST /troubleTicket?fields=...&{filtering} attaching the screen short of the same. We want to understand why Post has filtering and fields. 



    ------------------------------
    Vaibhav V Pawar
    Salesforce
    ------------------------------

    Attachment(s)

    pdf
    conformance.pdf   396 KB 1 version
    Original Message


  • 4.  RE: TMF 621 Version 5 Conformance Document

    Posted Apr 16, 2024 15:06

    Deciding which API operations are mandatory for conformance is a judgment call made by the lead for that particular API, and approved by the Open API architecture head.

    I've referred your query to the lead for the Trouble Ticket API.



    ------------------------------
    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.
    ------------------------------

    Original Message


Related Content