-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.json
21765 lines (21765 loc) · 694 KB
/
openapi.json
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"x-generator": "NSwag v13.6.2.0 (NJsonSchema v10.1.23.0 (Newtonsoft.Json v12.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "eTASK Universal BIM API",
"description": "# Welcome to the reference of the eTASK REST API\r\n\r\neTASK is an application for managing your real estate portfolio. You have access also via REST to your data. REST is a web-service protocol that enables an easy and rapid development by using everyday HTTP and JSON technology.\r\n\r\nThe eTASK REST API provides a broad set of operations and resources. The unified eTASK Universal BIM API enables you to create powerful real estate solutions for a variety of scenarios, e.g.\r\n\r\n* Access and share all information and documents\r\n* Navigate thour your BIM models\r\n* Drive your workflows\r\n* Integrate App on Android oder iOs Devices\r\n* Connect to you sensors or your favourite IoT Platform\r\n\r\nThis API offers a simple, fast and secure access, based on the OpenAPI specification. Write apps, integrate you data into other systems and digitize you workflow with the help of our API.\r\nEvery customer of eTASK has access to the API of the own instance based on the valid license model. In the cloud environment the API is available from the public internet.\r\nWant to share your opinion on how our API works for you? Tell us how you feel about using our API and what we can do to make it better.\r\n\r\n# Getting started\r\n*__Note__: If you need help using eTASK's APIs, then the best place to start is the issue list in the our [Github repository for the API](https://github.com/e-task/EtaskAPI). eTASK's support team for our application isn't able to answer questions about the API. Better, you contact the DEV team via GitHub, if you have a technical question.*\r\n\r\n## HTTP verbs\r\nWhere possible, the API strives to use the following HTTP verbs for each action.\r\n\r\n* __HEAD__ : Can be issued against any resource to get just the HTTP header info.\r\n* __GET__ : Used for retrieving resources.\r\n* __POST__ : Used for creating resources.\r\n* __PUT__ : Used for replacing resources or collections.\r\n* __DELETE__: Used for deleting resources.\r\n\r\n## Request Content-Type\r\nThe Content-Type for POST and PUT requests must be set to application/json, otherwise you may receive a bad request response.\r\n\r\n```\r\nContent-Type: application/json\r\n```\r\n\r\n## Encoding\r\nThe client must include in the header of every request this encoding: \r\n```\r\nAccept-Charset: utf-8\r\n```\r\nThe response will deliver every request in the encoding of UTF-8. \r\n\r\n## Encoding for URL parameters\r\nWhen using GET operation to fetch entries from a form via any REST client, URL parameters may be required. Examples of URL parameters are qualification (q), fields, limit and sort. While using any of these parameters with request URL, these must be encoded properly and then used in the request. Else results may not be as expected.\r\nTo encode URL parameters, use any third party tool or site such as https://www.w3schools.com/html/html_urlencode.asp, where non-encoded URL parameters can be converted into encoded URL parameter string. Use these encoded parameters to send a REST request.\r\n\r\nFor example, for sending qualification on a form like this: ```'Incident Number' = 'INC000000000701'``` the request should be encoded and sent like this: ```%27Incident+Number%27+%3D+%27INC000000000701%27```\r\n\r\n## Timezones\r\nWe apply the following rules, in order of priority, to determine timezone information for API calls. \r\n\r\n* Explicitly provide an ISO 8601 timestamp with timezone information. \r\n* For API calls that allow for a timestamp to be specified, we use that exact timestamp. \r\n* The provisioning of a timestamp in every field of type ```date``` or ```datetime``` is reqired in the API. \r\n* If, for whatever reason, there is no information about the timezone in the request, the API assumes the timezone '+01:00' in creating the answer. So, this request ```2019-02-27T15:05:06``` will be processed like this ```2019-02-27T15:05:06+01:00``` and the time information in the responses will be returned for the timezone '+01:00'.\r\n\r\n## HTTP Status Codes for Success and Errors\r\nThe response from eTASK will have an HTTP status code that will help you determine the status of the response. When an error occurs, our API will return an appropriate HTTP status code and an error message description. Our API uses the appropriate HTTP status code to indicate the type of success or the problem that was encountered. \r\n\r\nEvery ressource has documented HTTP status codes for the response with special meaning. Please check the documentation of the ressource you use.\r\n\r\nBelow is a general overview of what those codes mean, along with some suggestions that might help you fix things.\r\n\r\n* __200 Success__: The request has succeeded. The information returned with the response is dependent on the method used in the request.\r\n* __201 Created__: The request has been fulfilled and resulted in a new resource being created.\r\n* __400 Bad Request__: This is likely to be caused by a programming error on your part. Check the requirements of the endpoint you're calling in the HTTP API Reference.\r\n* __401 Unauthorized__: This means that we were not able to authenticate you based on the information provided in the request. Make sure you're sending your access_token and your credentials based on the security specification of our API. The section 'Authentication and API Keys' gives a detailed explanation of how this works. If you're connecting using OAuth, don't forget that tokens can expire. These will need to be refreshed. Not doing so can also result in getting a 401 error. If you need to check your application's system parameters page. This will include the token for your application.\r\n* __403 Forbidden__: You don't have access to whatever it is you're asking for.\r\n* __404 Not Found__: You're asking for something that doesn't exist. Check the URL that you're requesting.\r\n* __406 Not Accessible__: This means it wasn't possible to respond with the format you requested. Check the Accept header that you're sending.\r\n* __422 Unprocessable Entity__: The request was valid, but one or more of the parameters looks a little screwy. It's possible that you sent data in the wrong format. One example would be providing an array when we expected a string.\r\n* __429 Too Many Requests__: To keep the amount of spam on eTASK as low as possible, our API limits the rate at which you can perform certain actions. Read the Rate Limits page to find out more.\r\n* __500 Internal Server Error__: Uh-oh. Something went wrong on our side. We're sorry. We keep track of these, and we'll try to fix it! If possible, read the server log to get more information about this error.\r\n* __503 Service Unavailable__: This means that we're having some trouble, and our servers are too busy to handle your request. You'll want to check for these and give your user a chance to retry the request. We keep track of these and try to make sure they don't happen.\r\n* __504 Gateway Timeout__: This means the request is taking too long. However, it doesn't always mean that we didn't receive your request. We could still be chugging away on the changes you made, and this means that you may want to check before retrying.\r\n\r\n## Business rules\r\nMany ressources own specific business rules. Most of them can be requested in appendinge the element ```/Rules``` to the path of the ressource. The response will then be a list of the rules that shall be applied for the ressource. If the requests does not fulfill one of these rules, the response will contain the name of the violated rule and a notice that descibes the violation more in detail. In these situation you have to correct your request to fulfill with all rules.\r\n\r\n## Cross origin resource sharing\r\nThe API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. You can read the CORS W3C Recommendation, or this intro from the HTML 5 Security Guide.\r\nHere's a sample request sent from a browser hitting http://example.com:\r\n\r\n```\r\ncurl -iH \"Origin: http://example.com\" \"https://dotnet.etask.de/API/Core/Persons\"\r\nHTTP/1.1 302 Found\r\nAccess-Control-Allow-Origin: *\r\nAccess-Control-Expose-Headers: ETag, Link, X-Etask-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval\r\n```\r\n\r\nThis is what the CORS preflight request looks like:\r\n```\r\ncurl -iH \"Origin: http://example.com\" \"https://dotnet.etask.de/API/Core/Persons\" -X OPTIONS\r\nHTTP/1.1 204 No Content\r\nAccess-Control-Allow-Origin: *\r\nAccess-Control-Allow-Headers: Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, X-Etask-OTP, X-Requested-With\r\nAccess-Control-Allow-Methods: GET, POST, PATCH, PUT, DELETE\r\nAccess-Control-Expose-Headers: ETag, Link, X-Etask-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval\r\nAccess-Control-Max-Age: 86400\r\n```\r\n\r\n## <a name=\"ua-required\"></a>User agent required\r\nAll API requests MUST include a valid User-Agent header. Requests with no User-Agent header will be rejected. We request that you use your eTASK username, or the name of your application, for the User-Agent header value. This allows us to contact you if there are problems.\r\nHere's an example:\r\n\r\n```\r\nUser-Agent: My-Awesome-Etask-App\r\n```\r\n\r\ncURL sends a valid User-Agent header by default. If you provide an invalid User-Agent header via cURL (or via an alternative client), you will receive a 403 Forbidden response:\r\n\r\n```\r\ncurl -iH \"User-Agent: My-Awesome-Etask-App\" \"https://dotnet.etask.de/API/Core/Persons\"\r\nHTTP/1.0 403 Forbidden\r\nConnection: close\r\nContent-Type: text/html\r\nRequest forbidden by administrative rules.\r\nPlease make sure your request has a User-Agent header.\r\nCheck https://dotnet.etask.de/API for other possible causes.\r\n```\r\n\r\n## Conditional requests\r\nMost responses return an ETag header. Many responses also return a Last-Modified header. You can use the values of these headers to make subsequent requests to those resources using the If-None-Match and If-Modified-Since headers, respectively. If the resource has not changed, the server will return a 304 Not Modified.\r\nNote: Making a conditional request and receiving a 304 response does not count against your Rate Limit, so we encourage you to use it whenever possible.\r\n```\r\ncurl -i \"https://dotnet.etask.de/API/Core/Persons\"\r\n```\r\n\r\n```\r\nHTTP/1.1 200 OK\r\nCache-Control: private, max-age=60\r\nETag: '644b5b0155e6404a9cc4bd9d8b1ae730'\r\nLast-Modified: Thu, 05 Jul 2012 15:31:30 GMT\r\nStatus: 200 OK\r\nVary: Accept, Authorization, Cookie\r\nX-RateLimit-Limit: 5000\r\nX-RateLimit-Remaining: 4996\r\nX-RateLimit-Reset: 1372700873\r\n```\r\n```\r\ncurl -i \"https://dotnet.etask.de/API/Core/Persons\" -H \"If-None-Match: 644b5b0155e6404a9cc4bd9d8b1ae730\"\r\n```\r\n```\r\nHTTP/1.1 304 Not Modified\r\nCache-Control: private, max-age=60\r\nETag: '644b5b0155e6404a9cc4bd9d8b1ae730'\r\nLast-Modified: Thu, 05 Jul 2012 15:31:30 GMT\r\nStatus: 304 Not Modified\r\nVary: Accept, Authorization, Cookie\r\nX-RateLimit-Limit: 5000\r\nX-RateLimit-Remaining: 4996\r\nX-RateLimit-Reset: 1372700873\r\n```\r\n```\r\ncurl -i \"https://dotnet.etask.de/API/Core/Persons\" -H \"If-Modified-Since: Thu, 05 Jul 2012 15:31:30 GMT\"\r\n```\r\n```\r\nHTTP/1.1 304 Not Modified\r\nCache-Control: private, max-age=60\r\nLast-Modified: Thu, 05 Jul 2012 15:31:30 GMT\r\nStatus: 304 Not Modified\r\nVary: Accept, Authorization, Cookie\r\nX-RateLimit-Limit: 5000\r\nX-RateLimit-Remaining: 4996\r\nX-RateLimit-Reset: 1372700873\r\n```\r\n\r\n### Server URI\r\nThis API documentation uses the URI https://dotnet.etask.de/API as a placeholder for all other eTASK installations. Please replace https://dotnet.etask.de/API with the server URI of you eTASK installation. To try out the API, connect directly to your own eTASK installation or contact us to get access to a developer installation.\r\n\r\n### TLS connection required\r\nThe API requires connections based on Transport Layer Security (TLS), more known under it's predecessor designation Secure Sockets Layer (SSL). The API requires TLS 1.2. The server MUST provide a valid certificate, that is accepted by the client's computer. If the client's computer does not trust the certificate, the API will return a 403 Forbidden response:\r\n\r\n```\r\ncurl -iH \"User-Agent: My-Awesome-Etask-App\" \"https://dotnet.etask.de/API/\"\r\nHTTP/1.0 403 Forbidden\r\nConnection: close\r\nContent-Type: text/html\r\nRequest forbidden by administrative rules.\r\nPlease make sure your server provides a valid TLS certificate.\r\nCheck https://dotnet.etask.de/API for other possible causes.\r\n```\r\n\r\nRequests, that do not even use the https protocol will be automatically redirected to https.\r\n\r\n### Application Key\r\nEach application that wants to access the API needs an individual application key (e.g. your mobile App). Please visit our [customer portal](https://kundencenter.etask.de) to request an Application API key for your instance. In your submission, please be prepared to provide the following:\r\n*\tYour instance uri\r\n*\tThe 'live date' of your app and feature that integrates with the API. Briefly describe how the eTASK API integrates with your app and provide screenshots of the implementation.\r\n*\tAs per our section 5 A of our terms of service, we require all apps that use the eTASK API to conspicuously display 'Powered By eTASK' attribution marks where the API is utilized. You can find approved official logo marks here. Please provide screenshots of your attribution placement.\r\n\r\n### API token per user\r\n\r\nEvery request is secured by an user token that is created based on username and password with the ressource ```/Core/Login```. If the authentication was succesful, the API creates a key in the format of a Json Web Token (JWT). This token must be send in the header of every subsequent request (api_token). This ensures the security of all ressources and the compliance with the individual user rights per API ressource.\r\n\r\nTo obtain a user token, please call the following ressource:\r\n```\r\ncurl -iH \"User-Agent: My-Awesome-Etask-App\" \"https://dotnet.etask.de/API/Core/Login\"\r\n```\r\n\r\n## Ressource Names\r\nMost API endpoints provide the same content as their HTML counterparts in the related eTASK FM Portal. For example, the URL /rooms serves a list of rooms, the /api/rooms API provides the same information in JSON format. Please be aware, that the configuration of user rights and other UI related configuration of the FM-Portal can show less information, that the API.\r\n\r\n## Openapi file\r\nThe API is documented, based on the [specification](https://github.com/OAI/OpenAPI-Specification) of the [Openapi Initiative](https://www.openapis.org/) fka as Swagger.\r\n\r\nWe provide direct access to our [Openapi 3.0 file](/API/openapi/v1/openapi.json). Use it in you favourite API tool. \r\n\r\n## Thanks for reading until the end of the docs :-)\r\nIf you have any question, please feel free to contact us. Please submit API corrections via github issues. Please see our terms of service for any restrictions on using the service. We also recommend using the Postman or another client tool for restfull API’s view the API responses.\r\n\r\nWe are exited about what you will build upon our API. Have you made anything exciting? __Please share [here](https://twitter.com/etask)__.",
"contact": {
"name": "eTASK Immobilien Software GmbH",
"url": "https://etask.de",
"email": "api@etask.de"
},
"license": {
"name": "License",
"url": "https://www.etask.de/wp-content/uploads/eTASK_AGB.pdf"
},
"version": "2019"
},
"servers": [
{
"url": "https://dotnet.etask.de/API",
"description": "Local server"
}
],
"paths": {
"/Workplace/AllocationPersonnelToHseqFunctions": {
"get": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Fetch the list of all 'AllocationPersonnelToHseqFunctions'.",
"operationId": "AllocationPersonnelToHseqFunctions_GetAll",
"parameters": [
{
"name": "page",
"in": "query",
"description": "start page.",
"schema": {
"type": "integer",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 1.0,
"nullable": true
},
"x-position": 1
},
{
"name": "limit",
"in": "query",
"description": "limit of records per page.",
"schema": {
"type": "integer",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 1.0,
"nullable": true
},
"x-position": 2
},
{
"name": "expand",
"in": "query",
"description": "(optional) A csv list of all child properties to expand for this resource.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "returns a list of all items",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
}
}
}
},
"404": {
"description": "no 'AllocationPersonnelToHseqFunctions' found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"post": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Create a new 'AllocationPersonnelToHseqFunction'.",
"operationId": "AllocationPersonnelToHseqFunctions_Create",
"requestBody": {
"x-name": "item",
"description": "The 'AllocationPersonnelToHseqFunction' to create.",
"content": {
"application/json": {
"schema": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
]
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "creates a 'AllocationPersonnelToHseqFunction' and returns the new item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
}
}
},
"400": {
"description": "if given 'AllocationPersonnelToHseqFunction' is invalid"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/Workplace/AllocationPersonnelToHseqFunctions/{guid}": {
"get": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Fetch a 'AllocationPersonnelToHseqFunction' by the global identifier.",
"operationId": "AllocationPersonnelToHseqFunctions_GetByGuid",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "expand",
"in": "query",
"description": "(optional) The csv list of properties to expand in result.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "returns an item specified by given identifier",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
}
}
},
"404": {
"description": "'AllocationPersonnelToHseqFunction' not found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
},
"400": {
"description": "Parameter missing 'guid'"
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"delete": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Delete a 'AllocationPersonnelToHseqFunction' by given global identifier",
"operationId": "AllocationPersonnelToHseqFunctions_Delete",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "'AllocationPersonnelToHseqFunction' by given identifier was deleted"
},
"400": {
"description": "'AllocationPersonnelToHseqFunction' could not be delete"
},
"500": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Exception"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"put": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Update an specified 'AllocationPersonnelToHseqFunction' by given global identifier.",
"operationId": "AllocationPersonnelToHseqFunctions_Update",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "item",
"description": "The 'AllocationPersonnelToHseqFunction' to update.",
"content": {
"application/json": {
"schema": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
]
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "updates an specified 'AllocationPersonnelToHseqFunction' by given identifier",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllocationPersonnelToHseqFunction"
}
}
}
},
"404": {
"description": "'AllocationPersonnelToHseqFunction' not found!"
},
"400": {
"description": "if 'AllocationPersonnelToHseqFunction' is not valid"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Exception"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/Workplace/AllocationPersonnelToHseqFunctions/Count": {
"get": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "Fetch the total count of 'AllocationPersonnelToHseqFunctions'.",
"operationId": "AllocationPersonnelToHseqFunctions_GetCount",
"responses": {
"200": {
"description": "returns a count of items",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"404": {
"description": "no 'AllocationPersonnelToHseqFunctions' found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/Workplace/AllocationPersonnelToHseqFunctions/{guid}/Download/{filename}": {
"get": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "TODO",
"operationId": "AllocationPersonnelToHseqFunctions_Download",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "filename",
"in": "path",
"required": true,
"description": "filename",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"404": {
"description": "item or file not found"
},
"200": {
"description": "returns one file specified filename of an item specified by guid",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/Workplace/AllocationPersonnelToHseqFunctions/{guid}/Documents": {
"get": {
"tags": [
"Workplace.AllocationPersonnelToHseqFunctions"
],
"summary": "TODO",
"operationId": "AllocationPersonnelToHseqFunctions_Documents",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "returns all documents (without content) of an item specified by guid",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/WorkflowEngine/Substitutes": {
"get": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Fetch the list of all 'Substitutes'.",
"operationId": "Substitutes_GetAll",
"parameters": [
{
"name": "page",
"in": "query",
"description": "start page.",
"schema": {
"type": "integer",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 1.0,
"nullable": true
},
"x-position": 1
},
{
"name": "limit",
"in": "query",
"description": "limit of records per page.",
"schema": {
"type": "integer",
"format": "int32",
"maximum": 2147483647.0,
"minimum": 1.0,
"nullable": true
},
"x-position": 2
},
{
"name": "expand",
"in": "query",
"description": "(optional) A csv list of all child properties to expand for this resource.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "returns a list of all items",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Substitute"
}
}
}
}
},
"404": {
"description": "no 'Substitutes' found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"post": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Create a new 'Substitute'.",
"operationId": "Substitutes_Create",
"requestBody": {
"x-name": "item",
"description": "The 'Substitute' to create.",
"content": {
"application/json": {
"schema": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Substitute"
}
]
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"201": {
"description": "creates a 'Substitute' and returns the new item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Substitute"
}
}
}
},
"400": {
"description": "if given 'Substitute' is invalid"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/WorkflowEngine/Substitutes/{guid}": {
"get": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Fetch a 'Substitute' by the global identifier.",
"operationId": "Substitutes_GetByGuid",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
},
{
"name": "expand",
"in": "query",
"description": "(optional) The csv list of properties to expand in result.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "returns an item specified by given identifier",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Substitute"
}
}
}
},
"404": {
"description": "'Substitute' not found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
},
"400": {
"description": "Parameter missing 'guid'"
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"delete": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Delete a 'Substitute' by given global identifier",
"operationId": "Substitutes_Delete",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "'Substitute' by given identifier was deleted"
},
"400": {
"description": "'Substitute' could not be delete"
},
"500": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Exception"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
},
"put": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Update an specified 'Substitute' by given global identifier.",
"operationId": "Substitutes_Update",
"parameters": [
{
"name": "guid",
"in": "path",
"required": true,
"description": "global identifier (GUID/UUID)",
"schema": {
"type": "string",
"format": "guid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "item",
"description": "The 'Substitute' to update.",
"content": {
"application/json": {
"schema": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Substitute"
}
]
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "updates an specified 'Substitute' by given identifier",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Substitute"
}
}
}
},
"404": {
"description": "'Substitute' not found!"
},
"400": {
"description": "if 'Substitute' is not valid"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Exception"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/WorkflowEngine/Substitutes/Count": {
"get": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Fetch the total count of 'Substitutes'.",
"operationId": "Substitutes_GetCount",
"responses": {
"200": {
"description": "returns a count of items",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"404": {
"description": "no 'Substitutes' found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/WorkflowEngine/Substitutes/ByPerson/{login}": {
"get": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Fetches all 'Substitute' for Person.",
"operationId": "Substitutes_GetByLogin",
"parameters": [
{
"name": "login",
"in": "path",
"required": true,
"description": "The login name.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "expand",
"in": "query",
"description": "(optional) The csv list of properties to expand in result.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "returns a list of all Substitutes for user",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Substitute"
}
}
}
}
},
"404": {
"description": "no 'Substitute' found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/WorkflowEngine/Substitutes/SubstitutedPersonsByLogin/{login}": {
"get": {
"tags": [
"WorkflowEngine.Substitutes"
],
"summary": "Get substituted persons by loginname",
"operationId": "Substitutes_GetSubstitutedPersonsByLogin",
"parameters": [
{
"name": "login",
"in": "path",
"required": true,
"description": "The login.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "expand",
"in": "query",
"description": "List of related objects, that shall be returned additionally",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Returns a list of all persons for whom the user is listed as a substitute.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Substitute"
}
}
}
}
},
"404": {
"description": "no person found!"
},
"401": {
"description": "Unauthorized, the EtaskApiToken is missing or invalid (expired)"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/ProjectManagement/TimeRecording/Employee": {
"get": {
"tags": [
"ProjectManagement.TimeRecording"
],
"summary": "Returns the employee data record of the logged in user.",
"operationId": "TimeRecording_GetEmployee",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeDto"
}
}
}
},
"500": {
"description": "Not specified in more detail, see message for more information"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/ProjectManagement/TimeRecording/Timesheet": {
"get": {
"tags": [
"ProjectManagement.TimeRecording"
],
"summary": "Delivers the one time sheet including hour entries for the current day",
"operationId": "TimeRecording_GetEmployeeTimesheetOfToday",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimesheetDto"
}
}
}
},
"404": {
"description": "No timesheet for today has been started yet"
},
"500": {
"description": "Not specified in more detail, see message for more information"
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/ProjectManagement/TimeRecording/Timesheet/WorkDescriptions": {
"get": {
"tags": [
"ProjectManagement.TimeRecording"
],
"summary": "Returns the list of the hour entries of today's time sheet.",
"operationId": "TimeRecording_GetTimesheetWorkDescriptionsOfDate",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkDescriptionDto"
}
}
}
}
},
"404": {
"description": "No timesheet or work description found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
},
"500": {
"description": "Not specified in more detail, see message for more information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiException"
}
}
}
}
},
"security": [
{
"EtaskApiToken": []
}
]
}
},
"/ProjectManagement/TimeRecording/Timesheet/StartDay": {
"put": {