Open APIs

 View Only

  • 1.  Use of @type and @baseType

    Posted Oct 09, 2023 18:37

    Hi

    I am looking for some guidance on how I can use the @type and @baseType attributes. 

    I recognise that these attributes form part of the logic to determine how the API request is processed based on the @type value.

    For my situation, I am looking at the Product Order Management (TMF622) and Work Order Management (TMF697 pre-production) APIs for how I can use these. 

    For the Work Order (TMF697), I have different types of Work Orders, such as 'Reinstatement Work Order' or 'Inspection Work Order'; I assume that in this scenario, I can use the '@baseType = WorkOrder," and then for the actual operation (POST, GET, PUT, PATCH) and set the '@type = ReinstatementWorkOrder'. Would this be possible?

    For the Product Order (TMF622), I have different types of Product Orders that can be initiated, such as 'Connect New Service', 'Change Plan', etc.. In this case, I would like to set the '@baseType = ProductWorkOrder' and '@type = ConnectNew'. Would this be possible?

    I would like to thank you for your responses in advance.

    Pete

     



    ------------------------------
    Pete Bains
    BAINZ Consulting Limited (New Zealand)
    ------------------------------


  • 2.  RE: Use of @type and @baseType

    Posted Oct 16, 2023 01:35

    Hi Pete,

    The examples you are providing are indeed syntacticly correct.

    I am however convinced that there are better ways to solve your problem. Why would you create a new ProductOrder type "Connect New Service" if all that is required for the use case is a ProductOrder with an orderItem that has an action "create"? Why would you create a new ProductOrder type "Change Plan" if all that is required for the use case is a ProductOrder with an orderItem that has an action "modify"?

    For the WorkOrder the same logic can be applied. A workOrder would have order items that contain tasks from a task/work catalog. Tasks in this catalog could be "Reinstate cabinet door" or "inspect tower rigging". This can even help to simplify your processes because you can send one workOrder with several tasks. In most organisations a workOrder is a truck roll. So you just saved a truck roll by adding both tasks in a single workorder.

    Regards



    ------------------------------
    Koen Peeters
    OryxGateway FZ LLC
    ------------------------------

    Original Message


Related Content