Jump to

• Request
• Response
• Examples

Archive Transactions

post

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

Use this endpoint to archive the specified 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-_archive_transactionsCollectionRequest

Type: object

Show Source

• selectionCriteria: object Selection Query Definition
  Title: Selection Query Definition

  Captures the query definition for resource requests, specifically for collection-based process actions.

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

Nested Schema : Selection Query Definition

Type: object

Title: Selection Query Definition

Captures the query definition for resource requests, specifically for collection-based process actions.

Show Source

• fields: array fields
  Array of field names for display.
• orderBy: array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.
• q: string
  Filter(a "where"clause) to restrict the items returned in the collection. By default, no filtering is applied.
• search: string
  Seeded Search Name

{
    "type":"object",
    "properties":{
        "search":{
            "type":"string",
            "description":"Seeded Search Name"
        },
        "q":{
            "type":"string",
            "description":"Filter(a \"where\"clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names for display.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Selection Query Definition",
    "description":"Captures the query definition for resource requests, specifically for collection-based process actions."
}

Nested Schema : fields

Type: array

Array of field names for display.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names for display.",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderBy

Type: array

Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_archive_transactionsCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to archive the specified Commerce 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 "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/actions/_archive_transactions

Request Body Sample

{
  "selectionCriteria": {
    "q": "{'bsid':{$eq:'3022127625'}}",
    "orderBy": ["field1:ASC", "field2:DESC"]
  }
}

Success Response: 204 No Content

Back to Top