Newer Version Available

This content describes an older version of this product. View Latest

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
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Represents an automatically generated system name. Example: Request-001.
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
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.
TokenDataContentDocument
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
The default value is Generate.