Jump to

• Request
• Response
• Examples

Get Generated Documents List

get

/rest/v16/documentGenerator

This operation retrieves a list of recently generated documents.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Generated Documents

Type: object

Title: Generated Documents

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "title":"Generated Documents",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/generatedDocument"
            }
        },
        "hasMore":{
            "description":"Returns true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "totalResults":{
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "type":"integer"
        },
        "limit":{
            "description":"The actual paging size used by the server. ",
            "type":"integer"
        },
        "count":{
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset used in the current page.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Generated Document
  Title: Generated Document

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/generatedDocument"
    }
}

Nested Schema : Generated Document

Type: object

Title: Generated Document

Show Source

• id: integer
  Title: id

  The generated document id
• 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.
• links: string
  Title: Links

  Link to generated document.
• 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.

{
    "title":"Generated Document",
    "type":"object",
    "properties":{
        "templateName":{
            "title":"Template Name",
            "description":"The Document Designer template name",
            "type":"string"
        },
        "id":{
            "title":"id",
            "description":"The generated document id",
            "type":"integer"
        },
        "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"
        },
        "links":{
            "title":"Links",
            "description":"Link to generated document.",
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to access a document generator by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/documentGenerator

Response Body Sample

The following example shows the contents of the response body in JSON format, including the Document Generator IDs:

Example of Response Header (when using an Accept: application/octet-stream Header)

The following shows an example of the response header.

{
  "items": [{
    "id": "5607404",
    "languageCode": null,
    "transactionId": null,
    "outputFormat": "PDF",
    "processVarname": null,
    "templateName": null,
    "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/documentGenerator/5607404"
    }]
  },
  {
    "id": "5607142",
    "languageCode": null,
    "transactionId": null,
    "outputFormat": "PDF",
    "processVarname": null,
    "templateName": null,
    "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/documentGenerator/5607142"
    }]
  }],
  "links": [{
    "rel": "self",
    "href": "https://sitename.oracle.com/rest/v16/documentGenerator"
  }]
}

Back to Top