OBJECT

FieldDescriptor

link GraphQL Schema definition

  • type FieldDescriptor {
  • id: ID!
  • name: String!
  • nameTranslated: String
  • nameTranslations: JSONString!
  • apiName: String
  • graphqlName: String
  • entity: EntityNameEnum
  • entityApiName: String
  • externalEntity: String
  • useLang: Boolean!
  • primitiveType: PrimitiveType!
  • typeId: String!
  • type: TypeEntity!
  • sourceTypeId: String!
  • sourceFieldId: ID
  • permissionLevel: AccessLevelFieldEnum!
  • typeEnumClassName: String
  • isDeleted: Boolean!
  • defaultValue: String
  • # Id of this fields composite parent (main) field.
  • compositeFieldId: ID
  • dataSetId: ID
  • parentDataSetId: ID
  • # Formula used to calculate value of this field.
  • calcFormula: String
  • # Id of sequence used for this fields for auto incremented fields.
  • sequenceId: ID
  • # Marks if field is required no matter what form validator says.
  • systemRequired: Boolean
  • # Marks if field is readonly by default - cannot be updated.
  • systemReadonly: Boolean
  • systemType: FieldSystemType!
  • sharedWithFieldId: ID
  • # Entities where field is allowed to be used,
  • #
  • # for relation fields both left relation entity and right relation entity record
  • # is returned.
  • #
  • # Abstract Entity (e.g. LeadOppty, Activity) are not returned they have to be
  • # evaluated by receiver.
  • #
  • allowedEntityTypes: [AllowedEntityType!]!
  • # Properties for fields of type lookup. Otherwise null.
  • lookup: LookupProperty
  • # Properties for fields of type rollup. Otherwise null.
  • rollup: RollupProperty
  • # Formula used to calculate value of this field.
  • advancedFormula: AdvancedFormulaProperty
  • options: FieldOptionsProperty
  • # Describes possible usage of field in application.
  • #
  • fieldUseOptions: FieldUseOptions
  • # Arguments
  • # entity: Entity on which the field is being used. This is used
  • # to identify correct value options, e.g Using ActivityType (TaskType +
  • # AppointmentType together) options when Task.type field is used on Activity
  • # entity.
  • # externalEntity: External entity used in integrations
  • # filter: [Not documented]
  • # first: Number of option items to return.
  • # after: Return items located after item with this id.
  • # typeIds: Limit result set to options with provided ids.
  • valueOptions(
  • entity: EntityNameEnum,
  • externalEntity: String,
  • filter: FieldValueOptionFilterInput,
  • first: Int,
  • after: ID,
  • typeIds: [String!]
  • ): [FieldValueOption!]
  • relatedEntity: String
  • }

link Require by