INPUT_OBJECT

CreateDraftFieldInput

link GraphQL Schema definition

  • input CreateDraftFieldInput {
  • # Optional client-supplied identifier passed on a mutation input and echoed back
  • # unchanged on its payload, so a client can correlate the response with its
  • # request (Relay convention).
  • clientMutationId: String
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)
  • entityName: String!
  • # User friendly name for field.
  • name: String!
  • # Type of the field. Supported field types are: checkbox, currency,
  • # currency_foreign, date, datetime, dropdown, email, float, input, integer,
  • # multiselect_checkbox, phone, radio, sequence, text_area, url
  • typeId: String!
  • # Optional custom data set id can be set.
  • dataSetId: ID
  • # For dependent dropdown/radio fields, id of the parent field whose selected value
  • # restricts the options shown on this field.
  • parentOptionsFieldId: ID
  • # Calculated formula used for fields which supports calculation.
  • calcFormula: String
  • # A default value for field.
  • defaultValue: String
  • # If this field is allowed in global search.
  • useInGlobalSearch: Boolean
  • # If true, then there will be an API validation if value of entity is unique.
  • isUnique: Boolean
  • # For dropdown, radio, and multiselect-checkbox fields, the set of available
  • # options. Empty for other field types.
  • dataSet: [FieldDataSetItem!]
  • # Set at field creation to also create this field on another (related) entity,
  • # identified by its entity api name — used to share/map the field across entities.
  • # Write-only on create.
  • mapDependency: String
  • # Lookup field definition.
  • lookup: LookupPropertyParams
  • # Deprecated - previously returned sequence pattern used for sequence type of
  • # field.
  • sequencePattern: String
  • # Sequence field definition.
  • sequence: SequencePropertyParams
  • # Rollup field definition.
  • rollup: RollupPropertyParams
  • # Available option values for dropdown, radio, and multiselect-checkbox fields,
  • # including labels and translations. Empty for other field types.
  • options: FieldOptionsPropertyJSONString
  • # AI Smart Field options. Available for input, text_area, integer, float, email,
  • # phone, url, currency.
  • aiOptions: FieldAiOptionsParams
  • # Advanced calculated formula
  • advancedFormula: AdvancedFormulaPropertyParams
  • # Per-user-role access overrides for this field. Empty when the field uses default
  • # access (full access for all roles).
  • fieldPermissions: [FieldPermissionNoFieldBackrefInput!]
  • # Map of locale codes to translated field names (e.g. {"en-US": "First name",
  • # "de-DE": "Vorname"}). Empty when no translations are defined.
  • nameTranslations: JSONString
  • }

link Require by