Open APIs

Expand all | Collapse all

TMF641 Cancellation of service order

  • 1.  TMF641 Cancellation of service order

    TM Forum Member
    Posted Oct 29, 2020 05:25
    Hi @Ludovic Robert @Jonathan Goldberg

    While reviewing the new TMF641 specs version 4.0.0, I cant make out the process expected to be followed for cancellation of service orders. What i understood vaguely was that a new resource entity called cancelServiceOrder would need to be created, and it will reference the serviceOrder resource. Is the expectation that the system exposing this API is expected to create a cancelServiceOrder resource  , and should control the state of this resource while making changes on the serviceOrder resource internally (like updating state to cancelled)?

    After getting a cancelServiceOrder POST request, I can have my orch engine to initiate a patch on serviceOrder resource to update the state to "Cancelled", and once that is done, cancelServiceOrder resource can be pushed to "Done" state. Is that the ideal way to achieve cancellation, or is there a recommended pattern by API team?

    Also, the example for cancelServiceOrder POST published in the document, shows that the state of the resource is set to "Done" in the HTTP 201 response,  which is probably incorrect as you might have a few business rules to validate before we mark it "Done", and should ideally be responded back via notifications rather then a 201 response?

    Appreciate your guidance on this.​​

    ------------------------------
    Vishal Thakur
    BT Group plc
    ------------------------------


  • 2.  RE: TMF641 Cancellation of service order

    TM Forum Member
    Posted 29 days ago
    Hi Vishal,
    Yes your understanding is very good. The cancelServiceOrder is a new distinct resource to request service order cancellation. This resource creation will probably triggers a process in your Service Order Management component to assess cancellation (and you have service order state assessingCancellation in // to provide information at service order level). Once the cancellation is performed (if possible) the cancelServiceOrder is done and the serviceOrder in pendingCancellation and then Cancelled (pendingCancellation for my perspective is an optional one if we need some time to perform the cancellation). Internally in your SOM you'll perform a PATCH to change the service Order state.

    About your last point - suppose you are able to perfom the SO cancellation on the fly - I do not see any issue to answer with 201 and 'done'. But I got you point and probably less confusing to answer with 201 and acknowledged.

    Hope it helps

    Ludovic

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



  • 3.  RE: TMF641 Cancellation of service order

    TM Forum Member
    Posted 27 days ago
    Thanks as always. Your answer was very helpful.
    And thanks for removing the conditions on patchable attributes in the new version, that was turning out to be a pain to conform to :)
    Cheers!

    ------------------------------
    Vishal Thakur
    BT Group plc
    ------------------------------