Jump to

• Request
• Response
• Examples

Modify Asset

post

/rest/v19/assets/{id}/actions/modify

This operation calculates the projected state of the asset for the requested date and returns a configuration URL that can be used to launch the model configurator page reflecting the projected state.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Primary Key of Asset Resource.

Body ()

Root Schema : assets-modifyRequest

Type: object

Show Source

• sourceIdentifier: string
  Title: Source Identifier

  The variable name of the commerce process or external application identifier.
• transactionDate: string
  Title: Transaction Date

  The date and time on which the service request was made.
• transactionId: string
  Title: Transaction Id

  The current transaction identifier.

{
    "type":"object",
    "properties":{
        "sourceIdentifier":{
            "type":"string",
            "description":"The variable name of the commerce process or external application identifier.",
            "title":"Source Identifier"
        },
        "transactionDate":{
            "type":"string",
            "description":"The date and time on which the service request was made.",
            "title":"Transaction Date"
        },
        "transactionId":{
            "type":"string",
            "description":"The current transaction identifier.",
            "title":"Transaction Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : assets-modifyResponse

Type: object

Show Source

• result: object ABO Interactive Service Response.
  Title: ABO Interactive Service Response.

  Response Schema for ABO related actions which are used to launch configurator UI such as modify, reconfig, followonOrder
• resultTransactionId: integer
  Title: Result Transaction Id

  New transaction id created as part of asset operation.

{
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/definitions/aboInteractiveServiceResponse"
        },
        "resultTransactionId":{
            "type":"integer",
            "description":"New transaction id created as part of asset operation.",
            "title":"Result Transaction Id"
        }
    }
}

Nested Schema : ABO Interactive Service Response.

Type: object

Title: ABO Interactive Service Response.

Response Schema for ABO related actions which are used to launch configurator UI such as modify, reconfig, followonOrder

Show Source

• bomkey: string
  The instance id for the bom instance calculated by ABO process, this is needed to pass to configurator as url parameter as configurator will only use the bom if the bom instance id inside match the passed in bom key.
• configContextKey: string
  Context key passed to configurator session to retrieve bom instance being calculated by ABO process.
• configuratorURL: string
  URL to launch configurator with the BOM instance calculated by ABO process.
• model: string
  Model variable name for the model to launch configurator ui.
• product_line: string
  Product line variable name for the model to launch configurator ui.
• segment: string
  Segment variable name for the model to launch configurator ui.

{
    "type":"object",
    "properties":{
        "configContextKey":{
            "type":"string",
            "description":"Context key passed to configurator session to retrieve bom instance being calculated by ABO process."
        },
        "product_line":{
            "type":"string",
            "description":"Product line variable name for the model to launch configurator ui."
        },
        "model":{
            "type":"string",
            "description":"Model variable name for the model to launch configurator ui."
        },
        "segment":{
            "type":"string",
            "description":"Segment variable name for the model to launch configurator ui."
        },
        "bomkey":{
            "type":"string",
            "description":"The instance id for the bom instance calculated by ABO process, this is needed to pass to configurator as url parameter as configurator will only use the bom if the bom instance id inside match the passed in bom key."
        },
        "configuratorURL":{
            "type":"string",
            "description":"URL to launch configurator with the BOM instance calculated by ABO process."
        }
    },
    "title":"ABO Interactive Service Response.",
    "description":"Response Schema for ABO related actions which are used to launch configurator UI such as modify, reconfig, followonOrder"
}

Back to Top

Examples

The following example shows how to calculate the projected state of the asset for the requested date and returns a configuration URL that can be used to launch the model configurator page reflecting the projected state by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/assets/36562516/actions/modify

Request Body Sample

{
  "sourceIdentifier": "oraclecpqo",
  "transactionDate": "2025-04-14",
  "transactionId": ""
}

Response Body Sample

{
  "result": {
    "product_line": "sUPREMOPOWERGENERATION",
    "configContextKey": "5db6ea65-43bc-48a9-a339-38fa73674f23",
    "bomkey": "BOM_SupremoIndividualItems",
    "configuratorURL": "http://sitename.oracle.com/commerce/new_equipment/products/model_configs.jsp?_from_punchin=true&actionVarName=addLineItem_t&id=3025610365&product_line=sUPREMOPOWERGENERATION&model=sUPREMOPOWERGENERATIONPACKAGE&segment=sUPREMO&bm_sales_root_bom_item_id=BOM_SupremoIndividualItems&configContextKey=5db6ea65-43bc-48a9-a339-38fa73674f23",
    "segment": "sUPREMO",
    "model": "sUPREMOPOWERGENERATIONPACKAGE"
  },
  "resultTransactionId": "3025610365"
}

Back to Top