Open APIs

Expand all | Collapse all

Amend Product/Service/Resource Order

  • 1.  Amend Product/Service/Resource Order

    TM Forum Member
    Posted Jul 21, 2021 05:18
    The TMF API documentation for Product/Service/Resource order recommend using the 'PATCH' operation to amend an order. This pattern works very well if the amend order is a synchronous operation.

    However if the amend operation is long running wherein the system processing the order needs time to assess the amend, execute/reject the amend is the recommended option
    1) Implement a Task resource similar to the CancelServiceOrder Task resource that encapsulates the amend request. This has the advantage of having a distinct resource to capture any Amend specific information
    2) Implement the 'PATCH' operation as an async operation using the Monitor pattern

    What are the pros/cons of the two approaches?


    ------------------------------
    Lancy Mendonca
    ------------------------------


  • 2.  RE: Amend Product/Service/Resource Order

    TM Forum Member
    Posted Jul 21, 2021 10:21
    In my view, we should have task resources for Amend PO/SO/RO, for the same reasons as we have tasks for cancel. Apart from anything else there might be financial considerations to the Amend, which could be returned in an initial response to POST of this task resource, at least for product order amendment.

    ------------------------------
    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: Amend Product/Service/Resource Order

    TM Forum Member
    Posted Jul 22, 2021 01:51
    I agree with Jonathan. In-flight Revisions or Amendments can drive very complex compensation plans in an ongoing order and therefore needs to be treated with respect :). In my opinion, there is a clear pattern here that is established by the implementation of Cancel use case. Any complex operation on an ongoing Order should be driven via Task Resource Pattern described in TMF630 REST API Guidelines Part 1 which is defined as follows

    Task Resource Pattern 


    This section describes the use of Task resources to expose complex operations that are not easily or not decomposable to CRUD Entity based operations. 

    Apart from Cancel and Amend, other Order operations that qualifies for this pattern are Abort Order, Suspend/Resume an ongoing Order (different from Suspend/Resume of Service) etc.

    ------------------------------
    Kinshuk Kulshreshtha
    Oracle Corporation
    ------------------------------



  • 4.  RE: Amend Product/Service/Resource Order

    TM Forum Member
    Posted Jul 22, 2021 10:28
    Many thanks Kinshuk for confirming that we are proceeding in the right direction

    ------------------------------
    Lancy Mendonca
    ------------------------------