OBJECT

Record

# GraphQL Schema definition

1type Record implements PropertiesInterface, HasUsersInterface, HasRecordsInterface {
 
2# timestamp of when the record was created, automatically generated by the system
3created_at: JSONDate!
 
4# timestamp of when the record was soft delete, populated by delete action. It is
5# also possible to manually set it via update. To undelete change it back to empty
6# value, but please note that associated records would need to be manually
7# undeleted as well.
8deleted_at: JSONDate
 
9# Used mainly for import/export, if you want to use third party service as a
10# source of truth
11external_id: ID
 
12# ID of an object.
13id: ID
 
14# List of all properties assigned to the object.
15properties: HashObject
 
16# Fetch any property by name and return value as a String; ex: hair_color:
17# property(name: "hair_color")
18#
19# Arguments
20# name: [Not documented]
21property(name: String!): String
 
22# Fetch any property by name and return value as an Array of Strings. ex:
23# todo_list: property_array(name: "todo_list")
24#
25# Arguments
26# name: [Not documented]
27property_array(name: String!): [String!]
 
28# Fetch any property by name and return value as a Boolean; ex: price:
29# property_boolean(name: "enabled")
30#
31# Arguments
32# name: [Not documented]
33property_boolean(name: String!): Boolean
 
34# Fetch any property by name and return value as a Float; ex: price:
35# property_float(name: "price")
36#
37# Arguments
38# name: [Not documented]
39property_float(name: String!): Float
 
40# Fetch any property by name and return value as an Integer; ex: age:
41# property_int(name: "age")
42#
43# Arguments
44# name: [Not documented]
45property_int(name: String!): Int
 
46# Fetch any property by name and return value as a JSON string.
47#
48# Arguments
49# name: [Not documented]
50property_json(name: String!): JSONPayload
 
51# Fetch any property by name, parse it as a JSON and return object
52#
53# Arguments
54# name: [Not documented]
55property_object(name: String!): HashObject
 
56# Fetch any property by name and returns upload details
57#
58# Arguments
59# expires_in: Defines the number of seconds for which the
60# generated url will be accessible. Must be set if acl was set to private
61# name: [Not documented]
62property_upload(expires_in: Int, name: String!): PropertyUpload
 
63# Defines has-one relation with other record; ex: children: records(table: "child"
64# join_on_property: "parent_id" foreign_property: "parent_id") { id }
65#
66# Arguments
67# filter: [Not documented]
68# foreign_property: Load resources with foreign_property ==
69# join_on_property
70# join_on_property: Load resources with foreign_property ==
71# join_on_property
72# sort: [Not documented]
73# table: Joins record [formaly customization] with
74# record-schema-name == table
75related_record(
76filter: RecordsFilterInput,
77foreign_property: String,
78join_on_property: String!,
79sort: [RecordsSortInput!],
80table: [String]!
81): Record
 
82# Defines has-many relation with other records; ex: children:
83# related_records(table: "children", join_on_property: "parent_id",
84# foreign_property: "parent_id") { id }
85#
86# Arguments
87# filter: [Not documented]
88# foreign_property: Load resources with foreign_property ==
89# join_on_property
90# join_on_property: Load resources with foreign_property ==
91# join_on_property
92# limit: [Not documented]
93# sort: [Not documented]
94# table: Define table name which should be used as a source for
95# related records
96related_records(
97filter: RecordsFilterInput,
98foreign_property: String!,
99join_on_property: String!,
100limit: Int,
101sort: [RecordsSortInput!],
102table: [String]!
103): [Record!]
 
104# Defines relation with other user; ex: invited_by: related_user(join_on_property:
105# "invited_by_id") { id }
106#
107# Arguments
108# filter: [Not documented]
109# foreign_property: Load resources with foreign_property ==
110# join_on_property
111# join_on_property:
112# sort: [Not documented]
113related_user(
114filter: UsersFilterInput,
115foreign_property: String,
116join_on_property: String,
117sort: [UsersSortInput!]
118): User
 
119# Defines has-many relation with other user; ex: children: users(join_on_property:
120# "parent_id", foreign_property: "parent_id") { id }
121#
122# Arguments
123# filter: [Not documented]
124# foreign_property: Load resources with foreign_property ==
125# join_on_property
126# join_on_property: Load resources with foreign_property ==
127# join_on_property
128# limit: [Not documented]
129# sort: [Not documented]
130related_users(
131filter: UsersFilterInput,
132foreign_property: String!,
133join_on_property: String!,
134limit: Int,
135sort: [UsersSortInput!]
136): [User!]
 
137# Name of the Table to which it belongs
138table: String
 
139# ID of the Table to which it belongs
140table_id: ID!
 
141# timestamp of when the record was updated, automatically generated by the system
142updated_at: JSONDate!
 
143# Id of the User who created and owns the Record
144user_id: ID
 
145}

# Required by