Jump to

• Request
• Response
• Examples

Delete Archived Transactions

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_delete_archived_transactions

Use this endpoint to delete the specified archived transactions. Note: This action is only available for CPQ administrators with superuser access.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.

Body ()

Root Schema : Transaction-_delete_archived_transactionsCollectionRequest

Type: object

Show Source

• selectionCriteria: object Archived items selection Query Definition
  Title: Archived items selection Query Definition

  Captures the transaction ids of archived transactions

{
    "type":"object",
    "properties":{
        "selectionCriteria":{
            "$ref":"#/definitions/archiveSelectionQueryDef"
        }
    }
}

Nested Schema : Archived items selection Query Definition

Type: object

Title: Archived items selection Query Definition

Captures the transaction ids of archived transactions

Show Source

• ids: array ids
  Array of transaction ids.

{
    "type":"object",
    "properties":{
        "ids":{
            "type":"array",
            "description":"Array of transaction ids.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Archived items selection Query Definition",
    "description":"Captures the transaction ids of archived transactions"
}

Nested Schema : ids

Type: array

Array of transaction ids.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of transaction ids.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_delete_archived_transactionsCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to delete a list of archived transactions by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_delete_archived_transaction

Request Body Sample

{
  "selectionCriteria": {
    "ids": [19403637, 19403536, 19401289, 19397409, 19397331, 19397252, 19397175, 19396957, 19396878, 19396429, 19395774, 19395679, 19395605, 19385048, 19384977]
  }
}

Back to Top