OBJECT

TaskRepository

Read operations for Task records.

link GraphQL Schema definition

  • type TaskRepository {
  • # Returns the record with the given id, or null when there is none. Deleted
  • # records are returned as well.
  • #
  • # Arguments
  • # entityId: Id of the record to return.
  • getById(entityId: ID!): TaskEntity
  • # Returns the records with the given ids; ids without a record are left out.
  • # Deleted records are returned as well.
  • #
  • # Arguments
  • # entityIds: Ids of the records to return.
  • getByIds(entityIds: [ID!]!): [TaskEntity!]!
  • # Returns the records that match the filter, paged with limit and offset.
  • #
  • # Arguments
  • # limit: Maximum number of records to return.
  • # offset: Number of records to skip from the start of the result.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • getAll(
  • limit: Int,
  • offset: Int,
  • filter: TaskFilterInput,
  • orderBy: [TaskOrderByInput!],
  • includeDeleted: Boolean
  • ): [TaskEntity!]!
  • # Returns the records that match the filter as a cursor-paginated connection.
  • #
  • # Arguments
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • getByCriteria(
  • filter: TaskFilterInput,
  • orderBy: [TaskOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TaskEntityConnection
  • # Returns the ids of the fields of a record that changed after the given revision.
  • # Returns an empty list for entities without change tracking.
  • #
  • # Arguments
  • # id: Id of the record.
  • # revision: Revision to compare against; only later changes are
  • # returned.
  • getChangedFieldsSinceRevision(
  • id: UUID!,
  • revision: Int!
  • ): [UUID!]!
  • # Returns a page of records selected in a list or report: all records of the given
  • # result plus the explicitly included ids, minus the excluded ids.
  • #
  • # Arguments
  • # includedIds: Ids of records to add to the selection.
  • # excludedIds: Ids of records to remove from the selection.
  • # sessionId: Id of the list or report result to take the records
  • # from. Pass an empty string to select only the included ids.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • getBySession(
  • includedIds: [UUID!]!,
  • excludedIds: [UUID!]!,
  • sessionId: String!,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TaskEntityConnection
  • # Returns the values of a record's fields formatted for display, keyed by field
  • # id.
  • #
  • # Arguments
  • # id: Id of the record.
  • # fieldIds: Ids of the fields to return; null returns all fields.
  • getByIdFormatted(id: UUID!, fieldIds: [UUID!]): JSONString
  • # Returns a new, unsaved record pre-filled from a source record according to a
  • # field mapping. Nothing is saved; the returned values can be used as input for
  • # create.
  • #
  • # Arguments
  • # mappingId: Field mapping that defines how values are copied
  • # from the source record.
  • # entityId: Id of the source record the values are taken from.
  • # targetEntityTypeId: Type of the new record (e.g. opportunity
  • # type); applies the mapping rules defined for that source/target type pair.
  • autoPrefill(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID): TaskEntity!
  • # Returns an unsaved record pre-filled with the values proposed by an AI record
  • # suggestion, together with the fields the suggestion filled in. Nothing is saved;
  • # the caller can review the values and create or update the record.
  • #
  • # Arguments
  • # actionId: Id of the suggested action, as returned by the AI
  • # record suggestions or AI chat.
  • aiAutoPrefill(actionId: String!): TaskAutoPrefill!
  • # Returns a new, unsaved task pre-filled from an email conversation: subject and
  • # description from the last sent email of the conversation that the user can read,
  • # the records linked to the conversation (including ones the user cannot open) and
  • # its attachments as documents. Nothing is saved.
  • #
  • # Arguments
  • # emailId: Id of any email of the conversation.
  • # mailboxId: Mailbox the conversation was opened in; limits the
  • # conversation to that mailbox. It must be a mailbox the user can use.
  • autoPrefillFromEmail(emailId: UUID!, mailboxId: UUID): TaskAutoPrefill!
  • }

link Require by