Open APIs

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!

Party and PartyRole both include contactMedium, so that you have this via RelatedParty.

Hope it helps

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!

Thanks @Jonathan Goldberg for your inputs.

Can you please help with sample example or structure how can we use contactMedium object in TMF 639 under or outside relatedParty? 

Is that TMF compliance to include contactMedium in 639?

Please help how can we use contactMedium in 639 to share respective resource supplier contact details? as that's key use case at assurance end. 

Also, since we have not adopted 632 yet so need to accomodate this.

  "relatedParty": [
    {
      "id": "54",
      "href": "https://serverRoot/tmf-api/party/v4/individual/54",
      "name": "Carlos Mafalda",
      "role": "director",
      "@referredType": "individual"
    },
    {
      "id": "42",
      "href": "https://serverRoot/tmf-api/party/v4/individual/42",
      "name": "Jane Lamborgizzia",
      "role": "employer",
      "@referredType": "individual"
    }
  ],
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
      }
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "city": "Morristown",
        "country": "USA",
        "postcode": "07960",
        "stateOrProvince": "New Jersey",
        "street1": "240 Headquarters Plazza",
        "street2": "East Tower 10th Floor"
      }
    }
  ]

Party and PartyRole both include contactMedium, so that you have this via RelatedParty.

Hope it helps

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!

Dear @Jonathan Goldberg and team, further to our earlier discussion kindly confirm if we can use contactMedium object to provide supplier contact details via TMF 639 to other consumers because as we have not yet adopted TMF 632 for that matter Can we extend it in TMF 639 using contactMedium as suggested below?

Kindly revert, if its non-compliant or what?

{
  "relatedParty": [
    {
      "id": "54",
      "name": "Cisco",
      "role": "Last-Mile-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    },
    {
      "id": "45",
      "name": "NTT",
      "role": "Gateway-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    }
  ]
}

Thanks @Jonathan Goldberg for your inputs.

Can you please help with sample example or structure how can we use contactMedium object in TMF 639 under or outside relatedParty? 

Is that TMF compliance to include contactMedium in 639?

Please help how can we use contactMedium in 639 to share respective resource supplier contact details? as that's key use case at assurance end. 

Also, since we have not adopted 632 yet so need to accomodate this.

  "relatedParty": [
    {
      "id": "54",
      "href": "https://serverRoot/tmf-api/party/v4/individual/54",
      "name": "Carlos Mafalda",
      "role": "director",
      "@referredType": "individual"
    },
    {
      "id": "42",
      "href": "https://serverRoot/tmf-api/party/v4/individual/42",
      "name": "Jane Lamborgizzia",
      "role": "employer",
      "@referredType": "individual"
    }
  ],
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
      }
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "city": "Morristown",
        "country": "USA",
        "postcode": "07960",
        "stateOrProvince": "New Jersey",
        "street1": "240 Headquarters Plazza",
        "street2": "East Tower 10th Floor"
      }
    }
  ]

Party and PartyRole both include contactMedium, so that you have this via RelatedParty.

Hope it helps

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!

Hi Mahesh

I took a quick look. Basically you have replaced EntityRef with a value object for Organization, so that you get the contact medium array.

You can certainly extend API definitions to suit your business, but I cannot promise you that your implementation will pass the conformance test for TMF639 - if you are seeking formal conformance certification you'll have to test against the CTK.

Please note that in v5, both ContactMedium and RelatedParty were refactored:

• RelatedParty is now a strict refOrValue of Party, i.e. Organization or Individual. So in v5 you can use a value object for Organization exactly as per the standard
• ContactMedium is now a base class for strongly-typed contacts, so a phone contact has different properties to an address contact.

Hope it helps

Dear @Jonathan Goldberg and team, further to our earlier discussion kindly confirm if we can use contactMedium object to provide supplier contact details via TMF 639 to other consumers because as we have not yet adopted TMF 632 for that matter Can we extend it in TMF 639 using contactMedium as suggested below?

Kindly revert, if its non-compliant or what?

{
  "relatedParty": [
    {
      "id": "54",
      "name": "Cisco",
      "role": "Last-Mile-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    },
    {
      "id": "45",
      "name": "NTT",
      "role": "Gateway-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    }
  ]
}

Thanks @Jonathan Goldberg for your inputs.

Can you please help with sample example or structure how can we use contactMedium object in TMF 639 under or outside relatedParty? 

Is that TMF compliance to include contactMedium in 639?

Please help how can we use contactMedium in 639 to share respective resource supplier contact details? as that's key use case at assurance end. 

Also, since we have not adopted 632 yet so need to accomodate this.

  "relatedParty": [
    {
      "id": "54",
      "href": "https://serverRoot/tmf-api/party/v4/individual/54",
      "name": "Carlos Mafalda",
      "role": "director",
      "@referredType": "individual"
    },
    {
      "id": "42",
      "href": "https://serverRoot/tmf-api/party/v4/individual/42",
      "name": "Jane Lamborgizzia",
      "role": "employer",
      "@referredType": "individual"
    }
  ],
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
      }
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "city": "Morristown",
        "country": "USA",
        "postcode": "07960",
        "stateOrProvince": "New Jersey",
        "street1": "240 Headquarters Plazza",
        "street2": "East Tower 10th Floor"
      }
    }
  ]

Party and PartyRole both include contactMedium, so that you have this via RelatedParty.

Hope it helps

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!

Important correction - I erred when I said that relatedParty in v5 is reforvalue. In most cases relatedParty has been modeled only as ref, even in v5. You would be able to replace this by reforvalue but this would then be an extension.

Apologies for the misdirect.

Hi Mahesh

I took a quick look. Basically you have replaced EntityRef with a value object for Organization, so that you get the contact medium array.

You can certainly extend API definitions to suit your business, but I cannot promise you that your implementation will pass the conformance test for TMF639 - if you are seeking formal conformance certification you'll have to test against the CTK.

Please note that in v5, both ContactMedium and RelatedParty were refactored:

• RelatedParty is now a strict refOrValue of Party, i.e. Organization or Individual. So in v5 you can use a value object for Organization exactly as per the standard
• ContactMedium is now a base class for strongly-typed contacts, so a phone contact has different properties to an address contact.

Hope it helps

Dear @Jonathan Goldberg and team, further to our earlier discussion kindly confirm if we can use contactMedium object to provide supplier contact details via TMF 639 to other consumers because as we have not yet adopted TMF 632 for that matter Can we extend it in TMF 639 using contactMedium as suggested below?

Kindly revert, if its non-compliant or what?

{
  "relatedParty": [
    {
      "id": "54",
      "name": "Cisco",
      "role": "Last-Mile-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    },
    {
      "id": "45",
      "name": "NTT",
      "role": "Gateway-Supplier",
      "@referredType": "Organization",
      "contactMedium": [
        {
          "preferred": true,
          "mediumType": "email",
          "characteristic": {
            "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
          }
        },
        {
          "preferred": true,
          "mediumType": "mobile",
          "characteristic": {
            "phoneNumber": "+44123456789"
          }
        },
        {
          "preferred": false,
          "mediumType": "postalAddress",
          "validFor": {
            "startDateTime": "2018-10-22T08:31:52.028Z",
            "endDateTime": ""
          },
          "characteristic": {
            "city": "Morristown",
            "country": "USA",
            "postcode": "07960",
            "stateOrProvince": "New Jersey",
            "street1": "240 Headquarters Plazza",
            "street2": "East Tower 10th Floor"
          }
        }
      ]
    }
  ]
}

Thanks @Jonathan Goldberg for your inputs.

Can you please help with sample example or structure how can we use contactMedium object in TMF 639 under or outside relatedParty? 

Is that TMF compliance to include contactMedium in 639?

Please help how can we use contactMedium in 639 to share respective resource supplier contact details? as that's key use case at assurance end. 

Also, since we have not adopted 632 yet so need to accomodate this.

  "relatedParty": [
    {
      "id": "54",
      "href": "https://serverRoot/tmf-api/party/v4/individual/54",
      "name": "Carlos Mafalda",
      "role": "director",
      "@referredType": "individual"
    },
    {
      "id": "42",
      "href": "https://serverRoot/tmf-api/party/v4/individual/42",
      "name": "Jane Lamborgizzia",
      "role": "employer",
      "@referredType": "individual"
    }
  ],
  "contactMedium": [
    {
      "preferred": true,
      "mediumType": "email",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "emailAddress": "jane.lamborgizzia@coffeedobrazil.com"
      }
    },
    {
      "preferred": false,
      "mediumType": "postalAddress",
      "validFor": {
        "startDateTime": "2018-10-22T08:31:52.028Z",
        "endDateTime": ""
      },
      "characteristic": {
        "city": "Morristown",
        "country": "USA",
        "postcode": "07960",
        "stateOrProvince": "New Jersey",
        "street1": "240 Headquarters Plazza",
        "street2": "East Tower 10th Floor"
      }
    }
  ]

Party and PartyRole both include contactMedium, so that you have this via RelatedParty.

Hope it helps

Dear All,

Need quick input/suggestion on passing respctive contact details under relatedParty [] object as partyCharacteristics or contactMedium etc. in TMF 639 resource inventory API. Because our consumer like assurance and other systems wanted to know relatedParty like supplier, device vendor etc. contact details so that as part of CMDB consumption they can use that for any further assurance purpose.

Is there any way to pass contact details for given supplier details under relatedParty[].? Can we add partyCharacteristics etc. under that which is part of party management? API.

We have not implemented or adopted party management or party role related API's yet but want to accommodate this in TMF 639.

Kindly advise and help in this regard urgently.

Thanks for your support!!!