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
48collections(
49scope: CollectionScope,
50type: CollectionType,
51offset: Int,
52limit: Int,
53sort: [SortArgInput!]
54): CollectionsPage
55
56userCollections(
57type: CollectionType,
58userId: ID!,
59offset: Int,
60limit: Int,
61sort: [SortArgInput!]
62): CollectionsPage
63
64collection(id: ID!): Collection
65
66collectionItem(id: ID!): CollectionItem
67
68userScopeCollectionItems(
69collectionId: ID,
70offset: Int,
71limit: Int,
72sort: [CollectionItemSortArgInput!],
73filter: UserScopeCollectionItemFilterInput
74): CollectionItemsPage
75
76# Returns a project.
77#
78# Arguments
79# id: Id of a project.
80project(id: ID!): Project!
81
82# Returns a paginated list of projects.
83#
84# Arguments
85# offset: Offset of the projects' list.
86# limit: Limit of projects on one page.
87# sort: Sort args.
88# The list of projects can be sorted by id and name.
89# filter: Filter conditions for projects list.
90projects(
91offset: Int,
92limit: Int,
93sort: [SortArgInput!],
94filter: ProjectFilterInput
95): ProjectsPage!
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 time off types.
118#
119# Arguments
120# limit: Limit of time off types on one page.
121# offset: Offset of the time off types' list.
122# sort: Sort args.
123# The list of time off types can be sorted by id and name.
124timeOffTypes(limit: Int, offset: Int, sort: [SortArgInput!]): TimeOffTypesPage
125
126# Arguments
127# sort: Sort args.
128# The list of time off balances can be sorted by periodStartDate and
129# periodEndDate.
130# filter: Filter conditions.
131timeOffBalances(
132sort: [SortArgInput!],
133filter: TimeOffBalanceFilterInput
134): TimeOffBalancesPage
135
136# Returns a paginated list of locations.
137#
138# Arguments
139# offset: Offset of the locations' list.
140# limit: Limit of locations on one page.
141# sort: Sort args.
142# The list of locations can be sorted by id and name.
143locations(offset: Int, limit: Int, sort: [SortArgInput!]): LocationsPage
144
145# Get journey template.
146#
147# Arguments
148# id: Journey template id.
149journeyTemplate(id: ID!): JourneyTemplate
150
151# Get journey.
152#
153# Arguments
154# id: Journey id.
155journey(id: ID!): Journey
156
157# List of journeys.
158#
159# Arguments
160# filter: Filter for journeys.
161# offset: Offset of the journeys' list.
162# limit: Limit of journeys on one page.
163# sort: Sort args.
164journeys(
165filter: JourneysFilterInput,
166offset: Int,
167limit: Int,
168sort: [SortArgInput!]
169): JourneysPage
170
171# List of journey templates.
172#
173# Arguments
174# filter: Filter for journey templates.
175# offset: Offset of the journey templates' list.
176# limit: Limit of journey templates on one page.
177# sort: Sort args.
178journeyTemplates(
179filter: JourneyTemplatesFilterInput,
180offset: Int,
181limit: Int,
182sort: [SortArgInput!]
183): JourneyTemplatesPage
184
185# Returns a paginated list of journey types.
186#
187# Arguments
188# limit: Limit of journey types on one page.
189# offset: Offset of the journey types' list.
190# sort: Sort args.
191# accessLevel: Access level to filter journey types by.
192journeyTypes(
193limit: Int,
194offset: Int,
195sort: [SortArgInput!],
196accessLevel: AccessLevel
197): JourneyTypesPage
198
199# Returns a paginated list of positions.
200#
201# Arguments
202# offset: Offset of the positions' list.
203# limit: Limit of positions on one page.
204# sort: Sort args.
205# The list of positions can be sorted by id and name.
206positions(offset: Int, limit: Int, sort: [SortArgInput!]): PositionsPage
207
208# Returns a custom field.
209#
210# Arguments
211# id: ID of the custom field.
212customField(id: ID!): CustomField
213
214# Returns a paginated list of custom fields.
215#
216# Arguments
217# offset: Offset of the custom fields' list.
218# limit: Limit of the custom fields on one page.
219# sort: Sort args.
220# The list of custom fields can be sorted by id, name, section, type.
221customFields(offset: Int, limit: Int, sort: [SortArgInput!]): CustomFieldsPage
222
223# Returns a timesheet for user id and given date.
224#
225# Arguments
226# userId: User's id.
227# date: Date.
228timesheet(userId: ID, date: Date!): Timesheet
229
230# Returns a paginated list of timesheets.
231#
232# Arguments
233# userId: User's id.
234# dateFrom: Date range start.
235# dateTo: Date range end.
236# offset: Offset of the timesheets' list.
237# limit: Limit of timesheets on one page.
238# sort: Sort args.
239# The list of timesheets can be sorted by date.
240timesheets(
241userId: ID,
242dateFrom: Date!,
243dateTo: Date!,
244offset: Int,
245limit: Int,
246sort: [SortArgInput!]
247): TimesheetsPage!
248
249# Returns an Attendance Statement.
250#
251# Arguments
252# userId: User's id.
253# dateFrom: Date range start.
254# dateTo: Date range end.
255attendanceStatement(userId: ID!, dateFrom: Date!, dateTo: Date!): AttendanceStatement
256
257# Returns a paginated list of Attendance Statements.
258#
259# Arguments
260# sort: Sort args.
261# The list of attendance statements can be sorted by firstName and lastName.
262# filter: Filter conditions.
263attendanceStatements(
264sort: [SortArgInput!],
265filter: AttendanceStatementFilterInput!
266): AttendanceStatementsPage
267
268# Returns a paginated list of Overtime Balance Transactions.
269#
270# Arguments
271# userId: User's id.
272# offset: Offset of the Overtime Balance Transactions' list.
273# limit: Limit of Overtime Balance Transactions on one page.
274# sort: Sort args.
275# The list of overtime balance transactions can be sorted by date.
276# filter: Filter conditions.
277overtimeBalanceTransactions(
278userId: ID!,
279offset: Int,
280limit: Int,
281sort: [SortArgInput!],
282filter: OvertimeBalanceTransactionsFilterInput
283): OvertimeBalanceTransactionPage
284
285# Returns a paginated list of Overtime Balance Statements.
286#
287# Arguments
288# offset: Offset of the Overtime Balance Statements' list.
289# limit: Limit of Overtime Balance Statements on one page.
290# sort: Sort args.
291# The list of overtime balance statements can be sorted by firstName, lastName,
292# date and balance.
293overtimeBalanceStatements(
294offset: Int,
295limit: Int,
296sort: [SortArgInput!]
297): OvertimeBalanceStatementsPage
298
299}

link Required by

This element is not required by anyone