OBJECT
ReportScheduleEntity
Schedule that emails a report to its recipients at regular intervals.
link GraphQL Schema definition
- type ReportScheduleEntity {
- # 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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # User who owns the schedule. The schedule sends emails on behalf of this user.
- : ClientEntity
- # Report whose delivery is scheduled.
- : ReportEntity
- # Id of the owning user.
- : ID!
- # Id of the scheduled report.
- : ID!
- # Schedule configuration: cadence, timezone, recipients, email body and report
- # attachment options. Stored as a JSON document. This payload conforms to the
- # `ReportScheduleSchema` JSON Schema:
- # https://api-doc.coevera.com/schemas/ReportScheduleSchema.json
- : ReportScheduleSchema
- # Revision when entity was lastly changed.
- : Int
- # Files attached to scheduled emails sent for this report.
- : [CloudObjectRelationEntity!]
- # Email address used to send the scheduled report (company email when configured,
- # otherwise the owner's personal email).
- : String
- # Name of the scheduled report (mirror of the linked Report.name).
- : String!
- # Id of the user who owns the scheduled report.
- : UUID!
- # Kind of the scheduled report (e.g. TableReport, AdvancedReport,
- # DashboardReport).
- : ReportTypeEnum!
- # 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.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateReportSchedulePayloadResult of the createReportSchedule mutation.
- DeleteReportSchedulePayloadResult of the deleteReportSchedule mutation.
- ReportEntitySaved report or dashboard with its settings, sharing and delivery schedule.
- ReportScheduleEntityEdgeA Relay edge containing a `ReportScheduleEntity` and its cursor.
- ReportScheduleRepositoryRead operations for ReportSchedule records.
- UpdateReportSchedulePayloadResult of the updateReportSchedule mutation.