OBJECT

ProfileEntity

Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.

link GraphQL Schema definition

  • type ProfileEntity {
  • # 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
  • # User who owns the screen profile.
  • owner: ClientEntity
  • # Specific record this profile is synchronized to. Set only when syncEnabled is
  • # true.
  • syncEntity: ReportEntity
  • # Application screen the profile (saved view) belongs to, such as the leads,
  • # accounts or opportunities screen. For custom entity screens, entityApiName
  • # identifies the custom entity.
  • entity: ScreenTypeEnum!
  • # API name of the custom entity this profile applies to. Set only when the profile
  • # targets a custom entity screen; otherwise empty.
  • entityApiName: String
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Layout and chart configuration of the screen profile, stored as a JSON document.
  • # This payload conforms to the `ProfileSettings` JSON Schema:
  • # https://api-doc.coevera.com/schemas/ProfileSettings.json
  • settings: JSONString!
  • # Who besides the owner can use the profile: nobody (Private), selected users and
  • # sales units (Standard), or all users.
  • shareMode: ShareModeEnum
  • # When true, changes to the profile are propagated to records linked via
  • # ProfileRelation; when false, the profile is detached from the records.
  • syncEnabled: Boolean
  • # Id of the synchronized record.
  • syncEntityId: ID
  • # Whether the profile lists the records matching its filter (Dynamic) or a fixed
  • # list of records added to it explicitly (Static).
  • type: ProfileTypeEnum
  • # When true, the profile name is treated as a translation key and localized in the
  • # UI; otherwise the literal name is shown.
  • useLang: Boolean
  • # Revision when entity was lastly changed.
  • revision: Int
  • # For pipeline-screen profiles, ids of the pipelines included in the profile
  • # configuration; empty for profiles on other screens.
  • pipelines: [UUID!]!
  • # 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