-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
319 lines (313 loc) · 9.06 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
openapi: 3.0.0
info:
title: General API
description: >-
>
This is a description of the API.
# Authentication
## Token-based Authentication
One method of connecting to the API is to use a persistent access token that
is associated with a specific user account. This access token should be
passed using the Authorization header with each API request. For example, if
your Authentication Token was VnJexj4MzMhLilaLz7MdYFEKFRBmuBUAJMkDjOdTp, the
correct header would be:
```X-AUTH-TOKEN: VnJexj4MzMhLilaLz7MdYFEKFRBmuBUAJMkDjOdTp```
version: 0.3.0
x-api-status-urls:
- https://api.interviewstream.com/
servers:
- url: https://api.interviewstream.com
tags:
- name: RequisitionCandidate
- name: Requisitions
- name: Candidates
- name: Incoming Assessment
paths:
/incoming-assessment:
get:
tags:
- Incoming Assessment
operationId: IncomingAssessment_getData
parameters:
- description: ATS integration name
name: ats
in: query
required: true
style: form
schema:
type: string
- description: ID of the company
name: companyId
in: query
required: true
style: form
schema:
type: integer
format: int64
- description: ID of the Assessment Order
name: assessmentOrderId
in: query
required: true
style: form
schema:
type: integer
format: int64
responses:
'200':
description: >-
Perform an Incoming Assessment from the ATS SuccessFactors to IVS
application. This General API changes the status of an interview.
'400':
description: >-
Bad request: ATS, companyId, and assessmentOrderId are required. If
ATS is present, greenhouse is not supported yet
'404':
description: 'Not found: ATS was not found'
/candidates:
get:
tags:
- Candidates
summary: Returns a list of candidates that the API token has access to.
operationId: Candidates_listAccessible
security:
- HasApiKey: []
description: |2-
>
* Returns a list of candidates that the API token has access to.
responses:
'200':
description: Returns a list of candidates that the API token has access to.
'401':
description: Unauthenticated
'403':
description: Forbidden
'404':
description: Not Found
/candidates/{iCandidate}:
get:
tags:
- Candidates
summary: Gets a candidate by ID.
operationId: Candidates_getById
security:
- HasApiKey: []
description: |2-
>
* Returns detailed information about the specified Candidate.
parameters:
- description: Candidate ID
name: iCandidate
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: Returns detailed information about the specified Candidate.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/requisitions:
get:
tags:
- Requisitions
summary: Gets a list of Requisitions.
operationId: Requisitions_list
security:
- HasApiKey: []
description: |2-
>
* Returns a list of requisitions that the API token has access to.
responses:
'200':
description: Returns a list of requisitions that the API token has access to.
'401':
description: Unauthenticated
'403':
description: Forbidden
/requisitions/{iRequisition}:
get:
tags:
- Requisitions
summary: Gets a Requisition Candidate by ID.
operationId: Requisitions_getRequisitionCandidate
security:
- HasApiKey: []
description: |2-
>
* Returns detailed information about the specified Requisition.
parameters:
- description: Requisition ID
name: iRequisition
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: Returns detailed information about the specified Requisition.
'401':
description: Unauthorized
'403':
description: Forbidden
/requisitions/{iRequisition}/candidates:
get:
tags:
- Requisitions
summary: >-
Returns a list of RequisitionCandidates belonging to the specified
Requisition.
operationId: Requisitions_listCandidates
security:
- HasApiKey: []
description: |2-
>
* Returns a list of RequisitionCandidates belonging to the specified Requisition.
parameters:
- description: Requisition ID
name: iRequisition
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: >-
Returns a list of RequisitionCandidates belonging to the specified
Requisition.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/requisitionCandidates:
get:
tags:
- RequisitionCandidate
summary: >-
Returns a list of requisition candidates that the API token has access
to.
operationId: RequisitionCandidate_list
security:
- HasApiKey: []
description: |2-
>
* Returns a list of requisition candidates that the API token has access to.
responses:
'200':
description: >-
Returns a list of requisitions-candidates that the API token has
access to.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/requisitionCandidates/{iRequisitionCandidates}:
get:
tags:
- RequisitionCandidate
summary: Returns detailed information about the specified requisition candidates.
operationId: RequisitionCandidate_getDetails
security:
- HasApiKey: []
description: |2-
>
* Returns detailed information about the specified requisition candidates.
parameters:
- description: Requisition Candidate ID
name: iRequisitionCandidates
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: >-
Returns a list of requisitions-candidates that the API token has
access to.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/requisitionCandidates/{iRequisitionCandidates}/shareLinks:
get:
tags:
- RequisitionCandidate
summary: >-
Returns a list of RequisitionCandidateShareLinks belonging to this
RequisitionCandidate.
operationId: RequisitionCandidate_getShareLinks
security:
- HasApiKey: []
description: |2-
>
* Returns a list of RequisitionCandidateShareLinks belonging to this RequisitionCandidate.
parameters:
- description: Requisition Candidate ID
name: iRequisitionCandidates
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: >-
Returns a list of requisitions-candidates that the API token has
access to.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/requisitionCandidates/{iRequisitionCandidates}/requests:
get:
tags:
- RequisitionCandidate
summary: >-
Returns a list of RequisitionCandidateRequests belonging to this
RequisitionCandidate.
operationId: RequisitionCandidate_getRequests
security:
- HasApiKey: []
description: |2-
>
* Returns a list of RequisitionCandidateRequests belonging to this RequisitionCandidate.
parameters:
- description: Requisition Candidate ID
name: iRequisitionCandidates
in: path
required: true
style: form
schema:
type: integer
responses:
'200':
description: >-
Returns a list of requisitions-candidates that the API token has
access to.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
securitySchemes:
HasApiKey:
type: apiKey
name: X-AUTH-TOKEN
in: header