GraphQL - Interfaces
AdminPropertiesInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| fields | Property | Deprecated, use properties instead. |
| properties | Property | List of properties attributes to be included in the results |
AdminSharedAttributesInterface
Implemented by
- ApiCallNotification
- Asset
- AuthorizationPolicy
- EmailNotification
- Form
- FormConfiguration
- GraphQuery
- LiquidLayout
- LiquidPartial
- ModelSchema
- Page
- Property
- SmsNotification
- TransactableSchema
- UserProfileSchema
Fields
| Name | Type | Description |
|---|---|---|
| created_at | JSONDate | |
| id | ID | |
| metadata | HashObject | |
| physical_file_path | String | defines the physical path of the file |
| updated_at | JSONDate |
HasModelsInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| model | Model | Defines has-one relation with other model, e.g: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id } |
| models | Model | Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id } |
| related_model | Model | Defines has-one relation with other model; ex: children: models(model_name: "child" join_on_property: "parent_id" foreign_property: "parent_id") { id } |
| related_models | Model | Defines has-many relation with other model; ex: children: related_models(model_schema_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id } |
| related_user | User | Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id } |
| related_users | User | Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id } |
| user | User | Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id } |
| users | User | Defines has-many relation with other user; ex: children: users(join_on_property: "parent_id", foreign_property: "parent_id") { id } |
LegacyCustomAttributeInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| custom_address | CustomAddrress | Fetch address by name; ex: address: custom_address(name: "office_address") |
| custom_addresses | CustomAddrress | Fetch all addresses, optionaly you can filter results by name; ex: home: custom_addresses(name: "home") |
| custom_attachment | PrivateFile | Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report") |
| custom_attachments | PrivateFile | Fetch all attachments, optionally you can filter results by name; ex: sales_reports: custom_attachments(name: "sales_report") |
| custom_image | Image | Fetch image by name; ex: header: custom_image(name: "header") |
| custom_images | Image | Fetch all images, optionaly you can filter results by name; ex: cat_images: custom_images(name: "cat") |
ListingCustomAttributeInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| custom_address | ListingAddress | Fetch address by name; ex: address: custom_address(name: "office_address") |
| custom_addresses | ListingAddress | Fetch all addresses, optionaly you can filter results by name; ex: home: custom_addresses(name: "home") |
| custom_attachment | ListingsPrivateFile | Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report") |
| custom_attachments | ListingsPrivateFile | |
| custom_image | ListingImage | Fetch image by name; ex: header: custom_image(name: "header") |
| custom_images | ListingImage | Fetch all images, optionaly you can filter results by name; ex: cat_images: custom_images(name: "cat") |
| properties | HashObject | List of all properties assigned to the object. |
| property | String | Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color") |
| property_array | String | Fetch any property of Array type by name, it returns Array in contrast to "property" which returns String; ex: todo_list: property_array(name: "todo_list") |
| property_json | JSONPayload | Fetch any property of JSON type by name, it returns JSON in contrast to "property" which returns String; ex: todo_list: property_json(name: "todo_list") |
ListingsMetadata
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| sort_score | Int | when sorting by distance - field contains distance to target location |
PropertiesInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| address | CustomAddrress | Fetch address by name; ex: address: address(name: "office_address") |
| addresses | CustomAddrress | Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home") |
| attachment | PrivateFile | Fetch attachment by name; ex: sales_report: attachment(name: "sales_report") |
| attachments | PrivateFile | Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report") |
| id | ID | ID of an object. |
| image | Image | Fetch image by name; ex: header: image(name: "header") |
| images | Image | Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat") |
| properties | HashObject | List of all properties assigned to the object. |
| property | String | Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color") |
| property_array | String | Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list") |
| property_boolean | Boolean | Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled") |
| property_float | Float | Fetch any property by name and return value as a Float; ex: price: property_float(name: "price") |
| property_int | Int | Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age") |
| property_json | JSONPayload | Fetch any property by name and return value as a JSON. |
RelationOnDemandInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| model | ListingsCustomization | Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id } |
| models | ListingsCustomization | Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id } |
| related_model | ListingsCustomization | Defines belongs-to relation with other model; ex: parent: model(model_name: "parent", join_on_property: "parent_id") { id } |
| related_models | ListingsCustomization | Defines has-many relation with other model; ex: children: models(model_name: "child", join_on_property: "parent_id", foreign_property: "parent_id") { id } |
| related_user | User | Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id } |
| user | User | Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id } |
RemoteModelInterface
Implemented by
Fields
| Name | Type | Description |
|---|---|---|
| remote_model | Customization | Defines relation object accessible over HTTP in JSON collection identified by it's ID. |