Jump to

• Request
• Response
• Examples

Print Transaction

post

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_print_document

Use this endpoint to print the generated transaction document.

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.
• Stage(required): string
  The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-_print_documentRequest

Type: object

Show Source

• actionVariableName: string
  Title: Action Variable Name

  The print action variable name used to look up print action configuration
• attachmentIdsForMerge: array Attachments to be merged.
  Title: Attachments to be merged.

  List of attachments to be merged for an email or print action.
• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• languagePreference: string
  Title: Language Attribute Value

  Language attribute value for the print document
• saveToQuote: boolean
  Title: Save To Quote

  Indicates if the print document is saved to the quote, valid values are {true, false}
• updateQuoteWithAttachment: boolean
  Title: Update Quote With Attachment

  Indicates if quote has to be updated with print document attachment file, valid values are {true, false}
• xslView: integer
  Title: XSL View

  Printer friendly proposals or history outputs generated from predefined XSL templates

{
    "type":"object",
    "properties":{
        "languagePreference":{
            "type":"string",
            "description":"Language attribute value for the print document",
            "title":"Language Attribute Value"
        },
        "attachmentIdsForMerge":{
            "$ref":"#/definitions/attachmentIdsForMerge"
        },
        "xslView":{
            "type":"integer",
            "description":"Printer friendly proposals or history outputs generated from predefined XSL templates",
            "title":"XSL View"
        },
        "updateQuoteWithAttachment":{
            "type":"boolean",
            "description":"Indicates if quote has to be updated with print document attachment file, valid values are {true, false}",
            "title":"Update Quote With Attachment"
        },
        "saveToQuote":{
            "type":"boolean",
            "description":"Indicates if the print document is saved to the quote, valid values are {true, false}",
            "title":"Save To Quote"
        },
        "actionVariableName":{
            "type":"string",
            "description":"The print action variable name used to look up print action configuration",
            "title":"Action Variable Name"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        }
    }
}

Nested Schema : Attachments to be merged.

Type: array

Title: Attachments to be merged.

List of attachments to be merged for an email or print action.

Show Source

• Array of: object Attachment properties.
  Title: Attachment properties.

  Captures the id of the attachment.

{
    "title":"Attachments to be merged.",
    "type":"array",
    "description":"List of attachments to be merged for an email or print action.",
    "items":{
        "$ref":"#/definitions/attachmentIdDef"
    }
}

Nested Schema : Attachment properties.

Type: object

Title: Attachment properties.

Captures the id of the attachment.

Show Source

• id: integer
  ID for the attachment.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the attachment."
        }
    },
    "title":"Attachment properties.",
    "description":"Captures the id of the attachment."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_print_documentResponse

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• fileAttachmentAttribute: string
  Title: File Attachment Attribute

  Used for confirmation
• fileContent: string
  Title: File Content

  The Base64 encoded binary document value
• fileContentType: string
  Title: File Content Type

  The file content type
• fileTitle: string
  Title: File Title

  This file name used when saving to the quote file attachment attribute, or when downloading the file

{
    "type":"object",
    "properties":{
        "fileTitle":{
            "type":"string",
            "description":"This file name used when saving to the quote file attachment attribute, or when downloading the file",
            "title":"File Title"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        },
        "fileContent":{
            "type":"string",
            "description":"The Base64 encoded binary document value",
            "title":"File Content"
        },
        "fileContentType":{
            "type":"string",
            "description":"The file content type",
            "title":"File Content Type"
        },
        "fileAttachmentAttribute":{
            "type":"string",
            "description":"Used for confirmation",
            "title":"File Attachment Attribute"
        }
    }
}

Back to Top

Examples

The following example shows how to print the generated transaction document 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/18498612/actions/_print_document

Request Body Sample

{
    "actionVariableName": "_action_process_print",
    "languagePreference": "en",
    "xslView": 3023147879,
    "attachmentIdsForMerge": ["3023197953", "-2"]
}

Back to Top