Open APIs

Expand all | Collapse all

Understanding Service Activation and Configuration

  • 1.  Understanding Service Activation and Configuration

    TM Forum Member
    Posted Jun 18, 2020 07:31
    Hi All,

    I have few doubts in  Service Activation and Configuration API TMF-640.
    There are no mandatory fields in for creating post request but there is additional mandatory fields for subresource.

    serviceOrder id OR href
    serviceSpecific ation id OR href
    relatedParty id OR href, role


    So all the above fields are mandatory for service creation or any of them.As previously have developed Trouble Ticket API so in the same (ticket type, severity and description ) is mandatory for ticket creation. But here I am not getting clarity.

    Also in retrieve API operation what are the fields for filtering.

    GET {apiRoot}/service?fields=id,name,state&serviceType=Cloud&state=Active Accept: application/json

    Attribute selection is enabled for all first-level attributes




    ------------------------------
    Akansha Agarwal

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


  • 2.  RE: Understanding Service Activation and Configuration

    TM Forum Member
    Posted Jun 19, 2020 03:07
    These fields are mandatory only if you add a reference to it.
    e.g. ID and Role is mandatory only if you want to keep a reference to Party in the relatedParty

    Regarding the GET, I think you should all the first level attributes

    ------------------------------
    Varun Nair
    Telstra Corporation
    ------------------------------



  • 3.  RE: Understanding Service Activation and Configuration

    TM Forum Member
    Posted Jun 19, 2020 03:42
    Hi Varun,

    Thanks for the response.

    I have gone through the document there are no such mandatory fields exist for Post API operation they have mentioned below comment on document

    Additional Rules The following table provides additional rules indicating mandatory fields in sub-resources or relationships when creating a Service resource.

     

    context

    Mandatory SubAttributes

    serviceOrder

    id OR href

    relatedParty

    id OR href

    serviceSpecification

    id OR href



    Also for first level atttributes could you please explain that what do we mean by first level attributes.

    Thanks in Advance.
    Regards,
    Akansha Agarwal



    ------------------------------
    Akansha Agarwal
    Comviva
    ------------------------------



  • 4.  RE: Understanding Service Activation and Configuration

    TM Forum Member
    Posted Jun 21, 2020 19:38
    I think we now agree on the first point related to some mandatory attributes on the sub resources. For e.g. if you are referring to a Service Order, at the minimum ID or HREF needs to be provided for that reference. So it is conditional mandatory, condition is reference to the object.

    This is my interpretation of first level attributes. Any attribute which you see in the template of the API. Search should be automatically enabled for all these attributes in the API template.

    ------------------------------
    Varun Nair
    Telstra Corporation
    ------------------------------