OBJECT

FieldMappingEntity

Rules for copying field values from a source record to a new target record, for example when a lead is qualified into an opportunity.

link GraphQL Schema definition

  • type FieldMappingEntity {
  • # 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
  • # True when the mapping is shipped by the platform and cannot be deleted by the
  • # user.
  • isSystem: Boolean!
  • # Default field-to-field mapping template applied when no per-type-pair mapping
  • # matches.
  • mapping: FieldMappingTemplate
  • # Situation in which the mapping pre-fills a new target record from a source
  • # record, such as qualifying a lead into an opportunity or creating a follow-up
  • # activity.
  • operation: FieldMappingOperationTypeEnum
  • # API name of the source custom entity. Set only when sourceEntityName is
  • # "CustomEntity"; otherwise empty.
  • sourceEntityApiName: String
  • # API name of the target custom entity. Set only when targetEntityName is
  • # "CustomEntity"; otherwise empty.
  • targetEntityApiName: String
  • # Per-type-pair field mappings: each entry binds a set of source/target type ids
  • # and the field-to-field mapping that applies when both types match.
  • typeMappings: [EntityTypeFieldMapping!]
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Source entity kind for the mapping (e.g. Lead, Account, Contact). Returns
  • # "CustomEntity" when the source is a custom entity; the API name is then exposed
  • # via sourceEntityApiName.
  • sourceEntityName: EntityNameEnum!
  • # Target entity kind for the mapping (e.g. Lead, Account, Contact). Returns
  • # "CustomEntity" when the target is a custom entity; the API name is then exposed
  • # via targetEntityApiName.
  • targetEntityName: EntityNameEnum!
  • # Files attached to the mapping (e.g. import source files).
  • documents: [CloudObjectRelationEntity!]
  • # 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