Open APIs

 View Only
  • 1.  TMF655 Change management API support for attachment

    TM Forum Member
    Posted Oct 15, 2020 10:50
    Hi All,

    As per TMF655 specification, ChangeRequest can have attachment. Attachment object contains below fields:
    name, path, description, href, mimeType, Size, sizeUnit, url, validFor

    Could you please let me know how/where to send the actual file as attachment in the API response or is it sufficient to send only the url of the file?

    Thank you.

    Best Regards,

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------


  • 2.  RE: TMF655 Change management API support for attachment

    TM Forum Member
    Posted Oct 18, 2020 08:10
    Hi Kalpana

    The Attachment resource has been updated, as you will be able to see in more recently published APIs that include Attachment. For instance TMF633 Service Catalog (look for the swagger in the table here). This will eventually reach all the APIs, as they gradually get republished.

    You can supply the content (i.e. actual file) either as embedded content encoded as base64:
    "content": {
      "type": "string",
      "format": "base64",
      "description": "The actual contents of the attachment object, if embedded, encoded as base64"
    },

    or as a pointer to (presumably) a document or content management system:
    "url": {
      "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f",
      "type": "string",
      "format": "uri",
      "description": "Uniform Resource Locator, is a web page address (a subset of URI)"
    },

    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: TMF655 Change management API support for attachment

    TM Forum Member
    Posted Oct 19, 2020 05:41
    Thank you @Jonathan Goldberg. It helped a lot.

    Best Regards,​

    ------------------------------
    Kalpana HV
    Colt Technology Services
    ------------------------------