Jump to

• Request
• Response

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 Id

  The variable name of the commerce process or external application identifier. '_external_order' is the default value for external orders when this parameter is not specified. The commerce process variable name 'processVarName' is used for internal orders (e.g. oraclecpqo).
• transactionDate: string
  Title: Transaction Date

  The date and time that the service request needs to be processed or fulfilled.
• transactionId: string
  Title: Transaction Id

  The commerce transaction Id associated with the asset(s). When the transaction Id is not provided, a new transaction is created and associated with the requested operation.

{
    "type":"object",
    "properties":{
        "sourceIdentifier":{
            "type":"string",
            "description":"The variable name of the commerce process or external application identifier. '_external_order' is the default value for external orders when this parameter is not specified. The commerce process variable name 'processVarName' is used for internal orders (e.g. oraclecpqo).",
            "title":"Source Id"
        },
        "transactionDate":{
            "type":"string",
            "description":"The date and time that the service request needs to be processed or fulfilled.",
            "title":"Transaction Date"
        },
        "transactionId":{
            "type":"string",
            "description":"The commerce transaction Id associated with the asset(s). When the transaction Id is not provided, a new transaction is created and associated with the requested operation.",
            "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.

  The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).
• resultTransactionId: integer
  Title: Result Transaction Id

  The commerce transaction Id. If the transaction Id is not provided, a new transaction is created.

{
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/definitions/aboInteractiveServiceResponse"
        },
        "resultTransactionId":{
            "type":"integer",
            "description":"The commerce transaction Id. If the transaction Id is not provided, a new transaction is created.",
            "title":"Result Transaction Id"
        }
    }
}

Nested Schema : ABO Interactive Service Response.

Type: object

Title: ABO Interactive Service Response.

The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).

Show Source

• bomkey: string
  The id of the BOM instance calculated by the ABO process. This is used to pass to the URL parameter to configuration, since configuration will only use the BOM if the BOM id inside matches the id passed in the BOM key.
• configContextKey: string
  The context key passed to the configuration session to retrieve the BOM instance being calculated by the ABO process.
• configuratorURL: string
  The URL to launch the Configuration UI with the BOM instance calculated by the ABO process.
• model: string
  The model variable name for the model to launch the Configuration UI.
• product_line: string
  The product line variable name for the model to launch the Configuration UI.
• segment: string
  The segment variable name for the model to launch the Configuration UI.

{
    "type":"object",
    "properties":{
        "configContextKey":{
            "type":"string",
            "description":"The context key passed to the configuration session to retrieve the BOM instance being calculated by the ABO process."
        },
        "product_line":{
            "type":"string",
            "description":"The product line variable name for the model to launch the Configuration UI."
        },
        "model":{
            "type":"string",
            "description":"The model variable name for the model to launch the Configuration UI."
        },
        "segment":{
            "type":"string",
            "description":"The segment variable name for the model to launch the Configuration UI."
        },
        "bomkey":{
            "type":"string",
            "description":"The id of the BOM instance calculated by the ABO process. This is used to pass to the URL parameter to configuration, since configuration will only use the BOM if the BOM id inside matches the id passed in the BOM key."
        },
        "configuratorURL":{
            "type":"string",
            "description":"The URL to launch the Configuration UI with the BOM instance calculated by the ABO process."
        }
    },
    "title":"ABO Interactive Service Response.",
    "description":"The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order)."
}

Back to Top