OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3_internal_: String
4
5# Returns a user.
6#
7# Arguments
8# id: Id of the user.
9user(id: ID!): User
10
11# Returns a paginated list of users.
12#
13# Arguments
14# offset: Offset of the users' list.
15# limit: Limit of users on one page.
16# sort: Sort args.
17# The list of users can be sorted by id, firstName, lastName, postiion, team,
18# location.
19# filter: Filter conditions for the list of users.
20users(offset: Int, limit: Int, sort: [SortArgInput!], filter: UserFilterInput): UsersPage!
21
22# Returns a paginated list of available managers.
23#
24# Arguments
25# offset: Offset of the users' list.
26# limit: Limit of users on one page.
27# sort: Sort args.
28# The list of users can be sorted by id, firstName, lastName, position, team,
29# location.
30# filter: Filter conditions for the list of available managers.
31# To be used when querying for available managers for a specific user.
32availableManagers(
33offset: Int,
34limit: Int,
35sort: [SortArgInput!],
36filter: AvailableManagersFilterInput
37): UsersPage
38
39# Returns a paginated list of teams.
40#
41# Arguments
42# offset: Offset of the teams' list.
43# limit: Limit of teams on one page.
44# sort: Sort args.
45# The list of teams can be sorted by id and name.
46teams(offset: Int, limit: Int, sort: [SortArgInput!]): TeamsPage
47
48# Returns a project.
49#
50# Arguments
51# id: Id of a project.
52project(id: ID!): Project!
53
54# Returns a paginated list of projects.
55#
56# Arguments
57# offset: Offset of the projects' list.
58# limit: Limit of projects on one page.
59# sort: Sort args.
60# The list of projects can be sorted by id and name.
61# filter: Filter conditions for projects list.
62projects(
63offset: Int,
64limit: Int,
65sort: [SortArgInput!],
66filter: ProjectFilterInput
67): ProjectsPage!
68
69# Returns a paginated list of time off types.
70#
71# Arguments
72# limit: Limit of time off types on one page.
73# offset: Offset of the time off types' list.
74# sort: Sort args.
75# The list of time off types can be sorted by id and name.
76timeOffTypes(limit: Int, offset: Int, sort: [SortArgInput!]): TimeOffTypesPage
77
78# Arguments
79# sort: Sort args.
80# The list of time off balances can be sorted by periodStartDate and
81# periodEndDate.
82# filter: Filter conditions.
83timeOffBalances(
84sort: [SortArgInput!],
85filter: TimeOffBalanceFilterInput
86): TimeOffBalancesPage
87
88# Returns a paginated list of locations.
89#
90# Arguments
91# offset: Offset of the locations' list.
92# limit: Limit of locations on one page.
93# sort: Sort args.
94# The list of locations can be sorted by id and name.
95locations(offset: Int, limit: Int, sort: [SortArgInput!]): LocationsPage
96
97# Arguments
98# dateFrom: Date range start.
99# dateTo: Date range end.
100# timeOffTypeIds: Time-off type IDs.
101# offset: Offset of the Time-off Request Usage Statements' list.
102# limit: Limit of Time-off Request Usage Statements on one page.
103# sort: Sort args.
104# The list of time off request usage statements can be sorted by firstName and
105# lastName.
106# filter: Filter conditions.
107timeOffRequestUsageStatements(
108dateFrom: Date!,
109dateTo: Date!,
110timeOffTypeIds: [ID!]!,
111offset: Int,
112limit: Int,
113sort: [SortArgInput!],
114filter: UserFilterInput
115): TimeOffRequestUsageStatementsPage
116
117# Returns a paginated list of positions.
118#
119# Arguments
120# offset: Offset of the positions' list.
121# limit: Limit of positions on one page.
122# sort: Sort args.
123# The list of positions can be sorted by id and name.
124positions(offset: Int, limit: Int, sort: [SortArgInput!]): PositionsPage
125
126# Returns a custom field.
127#
128# Arguments
129# id: ID of the custom field.
130customField(id: ID!): CustomField
131
132# Returns a paginated list of custom fields.
133#
134# Arguments
135# offset: Offset of the custom fields' list.
136# limit: Limit of the custom fields on one page.
137# sort: Sort args.
138# The list of custom fields can be sorted by id, name, section, type.
139customFields(offset: Int, limit: Int, sort: [SortArgInput!]): CustomFieldsPage
140
141# Returns a timesheet for user id and given date.
142#
143# Arguments
144# userId: User's id.
145# date: Date.
146timesheet(userId: ID, date: Date!): Timesheet
147
148# Returns a paginated list of timesheets.
149#
150# Arguments
151# userId: User's id.
152# dateFrom: Date range start.
153# dateTo: Date range end.
154# offset: Offset of the timesheets' list.
155# limit: Limit of timesheets on one page.
156# sort: Sort args.
157# The list of timesheets can be sorted by date.
158timesheets(
159userId: ID,
160dateFrom: Date!,
161dateTo: Date!,
162offset: Int,
163limit: Int,
164sort: [SortArgInput!]
165): TimesheetsPage!
166
167# Returns an Attendance Statement.
168#
169# Arguments
170# userId: User's id.
171# dateFrom: Date range start.
172# dateTo: Date range end.
173attendanceStatement(userId: ID!, dateFrom: Date!, dateTo: Date!): AttendanceStatement
174
175# Returns a paginated list of Attendance Statements.
176#
177# Arguments
178# sort: Sort args.
179# The list of attendance statements can be sorted by firstName and lastName.
180# filter: Filter conditions.
181attendanceStatements(
182sort: [SortArgInput!],
183filter: AttendanceStatementFilterInput!
184): AttendanceStatementsPage
185
186# Returns a paginated list of Overtime Balance Transactions.
187#
188# Arguments
189# userId: User's id.
190# offset: Offset of the Overtime Balance Transactions' list.
191# limit: Limit of Overtime Balance Transactions on one page.
192# sort: Sort args.
193# The list of overtime balance transactions can be sorted by date.
194# filter: Filter conditions.
195overtimeBalanceTransactions(
196userId: ID!,
197offset: Int,
198limit: Int,
199sort: [SortArgInput!],
200filter: OvertimeBalanceTransactionsFilterInput
201): OvertimeBalanceTransactionPage
202
203# Returns a paginated list of Overtime Balance Statements.
204#
205# Arguments
206# offset: Offset of the Overtime Balance Statements' list.
207# limit: Limit of Overtime Balance Statements on one page.
208# sort: Sort args.
209# The list of overtime balance statements can be sorted by firstName, lastName,
210# date and balance.
211overtimeBalanceStatements(
212offset: Int,
213limit: Int,
214sort: [SortArgInput!]
215): OvertimeBalanceStatementsPage
216
217}

link Required by

This element is not required by anyone