OBJECT

CloudObjectTemplateEntity

Document template, such as a Word or Excel file with placeholders, used to generate documents filled with record data.

link GraphQL Schema definition

  • type CloudObjectTemplateEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Application that produced the object (e.g. Online Forms).
  • application: ApplicationEntity
  • # Company-level folder that contains the object, when stored in the company
  • # document tree.
  • companyCloudObjectFolder: CloudObjectFolderEntity
  • # User who uploaded the object.
  • creator: ClientEntity
  • # Id of the producing application.
  • applicationId: ID
  • # Id of the company folder, or empty when the object is not stored in the company
  • # tree.
  • companyCloudObjectFolderId: ID
  • # Id of the uploading user.
  • creatorId: ID
  • # File name (with extension) used when downloading the object.
  • filename: String!
  • # When true, the object can be served via a public URL (see publicUrl).
  • isPublic: Boolean
  • # Mime-type of the cloud object Is detected from content.
  • mimeType: String
  • # Size of the object in bytes.
  • size: Int!
  • # Whether the document template is active and offered for generating documents, or
  • # inactive and kept for later use. Defaults to Active.
  • status: CloudObjectTemplateStatusEnum
  • # Entity type the template renders (e.g. Account, Opportunity, Quote). For custom
  • # entities, the value is "CustomEntity" and the API name is exposed via
  • # templateEntityApiName.
  • templateEntityName: EntityNameEnum!
  • # Where the template file is stored: S3File for a file uploaded to Coevera storage
  • # (the default) or GoogleDriveFile for a Google Drive document. Set on create
  • # only.
  • type: CloudObjectTypeEnum!
  • # Editor the uploaded image is embedded in, such as an email template or rich-text
  • # content. Empty for files that are not embedded images.
  • uploadSource: UploadSourceEnum
  • # URL of the object. If URL scheme is not defined "http://" is automatically
  • # prepended to supplied URL.
  • url: String
  • # Revision when entity was lastly changed.
  • revision: Int
  • # API name of the custom entity the template renders. Set only when
  • # templateEntityName is "CustomEntity"; otherwise empty.
  • templateEntityApiName: String
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by