SCALAR
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- Agent
- AgentProspect
- AnewgoFloorplanTag
- AnewgoPlanTag
- Asset
- BlendElement
- BuilderTag
- BuilderTagAssignment
- BuilderTagCategory
- CityInfo
- Client
- ClientFilter
- ClientPlanTag
- Collection
- Color
- ColorTheme
- ColorThemeEntry
- CommonQueryFilter
- Community
- CommunityElevationInfo
- CommunityGallery
- CommunityGalleryPhoto
- CommunityHighlight
- CommunityHighlightPhoto
- CommunityImg
- CommunityMainPhoto
- CommunityOverviewPhoto
- CommunityPlanPricingResult
- CommunityPlanUpdateInput
- CommunityPlanUpdateResult
- CommunityPoi
- CommunityPoiCategory
- CommunityTag
- CommunityTagAssignment
- CommunityTagCategory
- Customization
- CustomOverlay
- Elevation
- ElevationOverlay
- File
- Floorplan
- FloorplanAlternate
- FloorplanElevationThis type is used to retrieve elevationn assignments for floorplans or floorplan groups When it's used to retrieve elevation assignments for a floorplan in the Community type, we also retrieve the "standard" which tells us whether or not the floorplan is standard for that elevation in that community.
- FloorplanGroup
- FloorplanMembership
- FloorplanTag
- HomeCategory
- HomeCategoryPhoto
- HomesiteThis type combines data from a Lot, and Inventory in a flat structure
- HomesiteUpdateResult
- HomeStyle
- Interior
- InteriorElement
- InteriorElementOption
- InteriorInputTop-level input type for queries.
- InteriorPackage
- InteriorPackageMember
- InteriorPackageMemberElement
- Inventory
- InventoryDataInput
- InventoryLotUpdateInput
- InventoryPhoto
- InventorySgtData
- Layerthis graphQL type doesn't have a 1-to-1 correspondence to a row in the database we omit using a required ID field because our IDs are the materialIDs, which which although are going to be unique per elevation, usage of these IDs for the entire system will not be unique. This can lead to problems for the graphQL client caching implementations that normalizes data based on the ID fields. graphQL client impls such as Apollo can still correctly cache instances of graphQL types that do not have ID fields. see here: https://www.apollographql.com/docs/react/advanced/caching.html#normalization
- LibraryVendor
- LotexternalId - an external identifier that matches to an instance of type Lot
- LotDataInput
- LotLegendEntry
- MasterCommunity
- MaterialPalette
- MetroInfo
- Mutation
- Paletteid is paletteID
- PaletteSelectionhex is meaningful for a selection that is a color swatch is meaningful for a selection that is an overlay masonryLib is true if the swatch is from a masonry library
- Photo
- Plan
- PlanElevationThe ID of this object is the concatenation of the planId and elevationId field names and values.
- PlanTagCategory
- PlanTagElevation
- PlanUpdateInput
- PlanUpdateResult
- PMFloorplan
- Prospect
- ProspectBaseInfo
- ProspectFavorite
- ProspectSgtData
- Query
- ReceivedFavorites
- Scheme
- SchemeElementmasonryLib is true if the swatch is retrieved from a masonry library
- SgtVendor
- Siteplan
- SiteplanHotspot
- SiteplanHotspotAsset
- SiteplanInfo
- StdFeature
- StdFeatureAssignment
- StdFeatureCategory
- Story
- SVGShape
- SVGShapeAttributes
- SVGViewBox
- Texture
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.