Jump to

• Request
• Response
• Examples

Generate Document

post

/rest/v16/documentGenerator

This operation creates a Document Designer document. When executed correctly, the external system will receive the URL of the document in the Location header of the REST response from CPQ.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Generate Document

Type: object

Title: Generate Document

Show Source

• languageCode: integer
  Title: Language Code

  The language integer value to specify the template language. To identify integer values, refer to the Supported Languages section in the CPQ Administration Online Help > Language Support topic.
• outputFormat: string
  Title: Output Format

  The output format options available are as follows (separated by comma): PDF, DOCX, RTF
• processVarname: string
  Title: Process Variable Name

  The Commerce Process variable name
• templateName: string
  Title: Template Name

  The Document Designer template name
• transactionId: integer
  Title: Transaction ID

  Commerce Transaction Id. However, this property will not have any data in the response.

{
    "type":"object",
    "title":"Generate Document",
    "properties":{
        "templateName":{
            "title":"Template Name",
            "description":"The Document Designer template name",
            "type":"string"
        },
        "processVarname":{
            "title":"Process Variable Name",
            "description":"The Commerce Process variable name",
            "type":"string"
        },
        "languageCode":{
            "title":"Language Code",
            "description":"The language integer value to specify the template language. To identify integer values, refer to the Supported Languages section in the CPQ Administration Online Help > Language Support topic.",
            "type":"integer"
        },
        "outputFormat":{
            "title":"Output Format",
            "description":"The output format options available are as follows (separated by comma): PDF, DOCX, RTF",
            "type":"string"
        },
        "transactionId":{
            "title":"Transaction ID",
            "description":"Commerce Transaction Id. However, this property will not have any data in the response.",
            "type":"integer"
        }
    }
}

Back to Top

Response

Default Response

No content. This task does not return elements in the response body.

Back to Top

Examples

The following example shows how to create a document generator 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" 
https://sitename.oracle.com/rest/v16/documentGenerator

Request Body Sample

{
"processVarname":"oraclecpqo",
"templateName":"Tech Solutions Output",
"transactionId":5531903,
"languageCode":-1,
"outputFormat":"PDF"
}

Back to Top