Model

No description

type Model implements HasModelsInterface, PropertiesInterface {
  address(name: String!): CustomAddrress
  addresses(name: String): [CustomAddrress!]
  attachment(name: String!): PrivateFile
  attachments(name: String): [PrivateFile!]
  created_at: JSONDate!
  customizable_id: ID
  customizable_type: String
  deleted_at: JSONDate
  external_id: ID
  id: ID
  image(name: String!): Image
  images(name: String): [Image!]
  model(
    filter: ModelsFilterInput
    foreign_property: String = "id"
    join_on_property: String!
    model_name: [String]!
    sort: [ModelsSortInput!]
  ): Model
  model_schema_id: ID!
  model_schema_name: String
  models(
    foreign_property: String!
    join_on_property: String!
    limit: Int
    model_name: [String]!
    sort: [ModelsSortInput!]
  ): [Model!]
  name: String
  properties(select: [PropertiesFieldInput!]): HashObject
  property(name: String!): String
  property_array(name: String!): [String!]
  property_boolean(name: String!): Boolean
  property_float(name: String!): Float
  property_int(name: String!): Int
  property_json(name: String!): JSONPayload
  property_object(name: String!): HashObject
  property_upload(expires_in: Int, name: String!): PropertyUpload
  related_model(
    filter: ModelsFilterInput
    foreign_property: String = "id"
    join_on_property: String!
    model_schema_name: [String]!
    sort: [ModelsSortInput!]
  ): Model
  related_models(
    filter: ModelsFilterInput
    foreign_property: String!
    join_on_property: String!
    limit: Int
    model_schema_name: [String]!
    sort: [ModelsSortInput!]
  ): [Model!]
  related_user(
    filter: ModelsFilterInput
    foreign_property: String = "id"
    join_on_property: String = "user_id"
    sort: [UsersSortInput!]
  ): User
  related_users(
    filter: ModelsFilterInput
    foreign_property: String!
    join_on_property: String!
    limit: Int
    sort: [UsersSortInput!]
  ): [User!]
  table: String
  table_id: ID!
  updated_at: JSONDate!
  user(
    foreign_property: String = "id"
    join_on_property: String = "user_id"
    sort: [UsersSortInput!]
  ): User
  user_id: ID
  users(
    foreign_property: String!
    join_on_property: String!
    limit: Int
    sort: [UsersSortInput!]
  ): [User!]
}

Fields

address (CustomAddrress)

Fetch address by name; ex: address: address(name: "office_address")

• name (String)

addresses (CustomAddrress)

Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home")

• name (String)

attachment (PrivateFile)

Fetch attachment by name; ex: sales_report: attachment(name: "sales_report")

• name (String)

attachments (PrivateFile)

Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report")

• name (String)

created_at (JSONDate)

timestamp of when the record was created, automatically generated by the system

customizable_id (ID)

customizable_type (String)

deleted_at (JSONDate)

timestamp of when the record was soft delete, populated by delete action. It
is also possible to manually set it via update. To undelete change it back to
empty value, but please note that associated records would need to be manually
undeleted as well.

external_id (ID)

Used mainly for import/export, if you want to use third party service as a source of truth

id (ID)

ID of an object.

image (Image)

Fetch image by name; ex: header: image(name: "header")

• name (String)

images (Image)

Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat")

• name (String)

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 }

• filter (ModelsFilterInput)

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• model_name (String)

Joins model [formaly customization] with model-schema-name == model_name

• sort (ModelsSortInput)

model_schema_id (ID)

ID of Model Schema to which it belongs

model_schema_name (String)

Name of the model schema to which it belongs

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 }

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• limit (Int)

• model_name (String)

Joins model [formaly customization] with model-schema-name == model_name

• sort (ModelsSortInput)

name (String)

Name of the model schema

properties (HashObject)

List of all properties assigned to the object.

• select (PropertiesFieldInput)

property (String)

Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color")

• name (String)

property_array (String)

Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list")

• name (String)

property_boolean (Boolean)

Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled")

• name (String)

property_float (Float)

Fetch any property by name and return value as a Float; ex: price: property_float(name: "price")

• name (String)

property_int (Int)

Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age")

• name (String)

property_json (JSONPayload)

Fetch any property by name and return value as a JSON string.

• name (String)

property_object (HashObject)

Fetch any property by name, parse it as a JSON and return object

• name (String)

property_upload (PropertyUpload)

Fetch any property by name and returns upload details

• expires_in (Int)

Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private

• name (String)

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 }

• filter (ModelsFilterInput)

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• model_schema_name (String)

Joins model [formaly customization] with model-schema-name == model_schema_name

• sort (ModelsSortInput)

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 }

• filter (ModelsFilterInput)

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• limit (Int)

• model_schema_name (String)

Joins model [formaly customization] with model-schema-name == model_schema_name

• sort (ModelsSortInput)

related_user (User)

Defines relation with other user; ex: invited_by: related_user(join_on_property: "invited_by_id") { id }

• filter (ModelsFilterInput)

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

• sort (UsersSortInput)

related_users (User)

Defines has-many relation with other user; ex: children:
users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

• filter (ModelsFilterInput)

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• limit (Int)

• sort (UsersSortInput)

table (String)

Name of the Table to which it belongs

table_id (ID)

ID of the Table to which it belongs

updated_at (JSONDate)

timestamp of when the record was updated, automatically generated by the system

user (User)

Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

• sort (UsersSortInput)

user_id (ID)

Id of the User who created and owns the Model

users (User)

Defines has-many relation with other user; ex: children:
users(join_on_property: "parent_id", foreign_property: "parent_id") { id }

• foreign_property (String)

Load resources with foreign_property == join_on_property

• join_on_property (String)

Load resources with foreign_property == join_on_property

• limit (Int)

• sort (UsersSortInput)

Interfaces

HasModelsInterface

PropertiesInterface