GraphQL Types index R
Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.
A B C D E F G H I J L M N O P Q R S T U V W X Y
ReactivateAccountInput ReactivateAccountPayload ReactivateContactInput ReactivateContactPayload ReactivateLeadInput ReactivateLeadOpptyInput ReactivateLeadOpptyPayload ReactivateLeadPayload ReactivateQuoteInput ReactivateQuotePayload RecentApprovalItem RecentExecutionItem RecordConversionOperationEnum RecordConversionOptions Rectangle RecurrenceConditionEnum RecurrenceConditionEnumFilterInput RecurrenceTypeEnum RecurrenceTypeEnumFilterInput RelationType RelationTypeFilterInput ReleaseOwnershipLeadInput ReleaseOwnershipLeadPayload ReleaseOwnershipTaskInput ReleaseOwnershipTaskPayload ReminderStatusEnum ReminderStatusEnumFilterInput RemoveReminderAppointmentInput RemoveReminderAppointmentPayload RemoveReminderTaskInput RemoveReminderTaskPayload RemoveScheduleReportInput RemoveScheduleReportPayload RemoveTargetInput RemoveTargetPayload ReopenProjectInput ReopenProjectPayload ReportBoxInterface ReportChart ReportChartType ReportComparisonDatesHistory ReportContent ReportEntity ReportEntityConnection ReportEntityEdge ReportField ReportFilterInput ReportFolderEntity ReportFolderEntityConnection ReportFolderEntityEdge ReportFolderFilterInput ReportFolderOrderByInput ReportFolderOrderByNestedInput ReportFolderRepository ReportHistoricalTrendHistory ReportHistory ReportHistoryCommon ReportHistoryComparisonDate ReportHistoryDynamicDate ReportHistoryDynamicDateOperation ReportHistoryDynamicDateUnit ReportHistoryField ReportHistorySpecialValue ReportMainBox ReportOrderByInput ReportOrderByNestedInput ReportRepository ReportSankeyChart ReportSchedule ReportScheduleEntity ReportScheduleEntityConnection ReportScheduleEntityEdge ReportScheduleFilterInput ReportScheduleOrderByInput ReportScheduleOrderByNestedInput ReportScheduleParams ReportScheduleRepository ReportScheduleSchema ReportScheduleSchemaJSONString ReportScheduleSchemaParams ReportSchema ReportSettings ReportSharingClientRelationEntity ReportSharingClientRelationEntityConnection ReportSharingClientRelationEntityEdge ReportSharingClientRelationFilterInput ReportSharingClientRelationOrderByInput ReportSharingClientRelationRepository ReportSharingSalesUnitRelationEntity ReportSharingSalesUnitRelationEntityConnection ReportSharingSalesUnitRelationEntityEdge ReportSharingSalesUnitRelationFilterInput ReportSharingSalesUnitRelationOrderByInput ReportSharingSalesUnitRelationRepository ReportSiblingBox ReportStructureItem ReportTabInterface ReportTable ReportTotalPosition ReportTypeEnum ReportTypeEnumFilterInput ReportValueField ReportValueFieldInterface ReportXlsxType RequestMethodEnum RequestMethodEnumFilterInput RespondToAppointmentInvitationInput RespondToAppointmentInvitationPayload ResponseAcceptanceThresholdCustomCondition ResponseAcceptanceThresholdProductsLimits ResponseAcceptanceThresholdType ResponseSummaryRelationCategory RestoreAccountInput RestoreAccountPayload RestoreAppointmentInput RestoreAppointmentPayload RestoreContactInput RestoreContactPayload RestoreDataInput RestoreDataPayload RestoreLeadInput RestoreLeadPayload RestoreOpportunityInput RestoreOpportunityPayload RestoreProjectInput RestoreProjectPayload RestoreQuoteInput RestoreQuotePayload RestoreTaskInput RestoreTaskPayload RevenueSchedulePeriodTypeEnum RevenueSchedulePeriodTypeEnumFilterInput RoleProfileInterface RoleTabInterface RollbackMethod RollupFieldAggregationFunctionEnum RollupProperty RollupPropertyParams
Types several repositories use, or none does, with their fields and their descriptions.
RecordConversionOperationEnum enum Nothing, Archive, Delete What happens to the source record after it is converted into a new record.
Value Description NothingThe source record is kept unchanged. ArchiveThe source record is archived; options decide which related records are archived or completed too. DeleteThe source record's activities, documents and notes move to the new record, then the source is deleted.
RecordConversionOptions input 7 fields: archiveAllRelatedContacts, archiveAllRelatedAccounts, archiveAllRelatedLeads, … Related records of the source that are archived or completed together with it when a record is converted with the Archive operation.
Input field Type Description archiveAllRelatedContactsBoolean For an account source, archives contacts whose primary account is it. archiveAllRelatedAccountsBoolean Not applicable: has no effect. archiveAllRelatedLeadsBoolean For an account or contact source, archives open leads whose primary account or contact is it. archiveAllRelatedOpportunitiesBoolean For an account or contact source, archives open opportunities whose primary account or contact is it; for a quote source, archives its open opportunity. archiveAllRelatedQuotesBoolean For an account or contact source, archives open quotes whose primary account or contact is it; for an opportunity source, archives its open quotes. completeAllRelatedProjectsBoolean For an account source, completes its unfinished projects. completeAllRelatedTasksBoolean Marks all tasks linked to the source record as completed.
Rectangle object x: Int!, y: Int!, width: Int!, height: Int! A rectangular area on a canvas/grid: origin (x, y) plus size, in integer grid units.
Field Type Description xInt! Horizontal position of the top-left corner from the left edge, in grid columns. yInt! Vertical position of the top-left corner from the top edge, in grid rows. widthInt! Width, in grid columns. heightInt! Height, in grid rows.
RecurrenceTypeEnum enum NotSet, Daily, Weekly, MonthlyRelative, MonthlyAbsolute, YearlyRelative, … (11 values) Schedule by which the next task or opportunity in a recurring series is created.
Value Description NotSetNo recurrence; no further items are created. DailyRepeats every occurEvery days on a fixed schedule. WeeklyRepeats every occurEvery weeks on the weekdays set in dayOfWeek. MonthlyRelativeRepeats every occurEvery months on a fixed day of the month given by day. MonthlyAbsoluteRepeats every occurEvery months on a given weekday of a given week of the month (week and dayOfWeek), for example the last Friday. YearlyRelativeRepeats every year on a fixed date given by month and day. YearlyAbsoluteRepeats every year on a given weekday of a given week in a given month (month, week and dayOfWeek). AfterNDaysCreates the next item occurEvery days after the current one is completed. AfterNWeeksCreates the next item occurEvery weeks after the current one is completed. AfterNMonthsCreates the next item occurEvery months after the current one is completed. AfterNYearsCreates the next item occurEvery years after the current one is completed.
RecurrenceTypeEnumFilterInput input eq: [RecurrenceTypeEnum!], NOT: RecurrenceTypeEnumFilterInput Conditions on an enumeration field. Several conditions given together must all match.
ReminderStatusEnum enum Snoozed, Scheduled, Dismissed State of a task or appointment reminder.
Value Description SnoozedThe reminder was postponed and fires again at its snooze date. ScheduledThe reminder fires at its set time. DismissedThe reminder was dismissed and does not fire again.
ReminderStatusEnumFilterInput input eq: [ReminderStatusEnum!], NOT: ReminderStatusEnumFilterInput Conditions on an enumeration field. Several conditions given together must all match.
ReportContent enum All, Charts, Table Parts of a report included in a PDF export.
Value Description AllBoth charts and the table. ChartsOnly the charts. TableOnly the table.
ReportFolderOrderByNestedInput input 7 fields: id, isDeleted, modified, … Sorting by a field of the related ReportFolder record. Set exactly one field in each item.
Input field Type Description idOrderByEnum Unique identifier of entity. isDeletedOrderByEnum Specifies if the entity is considered deleted. modifiedOrderByEnum Last modification time. createdOrderByEnum Creation time. nameOrderByEnum Name of the entity and its default text representation. parentReportFolderIdOrderByEnum Id of the parent folder, or empty for top-level folders. revisionOrderByEnum Revision when entity was lastly changed.
ReportFolderRepository object 5 fields: getById, getByIds, getAll, … Read operations for ReportFolder records.
Field Type Description getByIdReportFolderEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[ReportFolderEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[ReportFolderEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaReportFolderEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getChangedFieldsSinceRevision[UUID!]! (2 args) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ReportOrderByNestedInput input 14 fields: id, isDeleted, modified, … Sorting by a field of the related Report record. Set exactly one field in each item.
Input field Type Description idOrderByEnum Unique identifier of entity. isDeletedOrderByEnum Specifies if the entity is considered deleted. modifiedOrderByEnum Last modification time. createdOrderByEnum Creation time. accessLinkOrderByEnum Public access token used in shareable report URLs. Empty when public sharing is not configured for the report. descriptionOrderByEnum Free-text description shown alongside the report. nameOrderByEnum Name of the entity and its default text representation. ownerIdOrderByEnum Id of the owning user. reportsFolderIdOrderByEnum Id of the parent report folder. shareModeOrderByEnum Who besides the owner can access the report: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits (Standard), or all users (AllView to view, AllEdit to also edit). syncEnabledOrderByEnum When true, name and settings are kept in sync with the linked screen profile; when false, the report is detached from profile sync. syncEntityIdOrderByEnum Id of the synchronized record. typeOrderByEnum Kind of report: a table or pivot report, a dashboard, an opportunity forecast, or an advanced report built from several linked tables. revisionOrderByEnum Revision when entity was lastly changed.
ReportRepository object 5 fields: getById, getByIds, getAll, … Read operations for Report records.
Field Type Description getByIdReportEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[ReportEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[ReportEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaReportEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getChangedFieldsSinceRevision[UUID!]! (2 args) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ReportScheduleOrderByNestedInput input 7 fields: id, isDeleted, modified, … Sorting by a field of the related ReportSchedule record. Set exactly one field in each item.
ReportScheduleRepository object 5 fields: getById, getByIds, getAll, … Read operations for ReportSchedule records.
Field Type Description getByIdReportScheduleEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[ReportScheduleEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[ReportScheduleEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaReportScheduleEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getChangedFieldsSinceRevision[UUID!]! (2 args) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ReportScheduleSchemaJSONString scalar scalar JSON object, sent as a string, conforming to the ReportScheduleSchema type.
ReportSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for ReportSharingClientRelation records.
Field Type Description getByIdReportSharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[ReportSharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[ReportSharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaReportSharingClientRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getChangedFieldsSinceRevision[UUID!]! (2 args) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ReportSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for ReportSharingSalesUnitRelation records.
ReportTypeEnum enum TableReport, DashboardReport, ForecastReport, AdvancedReport Kind of report.
Value Description TableReportTable or pivot report of records. DashboardReportDashboard made of charts, tiles and other widgets. ForecastReportOpportunity forecast. AdvancedReportReport built from several linked tables or pivots, edited in the advanced report editor.
ReportXlsxType enum simplified, full Level of detail of an XLSX report export.
Value Description simplifiedData rows only, without total and summary rows. fullThe full report layout, including totals and summary rows.
RevenueSchedulePeriodTypeEnum enum Month, Quarter, Year Length of each period an opportunity or product revenue schedule is split into.
Value Description MonthRevenue is split into monthly periods. QuarterRevenue is split into quarterly periods. YearRevenue is split into yearly periods.
RevenueSchedulePeriodTypeEnumFilterInput input eq: [RevenueSchedulePeriodTypeEnum!], NOT: RevenueSchedulePeriodTypeEnumFilterInput Conditions on an enumeration field. Several conditions given together must all match.
RollbackMethod enum ROLLBACK_ALL, ROLLBACK_FAILED How a bulk operation handles items that fail.
Value Description ROLLBACK_ALLAny failed item fails the whole request; nothing is saved. ROLLBACK_FAILEDFailed items are skipped and reported in errors; the other items are saved.
