Open APIs

 View Only
  • 1.  relatedParty reference to party or partyRole use / examples

    TM Forum Member
    Posted 16 days ago
    Hi,

    Many of the TMF docs that talk about the use of relatedParty state that: "A related party defines party or party role linked to a specific entity."

    I find the above statement a little confusing because it implies you could have relatedParty make reference to a partyRole id as an alternative to a Party id and change the referredType accordingly :-

    Taking the TMF669 Party Role Management "Global Pirates" example... :-
     
    {
     "@type": "PartyRole",
     "href": "https:/host:port/tmf-api/partyRoleManagement/v4/partyRole/4079",
     "id": "4079",
     "name": "Global Pirates",
     "status": "Approved",
     "statusReason": "NDA has been signed",
     "validFor": {
     "startDateTime": "2018-06-16T00:00Z",
     "endDateTime": "2019-01-13T00:00Z"
     },
     
     "engagedParty": {
     "@referredType": "Organization",
     "href": "https:/host:port/tmf-api/partyManagement/v4/organization/99",
     "id": "99",
     "name": "Global Pirates",
     "role": "Provider"
     },
    .
    .

    ...could this mean a relatedParty reference in other TMFs could look like below - where the referredType is not the typical "organization / individual" but is actual of type "PartyRole" and make reference to the partyRole id :-

    "relatedParty": [
    {
    "@referredType": "PartyRole",
    "href": "https:/host:port/tmf-api/partyRoleManagement/v4/partyRole/4079",
    "id": "4079",
    "name": "Global Pirates",
    }

    If the above assumption is correct I assume you can't have a "role" reference because you are referring directly to the partyRole.

    I hope you can clarify my understanding.

    Regards.

    ------------------------------
    Jonathan Stonehouse
    BT Group plc
    ------------------------------


  • 2.  RE: relatedParty reference to party or partyRole use / examples

    TM Forum Member
    Posted 12 days ago
    Hi Jonathan
    There is unfortunately a long-running defect in this part of the model. The engagedParty attribute in PartyRole entity should be of type PartyRef, not RelatedParty. The engagedParty is the Party that is playing the PartyRole, and so it doesn't make sense that it could point to a different PartyRole.
    In the example you quote above, Global Pirates is a PartyRole (not sure what, maybe a partner or supplier, as hinted by the status reason). The Party playing this PartyRole is also called Global Pirates, an organization (presumably a commercial company).
    I don't know why this has not been fixed. If you happen to be a member of the Open API project, you can see the defect report here https://projects.tmforum.org/jira/browse/AP-2144
    Hope it clarifies things.

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