Open APIs

Expand all | Collapse all

TMF641 - Cancel Service Order lifecycle misalignment

  • 1.  TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 03, 2020 12:11
    Edited by Igor Veliev Sep 03, 2020 12:44
    Hello community,

    I'm confused a bit with Cancel Service Order state.
    Is initial state 'accepted' or 'acknowledged'?
    From CancelSO Lifecycle
    CancelSO Resource

    It is also not clear, how to describe error details in case of 'terminatedWithError'.


    By the way, will the Product Inventory/Ordering be consistent with the Service Inventory/Ordering in terms of 'status' vs 'state' in instances?



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------


  • 2.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 04, 2020 05:01
    Hello Igor,
    To provide you some information regarding first two points:
    • For 'accepted' or 'acknowledged' : Yes you're right. This inconsistency has been identifed by the team (thanks to @Ernie Bayha) and a Jira to fix it is already logged.
    • For describing error this is a valid point - May I request you to trigger a jira for this to the team?  @Kamal Maghsoudlou is currently working on TMF641 in particular to manage message.
    ​​​​Regarding the third point this is more complicated to solve. I assume  we have alignement on order (state).

    Hope it helps
    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 3.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 04, 2020 11:04

    Thank you Ludovic,

    I've opened the JIRA ticket https://projects.tmforum.org/jira/browse/AP-2343 and hope it wouldn't be missed



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------



  • 4.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 07, 2020 07:23

    @Ludovic Robert how about Service Order in failed state?
    If we believe CancelServiceOrder should have error details then probably each failed ServiceOrderItem within ServiceOrder needs to have something similar too?

    @Dave Milham maybe error details required in all Ordering APIs (622, 641, 652) on main Order and Cancel Order resources for failed/terminatedWithError states?



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------



  • 5.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 07, 2020 10:34
    Hi Igor,

    For the serviceOrder, the capability to have an Error Message is part of the current work in progress by @Kamal Maghsoudlou for the release 4.1. This feature will allow to refer (if needed) service order items. So I guess it will answer your requirement.

    Your jira 2343 is helpful to assess same patern for CancelServiceOrder resource.

    Hope it helps,

    Ludovic


    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 6.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 09, 2020 12:07
    Edited by Igor Veliev Sep 09, 2020 12:09

    @Ludovic Robert  I just saw meeting minutes after your discussion.​

    I have a small concern that the status must be 201 (Created) instead of 200 (Ok), because it's POST and we can receive created resource with GET /cancelServiceOrder/{id} even if it's 'terminatedWithError'.



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------



  • 7.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 09, 2020 12:12
    Yes good conversation with the team today.

    200 or 201 will depends on the implementation choice... if server side is able to repond on the fly in the response and do not want to manage cancelServiceOrder resource I'm fine with 200.
    If not, server will answer later, then a resource must be created, GET operation must be provided (and notification) then yes 201 must be sent.

    From my perspective I did no see objectiion to have both 200 and 201 in the API definition.


    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 8.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 09, 2020 12:36
    Edited by Igor Veliev Sep 09, 2020 12:56

    I'm confused a bit.
    200 (OK) means what was requested has been completed as for me.
    Requester asked cancellation for a Service Order. System responds with OK meaning 'cancellation impossible' and providing error details?

    Maybe it would be better to use 400 (Bad Request), 422 (Unprocessable Entity), or 412 (Precondition Failed)? We can put error details in the body with this responses.



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------



  • 9.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 10, 2020 02:36
    Hello Igor

    This was discussed also.
    From my perspective the CancelServiceOrder is a request to assess if service order cancellation is possible. It means that if the assesment is done and the result is: the serviceOrder cannot be cancelled then we should not have a 'bad request'. Technically everything went well. We are discussing the option to add specifically an attribute to indicate the cancellation request result. As of today the result is reflected on the service order state.

    Hope it helps
    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 10.  RE: TMF641 - Cancel Service Order lifecycle misalignment

    TM Forum Member
    Posted Sep 10, 2020 05:50

    Hello Ludovic

    I see your point. Thank you.



    ------------------------------
    Igor Veliev
    Netcracker Technology
    ------------------------------