OBJECT

ImportMappingMaskEntity

Saved mapping of import file columns to fields, reused when importing records of the same entity.

link GraphQL Schema definition

  • type ImportMappingMaskEntity {
  • # 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 import mapping mask.
  • owner: ClientEntity
  • # API name of the entity this mask is configured for (e.g. "Account", "Contact", a
  • # custom entity's API name).
  • entityApiName: String
  • # Entity the mask imports records into, such as leads, accounts, users or product
  • # prices. For custom entities, entityApiName identifies the custom entity.
  • entityType: ImportMaskEntityTypeEnum!
  • # How the import file fills each field, as a JSON array of objects conforming to
  • # the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex,
  • # UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index.
  • # Validated on write.
  • mapping: JSONString!
  • # Display name of the mask.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Record type selected for each mapped relation field, as a JSON array of objects
  • # conforming to the `ImportMappingRelationType` type, each with field_id and
  • # entity_type_id. Validated on write.
  • relationTypes: JSONString
  • # Who besides the owner can use the import mapping mask: nobody (Private, the
  • # default), the users and sales units in sharingClients and sharingUnits, or all
  • # users.
  • shareMode: ProfileShareMode
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Users granted shared access to this import mapping mask (custom share mode).
  • sharingClients: [ClientEntity!]
  • # Sales units granted shared access to this import mapping mask (custom share
  • # mode).
  • sharingUnits: [SalesUnitEntity!]
  • # 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!]!
  • # How the columns of the import file map to fields: one item per mapped field,
  • # with the mapping type and the source column.
  • mappingMask: [ImportMappingMaskItem!]
  • # Record type selected for each mapped relation field of the mask.
  • mappingRelationTypes: [ImportMappingRelationType!]
  • # True for a default import mapping mask provided by Coevera; it cannot be
  • # deleted.
  • isDefault: Boolean!
  • }