Open APIs

 View Only
  • 1.  Several questions related to Engaged Party API's

    TM Forum Member
    Posted Oct 17, 2019 08:44
    Hello,
    I am investigating info about open APIs rewarding the Engaged Party.
    And I have several questions.
    1- I have seen documents about onboarding saying that the POST method used t creat a new partyRole is admin users only but in the secs this seams to not be the case, what makes sense for me.
    2- On the SLA Specifications PDF the POST method is invoked using POST /SLA/{id} but on the swagger file it is done without the /{id} what makes sense when creating a new entity (same for SLA Violation).
    3- The File 668 about party types is now called only party management a bit confusing since 632 is about party managenet and is fiferent, and when is the party type invoqued in a process because on the example flows it is never used.

    Thanks for the help

    ------------------------------
    David Teles

    ------------------------------


  • 2.  RE: Several questions related to Engaged Party API's

    TM Forum Member
    Posted Oct 22, 2019 05:22
    Hi David
    1. Earlier versions of the Open API specifications tried to make a distinction between admin and other roles (and we had even published different Swagger files for these two). More recently we have stopped this, recognizing that authorization to use APIs should be applied externally. So published specs from Release 18.5 (I think) and onward do not relate to roles and authorization, and only a single swagger file is published for each API.
    2. I am not familiar with the SLA API. But in general all specifications published from Release 18.5 and onward have guaranteed consistency between the spec document and the swagger file, since they are generated by tooling. Specifically regarding POST with an ID - in most cases the ID would be ignored and should not be passed, since it will likely be assigned by the implementing backend (e.g. from a database sequence). For entities that are versioned (typically in the catalog domains), it is legitimate to create a new version, and in this case the POST would include the ID to indicate that a new version of the entity should be created, but with the same ID.
    3. TMF668 is about partnership management (not party management), and was republished in Release 19. I suggest you review the latest version and see if it resolves your concerns. TMF632 is indeed about party management, also republished in Release 19.

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