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.
47#
48# Arguments
49# name: [Not documented]
50property_json(name: String!): JSONPayload
 
51# Fetch any property by name and returns upload details
52#
53# Arguments
54# expires_in: Defines the number of seconds for which the
55# generated url will be accessible. Must be set if acl was set to private
56# name: [Not documented]
57property_upload(expires_in: Int, name: String!): PropertyUpload
 
58# Defines has-one relation with other record; ex: children: records(table: "child"
59# join_on_property: "parent_id" foreign_property: "parent_id") { id }
60#
61# Arguments
62# filter: [Not documented]
63# foreign_property: Load resources with foreign_property ==
64# join_on_property
65# join_on_property: Load resources with foreign_property ==
66# join_on_property
67# sort: [Not documented]
68# table: Joins record [formaly customization] with
69# record-schema-name == table
70related_record(
71filter: RecordsFilterInput,
72foreign_property: String,
73join_on_property: String!,
74sort: [RecordsSortInput!],
75table: [String]!
76): Record
 
77# Defines has-many relation with other records; ex: children:
78# related_records(table: "children", join_on_property: "parent_id",
79# foreign_property: "parent_id") { id }
80#
81# Arguments
82# filter: [Not documented]
83# foreign_property: Load resources with foreign_property ==
84# join_on_property
85# join_on_property: Load resources with foreign_property ==
86# join_on_property
87# limit: [Not documented]
88# sort: [Not documented]
89# table: Define table name which should be used as a source for
90# related records
91related_records(
92filter: RecordsFilterInput,
93foreign_property: String!,
94join_on_property: String!,
95limit: Int,
96sort: [RecordsSortInput!],
97table: [String]!
98): [Record!]
 
99# Defines relation with other user; ex: invited_by: related_user(join_on_property:
100# "invited_by_id") { id }
101#
102# Arguments
103# filter: [Not documented]
104# foreign_property: Load resources with foreign_property ==
105# join_on_property
106# join_on_property:
107# sort: [Not documented]
108related_user(
109filter: UsersFilterInput,
110foreign_property: String,
111join_on_property: String,
112sort: [UsersSortInput!]
113): User
 
114# Defines has-many relation with other user; ex: children: users(join_on_property:
115# "parent_id", foreign_property: "parent_id") { id }
116#
117# Arguments
118# filter: [Not documented]
119# foreign_property: Load resources with foreign_property ==
120# join_on_property
121# join_on_property: Load resources with foreign_property ==
122# join_on_property
123# limit: [Not documented]
124# sort: [Not documented]
125related_users(
126filter: UsersFilterInput,
127foreign_property: String!,
128join_on_property: String!,
129limit: Int,
130sort: [UsersSortInput!]
131): [User!]
 
132# Name of the Table to which it belongs
133table: String
 
134# ID of the Table to which it belongs
135table_id: ID!
 
136# timestamp of when the record was updated, automatically generated by the system
137updated_at: JSONDate!
 
138# Id of the User who created and owns the Record
139user_id: ID
 
140}

# Required by