Record

Last edit: May 19, 2024

No description

type Record implements HasRecordsInterface, HasUsersInterface, PropertiesInterface, RemoteRecordsInterface, RemoteUsersInterface {
  address(name: String!): CustomAddrress
  addresses(name: String): [CustomAddrress!]
  attachment(name: String!): PrivateFile
  attachments(name: String): [PrivateFile!]
  created_at: JSONDate!
  deleted_at: JSONDate
  external_id: ID
  id: ID
  image(name: String!): Image
  images(name: String): [Image!]
  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_record(
    filter: RecordsFilterInput
    foreign_property: String = "id"
    join_on_property: String!
    sort: [RecordsSortInput!]
    table: [String]!
  ): Record
  related_records(
    filter: RecordsFilterInput
    foreign_property: String!
    join_on_property: String!
    limit: Int
    sort: [RecordsSortInput!]
    table: [String]!
  ): [Record!]
  related_user(
    filter: UsersFilterInput
    foreign_property: String = "id"
    join_on_property: String = "user_id"
    sort: [UsersSortInput!]
  ): User
  related_users(
    filter: UsersFilterInput
    foreign_property: String!
    join_on_property: String!
    limit: Int
    sort: [UsersSortInput!]
  ): [User!]
  remote_records(endpoint: Endpoint!, join_on_property: String!): [Record!]
  remote_users(endpoint: Endpoint!, join_on_property: String!): [User!]
  table: String
  table_id: ID!
  updated_at: JSONDate!
  user_id: ID
}

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

`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)

`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_record` (`Record`)

Defines has-one relation with other record; ex: children: records(table:
"child" join_on_property: "parent_id" foreign_property: "parent_id") { id }

filter (RecordsFilterInput)
foreign_property (String)