Jump to

• Request
• Response

Suspend Asset

post

/rest/v16/assets/{id}/actions/suspend

This operation merges a suspend request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For suspend requests, the root and subordinate action codes are set to Suspend.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : assets-suspendRequest

Type: object

Show Source

• sourceIdentifier: string
  Title: Source Identifier

  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 Identifier"
        },
        "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-suspendResponse

Type: object

Show Source

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

  Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume).
• 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/aboHeadlessServiceResponse"
        },
        "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 Headless Service Response.

Type: object

Title: ABO Headless Service Response.

Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume).

Show Source

• bomkey: string
  Title: BOM Key

  The BOM instance ID, also is asset-key for the newly created order line.
• lineId: string
  Title: Line Id

  The transaction line identifier for the created line. For an internal CPQ Commerce process, it is the ine number. For an external commerce application, it is the config_id which can be used to construct the endpoint to access specific configuration instance.

{
    "type":"object",
    "properties":{
        "lineId":{
            "type":"string",
            "title":"Line Id",
            "description":"The transaction line identifier for the created line. For an internal CPQ Commerce process, it is the ine number. For an external commerce application, it is the config_id which can be used to construct the endpoint to access specific configuration instance."
        },
        "bomkey":{
            "type":"string",
            "title":"BOM Key",
            "description":"The BOM instance ID, also is asset-key for the newly created order line."
        }
    },
    "title":"ABO Headless Service Response.",
    "description":"Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume)."
}

Back to Top