DocumentGenerationProcess

Supports server-side document generation requests and responses. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
DataRaptorInput
Type
textarea
Properties
Create, Nillable, Update
Description
Specifies the input json to the Custom Class associated to the Document Template.
DocGen​ApiVersion​Type
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the API version to use for document generation. Possible values include Basic and Advanced. The default value is Basic.
Available in API version 62.0
Document​TemplateId
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
ID of the document template for operations like cloning or creating a new version.
Available in API version 62.0.
DocumentInputType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The input type of the document.
Possible values are:
  • DocumentTemplate—Document Template
  • None
The default value is None.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Represents an automatically generated system name. Example: Request-001.
HasDocGenFontSource
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the document template font (true) or a rich text editor font (false) is used for rendering values during document generation.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the user that owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PdfDocIdentifiersList
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The PDF document IDs of the contract documents to be converted into a single .pdf file. You can combine upto ten PDFs into a single file.

Make sure the content version ID for each PDF file is 18 characters long.

Available in API version 63.0 and later.
ReferenceObject
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Refers to the object to which generated document is attached.
RequestText
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Requests parameters that are passed in the payload.
ResponseText
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Requests parameters that are passed in the payload.
SourceObjectId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the object from which the document generation request is created. For example, Contract Document Version.
This field is a polymorphic relationship field.
Relationship Name
SourceObject
Relationship Type
Lookup
Refers To
ContractDocumentVersion
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Contains the status of the request.
Possible values are:
  • Failure
  • Success
  • InProgress
The default value is InProgress.
TokenData
Type
textarea
Properties
Create, Nillable, Update
Description
Contains JSON data with information that users enter in the new, generated document.
TokenData​Content​Document
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The Token Data Content Document associated with the Document Generation Process. Contains information that users enter in the new generated document.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Type of service requested for the document for generating and converting to PDF.
Possible values are:
  • Generate
  • Convert
  • GenerateAndConvert
  • MergePDF
The default value is Generate.