github.com/thetreep/go-swagger@v0.0.0-20240223100711-35af64f14f01/fixtures/bugs/2969/2969.json (about) 1 { 2 "swagger" : "2.0", 3 "info" : { 4 "version" : "2.6", 5 "title" : "Talend Management Console Public API" 6 }, 7 "basePath" : "/tmc/v2.6", 8 "tags" : [ { 9 "name" : "account :: subscription " 10 }, { 11 "name" : "artifacts" 12 }, { 13 "name" : "connections" 14 }, { 15 "name" : "environments" 16 }, { 17 "name" : "executions" 18 }, { 19 "name" : "executions :: logs" 20 }, { 21 "name" : "plans :: executables" 22 }, { 23 "name" : "plans :: executions" 24 }, { 25 "name" : "projects" 26 }, { 27 "name" : "projects :: authorization" 28 }, { 29 "name" : "promotions :: executables" 30 }, { 31 "name" : "promotions :: executables :: authorization" 32 }, { 33 "name" : "promotions :: executions" 34 }, { 35 "name" : "resources" 36 }, { 37 "name" : "runtime :: clusters" 38 }, { 39 "name" : "runtime :: clusters :: run-profiles" 40 }, { 41 "name" : "runtime :: engines" 42 }, { 43 "name" : "runtime :: engines :: run-profiles" 44 }, { 45 "name" : "runtime :: pipeline engines" 46 }, { 47 "name" : "runtime :: pipeline engines :: run profiles" 48 }, { 49 "name" : "runtime :: pipeline engines :: run profiles :: advanced" 50 }, { 51 "name" : "runtime :: pipeline engines :: run profiles :: big-data" 52 }, { 53 "name" : "runtime :: pipeline engines :: run profiles :: data-integration" 54 }, { 55 "name" : "runtime :: pipeline engines :: run profiles :: databricks" 56 }, { 57 "name" : "runtime :: pipeline engines :: run profiles :: standard" 58 }, { 59 "name" : "schedules" 60 }, { 61 "name" : "tasks" 62 }, { 63 "name" : "workspaces" 64 }, { 65 "name" : "workspaces :: permissions" 66 } ], 67 "paths" : { 68 "/artifacts" : { 69 "get" : { 70 "tags" : [ "artifacts" ], 71 "summary" : "Get available Artifacts", 72 "description" : "Get available Artifacts", 73 "operationId" : "getArtifactsAvailable", 74 "produces" : [ "application/json" ], 75 "parameters" : [ { 76 "name" : "name", 77 "in" : "query", 78 "description" : "artifact name filter", 79 "required" : false, 80 "type" : "string" 81 }, { 82 "name" : "workspaceId", 83 "in" : "query", 84 "description" : "workspace id", 85 "required" : false, 86 "type" : "string" 87 }, { 88 "name" : "environmentId", 89 "in" : "query", 90 "description" : "environment id", 91 "required" : false, 92 "type" : "string" 93 }, { 94 "name" : "limit", 95 "in" : "query", 96 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 97 "required" : false, 98 "type" : "integer", 99 "format" : "int32" 100 }, { 101 "name" : "offset", 102 "in" : "query", 103 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 104 "required" : false, 105 "type" : "integer", 106 "format" : "int32" 107 } ], 108 "responses" : { 109 "200" : { 110 "description" : "Successful response", 111 "schema" : { 112 "$ref" : "#/definitions/Page" 113 } 114 }, 115 "400" : { 116 "description" : "Bad Request", 117 "schema" : { 118 "$ref" : "#/definitions/ErrorResponse" 119 } 120 }, 121 "401" : { 122 "description" : "Unauthorized", 123 "schema" : { 124 "$ref" : "#/definitions/ErrorResponse" 125 } 126 }, 127 "403" : { 128 "description" : "Forbidden - no permissions to access resource", 129 "schema" : { 130 "$ref" : "#/definitions/ErrorResponse" 131 } 132 }, 133 "404" : { 134 "description" : "Not found - resource not found", 135 "schema" : { 136 "$ref" : "#/definitions/ErrorResponse" 137 } 138 }, 139 "500" : { 140 "description" : "Server error - something went wrong on server side", 141 "schema" : { 142 "$ref" : "#/definitions/ErrorResponse" 143 } 144 } 145 }, 146 "security" : [ { 147 "Authorization" : [ ] 148 } ] 149 } 150 }, 151 "/artifacts/{id}" : { 152 "get" : { 153 "tags" : [ "artifacts" ], 154 "summary" : "Get Artifact by id", 155 "description" : "Get Artifact by id", 156 "operationId" : "getArtifact", 157 "produces" : [ "application/json" ], 158 "parameters" : [ { 159 "name" : "id", 160 "in" : "path", 161 "description" : "artifact id", 162 "required" : true, 163 "type" : "string" 164 } ], 165 "responses" : { 166 "200" : { 167 "description" : "OK", 168 "schema" : { 169 "$ref" : "#/definitions/Artifact" 170 } 171 }, 172 "400" : { 173 "description" : "Bad Request", 174 "schema" : { 175 "$ref" : "#/definitions/ErrorResponse" 176 } 177 }, 178 "401" : { 179 "description" : "Unauthorized", 180 "schema" : { 181 "$ref" : "#/definitions/ErrorResponse" 182 } 183 }, 184 "403" : { 185 "description" : "Forbidden", 186 "schema" : { 187 "$ref" : "#/definitions/ErrorResponse" 188 } 189 }, 190 "404" : { 191 "description" : "Not Found", 192 "schema" : { 193 "$ref" : "#/definitions/ErrorResponse" 194 } 195 }, 196 "500" : { 197 "description" : "Internal Server Error", 198 "schema" : { 199 "$ref" : "#/definitions/ErrorResponse" 200 } 201 } 202 }, 203 "security" : [ { 204 "Authorization" : [ ] 205 } ] 206 }, 207 "delete" : { 208 "tags" : [ "artifacts" ], 209 "summary" : "Delete Artifact by id", 210 "description" : "Delete Artifact by id", 211 "operationId" : "deleteArtifact", 212 "parameters" : [ { 213 "name" : "id", 214 "in" : "path", 215 "description" : "artifact id", 216 "required" : true, 217 "type" : "string" 218 } ], 219 "responses" : { 220 "204" : { 221 "description" : "No content" 222 }, 223 "400" : { 224 "description" : "Bad Request", 225 "schema" : { 226 "$ref" : "#/definitions/ErrorResponse" 227 } 228 }, 229 "401" : { 230 "description" : "Unauthorized", 231 "schema" : { 232 "$ref" : "#/definitions/ErrorResponse" 233 } 234 }, 235 "403" : { 236 "description" : "Forbidden", 237 "schema" : { 238 "$ref" : "#/definitions/ErrorResponse" 239 } 240 }, 241 "404" : { 242 "description" : "Not Found", 243 "schema" : { 244 "$ref" : "#/definitions/ErrorResponse" 245 } 246 }, 247 "409" : { 248 "description" : "Conflict", 249 "schema" : { 250 "$ref" : "#/definitions/ErrorResponse" 251 } 252 }, 253 "500" : { 254 "description" : "Internal Server Error", 255 "schema" : { 256 "$ref" : "#/definitions/ErrorResponse" 257 } 258 } 259 }, 260 "security" : [ { 261 "Authorization" : [ ] 262 } ] 263 } 264 }, 265 "/artifacts/{id}/versions/{version}" : { 266 "get" : { 267 "tags" : [ "artifacts" ], 268 "summary" : "Get Artifact of a specified version", 269 "description" : "Get Artifact of a specified version", 270 "operationId" : "getArtifactOfVersion", 271 "produces" : [ "application/json" ], 272 "parameters" : [ { 273 "name" : "id", 274 "in" : "path", 275 "description" : "artifact id", 276 "required" : true, 277 "type" : "string" 278 }, { 279 "name" : "version", 280 "in" : "path", 281 "description" : "artifact version", 282 "required" : true, 283 "type" : "string" 284 } ], 285 "responses" : { 286 "200" : { 287 "description" : "OK", 288 "schema" : { 289 "$ref" : "#/definitions/ArtifactVersion" 290 } 291 }, 292 "400" : { 293 "description" : "Bad Request", 294 "schema" : { 295 "$ref" : "#/definitions/ErrorResponse" 296 } 297 }, 298 "401" : { 299 "description" : "Unauthorized", 300 "schema" : { 301 "$ref" : "#/definitions/ErrorResponse" 302 } 303 }, 304 "403" : { 305 "description" : "Forbidden", 306 "schema" : { 307 "$ref" : "#/definitions/ErrorResponse" 308 } 309 }, 310 "404" : { 311 "description" : "Not Found", 312 "schema" : { 313 "$ref" : "#/definitions/ErrorResponse" 314 } 315 }, 316 "500" : { 317 "description" : "Internal Server Error", 318 "schema" : { 319 "$ref" : "#/definitions/ErrorResponse" 320 } 321 } 322 }, 323 "security" : [ { 324 "Authorization" : [ ] 325 } ] 326 }, 327 "delete" : { 328 "tags" : [ "artifacts" ], 329 "summary" : "Delete Artifact of a specified version", 330 "description" : "Delete Artifact of a specified version", 331 "operationId" : "deleteArtifactOfVersion", 332 "parameters" : [ { 333 "name" : "id", 334 "in" : "path", 335 "description" : "artifact id", 336 "required" : true, 337 "type" : "string" 338 }, { 339 "name" : "version", 340 "in" : "path", 341 "description" : "artifact version", 342 "required" : true, 343 "type" : "string" 344 } ], 345 "responses" : { 346 "204" : { 347 "description" : "No content" 348 }, 349 "400" : { 350 "description" : "Bad Request", 351 "schema" : { 352 "$ref" : "#/definitions/ErrorResponse" 353 } 354 }, 355 "401" : { 356 "description" : "Unauthorized", 357 "schema" : { 358 "$ref" : "#/definitions/ErrorResponse" 359 } 360 }, 361 "403" : { 362 "description" : "Forbidden", 363 "schema" : { 364 "$ref" : "#/definitions/ErrorResponse" 365 } 366 }, 367 "404" : { 368 "description" : "Not Found", 369 "schema" : { 370 "$ref" : "#/definitions/ErrorResponse" 371 } 372 }, 373 "409" : { 374 "description" : "Conflict", 375 "schema" : { 376 "$ref" : "#/definitions/ErrorResponse" 377 } 378 }, 379 "500" : { 380 "description" : "Internal Server Error", 381 "schema" : { 382 "$ref" : "#/definitions/ErrorResponse" 383 } 384 } 385 }, 386 "security" : [ { 387 "Authorization" : [ ] 388 } ] 389 } 390 }, 391 "/connections" : { 392 "get" : { 393 "tags" : [ "connections" ], 394 "summary" : "Get available Connections", 395 "description" : "", 396 "operationId" : "getConnectionsPage", 397 "produces" : [ "application/json" ], 398 "parameters" : [ { 399 "name" : "name", 400 "in" : "query", 401 "required" : false, 402 "type" : "string" 403 }, { 404 "name" : "limit", 405 "in" : "query", 406 "required" : false, 407 "type" : "integer", 408 "default" : 100, 409 "format" : "int32" 410 }, { 411 "name" : "offset", 412 "in" : "query", 413 "required" : false, 414 "type" : "integer", 415 "default" : 0, 416 "format" : "int32" 417 } ], 418 "responses" : { 419 "200" : { 420 "description" : "OK", 421 "schema" : { 422 "$ref" : "#/definitions/Page" 423 } 424 }, 425 "400" : { 426 "description" : "Bad Request", 427 "schema" : { 428 "$ref" : "#/definitions/ErrorResponse" 429 } 430 }, 431 "401" : { 432 "description" : "Unauthorized", 433 "schema" : { 434 "$ref" : "#/definitions/ErrorResponse" 435 } 436 }, 437 "403" : { 438 "description" : "Forbidden", 439 "schema" : { 440 "$ref" : "#/definitions/ErrorResponse" 441 } 442 }, 443 "404" : { 444 "description" : "Not Found", 445 "schema" : { 446 "$ref" : "#/definitions/ErrorResponse" 447 } 448 }, 449 "500" : { 450 "description" : "Internal Server Error", 451 "schema" : { 452 "$ref" : "#/definitions/ErrorResponse" 453 } 454 } 455 }, 456 "security" : [ { 457 "Authorization" : [ ] 458 } ] 459 }, 460 "post" : { 461 "tags" : [ "connections" ], 462 "summary" : "Create a Connection", 463 "description" : "", 464 "operationId" : "createConnection", 465 "consumes" : [ "application/json" ], 466 "produces" : [ "application/json" ], 467 "parameters" : [ { 468 "in" : "body", 469 "name" : "body", 470 "required" : true, 471 "schema" : { 472 "$ref" : "#/definitions/CreateConnectionRequest" 473 } 474 } ], 475 "responses" : { 476 "200" : { 477 "description" : "successful operation", 478 "schema" : { 479 "$ref" : "#/definitions/ConnectionDetails" 480 } 481 }, 482 "201" : { 483 "description" : "Created successfully", 484 "schema" : { 485 "$ref" : "#/definitions/ConnectionDetails" 486 } 487 }, 488 "400" : { 489 "description" : "Bad Request", 490 "schema" : { 491 "$ref" : "#/definitions/ErrorResponse" 492 } 493 }, 494 "401" : { 495 "description" : "Unauthorized", 496 "schema" : { 497 "$ref" : "#/definitions/ErrorResponse" 498 } 499 }, 500 "403" : { 501 "description" : "Forbidden", 502 "schema" : { 503 "$ref" : "#/definitions/ErrorResponse" 504 } 505 }, 506 "409" : { 507 "description" : "Connection name already exists", 508 "schema" : { 509 "$ref" : "#/definitions/ErrorResponse" 510 } 511 }, 512 "500" : { 513 "description" : "Internal Server Error", 514 "schema" : { 515 "$ref" : "#/definitions/ErrorResponse" 516 } 517 } 518 }, 519 "security" : [ { 520 "Authorization" : [ ] 521 } ] 522 } 523 }, 524 "/connections/{id}" : { 525 "get" : { 526 "tags" : [ "connections" ], 527 "summary" : "Get a Connection details", 528 "description" : "", 529 "operationId" : "getConnectionDetails", 530 "produces" : [ "application/json" ], 531 "parameters" : [ { 532 "name" : "id", 533 "in" : "path", 534 "required" : true, 535 "type" : "string" 536 } ], 537 "responses" : { 538 "200" : { 539 "description" : "OK", 540 "schema" : { 541 "$ref" : "#/definitions/ConnectionDetails" 542 } 543 }, 544 "400" : { 545 "description" : "Bad Request", 546 "schema" : { 547 "$ref" : "#/definitions/ErrorResponse" 548 } 549 }, 550 "401" : { 551 "description" : "Unauthorized", 552 "schema" : { 553 "$ref" : "#/definitions/ErrorResponse" 554 } 555 }, 556 "403" : { 557 "description" : "Forbidden", 558 "schema" : { 559 "$ref" : "#/definitions/ErrorResponse" 560 } 561 }, 562 "404" : { 563 "description" : "Not Found", 564 "schema" : { 565 "$ref" : "#/definitions/ErrorResponse" 566 } 567 }, 568 "500" : { 569 "description" : "Internal Server Error", 570 "schema" : { 571 "$ref" : "#/definitions/ErrorResponse" 572 } 573 } 574 }, 575 "security" : [ { 576 "Authorization" : [ ] 577 } ] 578 }, 579 "put" : { 580 "tags" : [ "connections" ], 581 "summary" : "Update a Connection", 582 "description" : "", 583 "operationId" : "updateConnection", 584 "consumes" : [ "application/json" ], 585 "produces" : [ "application/json" ], 586 "parameters" : [ { 587 "name" : "id", 588 "in" : "path", 589 "required" : true, 590 "type" : "string" 591 }, { 592 "in" : "body", 593 "name" : "body", 594 "required" : true, 595 "schema" : { 596 "$ref" : "#/definitions/UpdateConnectionRequest" 597 } 598 } ], 599 "responses" : { 600 "200" : { 601 "description" : "Updated", 602 "schema" : { 603 "$ref" : "#/definitions/ConnectionDetails" 604 } 605 }, 606 "400" : { 607 "description" : "Bad Request", 608 "schema" : { 609 "$ref" : "#/definitions/ErrorResponse" 610 } 611 }, 612 "401" : { 613 "description" : "Unauthorized", 614 "schema" : { 615 "$ref" : "#/definitions/ErrorResponse" 616 } 617 }, 618 "403" : { 619 "description" : "Forbidden", 620 "schema" : { 621 "$ref" : "#/definitions/ErrorResponse" 622 } 623 }, 624 "404" : { 625 "description" : "Not Found", 626 "schema" : { 627 "$ref" : "#/definitions/ErrorResponse" 628 } 629 }, 630 "409" : { 631 "description" : "Connection name already exists", 632 "schema" : { 633 "$ref" : "#/definitions/ErrorResponse" 634 } 635 }, 636 "500" : { 637 "description" : "Internal Server Error", 638 "schema" : { 639 "$ref" : "#/definitions/ErrorResponse" 640 } 641 } 642 }, 643 "security" : [ { 644 "Authorization" : [ ] 645 } ] 646 }, 647 "delete" : { 648 "tags" : [ "connections" ], 649 "summary" : "Delete a Connection", 650 "description" : "", 651 "operationId" : "deleteConnection", 652 "produces" : [ "application/json" ], 653 "parameters" : [ { 654 "name" : "id", 655 "in" : "path", 656 "required" : true, 657 "type" : "string" 658 } ], 659 "responses" : { 660 "204" : { 661 "description" : "No Content" 662 }, 663 "400" : { 664 "description" : "Bad Request", 665 "schema" : { 666 "$ref" : "#/definitions/ErrorResponse" 667 } 668 }, 669 "401" : { 670 "description" : "Unauthorized", 671 "schema" : { 672 "$ref" : "#/definitions/ErrorResponse" 673 } 674 }, 675 "403" : { 676 "description" : "Forbidden", 677 "schema" : { 678 "$ref" : "#/definitions/ErrorResponse" 679 } 680 }, 681 "404" : { 682 "description" : "Not Found", 683 "schema" : { 684 "$ref" : "#/definitions/ErrorResponse" 685 } 686 }, 687 "409" : { 688 "description" : "Connection is in use", 689 "schema" : { 690 "$ref" : "#/definitions/ErrorResponse" 691 } 692 }, 693 "500" : { 694 "description" : "Internal Server Error", 695 "schema" : { 696 "$ref" : "#/definitions/ErrorResponse" 697 } 698 } 699 }, 700 "security" : [ { 701 "Authorization" : [ ] 702 } ] 703 } 704 }, 705 "/environments" : { 706 "get" : { 707 "tags" : [ "environments" ], 708 "summary" : "Get available environments", 709 "description" : "Get available environments", 710 "operationId" : "getEnvironments", 711 "produces" : [ "application/json" ], 712 "parameters" : [ { 713 "name" : "query", 714 "in" : "query", 715 "description" : "search query (FIQL format), e.g. name==Dev*;description==*environment*", 716 "required" : false, 717 "type" : "string" 718 } ], 719 "responses" : { 720 "200" : { 721 "description" : "OK", 722 "schema" : { 723 "type" : "array", 724 "items" : { 725 "$ref" : "#/definitions/EnvironmentInfo" 726 } 727 } 728 }, 729 "401" : { 730 "description" : "Unauthorized", 731 "schema" : { 732 "$ref" : "#/definitions/ErrorResponse" 733 } 734 }, 735 "403" : { 736 "description" : "Forbidden", 737 "schema" : { 738 "$ref" : "#/definitions/ErrorResponse" 739 } 740 }, 741 "500" : { 742 "description" : "Internal Server Error", 743 "schema" : { 744 "$ref" : "#/definitions/ErrorResponse" 745 } 746 } 747 }, 748 "security" : [ { 749 "Authorization" : [ ] 750 } ] 751 }, 752 "post" : { 753 "tags" : [ "environments" ], 754 "summary" : "Create an environment ", 755 "description" : "Create an environment.", 756 "operationId" : "createEnvironment", 757 "consumes" : [ "application/json" ], 758 "produces" : [ "application/json" ], 759 "parameters" : [ { 760 "in" : "body", 761 "name" : "body", 762 "required" : false, 763 "schema" : { 764 "$ref" : "#/definitions/CreateEnvironmentRequest" 765 } 766 } ], 767 "responses" : { 768 "201" : { 769 "description" : "Environment successfully created", 770 "schema" : { 771 "$ref" : "#/definitions/EnvironmentInfo" 772 } 773 }, 774 "400" : { 775 "description" : "Parameters not valid", 776 "schema" : { 777 "$ref" : "#/definitions/ErrorResponse" 778 } 779 }, 780 "401" : { 781 "description" : "Unauthorized", 782 "schema" : { 783 "$ref" : "#/definitions/ErrorResponse" 784 } 785 }, 786 "403" : { 787 "description" : "Not authorized to create the environment", 788 "schema" : { 789 "$ref" : "#/definitions/ErrorResponse" 790 } 791 }, 792 "409" : { 793 "description" : "Environment name should be unique", 794 "schema" : { 795 "$ref" : "#/definitions/ErrorResponse" 796 } 797 }, 798 "500" : { 799 "description" : "Internal server error", 800 "schema" : { 801 "$ref" : "#/definitions/ErrorResponse" 802 } 803 } 804 }, 805 "security" : [ { 806 "Authorization" : [ ] 807 } ] 808 } 809 }, 810 "/environments/{environmentId}" : { 811 "put" : { 812 "tags" : [ "environments" ], 813 "summary" : "Update environment", 814 "description" : "", 815 "operationId" : "updateEnvironment", 816 "consumes" : [ "application/json" ], 817 "parameters" : [ { 818 "name" : "environmentId", 819 "in" : "path", 820 "required" : true, 821 "type" : "string" 822 }, { 823 "in" : "body", 824 "name" : "body", 825 "description" : "Environment to update", 826 "required" : true, 827 "schema" : { 828 "$ref" : "#/definitions/UpdateEnvironmentRequest" 829 } 830 } ], 831 "responses" : { 832 "204" : { 833 "description" : "Environment successfully updated" 834 }, 835 "400" : { 836 "description" : "Parameters not valid", 837 "schema" : { 838 "$ref" : "#/definitions/ErrorResponse" 839 } 840 }, 841 "401" : { 842 "description" : "Unauthorized", 843 "schema" : { 844 "$ref" : "#/definitions/ErrorResponse" 845 } 846 }, 847 "403" : { 848 "description" : "Not authorized to update the environment", 849 "schema" : { 850 "$ref" : "#/definitions/ErrorResponse" 851 } 852 }, 853 "409" : { 854 "description" : "Environment name should be unique", 855 "schema" : { 856 "$ref" : "#/definitions/ErrorResponse" 857 } 858 }, 859 "500" : { 860 "description" : "Internal server error", 861 "schema" : { 862 "$ref" : "#/definitions/ErrorResponse" 863 } 864 } 865 }, 866 "security" : [ { 867 "Authorization" : [ ] 868 } ] 869 }, 870 "delete" : { 871 "tags" : [ "environments" ], 872 "summary" : "Delete the environment for a given identifier", 873 "description" : "", 874 "operationId" : "deleteEnvironment", 875 "parameters" : [ { 876 "name" : "environmentId", 877 "in" : "path", 878 "required" : true, 879 "type" : "string" 880 } ], 881 "responses" : { 882 "204" : { 883 "description" : "Environment successfully deleted" 884 }, 885 "400" : { 886 "description" : "Cannot delete environment: it is used in promotions(s)", 887 "schema" : { 888 "$ref" : "#/definitions/ErrorResponse" 889 } 890 }, 891 "401" : { 892 "description" : "Unauthorized", 893 "schema" : { 894 "$ref" : "#/definitions/ErrorResponse" 895 } 896 }, 897 "403" : { 898 "description" : "Not authorized to delete the environment", 899 "schema" : { 900 "$ref" : "#/definitions/ErrorResponse" 901 } 902 }, 903 "404" : { 904 "description" : "Environment not found", 905 "schema" : { 906 "$ref" : "#/definitions/ErrorResponse" 907 } 908 }, 909 "500" : { 910 "description" : "Internal server error", 911 "schema" : { 912 "$ref" : "#/definitions/ErrorResponse" 913 } 914 } 915 }, 916 "security" : [ { 917 "Authorization" : [ ] 918 } ] 919 } 920 }, 921 "/executables/events/search" : { 922 "post" : { 923 "tags" : [ "tasks" ], 924 "summary" : "Get scheduled executions", 925 "description" : "Get scheduled executions of all types", 926 "operationId" : "getScheduledEvents", 927 "consumes" : [ "application/json" ], 928 "produces" : [ "application/json" ], 929 "parameters" : [ { 930 "in" : "body", 931 "name" : "body", 932 "description" : "Scheduled executions request", 933 "required" : true, 934 "schema" : { 935 "$ref" : "#/definitions/ScheduledEventsRequest" 936 } 937 } ], 938 "responses" : { 939 "200" : { 940 "description" : "OK", 941 "schema" : { 942 "$ref" : "#/definitions/PageScheduledEventsResponse" 943 } 944 }, 945 "400" : { 946 "description" : "Bad Request", 947 "schema" : { 948 "$ref" : "#/definitions/Response" 949 } 950 }, 951 "401" : { 952 "description" : "Unauthorized", 953 "schema" : { 954 "$ref" : "#/definitions/Response" 955 } 956 }, 957 "403" : { 958 "description" : "Forbidden", 959 "schema" : { 960 "$ref" : "#/definitions/Response" 961 } 962 }, 963 "404" : { 964 "description" : "Not Found", 965 "schema" : { 966 "$ref" : "#/definitions/Response" 967 } 968 }, 969 "500" : { 970 "description" : "Internal Server Error", 971 "schema" : { 972 "$ref" : "#/definitions/Response" 973 } 974 } 975 }, 976 "security" : [ { 977 "Authorization" : [ ] 978 } ] 979 } 980 }, 981 "/executables/plans" : { 982 "get" : { 983 "tags" : [ "plans :: executables" ], 984 "summary" : "Get available Plans", 985 "description" : "Get available Plans", 986 "operationId" : "getAvailablePlans", 987 "produces" : [ "application/json" ], 988 "parameters" : [ { 989 "name" : "name", 990 "in" : "query", 991 "description" : "plan name filter", 992 "required" : false, 993 "type" : "string" 994 }, { 995 "name" : "taskId", 996 "in" : "query", 997 "description" : "task Id", 998 "required" : false, 999 "type" : "string" 1000 }, { 1001 "name" : "planId", 1002 "in" : "query", 1003 "description" : "plan Id (available from V2.5)", 1004 "required" : false, 1005 "type" : "string" 1006 }, { 1007 "name" : "environmentId", 1008 "in" : "query", 1009 "description" : "environment id", 1010 "required" : false, 1011 "type" : "string" 1012 }, { 1013 "name" : "workspaceId", 1014 "in" : "query", 1015 "description" : "workspace id", 1016 "required" : false, 1017 "type" : "string" 1018 }, { 1019 "name" : "limit", 1020 "in" : "query", 1021 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 1022 "required" : false, 1023 "type" : "integer", 1024 "format" : "int32" 1025 }, { 1026 "name" : "offset", 1027 "in" : "query", 1028 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 1029 "required" : false, 1030 "type" : "integer", 1031 "format" : "int32" 1032 } ], 1033 "responses" : { 1034 "200" : { 1035 "description" : "OK", 1036 "schema" : { 1037 "$ref" : "#/definitions/Page" 1038 } 1039 }, 1040 "400" : { 1041 "description" : "Bad Request", 1042 "schema" : { 1043 "$ref" : "#/definitions/ErrorResponse" 1044 } 1045 }, 1046 "401" : { 1047 "description" : "Unauthorized", 1048 "schema" : { 1049 "$ref" : "#/definitions/ErrorResponse" 1050 } 1051 }, 1052 "403" : { 1053 "description" : "Forbidden", 1054 "schema" : { 1055 "$ref" : "#/definitions/ErrorResponse" 1056 } 1057 }, 1058 "500" : { 1059 "description" : "Internal Server Error", 1060 "schema" : { 1061 "$ref" : "#/definitions/ErrorResponse" 1062 } 1063 } 1064 }, 1065 "security" : [ { 1066 "Authorization" : [ ] 1067 } ] 1068 }, 1069 "post" : { 1070 "tags" : [ "plans :: executables" ], 1071 "summary" : "Create Plan", 1072 "description" : "Create Plan", 1073 "operationId" : "createPlan", 1074 "consumes" : [ "application/json" ], 1075 "produces" : [ "application/json" ], 1076 "parameters" : [ { 1077 "in" : "body", 1078 "name" : "body", 1079 "description" : "Execution plan", 1080 "required" : true, 1081 "schema" : { 1082 "$ref" : "#/definitions/PlanRequest" 1083 } 1084 } ], 1085 "responses" : { 1086 "201" : { 1087 "description" : "Created", 1088 "schema" : { 1089 "$ref" : "#/definitions/Plan" 1090 } 1091 }, 1092 "400" : { 1093 "description" : "Bad Request", 1094 "schema" : { 1095 "$ref" : "#/definitions/ErrorResponse" 1096 } 1097 }, 1098 "401" : { 1099 "description" : "Unauthorized", 1100 "schema" : { 1101 "$ref" : "#/definitions/ErrorResponse" 1102 } 1103 }, 1104 "403" : { 1105 "description" : "Forbidden", 1106 "schema" : { 1107 "$ref" : "#/definitions/ErrorResponse" 1108 } 1109 }, 1110 "500" : { 1111 "description" : "Internal Server Error", 1112 "schema" : { 1113 "$ref" : "#/definitions/ErrorResponse" 1114 } 1115 } 1116 }, 1117 "security" : [ { 1118 "Authorization" : [ ] 1119 } ] 1120 } 1121 }, 1122 "/executables/plans/executions" : { 1123 "get" : { 1124 "tags" : [ "plans :: executions" ], 1125 "summary" : "Get available Plans executions", 1126 "description" : "Get available Plans executions", 1127 "operationId" : "listAvailablePlansExecutions", 1128 "produces" : [ "application/json" ], 1129 "parameters" : [ { 1130 "name" : "limit", 1131 "in" : "query", 1132 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 1133 "required" : false, 1134 "type" : "integer", 1135 "format" : "int32" 1136 }, { 1137 "name" : "offset", 1138 "in" : "query", 1139 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 1140 "required" : false, 1141 "type" : "integer", 1142 "format" : "int32" 1143 }, { 1144 "name" : "status", 1145 "in" : "query", 1146 "description" : "execution status", 1147 "required" : false, 1148 "type" : "string", 1149 "enum" : [ "executing", "execution_successful", "execution_failed" ] 1150 }, { 1151 "name" : "from", 1152 "in" : "query", 1153 "description" : "from date time (milliseconds)", 1154 "required" : false, 1155 "type" : "integer", 1156 "format" : "int64" 1157 }, { 1158 "name" : "to", 1159 "in" : "query", 1160 "description" : "to date time (milliseconds)", 1161 "required" : false, 1162 "type" : "integer", 1163 "format" : "int64" 1164 }, { 1165 "name" : "lastDays", 1166 "in" : "query", 1167 "description" : "lastDays", 1168 "required" : false, 1169 "type" : "integer", 1170 "format" : "int32" 1171 }, { 1172 "name" : "environmentId", 1173 "in" : "query", 1174 "description" : "environment id", 1175 "required" : false, 1176 "type" : "string" 1177 }, { 1178 "name" : "workspaceId", 1179 "in" : "query", 1180 "description" : "workspace id", 1181 "required" : false, 1182 "type" : "string" 1183 } ], 1184 "responses" : { 1185 "200" : { 1186 "description" : "OK", 1187 "schema" : { 1188 "$ref" : "#/definitions/Page" 1189 } 1190 }, 1191 "400" : { 1192 "description" : "Bad Request", 1193 "schema" : { 1194 "$ref" : "#/definitions/ErrorResponse" 1195 } 1196 }, 1197 "401" : { 1198 "description" : "Unauthorized", 1199 "schema" : { 1200 "$ref" : "#/definitions/ErrorResponse" 1201 } 1202 }, 1203 "403" : { 1204 "description" : "Forbidden", 1205 "schema" : { 1206 "$ref" : "#/definitions/ErrorResponse" 1207 } 1208 }, 1209 "500" : { 1210 "description" : "Internal Server Error", 1211 "schema" : { 1212 "$ref" : "#/definitions/ErrorResponse" 1213 } 1214 } 1215 }, 1216 "security" : [ { 1217 "Authorization" : [ ] 1218 } ] 1219 } 1220 }, 1221 "/executables/plans/{planId}" : { 1222 "get" : { 1223 "tags" : [ "plans :: executables" ], 1224 "summary" : "Get Plan details", 1225 "description" : "Get Plan details", 1226 "operationId" : "getExecutableDetails", 1227 "produces" : [ "application/json" ], 1228 "parameters" : [ { 1229 "name" : "planId", 1230 "in" : "path", 1231 "description" : "executable ID", 1232 "required" : true, 1233 "type" : "string" 1234 } ], 1235 "responses" : { 1236 "200" : { 1237 "description" : "Successful response", 1238 "schema" : { 1239 "$ref" : "#/definitions/PlanExecutabledetails" 1240 } 1241 }, 1242 "400" : { 1243 "description" : "Bad Request", 1244 "schema" : { 1245 "$ref" : "#/definitions/ErrorResponse" 1246 } 1247 }, 1248 "401" : { 1249 "description" : "Unauthorized", 1250 "schema" : { 1251 "$ref" : "#/definitions/ErrorResponse" 1252 } 1253 }, 1254 "403" : { 1255 "description" : "Forbidden - no permissions to access resource", 1256 "schema" : { 1257 "$ref" : "#/definitions/ErrorResponse" 1258 } 1259 }, 1260 "404" : { 1261 "description" : "Not found - resource not found", 1262 "schema" : { 1263 "$ref" : "#/definitions/ErrorResponse" 1264 } 1265 }, 1266 "500" : { 1267 "description" : "Server error - something went wrong on server side", 1268 "schema" : { 1269 "$ref" : "#/definitions/ErrorResponse" 1270 } 1271 } 1272 }, 1273 "security" : [ { 1274 "Authorization" : [ ] 1275 } ] 1276 }, 1277 "put" : { 1278 "tags" : [ "plans :: executables" ], 1279 "summary" : "Update plan", 1280 "description" : "Update Plan", 1281 "operationId" : "updatePlan", 1282 "consumes" : [ "application/json" ], 1283 "produces" : [ "application/json" ], 1284 "parameters" : [ { 1285 "name" : "planId", 1286 "in" : "path", 1287 "description" : "plan ID", 1288 "required" : true, 1289 "type" : "string" 1290 }, { 1291 "in" : "body", 1292 "name" : "body", 1293 "description" : "execution plan", 1294 "required" : true, 1295 "schema" : { 1296 "$ref" : "#/definitions/PlanRequest" 1297 } 1298 } ], 1299 "responses" : { 1300 "200" : { 1301 "description" : "OK", 1302 "schema" : { 1303 "$ref" : "#/definitions/Plan" 1304 } 1305 }, 1306 "400" : { 1307 "description" : "Bad Request", 1308 "schema" : { 1309 "$ref" : "#/definitions/ErrorResponse" 1310 } 1311 }, 1312 "401" : { 1313 "description" : "Unauthorized", 1314 "schema" : { 1315 "$ref" : "#/definitions/ErrorResponse" 1316 } 1317 }, 1318 "403" : { 1319 "description" : "Forbidden", 1320 "schema" : { 1321 "$ref" : "#/definitions/ErrorResponse" 1322 } 1323 }, 1324 "404" : { 1325 "description" : "Not Found", 1326 "schema" : { 1327 "$ref" : "#/definitions/ErrorResponse" 1328 } 1329 }, 1330 "500" : { 1331 "description" : "Internal Server Error", 1332 "schema" : { 1333 "$ref" : "#/definitions/ErrorResponse" 1334 } 1335 } 1336 }, 1337 "security" : [ { 1338 "Authorization" : [ ] 1339 } ] 1340 }, 1341 "delete" : { 1342 "tags" : [ "plans :: executables" ], 1343 "summary" : "Delete Plan", 1344 "description" : "Delete Plan", 1345 "operationId" : "deletePlan", 1346 "parameters" : [ { 1347 "name" : "planId", 1348 "in" : "path", 1349 "description" : "plan ID", 1350 "required" : true, 1351 "type" : "string" 1352 } ], 1353 "responses" : { 1354 "204" : { 1355 "description" : "No Content" 1356 }, 1357 "400" : { 1358 "description" : "Bad Request", 1359 "schema" : { 1360 "$ref" : "#/definitions/ErrorResponse" 1361 } 1362 }, 1363 "401" : { 1364 "description" : "Unauthorized", 1365 "schema" : { 1366 "$ref" : "#/definitions/ErrorResponse" 1367 } 1368 }, 1369 "403" : { 1370 "description" : "Forbidden", 1371 "schema" : { 1372 "$ref" : "#/definitions/ErrorResponse" 1373 } 1374 }, 1375 "404" : { 1376 "description" : "Not Found", 1377 "schema" : { 1378 "$ref" : "#/definitions/ErrorResponse" 1379 } 1380 }, 1381 "409" : { 1382 "description" : "Conflict", 1383 "schema" : { 1384 "$ref" : "#/definitions/ErrorResponse" 1385 } 1386 }, 1387 "500" : { 1388 "description" : "Internal Server Error", 1389 "schema" : { 1390 "$ref" : "#/definitions/ErrorResponse" 1391 } 1392 } 1393 }, 1394 "security" : [ { 1395 "Authorization" : [ ] 1396 } ] 1397 } 1398 }, 1399 "/executables/plans/{planId}/executions" : { 1400 "get" : { 1401 "tags" : [ "plans :: executions" ], 1402 "summary" : "Get Plan executions", 1403 "description" : "Get Plan executions", 1404 "operationId" : "listPlanExecutions", 1405 "produces" : [ "application/json" ], 1406 "parameters" : [ { 1407 "name" : "planId", 1408 "in" : "path", 1409 "description" : "plan ID", 1410 "required" : true, 1411 "type" : "string" 1412 }, { 1413 "name" : "limit", 1414 "in" : "query", 1415 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 1416 "required" : false, 1417 "type" : "integer", 1418 "format" : "int32" 1419 }, { 1420 "name" : "offset", 1421 "in" : "query", 1422 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 1423 "required" : false, 1424 "type" : "integer", 1425 "format" : "int32" 1426 }, { 1427 "name" : "status", 1428 "in" : "query", 1429 "description" : "execution status", 1430 "required" : false, 1431 "type" : "string", 1432 "enum" : [ "executing", "execution_successful", "execution_failed" ] 1433 }, { 1434 "name" : "from", 1435 "in" : "query", 1436 "description" : "from date time (milliseconds)", 1437 "required" : false, 1438 "type" : "integer", 1439 "format" : "int64" 1440 }, { 1441 "name" : "to", 1442 "in" : "query", 1443 "description" : "to date time (milliseconds)", 1444 "required" : false, 1445 "type" : "integer", 1446 "format" : "int64" 1447 }, { 1448 "name" : "lastDays", 1449 "in" : "query", 1450 "description" : "lastDays", 1451 "required" : false, 1452 "type" : "integer", 1453 "format" : "int32" 1454 } ], 1455 "responses" : { 1456 "200" : { 1457 "description" : "OK", 1458 "schema" : { 1459 "$ref" : "#/definitions/Page" 1460 } 1461 }, 1462 "400" : { 1463 "description" : "Bad Request", 1464 "schema" : { 1465 "$ref" : "#/definitions/ErrorResponse" 1466 } 1467 }, 1468 "401" : { 1469 "description" : "Unauthorized", 1470 "schema" : { 1471 "$ref" : "#/definitions/ErrorResponse" 1472 } 1473 }, 1474 "403" : { 1475 "description" : "Forbidden", 1476 "schema" : { 1477 "$ref" : "#/definitions/ErrorResponse" 1478 } 1479 }, 1480 "404" : { 1481 "description" : "Not Found", 1482 "schema" : { 1483 "$ref" : "#/definitions/ErrorResponse" 1484 } 1485 }, 1486 "500" : { 1487 "description" : "Internal Server Error", 1488 "schema" : { 1489 "$ref" : "#/definitions/ErrorResponse" 1490 } 1491 } 1492 }, 1493 "security" : [ { 1494 "Authorization" : [ ] 1495 } ] 1496 } 1497 }, 1498 "/executables/plans/{planId}/pause" : { 1499 "put" : { 1500 "tags" : [ "plans :: executables" ], 1501 "summary" : "Pause-Resume Plan execution", 1502 "description" : "", 1503 "operationId" : "pausePlanExecution", 1504 "consumes" : [ "application/json" ], 1505 "parameters" : [ { 1506 "name" : "planId", 1507 "in" : "path", 1508 "description" : "plan id", 1509 "required" : true, 1510 "type" : "string" 1511 }, { 1512 "in" : "body", 1513 "name" : "body", 1514 "description" : "Action to perform ", 1515 "required" : true, 1516 "schema" : { 1517 "$ref" : "#/definitions/PlanPauseDetails" 1518 } 1519 } ], 1520 "responses" : { 1521 "202" : { 1522 "description" : "Plan execution state changed" 1523 }, 1524 "204" : { 1525 "description" : "Plan execution already in same pause state" 1526 }, 1527 "400" : { 1528 "description" : "Bad Request", 1529 "schema" : { 1530 "$ref" : "#/definitions/ErrorResponse" 1531 } 1532 }, 1533 "401" : { 1534 "description" : "Unauthorized", 1535 "schema" : { 1536 "$ref" : "#/definitions/ErrorResponse" 1537 } 1538 }, 1539 "403" : { 1540 "description" : "Forbidden", 1541 "schema" : { 1542 "$ref" : "#/definitions/ErrorResponse" 1543 } 1544 }, 1545 "404" : { 1546 "description" : "Not Found", 1547 "schema" : { 1548 "$ref" : "#/definitions/ErrorResponse" 1549 } 1550 }, 1551 "500" : { 1552 "description" : "Internal Server Error", 1553 "schema" : { 1554 "$ref" : "#/definitions/ErrorResponse" 1555 } 1556 } 1557 }, 1558 "security" : [ { 1559 "Authorization" : [ ] 1560 } ] 1561 } 1562 }, 1563 "/executables/plans/{planId}/run-config" : { 1564 "get" : { 1565 "tags" : [ "plans :: executables" ], 1566 "summary" : "Get Plan configuration", 1567 "description" : "Get Plan configuration", 1568 "operationId" : "getPlanRunConfiguration", 1569 "produces" : [ "application/json" ], 1570 "parameters" : [ { 1571 "name" : "planId", 1572 "in" : "path", 1573 "description" : "plan id", 1574 "required" : true, 1575 "type" : "string" 1576 } ], 1577 "responses" : { 1578 "200" : { 1579 "description" : "OK", 1580 "schema" : { 1581 "$ref" : "#/definitions/PlanRunConfig" 1582 } 1583 }, 1584 "400" : { 1585 "description" : "Bad Request", 1586 "schema" : { 1587 "$ref" : "#/definitions/ErrorResponse" 1588 } 1589 }, 1590 "401" : { 1591 "description" : "Unauthorized", 1592 "schema" : { 1593 "$ref" : "#/definitions/ErrorResponse" 1594 } 1595 }, 1596 "403" : { 1597 "description" : "Forbidden", 1598 "schema" : { 1599 "$ref" : "#/definitions/ErrorResponse" 1600 } 1601 }, 1602 "404" : { 1603 "description" : "Not Found", 1604 "schema" : { 1605 "$ref" : "#/definitions/ErrorResponse" 1606 } 1607 }, 1608 "500" : { 1609 "description" : "Internal Server Error", 1610 "schema" : { 1611 "$ref" : "#/definitions/ErrorResponse" 1612 } 1613 } 1614 }, 1615 "security" : [ { 1616 "Authorization" : [ ] 1617 } ] 1618 }, 1619 "put" : { 1620 "tags" : [ "plans :: executables" ], 1621 "summary" : "Configure Plan execution", 1622 "description" : "Configure Plan execution", 1623 "operationId" : "configurePlanExecution", 1624 "consumes" : [ "application/json" ], 1625 "produces" : [ "application/json" ], 1626 "parameters" : [ { 1627 "name" : "planId", 1628 "in" : "path", 1629 "description" : "Plan id", 1630 "required" : true, 1631 "type" : "string" 1632 }, { 1633 "in" : "body", 1634 "name" : "body", 1635 "description" : "RunConfig", 1636 "required" : false, 1637 "schema" : { 1638 "$ref" : "#/definitions/PlanRunConfig" 1639 } 1640 } ], 1641 "responses" : { 1642 "200" : { 1643 "description" : "OK", 1644 "schema" : { 1645 "$ref" : "#/definitions/PlanRunConfig" 1646 } 1647 }, 1648 "400" : { 1649 "description" : "Bad Request", 1650 "schema" : { 1651 "$ref" : "#/definitions/ErrorResponse" 1652 } 1653 }, 1654 "401" : { 1655 "description" : "Unauthorized", 1656 "schema" : { 1657 "$ref" : "#/definitions/ErrorResponse" 1658 } 1659 }, 1660 "403" : { 1661 "description" : "Forbidden", 1662 "schema" : { 1663 "$ref" : "#/definitions/ErrorResponse" 1664 } 1665 }, 1666 "404" : { 1667 "description" : "Not Found", 1668 "schema" : { 1669 "$ref" : "#/definitions/ErrorResponse" 1670 } 1671 }, 1672 "500" : { 1673 "description" : "Internal Server Error", 1674 "schema" : { 1675 "$ref" : "#/definitions/ErrorResponse" 1676 } 1677 } 1678 }, 1679 "security" : [ { 1680 "Authorization" : [ ] 1681 } ] 1682 }, 1683 "delete" : { 1684 "tags" : [ "plans :: executables" ], 1685 "summary" : "Stop schedule for plan", 1686 "description" : "Stop schedule for plan", 1687 "operationId" : "stopScheduleForPlan", 1688 "parameters" : [ { 1689 "name" : "planId", 1690 "in" : "path", 1691 "description" : "plan ID", 1692 "required" : true, 1693 "type" : "string" 1694 } ], 1695 "responses" : { 1696 "204" : { 1697 "description" : "No Content" 1698 }, 1699 "400" : { 1700 "description" : "Bad Request", 1701 "schema" : { 1702 "$ref" : "#/definitions/ErrorResponse" 1703 } 1704 }, 1705 "401" : { 1706 "description" : "Unauthorized", 1707 "schema" : { 1708 "$ref" : "#/definitions/ErrorResponse" 1709 } 1710 }, 1711 "403" : { 1712 "description" : "Forbidden", 1713 "schema" : { 1714 "$ref" : "#/definitions/ErrorResponse" 1715 } 1716 }, 1717 "404" : { 1718 "description" : "Not Found", 1719 "schema" : { 1720 "$ref" : "#/definitions/ErrorResponse" 1721 } 1722 }, 1723 "500" : { 1724 "description" : "Internal Server Error", 1725 "schema" : { 1726 "$ref" : "#/definitions/ErrorResponse" 1727 } 1728 } 1729 }, 1730 "security" : [ { 1731 "Authorization" : [ ] 1732 } ] 1733 } 1734 }, 1735 "/executables/plans/{planId}/run-config/events" : { 1736 "get" : { 1737 "tags" : [ "plans :: executables" ], 1738 "summary" : "Get plan scheduled triggers ", 1739 "description" : "Get plan triggers", 1740 "operationId" : "getPlanScheduledEvents", 1741 "produces" : [ "application/json" ], 1742 "parameters" : [ { 1743 "name" : "planId", 1744 "in" : "path", 1745 "description" : "plan id", 1746 "required" : true, 1747 "type" : "string" 1748 }, { 1749 "name" : "from", 1750 "in" : "query", 1751 "description" : "from date time (milliseconds)", 1752 "required" : false, 1753 "type" : "integer", 1754 "format" : "int64" 1755 }, { 1756 "name" : "to", 1757 "in" : "query", 1758 "description" : "to date time (milliseconds)", 1759 "required" : true, 1760 "type" : "integer", 1761 "format" : "int64" 1762 }, { 1763 "name" : "limit", 1764 "in" : "query", 1765 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 1766 "required" : false, 1767 "type" : "integer", 1768 "format" : "int32" 1769 }, { 1770 "name" : "offset", 1771 "in" : "query", 1772 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 1773 "required" : false, 1774 "type" : "integer", 1775 "format" : "int32" 1776 } ], 1777 "responses" : { 1778 "200" : { 1779 "description" : "OK", 1780 "schema" : { 1781 "$ref" : "#/definitions/Page" 1782 } 1783 }, 1784 "400" : { 1785 "description" : "Bad Request", 1786 "schema" : { 1787 "$ref" : "#/definitions/ErrorResponse" 1788 } 1789 }, 1790 "401" : { 1791 "description" : "Unauthorized", 1792 "schema" : { 1793 "$ref" : "#/definitions/ErrorResponse" 1794 } 1795 }, 1796 "403" : { 1797 "description" : "Forbidden", 1798 "schema" : { 1799 "$ref" : "#/definitions/ErrorResponse" 1800 } 1801 }, 1802 "404" : { 1803 "description" : "Not Found", 1804 "schema" : { 1805 "$ref" : "#/definitions/ErrorResponse" 1806 } 1807 }, 1808 "500" : { 1809 "description" : "Internal Server Error", 1810 "schema" : { 1811 "$ref" : "#/definitions/ErrorResponse" 1812 } 1813 } 1814 }, 1815 "security" : [ { 1816 "Authorization" : [ ] 1817 } ] 1818 } 1819 }, 1820 "/executables/plans/{planId}/schedule" : { 1821 "get" : { 1822 "tags" : [ "plans :: executables" ], 1823 "summary" : "Get plan schedule", 1824 "description" : "Get plan schedule multiple triggers", 1825 "operationId" : "getPlanScheduleMultipleTriggers", 1826 "produces" : [ "application/json" ], 1827 "parameters" : [ { 1828 "name" : "planId", 1829 "in" : "path", 1830 "description" : "plan id", 1831 "required" : true, 1832 "type" : "string" 1833 } ], 1834 "responses" : { 1835 "200" : { 1836 "description" : "OK", 1837 "schema" : { 1838 "$ref" : "#/definitions/Schedule" 1839 } 1840 }, 1841 "400" : { 1842 "description" : "Bad Request", 1843 "schema" : { 1844 "$ref" : "#/definitions/ErrorResponse" 1845 } 1846 }, 1847 "401" : { 1848 "description" : "Unauthorized", 1849 "schema" : { 1850 "$ref" : "#/definitions/ErrorResponse" 1851 } 1852 }, 1853 "403" : { 1854 "description" : "Forbidden", 1855 "schema" : { 1856 "$ref" : "#/definitions/ErrorResponse" 1857 } 1858 }, 1859 "404" : { 1860 "description" : "Not Found", 1861 "schema" : { 1862 "$ref" : "#/definitions/ErrorResponse" 1863 } 1864 }, 1865 "500" : { 1866 "description" : "Internal Server Error", 1867 "schema" : { 1868 "$ref" : "#/definitions/ErrorResponse" 1869 } 1870 } 1871 }, 1872 "security" : [ { 1873 "Authorization" : [ ] 1874 } ] 1875 }, 1876 "put" : { 1877 "tags" : [ "plans :: executables" ], 1878 "summary" : "Link plan schedule", 1879 "description" : "Link schedule with plan", 1880 "operationId" : "linkPlanSchedule", 1881 "parameters" : [ { 1882 "name" : "planId", 1883 "in" : "path", 1884 "description" : "plan id", 1885 "required" : true, 1886 "type" : "string" 1887 }, { 1888 "in" : "body", 1889 "name" : "body", 1890 "description" : "schedule id", 1891 "required" : false, 1892 "schema" : { 1893 "$ref" : "#/definitions/LinkScheduleMultipleTriggerRequest" 1894 } 1895 } ], 1896 "responses" : { 1897 "200" : { 1898 "description" : "OK", 1899 "schema" : { 1900 "$ref" : "#/definitions/Response" 1901 } 1902 }, 1903 "400" : { 1904 "description" : "Bad Request", 1905 "schema" : { 1906 "$ref" : "#/definitions/ErrorResponse" 1907 } 1908 }, 1909 "401" : { 1910 "description" : "Unauthorized", 1911 "schema" : { 1912 "$ref" : "#/definitions/ErrorResponse" 1913 } 1914 }, 1915 "403" : { 1916 "description" : "Forbidden", 1917 "schema" : { 1918 "$ref" : "#/definitions/ErrorResponse" 1919 } 1920 }, 1921 "404" : { 1922 "description" : "Not Found", 1923 "schema" : { 1924 "$ref" : "#/definitions/ErrorResponse" 1925 } 1926 }, 1927 "500" : { 1928 "description" : "Internal Server Error", 1929 "schema" : { 1930 "$ref" : "#/definitions/ErrorResponse" 1931 } 1932 } 1933 }, 1934 "security" : [ { 1935 "Authorization" : [ ] 1936 } ] 1937 }, 1938 "delete" : { 1939 "tags" : [ "plans :: executables" ], 1940 "summary" : "Unlink plan schedule", 1941 "description" : "Unlink schedule from plan", 1942 "operationId" : "unlinkPlanSchedule", 1943 "parameters" : [ { 1944 "name" : "planId", 1945 "in" : "path", 1946 "description" : "plan id", 1947 "required" : true, 1948 "type" : "string" 1949 } ], 1950 "responses" : { 1951 "204" : { 1952 "description" : "No Content", 1953 "schema" : { 1954 "$ref" : "#/definitions/Response" 1955 } 1956 }, 1957 "400" : { 1958 "description" : "Bad Request", 1959 "schema" : { 1960 "$ref" : "#/definitions/ErrorResponse" 1961 } 1962 }, 1963 "401" : { 1964 "description" : "Unauthorized", 1965 "schema" : { 1966 "$ref" : "#/definitions/ErrorResponse" 1967 } 1968 }, 1969 "403" : { 1970 "description" : "Forbidden", 1971 "schema" : { 1972 "$ref" : "#/definitions/ErrorResponse" 1973 } 1974 }, 1975 "404" : { 1976 "description" : "Not Found", 1977 "schema" : { 1978 "$ref" : "#/definitions/ErrorResponse" 1979 } 1980 }, 1981 "500" : { 1982 "description" : "Internal Server Error", 1983 "schema" : { 1984 "$ref" : "#/definitions/ErrorResponse" 1985 } 1986 } 1987 }, 1988 "security" : [ { 1989 "Authorization" : [ ] 1990 } ] 1991 } 1992 }, 1993 "/executables/promotions" : { 1994 "get" : { 1995 "tags" : [ "promotions :: executables" ], 1996 "summary" : "Get available Promotions", 1997 "description" : "Get available Promotions", 1998 "operationId" : "getAvailablePromotions", 1999 "produces" : [ "application/json" ], 2000 "parameters" : [ { 2001 "name" : "_s", 2002 "in" : "query", 2003 "description" : "search query (FIQL format), e.g. \"name==dev to prod*\"", 2004 "required" : false, 2005 "type" : "string" 2006 } ], 2007 "responses" : { 2008 "200" : { 2009 "description" : "OK", 2010 "schema" : { 2011 "type" : "array", 2012 "items" : { 2013 "$ref" : "#/definitions/PromotionExecutableDetails" 2014 } 2015 } 2016 }, 2017 "400" : { 2018 "description" : "Bad Request", 2019 "schema" : { 2020 "$ref" : "#/definitions/ErrorResponse" 2021 } 2022 }, 2023 "401" : { 2024 "description" : "Unauthorized", 2025 "schema" : { 2026 "$ref" : "#/definitions/ErrorResponse" 2027 } 2028 }, 2029 "403" : { 2030 "description" : "Forbidden", 2031 "schema" : { 2032 "$ref" : "#/definitions/ErrorResponse" 2033 } 2034 }, 2035 "500" : { 2036 "description" : "Internal Server Error", 2037 "schema" : { 2038 "$ref" : "#/definitions/ErrorResponse" 2039 } 2040 } 2041 }, 2042 "security" : [ { 2043 "Authorization" : [ ] 2044 } ] 2045 }, 2046 "post" : { 2047 "tags" : [ "promotions :: executables" ], 2048 "summary" : "Create a Promotion", 2049 "description" : "Create a Promotion", 2050 "operationId" : "createPromotion", 2051 "consumes" : [ "application/json" ], 2052 "produces" : [ "application/json" ], 2053 "parameters" : [ { 2054 "in" : "body", 2055 "name" : "body", 2056 "description" : "Promotion", 2057 "required" : true, 2058 "schema" : { 2059 "$ref" : "#/definitions/CreatePromotionRequest" 2060 } 2061 } ], 2062 "responses" : { 2063 "201" : { 2064 "description" : "Created", 2065 "schema" : { 2066 "$ref" : "#/definitions/PromotionExecutableDetails" 2067 } 2068 }, 2069 "400" : { 2070 "description" : "Bad Request", 2071 "schema" : { 2072 "$ref" : "#/definitions/ErrorResponse" 2073 } 2074 }, 2075 "401" : { 2076 "description" : "Unauthorized", 2077 "schema" : { 2078 "$ref" : "#/definitions/ErrorResponse" 2079 } 2080 }, 2081 "403" : { 2082 "description" : "Forbidden", 2083 "schema" : { 2084 "$ref" : "#/definitions/ErrorResponse" 2085 } 2086 }, 2087 "404" : { 2088 "description" : "Not Found", 2089 "schema" : { 2090 "$ref" : "#/definitions/ErrorResponse" 2091 } 2092 }, 2093 "409" : { 2094 "description" : "Promotion with same source and target already exists", 2095 "schema" : { 2096 "$ref" : "#/definitions/ErrorResponse" 2097 } 2098 }, 2099 "500" : { 2100 "description" : "Internal Server Error", 2101 "schema" : { 2102 "$ref" : "#/definitions/ErrorResponse" 2103 } 2104 } 2105 }, 2106 "security" : [ { 2107 "Authorization" : [ ] 2108 } ] 2109 } 2110 }, 2111 "/executables/promotions/{id}" : { 2112 "post" : { 2113 "tags" : [ "promotions :: executables" ], 2114 "summary" : "Perform promotion simulation analysis", 2115 "description" : "Perform promotion simulation analysis", 2116 "operationId" : "performPromotionAnalysis", 2117 "consumes" : [ "application/json" ], 2118 "produces" : [ "application/json" ], 2119 "parameters" : [ { 2120 "name" : "id", 2121 "in" : "path", 2122 "required" : true, 2123 "type" : "string" 2124 }, { 2125 "in" : "body", 2126 "name" : "body", 2127 "required" : false, 2128 "schema" : { 2129 "$ref" : "#/definitions/PromotionExecutionDetails" 2130 } 2131 } ], 2132 "responses" : { 2133 "200" : { 2134 "description" : "OK", 2135 "schema" : { 2136 "$ref" : "#/definitions/PromotionExecutionStatus" 2137 } 2138 }, 2139 "400" : { 2140 "description" : "Bad Request", 2141 "schema" : { 2142 "$ref" : "#/definitions/ErrorResponse" 2143 } 2144 }, 2145 "401" : { 2146 "description" : "Unauthorized", 2147 "schema" : { 2148 "$ref" : "#/definitions/ErrorResponse" 2149 } 2150 }, 2151 "403" : { 2152 "description" : "Forbidden", 2153 "schema" : { 2154 "$ref" : "#/definitions/ErrorResponse" 2155 } 2156 }, 2157 "404" : { 2158 "description" : "Not Found", 2159 "schema" : { 2160 "$ref" : "#/definitions/ErrorResponse" 2161 } 2162 }, 2163 "500" : { 2164 "description" : "Internal Server Error", 2165 "schema" : { 2166 "$ref" : "#/definitions/ErrorResponse" 2167 } 2168 } 2169 }, 2170 "security" : [ { 2171 "Authorization" : [ ] 2172 } ] 2173 } 2174 }, 2175 "/executables/promotions/{promotionId}" : { 2176 "get" : { 2177 "tags" : [ "promotions :: executables" ], 2178 "summary" : "Get Promotion details", 2179 "description" : "Get Promotion details", 2180 "operationId" : "getPromotionDetailsById", 2181 "produces" : [ "application/json" ], 2182 "parameters" : [ { 2183 "name" : "promotionId", 2184 "in" : "path", 2185 "description" : "Promotion ID", 2186 "required" : true, 2187 "type" : "string" 2188 } ], 2189 "responses" : { 2190 "200" : { 2191 "description" : "OK", 2192 "schema" : { 2193 "$ref" : "#/definitions/PromotionExecutableDetails" 2194 } 2195 }, 2196 "400" : { 2197 "description" : "Bad Request", 2198 "schema" : { 2199 "$ref" : "#/definitions/ErrorResponse" 2200 } 2201 }, 2202 "401" : { 2203 "description" : "Unauthorized", 2204 "schema" : { 2205 "$ref" : "#/definitions/ErrorResponse" 2206 } 2207 }, 2208 "403" : { 2209 "description" : "Forbidden", 2210 "schema" : { 2211 "$ref" : "#/definitions/ErrorResponse" 2212 } 2213 }, 2214 "404" : { 2215 "description" : "Not Found", 2216 "schema" : { 2217 "$ref" : "#/definitions/ErrorResponse" 2218 } 2219 }, 2220 "500" : { 2221 "description" : "Internal Server Error", 2222 "schema" : { 2223 "$ref" : "#/definitions/ErrorResponse" 2224 } 2225 } 2226 }, 2227 "security" : [ { 2228 "Authorization" : [ ] 2229 } ] 2230 }, 2231 "delete" : { 2232 "tags" : [ "promotions :: executables" ], 2233 "summary" : "Delete a Promotion", 2234 "description" : "Delete a Promotion", 2235 "operationId" : "deletePromotion", 2236 "parameters" : [ { 2237 "name" : "promotionId", 2238 "in" : "path", 2239 "description" : "Promotion ID", 2240 "required" : true, 2241 "type" : "string" 2242 } ], 2243 "responses" : { 2244 "204" : { 2245 "description" : "No Content" 2246 }, 2247 "400" : { 2248 "description" : "Bad Request", 2249 "schema" : { 2250 "$ref" : "#/definitions/ErrorResponse" 2251 } 2252 }, 2253 "401" : { 2254 "description" : "Unauthorized", 2255 "schema" : { 2256 "$ref" : "#/definitions/ErrorResponse" 2257 } 2258 }, 2259 "403" : { 2260 "description" : "Forbidden", 2261 "schema" : { 2262 "$ref" : "#/definitions/ErrorResponse" 2263 } 2264 }, 2265 "404" : { 2266 "description" : "Not Found", 2267 "schema" : { 2268 "$ref" : "#/definitions/ErrorResponse" 2269 } 2270 }, 2271 "500" : { 2272 "description" : "Internal Server Error", 2273 "schema" : { 2274 "$ref" : "#/definitions/ErrorResponse" 2275 } 2276 } 2277 }, 2278 "security" : [ { 2279 "Authorization" : [ ] 2280 } ] 2281 }, 2282 "patch" : { 2283 "tags" : [ "promotions :: executables" ], 2284 "summary" : "Update a Promotion", 2285 "description" : "Update a Promotion", 2286 "operationId" : "updatePromotion", 2287 "consumes" : [ "application/json" ], 2288 "parameters" : [ { 2289 "name" : "promotionId", 2290 "in" : "path", 2291 "description" : "Promotion ID", 2292 "required" : true, 2293 "type" : "string" 2294 }, { 2295 "in" : "body", 2296 "name" : "body", 2297 "description" : "Update request", 2298 "required" : true, 2299 "schema" : { 2300 "$ref" : "#/definitions/UpdateDescriptionRequest" 2301 } 2302 } ], 2303 "responses" : { 2304 "204" : { 2305 "description" : "No Content" 2306 }, 2307 "400" : { 2308 "description" : "Bad Request", 2309 "schema" : { 2310 "$ref" : "#/definitions/ErrorResponse" 2311 } 2312 }, 2313 "401" : { 2314 "description" : "Unauthorized", 2315 "schema" : { 2316 "$ref" : "#/definitions/ErrorResponse" 2317 } 2318 }, 2319 "403" : { 2320 "description" : "Forbidden", 2321 "schema" : { 2322 "$ref" : "#/definitions/ErrorResponse" 2323 } 2324 }, 2325 "404" : { 2326 "description" : "Not Found", 2327 "schema" : { 2328 "$ref" : "#/definitions/ErrorResponse" 2329 } 2330 }, 2331 "500" : { 2332 "description" : "Internal Server Error", 2333 "schema" : { 2334 "$ref" : "#/definitions/ErrorResponse" 2335 } 2336 } 2337 }, 2338 "security" : [ { 2339 "Authorization" : [ ] 2340 } ] 2341 } 2342 }, 2343 "/executables/promotions/{promotionId}/users" : { 2344 "get" : { 2345 "tags" : [ "promotions :: executables :: authorization" ], 2346 "summary" : "Get users assigned to Promotion", 2347 "description" : "Get users assigned to Promotion", 2348 "operationId" : "getPromotionUsers", 2349 "produces" : [ "application/json" ], 2350 "parameters" : [ { 2351 "name" : "promotionId", 2352 "in" : "path", 2353 "description" : "Promotion ID", 2354 "required" : true, 2355 "type" : "string" 2356 } ], 2357 "responses" : { 2358 "200" : { 2359 "description" : "OK", 2360 "schema" : { 2361 "$ref" : "#/definitions/PromotionUsersResponse" 2362 } 2363 }, 2364 "400" : { 2365 "description" : "Bad Request", 2366 "schema" : { 2367 "$ref" : "#/definitions/ErrorResponse" 2368 } 2369 }, 2370 "401" : { 2371 "description" : "Unauthorized", 2372 "schema" : { 2373 "$ref" : "#/definitions/ErrorResponse" 2374 } 2375 }, 2376 "403" : { 2377 "description" : "Forbidden", 2378 "schema" : { 2379 "$ref" : "#/definitions/ErrorResponse" 2380 } 2381 }, 2382 "404" : { 2383 "description" : "Not Found", 2384 "schema" : { 2385 "$ref" : "#/definitions/ErrorResponse" 2386 } 2387 }, 2388 "500" : { 2389 "description" : "Internal Server Error", 2390 "schema" : { 2391 "$ref" : "#/definitions/ErrorResponse" 2392 } 2393 } 2394 }, 2395 "security" : [ { 2396 "Authorization" : [ ] 2397 } ] 2398 } 2399 }, 2400 "/executables/promotions/{promotionId}/users/{userId}" : { 2401 "put" : { 2402 "tags" : [ "promotions :: executables :: authorization" ], 2403 "summary" : "Assign user to Promotion", 2404 "description" : "Assign user to Promotion", 2405 "operationId" : "addPromotionUser", 2406 "parameters" : [ { 2407 "name" : "promotionId", 2408 "in" : "path", 2409 "description" : "Promotion ID", 2410 "required" : true, 2411 "type" : "string" 2412 }, { 2413 "name" : "userId", 2414 "in" : "path", 2415 "description" : "User ID", 2416 "required" : true, 2417 "type" : "string" 2418 } ], 2419 "responses" : { 2420 "204" : { 2421 "description" : "No Content" 2422 }, 2423 "400" : { 2424 "description" : "Bad Request", 2425 "schema" : { 2426 "$ref" : "#/definitions/ErrorResponse" 2427 } 2428 }, 2429 "401" : { 2430 "description" : "Unauthorized", 2431 "schema" : { 2432 "$ref" : "#/definitions/ErrorResponse" 2433 } 2434 }, 2435 "403" : { 2436 "description" : "Forbidden", 2437 "schema" : { 2438 "$ref" : "#/definitions/ErrorResponse" 2439 } 2440 }, 2441 "404" : { 2442 "description" : "Not Found", 2443 "schema" : { 2444 "$ref" : "#/definitions/ErrorResponse" 2445 } 2446 }, 2447 "409" : { 2448 "description" : "User is already assigned to the promotion", 2449 "schema" : { 2450 "$ref" : "#/definitions/ErrorResponse" 2451 } 2452 }, 2453 "500" : { 2454 "description" : "Internal Server Error", 2455 "schema" : { 2456 "$ref" : "#/definitions/ErrorResponse" 2457 } 2458 } 2459 }, 2460 "security" : [ { 2461 "Authorization" : [ ] 2462 } ] 2463 }, 2464 "delete" : { 2465 "tags" : [ "promotions :: executables :: authorization" ], 2466 "summary" : "Unassign user from Promotion", 2467 "description" : "Unassign user from Promotion", 2468 "operationId" : "deletePromotionUser", 2469 "parameters" : [ { 2470 "name" : "promotionId", 2471 "in" : "path", 2472 "description" : "Promotion ID", 2473 "required" : true, 2474 "type" : "string" 2475 }, { 2476 "name" : "userId", 2477 "in" : "path", 2478 "description" : "User ID", 2479 "required" : true, 2480 "type" : "string" 2481 } ], 2482 "responses" : { 2483 "204" : { 2484 "description" : "No Content" 2485 }, 2486 "400" : { 2487 "description" : "Bad Request", 2488 "schema" : { 2489 "$ref" : "#/definitions/ErrorResponse" 2490 } 2491 }, 2492 "401" : { 2493 "description" : "Unauthorized", 2494 "schema" : { 2495 "$ref" : "#/definitions/ErrorResponse" 2496 } 2497 }, 2498 "403" : { 2499 "description" : "Forbidden", 2500 "schema" : { 2501 "$ref" : "#/definitions/ErrorResponse" 2502 } 2503 }, 2504 "404" : { 2505 "description" : "Not Found", 2506 "schema" : { 2507 "$ref" : "#/definitions/ErrorResponse" 2508 } 2509 }, 2510 "500" : { 2511 "description" : "Internal Server Error", 2512 "schema" : { 2513 "$ref" : "#/definitions/ErrorResponse" 2514 } 2515 } 2516 }, 2517 "security" : [ { 2518 "Authorization" : [ ] 2519 } ] 2520 } 2521 }, 2522 "/executables/tasks" : { 2523 "get" : { 2524 "tags" : [ "tasks" ], 2525 "summary" : "Get available Tasks", 2526 "description" : "Get available Tasks", 2527 "operationId" : "getAvailableTasks", 2528 "produces" : [ "application/json" ], 2529 "parameters" : [ { 2530 "name" : "name", 2531 "in" : "query", 2532 "description" : "task name filter", 2533 "required" : false, 2534 "type" : "string" 2535 }, { 2536 "name" : "environmentId", 2537 "in" : "query", 2538 "description" : "environment id", 2539 "required" : false, 2540 "type" : "string" 2541 }, { 2542 "name" : "workspaceId", 2543 "in" : "query", 2544 "description" : "workspace id", 2545 "required" : false, 2546 "type" : "string" 2547 }, { 2548 "name" : "limit", 2549 "in" : "query", 2550 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 2551 "required" : false, 2552 "type" : "integer", 2553 "format" : "int32" 2554 }, { 2555 "name" : "offset", 2556 "in" : "query", 2557 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 2558 "required" : false, 2559 "type" : "integer", 2560 "format" : "int32" 2561 }, { 2562 "name" : "artifactId", 2563 "in" : "query", 2564 "description" : "artifact id", 2565 "required" : false, 2566 "type" : "string" 2567 }, { 2568 "name" : "runtimeType", 2569 "in" : "query", 2570 "description" : "runtime type", 2571 "required" : false, 2572 "type" : "string", 2573 "enum" : [ "CLOUD", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER", "CLOUD_EXCLUSIVE", "PIPELINE_ENGINE" ] 2574 }, { 2575 "name" : "runtimeId", 2576 "in" : "query", 2577 "description" : "runtime id", 2578 "required" : false, 2579 "type" : "string" 2580 }, { 2581 "name" : "runtimeRunProfileId", 2582 "in" : "query", 2583 "description" : "runtime run profile id", 2584 "required" : false, 2585 "type" : "string" 2586 } ], 2587 "responses" : { 2588 "200" : { 2589 "description" : "OK", 2590 "schema" : { 2591 "$ref" : "#/definitions/Page" 2592 } 2593 }, 2594 "400" : { 2595 "description" : "Bad Request", 2596 "schema" : { 2597 "$ref" : "#/definitions/ErrorResponse" 2598 } 2599 }, 2600 "401" : { 2601 "description" : "Unauthorized", 2602 "schema" : { 2603 "$ref" : "#/definitions/ErrorResponse" 2604 } 2605 }, 2606 "403" : { 2607 "description" : "Forbidden", 2608 "schema" : { 2609 "$ref" : "#/definitions/ErrorResponse" 2610 } 2611 }, 2612 "500" : { 2613 "description" : "Internal Server Error", 2614 "schema" : { 2615 "$ref" : "#/definitions/ErrorResponse" 2616 } 2617 } 2618 }, 2619 "security" : [ { 2620 "Authorization" : [ ] 2621 } ] 2622 }, 2623 "post" : { 2624 "tags" : [ "tasks" ], 2625 "summary" : "Create Task", 2626 "description" : "Create Task. By default the created task will have 'CLOUD' as its execution environment", 2627 "operationId" : "createTask", 2628 "consumes" : [ "application/json" ], 2629 "produces" : [ "application/json" ], 2630 "parameters" : [ { 2631 "in" : "body", 2632 "name" : "body", 2633 "description" : "Task to create", 2634 "required" : true, 2635 "schema" : { 2636 "$ref" : "#/definitions/TaskV21CreateRequest" 2637 } 2638 } ], 2639 "responses" : { 2640 "201" : { 2641 "description" : "Created", 2642 "schema" : { 2643 "$ref" : "#/definitions/TaskV21" 2644 } 2645 }, 2646 "400" : { 2647 "description" : "Bad Request", 2648 "schema" : { 2649 "$ref" : "#/definitions/ErrorResponse" 2650 } 2651 }, 2652 "401" : { 2653 "description" : "Unauthorized", 2654 "schema" : { 2655 "$ref" : "#/definitions/ErrorResponse" 2656 } 2657 }, 2658 "403" : { 2659 "description" : "Forbidden", 2660 "schema" : { 2661 "$ref" : "#/definitions/ErrorResponse" 2662 } 2663 }, 2664 "500" : { 2665 "description" : "Internal Server Error", 2666 "schema" : { 2667 "$ref" : "#/definitions/ErrorResponse" 2668 } 2669 } 2670 }, 2671 "security" : [ { 2672 "Authorization" : [ ] 2673 } ] 2674 } 2675 }, 2676 "/executables/tasks/executions" : { 2677 "get" : { 2678 "tags" : [ "tasks" ], 2679 "summary" : "Get available Tasks Executions", 2680 "description" : "Get available Tasks Executions. Chosen date range cannot be more than 60 days", 2681 "operationId" : "listAvailableTaskExecutions", 2682 "produces" : [ "application/json" ], 2683 "parameters" : [ { 2684 "name" : "limit", 2685 "in" : "query", 2686 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 2687 "required" : false, 2688 "type" : "integer", 2689 "format" : "int32" 2690 }, { 2691 "name" : "offset", 2692 "in" : "query", 2693 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 2694 "required" : false, 2695 "type" : "integer", 2696 "format" : "int32" 2697 }, { 2698 "name" : "status", 2699 "in" : "query", 2700 "description" : "execution status", 2701 "required" : false, 2702 "type" : "string", 2703 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_successful", "execution_rejected", "execution_failed", "terminated", "terminated_timeout" ] 2704 }, { 2705 "name" : "from", 2706 "in" : "query", 2707 "description" : "from date time (milliseconds)", 2708 "required" : false, 2709 "type" : "integer", 2710 "format" : "int64" 2711 }, { 2712 "name" : "to", 2713 "in" : "query", 2714 "description" : "to date time (milliseconds)", 2715 "required" : false, 2716 "type" : "integer", 2717 "format" : "int64" 2718 }, { 2719 "name" : "lastDays", 2720 "in" : "query", 2721 "description" : "lastDays", 2722 "required" : false, 2723 "type" : "integer", 2724 "format" : "int32" 2725 }, { 2726 "name" : "environmentId", 2727 "in" : "query", 2728 "description" : "environment id", 2729 "required" : false, 2730 "type" : "string" 2731 }, { 2732 "name" : "workspaceId", 2733 "in" : "query", 2734 "description" : "workspace id", 2735 "required" : false, 2736 "type" : "string" 2737 } ], 2738 "responses" : { 2739 "200" : { 2740 "description" : "OK", 2741 "schema" : { 2742 "$ref" : "#/definitions/Page" 2743 } 2744 }, 2745 "400" : { 2746 "description" : "Bad Request", 2747 "schema" : { 2748 "$ref" : "#/definitions/ErrorResponse" 2749 } 2750 }, 2751 "401" : { 2752 "description" : "Unauthorized", 2753 "schema" : { 2754 "$ref" : "#/definitions/ErrorResponse" 2755 } 2756 }, 2757 "403" : { 2758 "description" : "Forbidden", 2759 "schema" : { 2760 "$ref" : "#/definitions/ErrorResponse" 2761 } 2762 }, 2763 "500" : { 2764 "description" : "Internal Server Error", 2765 "schema" : { 2766 "$ref" : "#/definitions/ErrorResponse" 2767 } 2768 } 2769 }, 2770 "security" : [ { 2771 "Authorization" : [ ] 2772 } ] 2773 }, 2774 "post" : { 2775 "tags" : [ "tasks" ], 2776 "summary" : "Get available Tasks Executions", 2777 "description" : "Get available Tasks Executions", 2778 "operationId" : "executablelistAvailableTaskExecutions", 2779 "consumes" : [ "application/json" ], 2780 "produces" : [ "application/json" ], 2781 "parameters" : [ { 2782 "in" : "body", 2783 "name" : "body", 2784 "required" : false, 2785 "schema" : { 2786 "$ref" : "#/definitions/TaskExecutionsRequest" 2787 } 2788 } ], 2789 "responses" : { 2790 "200" : { 2791 "description" : "OK", 2792 "schema" : { 2793 "$ref" : "#/definitions/Page" 2794 } 2795 }, 2796 "400" : { 2797 "description" : "Bad Request", 2798 "schema" : { 2799 "$ref" : "#/definitions/ErrorResponse" 2800 } 2801 }, 2802 "401" : { 2803 "description" : "Unauthorized", 2804 "schema" : { 2805 "$ref" : "#/definitions/ErrorResponse" 2806 } 2807 }, 2808 "403" : { 2809 "description" : "Forbidden", 2810 "schema" : { 2811 "$ref" : "#/definitions/ErrorResponse" 2812 } 2813 }, 2814 "404" : { 2815 "description" : "Not Found", 2816 "schema" : { 2817 "$ref" : "#/definitions/ErrorResponse" 2818 } 2819 }, 2820 "500" : { 2821 "description" : "Internal Server Error", 2822 "schema" : { 2823 "$ref" : "#/definitions/ErrorResponse" 2824 } 2825 } 2826 }, 2827 "security" : [ { 2828 "Authorization" : [ ] 2829 } ] 2830 } 2831 }, 2832 "/executables/tasks/search" : { 2833 "post" : { 2834 "tags" : [ "tasks" ], 2835 "summary" : "Search Tasks", 2836 "description" : "Search Tasks", 2837 "operationId" : "searchTasks", 2838 "consumes" : [ "application/json" ], 2839 "produces" : [ "application/json" ], 2840 "parameters" : [ { 2841 "in" : "body", 2842 "name" : "body", 2843 "description" : "Search tasks filters", 2844 "required" : true, 2845 "schema" : { 2846 "$ref" : "#/definitions/FetchTasksModel" 2847 } 2848 } ], 2849 "responses" : { 2850 "200" : { 2851 "description" : "OK", 2852 "schema" : { 2853 "$ref" : "#/definitions/Page" 2854 } 2855 }, 2856 "400" : { 2857 "description" : "Bad Request", 2858 "schema" : { 2859 "$ref" : "#/definitions/ErrorResponse" 2860 } 2861 }, 2862 "401" : { 2863 "description" : "Unauthorized", 2864 "schema" : { 2865 "$ref" : "#/definitions/ErrorResponse" 2866 } 2867 }, 2868 "403" : { 2869 "description" : "Forbidden", 2870 "schema" : { 2871 "$ref" : "#/definitions/ErrorResponse" 2872 } 2873 }, 2874 "404" : { 2875 "description" : "Not Found", 2876 "schema" : { 2877 "$ref" : "#/definitions/ErrorResponse" 2878 } 2879 }, 2880 "500" : { 2881 "description" : "Internal Server Error", 2882 "schema" : { 2883 "$ref" : "#/definitions/ErrorResponse" 2884 } 2885 } 2886 }, 2887 "security" : [ { 2888 "Authorization" : [ ] 2889 } ] 2890 } 2891 }, 2892 "/executables/tasks/{taskId}" : { 2893 "get" : { 2894 "tags" : [ "tasks" ], 2895 "summary" : "Get Task by id", 2896 "description" : "Get Task by id", 2897 "operationId" : "getTask", 2898 "produces" : [ "application/json" ], 2899 "parameters" : [ { 2900 "name" : "taskId", 2901 "in" : "path", 2902 "description" : "task id", 2903 "required" : true, 2904 "type" : "string" 2905 } ], 2906 "responses" : { 2907 "200" : { 2908 "description" : "OK", 2909 "schema" : { 2910 "$ref" : "#/definitions/TaskV21" 2911 } 2912 }, 2913 "400" : { 2914 "description" : "Bad Request", 2915 "schema" : { 2916 "$ref" : "#/definitions/ErrorResponse" 2917 } 2918 }, 2919 "401" : { 2920 "description" : "Unauthorized", 2921 "schema" : { 2922 "$ref" : "#/definitions/ErrorResponse" 2923 } 2924 }, 2925 "403" : { 2926 "description" : "Forbidden", 2927 "schema" : { 2928 "$ref" : "#/definitions/ErrorResponse" 2929 } 2930 }, 2931 "404" : { 2932 "description" : "Not Found", 2933 "schema" : { 2934 "$ref" : "#/definitions/ErrorResponse" 2935 } 2936 }, 2937 "500" : { 2938 "description" : "Internal Server Error", 2939 "schema" : { 2940 "$ref" : "#/definitions/ErrorResponse" 2941 } 2942 } 2943 }, 2944 "security" : [ { 2945 "Authorization" : [ ] 2946 } ] 2947 }, 2948 "put" : { 2949 "tags" : [ "tasks" ], 2950 "summary" : "Update Task", 2951 "description" : "Update Task", 2952 "operationId" : "updateTask", 2953 "consumes" : [ "application/json" ], 2954 "produces" : [ "application/json" ], 2955 "parameters" : [ { 2956 "name" : "taskId", 2957 "in" : "path", 2958 "description" : "task ID", 2959 "required" : true, 2960 "type" : "string" 2961 }, { 2962 "in" : "body", 2963 "name" : "body", 2964 "description" : "task", 2965 "required" : true, 2966 "schema" : { 2967 "$ref" : "#/definitions/TaskAutoUpgradeRequest" 2968 } 2969 } ], 2970 "responses" : { 2971 "200" : { 2972 "description" : "OK", 2973 "schema" : { 2974 "$ref" : "#/definitions/TaskV21" 2975 } 2976 }, 2977 "400" : { 2978 "description" : "Bad Request", 2979 "schema" : { 2980 "$ref" : "#/definitions/ErrorResponse" 2981 } 2982 }, 2983 "401" : { 2984 "description" : "Unauthorized", 2985 "schema" : { 2986 "$ref" : "#/definitions/ErrorResponse" 2987 } 2988 }, 2989 "403" : { 2990 "description" : "Forbidden", 2991 "schema" : { 2992 "$ref" : "#/definitions/ErrorResponse" 2993 } 2994 }, 2995 "404" : { 2996 "description" : "Not Found", 2997 "schema" : { 2998 "$ref" : "#/definitions/ErrorResponse" 2999 } 3000 }, 3001 "500" : { 3002 "description" : "Internal Server Error", 3003 "schema" : { 3004 "$ref" : "#/definitions/ErrorResponse" 3005 } 3006 } 3007 }, 3008 "security" : [ { 3009 "Authorization" : [ ] 3010 } ] 3011 }, 3012 "delete" : { 3013 "tags" : [ "tasks" ], 3014 "summary" : "Delete Task", 3015 "description" : "Delete Task", 3016 "operationId" : "deleteTask", 3017 "parameters" : [ { 3018 "name" : "taskId", 3019 "in" : "path", 3020 "description" : "task ID", 3021 "required" : true, 3022 "type" : "string" 3023 }, { 3024 "name" : "terminateExecutions", 3025 "in" : "query", 3026 "description" : "terminate task executions", 3027 "required" : false, 3028 "type" : "boolean" 3029 } ], 3030 "responses" : { 3031 "204" : { 3032 "description" : "No Content" 3033 }, 3034 "400" : { 3035 "description" : "Bad Request", 3036 "schema" : { 3037 "$ref" : "#/definitions/ErrorResponse" 3038 } 3039 }, 3040 "401" : { 3041 "description" : "Unauthorized", 3042 "schema" : { 3043 "$ref" : "#/definitions/ErrorResponse" 3044 } 3045 }, 3046 "403" : { 3047 "description" : "Forbidden", 3048 "schema" : { 3049 "$ref" : "#/definitions/ErrorResponse" 3050 } 3051 }, 3052 "404" : { 3053 "description" : "Not Found", 3054 "schema" : { 3055 "$ref" : "#/definitions/ErrorResponse" 3056 } 3057 }, 3058 "409" : { 3059 "description" : "Conflict", 3060 "schema" : { 3061 "$ref" : "#/definitions/ErrorResponse" 3062 } 3063 }, 3064 "500" : { 3065 "description" : "Internal Server Error", 3066 "schema" : { 3067 "$ref" : "#/definitions/ErrorResponse" 3068 } 3069 } 3070 }, 3071 "security" : [ { 3072 "Authorization" : [ ] 3073 } ] 3074 } 3075 }, 3076 "/executables/tasks/{taskId}/executions" : { 3077 "get" : { 3078 "tags" : [ "tasks" ], 3079 "summary" : "Get Task Executions", 3080 "description" : "Get task executions. Chosen date range cannot be more than 60 days", 3081 "operationId" : "listTaskExecutions", 3082 "produces" : [ "application/json" ], 3083 "parameters" : [ { 3084 "name" : "taskId", 3085 "in" : "path", 3086 "description" : "task ID", 3087 "required" : true, 3088 "type" : "string" 3089 }, { 3090 "name" : "limit", 3091 "in" : "query", 3092 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 3093 "required" : false, 3094 "type" : "integer", 3095 "format" : "int32" 3096 }, { 3097 "name" : "offset", 3098 "in" : "query", 3099 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 3100 "required" : false, 3101 "type" : "integer", 3102 "format" : "int32" 3103 }, { 3104 "name" : "status", 3105 "in" : "query", 3106 "description" : "execution status", 3107 "required" : false, 3108 "type" : "string", 3109 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_successful", "execution_rejected", "execution_failed", "terminated", "terminated_timeout" ] 3110 }, { 3111 "name" : "from", 3112 "in" : "query", 3113 "description" : "from date time (milliseconds)", 3114 "required" : false, 3115 "type" : "integer", 3116 "format" : "int64" 3117 }, { 3118 "name" : "to", 3119 "in" : "query", 3120 "description" : "to date time (milliseconds)", 3121 "required" : false, 3122 "type" : "integer", 3123 "format" : "int64" 3124 }, { 3125 "name" : "lastDays", 3126 "in" : "query", 3127 "description" : "lastDays", 3128 "required" : false, 3129 "type" : "integer", 3130 "format" : "int32" 3131 } ], 3132 "responses" : { 3133 "200" : { 3134 "description" : "OK", 3135 "schema" : { 3136 "$ref" : "#/definitions/Page" 3137 } 3138 }, 3139 "400" : { 3140 "description" : "Bad Request", 3141 "schema" : { 3142 "$ref" : "#/definitions/ErrorResponse" 3143 } 3144 }, 3145 "401" : { 3146 "description" : "Unauthorized", 3147 "schema" : { 3148 "$ref" : "#/definitions/ErrorResponse" 3149 } 3150 }, 3151 "403" : { 3152 "description" : "Forbidden", 3153 "schema" : { 3154 "$ref" : "#/definitions/ErrorResponse" 3155 } 3156 }, 3157 "404" : { 3158 "description" : "Not Found", 3159 "schema" : { 3160 "$ref" : "#/definitions/ErrorResponse" 3161 } 3162 }, 3163 "500" : { 3164 "description" : "Internal Server Error", 3165 "schema" : { 3166 "$ref" : "#/definitions/ErrorResponse" 3167 } 3168 } 3169 }, 3170 "security" : [ { 3171 "Authorization" : [ ] 3172 } ] 3173 } 3174 }, 3175 "/executables/tasks/{taskId}/pause" : { 3176 "put" : { 3177 "tags" : [ "tasks" ], 3178 "summary" : "Pause-Resume task execution", 3179 "description" : "", 3180 "operationId" : "pauseTaskExecution", 3181 "consumes" : [ "application/json" ], 3182 "parameters" : [ { 3183 "name" : "taskId", 3184 "in" : "path", 3185 "description" : "task id", 3186 "required" : true, 3187 "type" : "string" 3188 }, { 3189 "in" : "body", 3190 "name" : "body", 3191 "description" : "Action to perform ", 3192 "required" : true, 3193 "schema" : { 3194 "$ref" : "#/definitions/TaskPauseDetails" 3195 } 3196 } ], 3197 "responses" : { 3198 "202" : { 3199 "description" : "Task execution state changed" 3200 }, 3201 "204" : { 3202 "description" : "Task execution already in same state" 3203 }, 3204 "400" : { 3205 "description" : "Bad Request", 3206 "schema" : { 3207 "$ref" : "#/definitions/ErrorResponse" 3208 } 3209 }, 3210 "401" : { 3211 "description" : "Unauthorized", 3212 "schema" : { 3213 "$ref" : "#/definitions/ErrorResponse" 3214 } 3215 }, 3216 "403" : { 3217 "description" : "Forbidden", 3218 "schema" : { 3219 "$ref" : "#/definitions/ErrorResponse" 3220 } 3221 }, 3222 "404" : { 3223 "description" : "Not Found", 3224 "schema" : { 3225 "$ref" : "#/definitions/ErrorResponse" 3226 } 3227 }, 3228 "500" : { 3229 "description" : "Internal Server Error", 3230 "schema" : { 3231 "$ref" : "#/definitions/ErrorResponse" 3232 } 3233 } 3234 }, 3235 "security" : [ { 3236 "Authorization" : [ ] 3237 } ] 3238 } 3239 }, 3240 "/executables/tasks/{taskId}/run-config" : { 3241 "get" : { 3242 "tags" : [ "tasks" ], 3243 "summary" : "Get Task configuration", 3244 "description" : "Get Task configuration", 3245 "operationId" : "getTaskConfiguration", 3246 "produces" : [ "application/json" ], 3247 "parameters" : [ { 3248 "name" : "taskId", 3249 "in" : "path", 3250 "description" : "task id", 3251 "required" : true, 3252 "type" : "string" 3253 } ], 3254 "responses" : { 3255 "200" : { 3256 "description" : "OK", 3257 "schema" : { 3258 "$ref" : "#/definitions/TaskRunConfig" 3259 } 3260 }, 3261 "400" : { 3262 "description" : "Bad Request", 3263 "schema" : { 3264 "$ref" : "#/definitions/ErrorResponse" 3265 } 3266 }, 3267 "401" : { 3268 "description" : "Unauthorized", 3269 "schema" : { 3270 "$ref" : "#/definitions/ErrorResponse" 3271 } 3272 }, 3273 "403" : { 3274 "description" : "Forbidden", 3275 "schema" : { 3276 "$ref" : "#/definitions/ErrorResponse" 3277 } 3278 }, 3279 "404" : { 3280 "description" : "Not Found", 3281 "schema" : { 3282 "$ref" : "#/definitions/ErrorResponse" 3283 } 3284 }, 3285 "500" : { 3286 "description" : "Internal Server Error", 3287 "schema" : { 3288 "$ref" : "#/definitions/ErrorResponse" 3289 } 3290 } 3291 }, 3292 "security" : [ { 3293 "Authorization" : [ ] 3294 } ] 3295 }, 3296 "put" : { 3297 "tags" : [ "tasks" ], 3298 "summary" : "Configure Task execution", 3299 "description" : "Configure Task execution.<br>User must have the specific permission \"Run Profile - Manage\" or \"Engines - Manage\". Usage of attribute `parallelExecutionAllowed` with `REMOTE_ENGINE` runtime type requires API v2.6 and higher.", 3300 "operationId" : "configureTaskExecution", 3301 "consumes" : [ "application/json" ], 3302 "produces" : [ "application/json" ], 3303 "parameters" : [ { 3304 "name" : "taskId", 3305 "in" : "path", 3306 "description" : "task id", 3307 "required" : true, 3308 "type" : "string" 3309 }, { 3310 "in" : "body", 3311 "name" : "body", 3312 "description" : "RunConfig", 3313 "required" : true, 3314 "schema" : { 3315 "$ref" : "#/definitions/TaskRunConfig" 3316 } 3317 } ], 3318 "responses" : { 3319 "200" : { 3320 "description" : "OK", 3321 "schema" : { 3322 "$ref" : "#/definitions/TaskRunConfig" 3323 } 3324 }, 3325 "400" : { 3326 "description" : "Bad Request", 3327 "schema" : { 3328 "$ref" : "#/definitions/ErrorResponse" 3329 } 3330 }, 3331 "401" : { 3332 "description" : "Unauthorized", 3333 "schema" : { 3334 "$ref" : "#/definitions/ErrorResponse" 3335 } 3336 }, 3337 "403" : { 3338 "description" : "Forbidden", 3339 "schema" : { 3340 "$ref" : "#/definitions/ErrorResponse" 3341 } 3342 }, 3343 "404" : { 3344 "description" : "Not Found", 3345 "schema" : { 3346 "$ref" : "#/definitions/ErrorResponse" 3347 } 3348 }, 3349 "500" : { 3350 "description" : "Internal Server Error", 3351 "schema" : { 3352 "$ref" : "#/definitions/ErrorResponse" 3353 } 3354 } 3355 }, 3356 "security" : [ { 3357 "Authorization" : [ ] 3358 } ] 3359 }, 3360 "delete" : { 3361 "tags" : [ "tasks" ], 3362 "summary" : "Stop schedule for Task", 3363 "description" : "Stop schedule for task", 3364 "operationId" : "stopSchedule", 3365 "parameters" : [ { 3366 "name" : "taskId", 3367 "in" : "path", 3368 "description" : "task ID", 3369 "required" : true, 3370 "type" : "string" 3371 } ], 3372 "responses" : { 3373 "204" : { 3374 "description" : "No Content" 3375 }, 3376 "400" : { 3377 "description" : "Bad Request", 3378 "schema" : { 3379 "$ref" : "#/definitions/ErrorResponse" 3380 } 3381 }, 3382 "401" : { 3383 "description" : "Unauthorized", 3384 "schema" : { 3385 "$ref" : "#/definitions/ErrorResponse" 3386 } 3387 }, 3388 "403" : { 3389 "description" : "Forbidden", 3390 "schema" : { 3391 "$ref" : "#/definitions/ErrorResponse" 3392 } 3393 }, 3394 "404" : { 3395 "description" : "Not Found", 3396 "schema" : { 3397 "$ref" : "#/definitions/ErrorResponse" 3398 } 3399 }, 3400 "500" : { 3401 "description" : "Internal Server Error", 3402 "schema" : { 3403 "$ref" : "#/definitions/ErrorResponse" 3404 } 3405 } 3406 }, 3407 "security" : [ { 3408 "Authorization" : [ ] 3409 } ] 3410 } 3411 }, 3412 "/executables/tasks/{taskId}/run-config/events" : { 3413 "get" : { 3414 "tags" : [ "tasks" ], 3415 "summary" : "Get task scheduled triggers", 3416 "description" : "Get task triggers", 3417 "operationId" : "getTaskScheduledEvents", 3418 "produces" : [ "application/json" ], 3419 "parameters" : [ { 3420 "name" : "taskId", 3421 "in" : "path", 3422 "description" : "task id", 3423 "required" : true, 3424 "type" : "string" 3425 }, { 3426 "name" : "from", 3427 "in" : "query", 3428 "description" : "from date time (milliseconds)", 3429 "required" : false, 3430 "type" : "integer", 3431 "format" : "int64" 3432 }, { 3433 "name" : "to", 3434 "in" : "query", 3435 "description" : "to date time (milliseconds)", 3436 "required" : true, 3437 "type" : "integer", 3438 "format" : "int64" 3439 }, { 3440 "name" : "limit", 3441 "in" : "query", 3442 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 3443 "required" : false, 3444 "type" : "integer", 3445 "format" : "int32" 3446 }, { 3447 "name" : "offset", 3448 "in" : "query", 3449 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 3450 "required" : false, 3451 "type" : "integer", 3452 "format" : "int32" 3453 } ], 3454 "responses" : { 3455 "200" : { 3456 "description" : "OK", 3457 "schema" : { 3458 "$ref" : "#/definitions/Page" 3459 } 3460 }, 3461 "400" : { 3462 "description" : "Bad Request", 3463 "schema" : { 3464 "$ref" : "#/definitions/ErrorResponse" 3465 } 3466 }, 3467 "401" : { 3468 "description" : "Unauthorized", 3469 "schema" : { 3470 "$ref" : "#/definitions/ErrorResponse" 3471 } 3472 }, 3473 "403" : { 3474 "description" : "Forbidden", 3475 "schema" : { 3476 "$ref" : "#/definitions/ErrorResponse" 3477 } 3478 }, 3479 "404" : { 3480 "description" : "Not Found", 3481 "schema" : { 3482 "$ref" : "#/definitions/ErrorResponse" 3483 } 3484 }, 3485 "500" : { 3486 "description" : "Internal Server Error", 3487 "schema" : { 3488 "$ref" : "#/definitions/ErrorResponse" 3489 } 3490 } 3491 }, 3492 "security" : [ { 3493 "Authorization" : [ ] 3494 } ] 3495 } 3496 }, 3497 "/executables/tasks/{taskId}/schedule" : { 3498 "get" : { 3499 "tags" : [ "tasks" ], 3500 "summary" : "Get task schedule", 3501 "description" : "Get task schedule multiple triggers", 3502 "operationId" : "getTaskScheduleMultipleTriggers", 3503 "produces" : [ "application/json" ], 3504 "parameters" : [ { 3505 "name" : "taskId", 3506 "in" : "path", 3507 "description" : "task id", 3508 "required" : true, 3509 "type" : "string" 3510 } ], 3511 "responses" : { 3512 "200" : { 3513 "description" : "OK", 3514 "schema" : { 3515 "$ref" : "#/definitions/Schedule" 3516 } 3517 }, 3518 "400" : { 3519 "description" : "Bad Request", 3520 "schema" : { 3521 "$ref" : "#/definitions/ErrorResponse" 3522 } 3523 }, 3524 "401" : { 3525 "description" : "Unauthorized", 3526 "schema" : { 3527 "$ref" : "#/definitions/ErrorResponse" 3528 } 3529 }, 3530 "403" : { 3531 "description" : "Forbidden", 3532 "schema" : { 3533 "$ref" : "#/definitions/ErrorResponse" 3534 } 3535 }, 3536 "404" : { 3537 "description" : "Not Found", 3538 "schema" : { 3539 "$ref" : "#/definitions/ErrorResponse" 3540 } 3541 }, 3542 "500" : { 3543 "description" : "Internal Server Error", 3544 "schema" : { 3545 "$ref" : "#/definitions/ErrorResponse" 3546 } 3547 } 3548 }, 3549 "security" : [ { 3550 "Authorization" : [ ] 3551 } ] 3552 }, 3553 "put" : { 3554 "tags" : [ "tasks" ], 3555 "summary" : "Link task schedule", 3556 "description" : "Link schedule with task", 3557 "operationId" : "linkTaskSchedule", 3558 "consumes" : [ "application/json" ], 3559 "parameters" : [ { 3560 "name" : "taskId", 3561 "in" : "path", 3562 "description" : "task id", 3563 "required" : true, 3564 "type" : "string" 3565 }, { 3566 "in" : "body", 3567 "name" : "body", 3568 "description" : "schedule id", 3569 "required" : false, 3570 "schema" : { 3571 "$ref" : "#/definitions/LinkScheduleMultipleTriggerRequest" 3572 } 3573 } ], 3574 "responses" : { 3575 "200" : { 3576 "description" : "OK", 3577 "schema" : { 3578 "$ref" : "#/definitions/Response" 3579 } 3580 }, 3581 "400" : { 3582 "description" : "Bad Request", 3583 "schema" : { 3584 "$ref" : "#/definitions/ErrorResponse" 3585 } 3586 }, 3587 "401" : { 3588 "description" : "Unauthorized", 3589 "schema" : { 3590 "$ref" : "#/definitions/ErrorResponse" 3591 } 3592 }, 3593 "403" : { 3594 "description" : "Forbidden", 3595 "schema" : { 3596 "$ref" : "#/definitions/ErrorResponse" 3597 } 3598 }, 3599 "404" : { 3600 "description" : "Not Found", 3601 "schema" : { 3602 "$ref" : "#/definitions/ErrorResponse" 3603 } 3604 }, 3605 "500" : { 3606 "description" : "Internal Server Error", 3607 "schema" : { 3608 "$ref" : "#/definitions/ErrorResponse" 3609 } 3610 } 3611 }, 3612 "security" : [ { 3613 "Authorization" : [ ] 3614 } ] 3615 }, 3616 "delete" : { 3617 "tags" : [ "tasks" ], 3618 "summary" : "Unlink task schedule", 3619 "description" : "Unlink schedule from task", 3620 "operationId" : "unlinkTaskSchedule", 3621 "parameters" : [ { 3622 "name" : "taskId", 3623 "in" : "path", 3624 "description" : "task id", 3625 "required" : true, 3626 "type" : "string" 3627 } ], 3628 "responses" : { 3629 "204" : { 3630 "description" : "No content", 3631 "schema" : { 3632 "$ref" : "#/definitions/Response" 3633 } 3634 }, 3635 "400" : { 3636 "description" : "Bad Request", 3637 "schema" : { 3638 "$ref" : "#/definitions/ErrorResponse" 3639 } 3640 }, 3641 "401" : { 3642 "description" : "Unauthorized", 3643 "schema" : { 3644 "$ref" : "#/definitions/ErrorResponse" 3645 } 3646 }, 3647 "403" : { 3648 "description" : "Forbidden", 3649 "schema" : { 3650 "$ref" : "#/definitions/ErrorResponse" 3651 } 3652 }, 3653 "404" : { 3654 "description" : "Not Found", 3655 "schema" : { 3656 "$ref" : "#/definitions/ErrorResponse" 3657 } 3658 }, 3659 "500" : { 3660 "description" : "Internal Server Error", 3661 "schema" : { 3662 "$ref" : "#/definitions/ErrorResponse" 3663 } 3664 } 3665 }, 3666 "security" : [ { 3667 "Authorization" : [ ] 3668 } ] 3669 } 3670 }, 3671 "/executions" : { 3672 "post" : { 3673 "tags" : [ "executions" ], 3674 "summary" : "Execute Task", 3675 "description" : "Execute Task", 3676 "operationId" : "execute", 3677 "consumes" : [ "application/json" ], 3678 "produces" : [ "application/json" ], 3679 "parameters" : [ { 3680 "in" : "body", 3681 "name" : "body", 3682 "description" : "Executable identifier", 3683 "required" : true, 3684 "schema" : { 3685 "$ref" : "#/definitions/Executabletask" 3686 } 3687 } ], 3688 "responses" : { 3689 "201" : { 3690 "description" : "Execution started", 3691 "schema" : { 3692 "$ref" : "#/definitions/Executionidentifier" 3693 } 3694 }, 3695 "400" : { 3696 "description" : "Bad Request", 3697 "schema" : { 3698 "$ref" : "#/definitions/ErrorResponse" 3699 } 3700 }, 3701 "401" : { 3702 "description" : "Unauthorized", 3703 "schema" : { 3704 "$ref" : "#/definitions/ErrorResponse" 3705 } 3706 }, 3707 "403" : { 3708 "description" : "Forbidden - no permissions to access resource", 3709 "schema" : { 3710 "$ref" : "#/definitions/ErrorResponse" 3711 } 3712 }, 3713 "404" : { 3714 "description" : "Not found - resource not found", 3715 "schema" : { 3716 "$ref" : "#/definitions/ErrorResponse" 3717 } 3718 }, 3719 "500" : { 3720 "description" : "Server error - something went wrong on server side", 3721 "schema" : { 3722 "$ref" : "#/definitions/ErrorResponse" 3723 } 3724 }, 3725 "501" : { 3726 "description" : "Task cannot be deployed because it is not configured", 3727 "schema" : { 3728 "$ref" : "#/definitions/ErrorResponse" 3729 } 3730 } 3731 }, 3732 "security" : [ { 3733 "Authorization" : [ ] 3734 } ] 3735 } 3736 }, 3737 "/executions/plans" : { 3738 "post" : { 3739 "tags" : [ "plans :: executions" ], 3740 "summary" : "Execute Plan", 3741 "description" : "Allows to run a Plan (starting from V2.4: allows also to rerun the plan from a specific step)", 3742 "operationId" : "executePlan", 3743 "consumes" : [ "application/json" ], 3744 "produces" : [ "application/json" ], 3745 "parameters" : [ { 3746 "in" : "body", 3747 "name" : "body", 3748 "description" : "Executable identifier", 3749 "required" : true, 3750 "schema" : { 3751 "$ref" : "#/definitions/PlanExecutable" 3752 } 3753 } ], 3754 "responses" : { 3755 "201" : { 3756 "description" : "Execution started", 3757 "schema" : { 3758 "$ref" : "#/definitions/Executionidentifier" 3759 } 3760 }, 3761 "400" : { 3762 "description" : "Bad Request", 3763 "schema" : { 3764 "$ref" : "#/definitions/ErrorResponse" 3765 } 3766 }, 3767 "401" : { 3768 "description" : "Unauthorized", 3769 "schema" : { 3770 "$ref" : "#/definitions/ErrorResponse" 3771 } 3772 }, 3773 "403" : { 3774 "description" : "Forbidden - no permissions to access resource", 3775 "schema" : { 3776 "$ref" : "#/definitions/ErrorResponse" 3777 } 3778 }, 3779 "404" : { 3780 "description" : "Not found - resource not found", 3781 "schema" : { 3782 "$ref" : "#/definitions/ErrorResponse" 3783 } 3784 }, 3785 "405" : { 3786 "description" : "Operation not allowed - Plan execution paused", 3787 "schema" : { 3788 "$ref" : "#/definitions/ErrorResponse" 3789 } 3790 }, 3791 "422" : { 3792 "description" : "Entity exists but cannot be processed, because too old or plan exec didn't fail ", 3793 "schema" : { 3794 "$ref" : "#/definitions/ErrorResponse" 3795 } 3796 }, 3797 "500" : { 3798 "description" : "Server error - something went wrong on server side", 3799 "schema" : { 3800 "$ref" : "#/definitions/ErrorResponse" 3801 } 3802 }, 3803 "501" : { 3804 "description" : "Plan cannot be deployed because it is not configured", 3805 "schema" : { 3806 "$ref" : "#/definitions/ErrorResponse" 3807 } 3808 } 3809 }, 3810 "security" : [ { 3811 "Authorization" : [ ] 3812 } ] 3813 } 3814 }, 3815 "/executions/plans/{id}" : { 3816 "get" : { 3817 "tags" : [ "plans :: executions" ], 3818 "summary" : "Get Plan execution status", 3819 "description" : "Get Plan execution status", 3820 "operationId" : "getPlanExecutionStatus", 3821 "produces" : [ "application/json" ], 3822 "parameters" : [ { 3823 "name" : "id", 3824 "in" : "path", 3825 "description" : "execution ID", 3826 "required" : true, 3827 "type" : "string" 3828 } ], 3829 "responses" : { 3830 "200" : { 3831 "description" : "Successful response", 3832 "schema" : { 3833 "$ref" : "#/definitions/PlanExecutionStatus" 3834 } 3835 }, 3836 "400" : { 3837 "description" : "Bad Request", 3838 "schema" : { 3839 "$ref" : "#/definitions/ErrorResponse" 3840 } 3841 }, 3842 "401" : { 3843 "description" : "Unauthorized", 3844 "schema" : { 3845 "$ref" : "#/definitions/ErrorResponse" 3846 } 3847 }, 3848 "403" : { 3849 "description" : "Forbidden - no permissions to access resource", 3850 "schema" : { 3851 "$ref" : "#/definitions/ErrorResponse" 3852 } 3853 }, 3854 "404" : { 3855 "description" : "Not found - resource not found", 3856 "schema" : { 3857 "$ref" : "#/definitions/ErrorResponse" 3858 } 3859 }, 3860 "429" : { 3861 "description" : "Too many requests", 3862 "schema" : { 3863 "$ref" : "#/definitions/ErrorResponse" 3864 } 3865 }, 3866 "500" : { 3867 "description" : "Server error - something went wrong on server side", 3868 "schema" : { 3869 "$ref" : "#/definitions/ErrorResponse" 3870 } 3871 } 3872 }, 3873 "security" : [ { 3874 "Authorization" : [ ] 3875 } ] 3876 } 3877 }, 3878 "/executions/plans/{planExecutionId}/steps" : { 3879 "get" : { 3880 "tags" : [ "plans :: executions" ], 3881 "summary" : "Get all steps for a plan execution (order by designed execution, only steps, without error handlers)", 3882 "description" : "Get Steps executions status", 3883 "operationId" : "getAllStepExecutions", 3884 "produces" : [ "application/json" ], 3885 "parameters" : [ { 3886 "name" : "planExecutionId", 3887 "in" : "path", 3888 "description" : "Plan execution ID", 3889 "required" : true, 3890 "type" : "string" 3891 } ], 3892 "responses" : { 3893 "200" : { 3894 "description" : "Successful response", 3895 "schema" : { 3896 "type" : "array", 3897 "items" : { 3898 "$ref" : "#/definitions/StepExecution" 3899 } 3900 } 3901 }, 3902 "400" : { 3903 "description" : "Bad Request", 3904 "schema" : { 3905 "$ref" : "#/definitions/ErrorResponse" 3906 } 3907 }, 3908 "401" : { 3909 "description" : "Unauthorized", 3910 "schema" : { 3911 "$ref" : "#/definitions/ErrorResponse" 3912 } 3913 }, 3914 "403" : { 3915 "description" : "Forbidden - no permissions to access resource", 3916 "schema" : { 3917 "$ref" : "#/definitions/ErrorResponse" 3918 } 3919 }, 3920 "404" : { 3921 "description" : "Not found - resource not found", 3922 "schema" : { 3923 "$ref" : "#/definitions/ErrorResponse" 3924 } 3925 }, 3926 "500" : { 3927 "description" : "Server error - something went wrong on server side", 3928 "schema" : { 3929 "$ref" : "#/definitions/ErrorResponse" 3930 } 3931 } 3932 }, 3933 "security" : [ { 3934 "Authorization" : [ ] 3935 } ] 3936 } 3937 }, 3938 "/executions/plans/{planExecutionId}/steps/{stepExecutionId}" : { 3939 "get" : { 3940 "tags" : [ "plans :: executions" ], 3941 "summary" : "Get the step for plan execution without error handlers", 3942 "description" : "Get Step execution status", 3943 "operationId" : "getStepExecution", 3944 "produces" : [ "application/json" ], 3945 "parameters" : [ { 3946 "name" : "planExecutionId", 3947 "in" : "path", 3948 "description" : "Plan execution ID", 3949 "required" : true, 3950 "type" : "string" 3951 }, { 3952 "name" : "stepExecutionId", 3953 "in" : "path", 3954 "description" : "Step execution ID", 3955 "required" : true, 3956 "type" : "string" 3957 } ], 3958 "responses" : { 3959 "200" : { 3960 "description" : "Successful response", 3961 "schema" : { 3962 "$ref" : "#/definitions/PlanExecutionStatus" 3963 } 3964 }, 3965 "400" : { 3966 "description" : "Bad Request", 3967 "schema" : { 3968 "$ref" : "#/definitions/ErrorResponse" 3969 } 3970 }, 3971 "401" : { 3972 "description" : "Unauthorized", 3973 "schema" : { 3974 "$ref" : "#/definitions/ErrorResponse" 3975 } 3976 }, 3977 "403" : { 3978 "description" : "Forbidden - no permissions to access resource", 3979 "schema" : { 3980 "$ref" : "#/definitions/ErrorResponse" 3981 } 3982 }, 3983 "404" : { 3984 "description" : "Not found - resource not found", 3985 "schema" : { 3986 "$ref" : "#/definitions/ErrorResponse" 3987 } 3988 }, 3989 "500" : { 3990 "description" : "Server error - something went wrong on server side", 3991 "schema" : { 3992 "$ref" : "#/definitions/ErrorResponse" 3993 } 3994 } 3995 }, 3996 "security" : [ { 3997 "Authorization" : [ ] 3998 } ] 3999 } 4000 }, 4001 "/executions/plans/{planExecutionId}/steps/{stepExecutionId}/error-handler" : { 4002 "get" : { 4003 "tags" : [ "plans :: executions" ], 4004 "summary" : "Get execution status of the handler for the specified step", 4005 "description" : "Get Step handler execution status", 4006 "operationId" : "getStepHandlerExecution", 4007 "produces" : [ "application/json" ], 4008 "parameters" : [ { 4009 "name" : "planExecutionId", 4010 "in" : "path", 4011 "description" : "Plan execution ID", 4012 "required" : true, 4013 "type" : "string" 4014 }, { 4015 "name" : "stepExecutionId", 4016 "in" : "path", 4017 "description" : "Step execution ID", 4018 "required" : true, 4019 "type" : "string" 4020 } ], 4021 "responses" : { 4022 "200" : { 4023 "description" : "Successful response", 4024 "schema" : { 4025 "$ref" : "#/definitions/PlanExecutionStatus" 4026 } 4027 }, 4028 "400" : { 4029 "description" : "Bad Request", 4030 "schema" : { 4031 "$ref" : "#/definitions/ErrorResponse" 4032 } 4033 }, 4034 "401" : { 4035 "description" : "Unauthorized", 4036 "schema" : { 4037 "$ref" : "#/definitions/ErrorResponse" 4038 } 4039 }, 4040 "403" : { 4041 "description" : "Forbidden - no permissions to access resource", 4042 "schema" : { 4043 "$ref" : "#/definitions/ErrorResponse" 4044 } 4045 }, 4046 "404" : { 4047 "description" : "Not found - resource not found", 4048 "schema" : { 4049 "$ref" : "#/definitions/ErrorResponse" 4050 } 4051 }, 4052 "500" : { 4053 "description" : "Server error - something went wrong on server side", 4054 "schema" : { 4055 "$ref" : "#/definitions/ErrorResponse" 4056 } 4057 } 4058 }, 4059 "security" : [ { 4060 "Authorization" : [ ] 4061 } ] 4062 } 4063 }, 4064 "/executions/promotions" : { 4065 "post" : { 4066 "tags" : [ "promotions :: executions" ], 4067 "summary" : "Execute a Promotion", 4068 "description" : "Execute a Promotion", 4069 "operationId" : "executePromotion", 4070 "consumes" : [ "application/json" ], 4071 "produces" : [ "application/json" ], 4072 "parameters" : [ { 4073 "in" : "body", 4074 "name" : "body", 4075 "description" : "Executable task", 4076 "required" : true, 4077 "schema" : { 4078 "$ref" : "#/definitions/PromotionExecutableTask" 4079 } 4080 } ], 4081 "responses" : { 4082 "201" : { 4083 "description" : "Execution success", 4084 "schema" : { 4085 "$ref" : "#/definitions/PromotionExecutionReport" 4086 } 4087 }, 4088 "202" : { 4089 "description" : "Execution started" 4090 }, 4091 "400" : { 4092 "description" : "Bad Request", 4093 "schema" : { 4094 "$ref" : "#/definitions/ErrorResponse" 4095 } 4096 }, 4097 "401" : { 4098 "description" : "Unauthorized", 4099 "schema" : { 4100 "$ref" : "#/definitions/ErrorResponse" 4101 } 4102 }, 4103 "403" : { 4104 "description" : "Forbidden", 4105 "schema" : { 4106 "$ref" : "#/definitions/ErrorResponse" 4107 } 4108 }, 4109 "404" : { 4110 "description" : "Not Found", 4111 "schema" : { 4112 "$ref" : "#/definitions/ErrorResponse" 4113 } 4114 }, 4115 "500" : { 4116 "description" : "Internal Server Error", 4117 "schema" : { 4118 "$ref" : "#/definitions/ErrorResponse" 4119 } 4120 }, 4121 "501" : { 4122 "description" : "Promotions can't be executed because it has errors", 4123 "schema" : { 4124 "$ref" : "#/definitions/ErrorResponse" 4125 } 4126 } 4127 }, 4128 "security" : [ { 4129 "Authorization" : [ ] 4130 } ] 4131 } 4132 }, 4133 "/executions/promotions/{executionId}" : { 4134 "get" : { 4135 "tags" : [ "promotions :: executions" ], 4136 "summary" : "Get Promotion execution status", 4137 "description" : "Get Promotion execution status", 4138 "operationId" : "getPromotionExecutionStatus", 4139 "produces" : [ "application/json" ], 4140 "parameters" : [ { 4141 "name" : "executionId", 4142 "in" : "path", 4143 "description" : "Execution ID", 4144 "required" : true, 4145 "type" : "string" 4146 } ], 4147 "responses" : { 4148 "200" : { 4149 "description" : "OK", 4150 "schema" : { 4151 "$ref" : "#/definitions/PromotionExecutionStatus" 4152 } 4153 }, 4154 "400" : { 4155 "description" : "Bad Request", 4156 "schema" : { 4157 "$ref" : "#/definitions/ErrorResponse" 4158 } 4159 }, 4160 "401" : { 4161 "description" : "Unauthorized", 4162 "schema" : { 4163 "$ref" : "#/definitions/ErrorResponse" 4164 } 4165 }, 4166 "403" : { 4167 "description" : "Forbidden", 4168 "schema" : { 4169 "$ref" : "#/definitions/ErrorResponse" 4170 } 4171 }, 4172 "404" : { 4173 "description" : "Not Found", 4174 "schema" : { 4175 "$ref" : "#/definitions/ErrorResponse" 4176 } 4177 }, 4178 "500" : { 4179 "description" : "Internal Server Error", 4180 "schema" : { 4181 "$ref" : "#/definitions/ErrorResponse" 4182 } 4183 } 4184 }, 4185 "security" : [ { 4186 "Authorization" : [ ] 4187 } ] 4188 } 4189 }, 4190 "/executions/promotions/{id}" : { 4191 "post" : { 4192 "tags" : [ "promotions :: executions" ], 4193 "summary" : "Perform promotion simulation analysis", 4194 "description" : "Perform promotion simulation analysis", 4195 "operationId" : "performPromotionAnalysisDeprecated", 4196 "consumes" : [ "application/json" ], 4197 "produces" : [ "application/json" ], 4198 "parameters" : [ { 4199 "name" : "id", 4200 "in" : "path", 4201 "required" : true, 4202 "type" : "string" 4203 }, { 4204 "in" : "body", 4205 "name" : "body", 4206 "required" : false, 4207 "schema" : { 4208 "$ref" : "#/definitions/PromotionExecutionDetails" 4209 } 4210 } ], 4211 "responses" : { 4212 "200" : { 4213 "description" : "OK", 4214 "schema" : { 4215 "$ref" : "#/definitions/PromotionExecutionStatus" 4216 } 4217 }, 4218 "400" : { 4219 "description" : "Bad Request", 4220 "schema" : { 4221 "$ref" : "#/definitions/ErrorResponse" 4222 } 4223 }, 4224 "401" : { 4225 "description" : "Unauthorized", 4226 "schema" : { 4227 "$ref" : "#/definitions/ErrorResponse" 4228 } 4229 }, 4230 "403" : { 4231 "description" : "Forbidden", 4232 "schema" : { 4233 "$ref" : "#/definitions/ErrorResponse" 4234 } 4235 }, 4236 "404" : { 4237 "description" : "Not Found", 4238 "schema" : { 4239 "$ref" : "#/definitions/ErrorResponse" 4240 } 4241 }, 4242 "500" : { 4243 "description" : "Internal Server Error", 4244 "schema" : { 4245 "$ref" : "#/definitions/ErrorResponse" 4246 } 4247 } 4248 }, 4249 "security" : [ { 4250 "Authorization" : [ ] 4251 } ], 4252 "deprecated" : true 4253 } 4254 }, 4255 "/executions/{id}" : { 4256 "get" : { 4257 "tags" : [ "executions" ], 4258 "summary" : "Get Task execution status", 4259 "description" : "Get Task execution status", 4260 "operationId" : "getTaskExecutionStatus", 4261 "produces" : [ "application/json" ], 4262 "parameters" : [ { 4263 "name" : "id", 4264 "in" : "path", 4265 "description" : "execution ID", 4266 "required" : true, 4267 "type" : "string" 4268 } ], 4269 "responses" : { 4270 "200" : { 4271 "description" : "Successful response", 4272 "schema" : { 4273 "$ref" : "#/definitions/JobExecutionStatusV21" 4274 } 4275 }, 4276 "400" : { 4277 "description" : "Bad Request", 4278 "schema" : { 4279 "$ref" : "#/definitions/ErrorResponse" 4280 } 4281 }, 4282 "401" : { 4283 "description" : "Unauthorized", 4284 "schema" : { 4285 "$ref" : "#/definitions/ErrorResponse" 4286 } 4287 }, 4288 "403" : { 4289 "description" : "Forbidden - no permissions to access resource", 4290 "schema" : { 4291 "$ref" : "#/definitions/ErrorResponse" 4292 } 4293 }, 4294 "404" : { 4295 "description" : "Not found - resource not found", 4296 "schema" : { 4297 "$ref" : "#/definitions/ErrorResponse" 4298 } 4299 }, 4300 "429" : { 4301 "description" : "Too many requests", 4302 "schema" : { 4303 "$ref" : "#/definitions/ErrorResponse" 4304 } 4305 }, 4306 "500" : { 4307 "description" : "Server error - something went wrong on server side", 4308 "schema" : { 4309 "$ref" : "#/definitions/ErrorResponse" 4310 } 4311 } 4312 }, 4313 "security" : [ { 4314 "Authorization" : [ ] 4315 } ] 4316 }, 4317 "delete" : { 4318 "tags" : [ "executions" ], 4319 "summary" : "Terminate Task execution", 4320 "description" : "Terminate Task execution", 4321 "operationId" : "stopExecution", 4322 "produces" : [ "text/plain" ], 4323 "parameters" : [ { 4324 "name" : "id", 4325 "in" : "path", 4326 "description" : "execution ID", 4327 "required" : true, 4328 "type" : "string" 4329 } ], 4330 "responses" : { 4331 "200" : { 4332 "description" : "Execution already finished", 4333 "schema" : { 4334 "type" : "string" 4335 } 4336 }, 4337 "204" : { 4338 "description" : "Execution stopped succesfully" 4339 }, 4340 "400" : { 4341 "description" : "Bad Request", 4342 "schema" : { 4343 "$ref" : "#/definitions/ErrorResponse" 4344 } 4345 }, 4346 "401" : { 4347 "description" : "Unauthorized", 4348 "schema" : { 4349 "$ref" : "#/definitions/ErrorResponse" 4350 } 4351 }, 4352 "403" : { 4353 "description" : "Forbidden - no permissions to access resource", 4354 "schema" : { 4355 "$ref" : "#/definitions/ErrorResponse" 4356 } 4357 }, 4358 "404" : { 4359 "description" : "Not found - resource not found", 4360 "schema" : { 4361 "$ref" : "#/definitions/ErrorResponse" 4362 } 4363 }, 4364 "500" : { 4365 "description" : "Server error - something went wrong on server side", 4366 "schema" : { 4367 "$ref" : "#/definitions/ErrorResponse" 4368 } 4369 } 4370 }, 4371 "security" : [ { 4372 "Authorization" : [ ] 4373 } ] 4374 } 4375 }, 4376 "/executions/{id}/logs" : { 4377 "get" : { 4378 "tags" : [ "executions :: logs" ], 4379 "summary" : "Get Task execution logs", 4380 "description" : "Get Task execution logs", 4381 "operationId" : "getTaskExecutionLog", 4382 "produces" : [ "application/json" ], 4383 "parameters" : [ { 4384 "name" : "id", 4385 "in" : "path", 4386 "description" : "ID of Task Execution", 4387 "required" : true, 4388 "type" : "string" 4389 }, { 4390 "name" : "startTime", 4391 "in" : "query", 4392 "description" : "Earliest log date and time, default value is set to the start time of the execution. Floored to minute unit. Example: 2021-06-14T07:01:45Z", 4393 "required" : false, 4394 "type" : "string" 4395 }, { 4396 "name" : "endTime", 4397 "in" : "query", 4398 "description" : "Latest log date and time, default value is set to the current time when the request is received. Floored to minute unit. Example: 2021-06-14T15:04:45Z", 4399 "required" : false, 4400 "type" : "string" 4401 }, { 4402 "name" : "startIndex", 4403 "in" : "query", 4404 "description" : "Index for pagination to start with, default value is set to 0", 4405 "required" : false, 4406 "type" : "integer", 4407 "default" : 0, 4408 "format" : "int32" 4409 }, { 4410 "name" : "count", 4411 "in" : "query", 4412 "description" : "Number of log messages, default value is equal to 50, the maximum value is equal to 200", 4413 "required" : false, 4414 "type" : "integer", 4415 "default" : 50, 4416 "format" : "int32" 4417 }, { 4418 "name" : "order", 4419 "in" : "query", 4420 "description" : "Sort order (ASC, DESC) for logs by logTimestamp, default is DESC : last logs are first.", 4421 "required" : false, 4422 "type" : "string", 4423 "default" : "DESC" 4424 } ], 4425 "responses" : { 4426 "200" : { 4427 "description" : "Successful response", 4428 "schema" : { 4429 "$ref" : "#/definitions/ExecutionLogs" 4430 } 4431 }, 4432 "400" : { 4433 "description" : "Bad Request", 4434 "schema" : { 4435 "$ref" : "#/definitions/ErrorResponse" 4436 } 4437 }, 4438 "401" : { 4439 "description" : "Unauthorized", 4440 "schema" : { 4441 "$ref" : "#/definitions/ErrorResponse" 4442 } 4443 }, 4444 "403" : { 4445 "description" : "Forbidden - no permissions to access resource", 4446 "schema" : { 4447 "$ref" : "#/definitions/ErrorResponse" 4448 } 4449 }, 4450 "404" : { 4451 "description" : "Not found - resource not found", 4452 "schema" : { 4453 "$ref" : "#/definitions/ErrorResponse" 4454 } 4455 }, 4456 "500" : { 4457 "description" : "Server error - something went wrong on server side", 4458 "schema" : { 4459 "$ref" : "#/definitions/ErrorResponse" 4460 } 4461 } 4462 }, 4463 "security" : [ { 4464 "Authorization" : [ ] 4465 } ] 4466 }, 4467 "post" : { 4468 "tags" : [ "executions :: logs" ], 4469 "summary" : "Generate full logs for Task execution", 4470 "description" : "Generate full logs for Task execution. Please note the customer log download API is asynchronous, after receiving a token, the frequency on which you should check logs file status depends on the size of logs, the status endpoint should be used for this purpose", 4471 "operationId" : "generateFullTaskExecutionLogs", 4472 "produces" : [ "application/json" ], 4473 "parameters" : [ { 4474 "name" : "id", 4475 "in" : "path", 4476 "description" : "ID of Task Execution", 4477 "required" : true, 4478 "type" : "string" 4479 }, { 4480 "name" : "startTime", 4481 "in" : "query", 4482 "description" : "Earliest log date and time", 4483 "required" : false, 4484 "type" : "string" 4485 }, { 4486 "name" : "endTime", 4487 "in" : "query", 4488 "description" : "Latest log date and time", 4489 "required" : false, 4490 "type" : "string" 4491 }, { 4492 "name" : "fileFormat", 4493 "in" : "query", 4494 "description" : "Generated file format JSON/TEXT", 4495 "required" : false, 4496 "type" : "string", 4497 "default" : "JSON", 4498 "enum" : [ "TEXT", "JSON" ] 4499 }, { 4500 "name" : "newFileName", 4501 "in" : "query", 4502 "description" : "Use new file name for generated file: taskId_executionId.log", 4503 "required" : false, 4504 "type" : "string" 4505 } ], 4506 "responses" : { 4507 "200" : { 4508 "description" : "Successful response", 4509 "schema" : { 4510 "$ref" : "#/definitions/DownloadLogs" 4511 } 4512 }, 4513 "400" : { 4514 "description" : "Bad Request", 4515 "schema" : { 4516 "$ref" : "#/definitions/ErrorResponse" 4517 } 4518 }, 4519 "401" : { 4520 "description" : "Unauthorized", 4521 "schema" : { 4522 "$ref" : "#/definitions/ErrorResponse" 4523 } 4524 }, 4525 "403" : { 4526 "description" : "Forbidden - no permissions to access resource", 4527 "schema" : { 4528 "$ref" : "#/definitions/ErrorResponse" 4529 } 4530 }, 4531 "404" : { 4532 "description" : "Not found - resource not found", 4533 "schema" : { 4534 "$ref" : "#/definitions/ErrorResponse" 4535 } 4536 }, 4537 "500" : { 4538 "description" : "Server error - something went wrong on server side", 4539 "schema" : { 4540 "$ref" : "#/definitions/ErrorResponse" 4541 } 4542 } 4543 }, 4544 "security" : [ { 4545 "Authorization" : [ ] 4546 } ] 4547 } 4548 }, 4549 "/executions/{id}/logs/status" : { 4550 "post" : { 4551 "tags" : [ "executions :: logs" ], 4552 "summary" : "Check download token status", 4553 "description" : "Check download token status, possible status values: READY, IN_PROGRESS. Returns a pre-signed URL valid for one hour once the status is READY", 4554 "operationId" : "checkDownloadTokenStatus", 4555 "produces" : [ "application/json" ], 4556 "parameters" : [ { 4557 "name" : "id", 4558 "in" : "path", 4559 "description" : "ID of Task Execution", 4560 "required" : true, 4561 "type" : "string" 4562 }, { 4563 "in" : "body", 4564 "name" : "body", 4565 "description" : "Download token", 4566 "required" : true, 4567 "schema" : { 4568 "type" : "string" 4569 } 4570 } ], 4571 "responses" : { 4572 "200" : { 4573 "description" : "Successful response", 4574 "schema" : { 4575 "$ref" : "#/definitions/DownloadLogsStatus" 4576 } 4577 }, 4578 "400" : { 4579 "description" : "Bad Request", 4580 "schema" : { 4581 "$ref" : "#/definitions/ErrorResponse" 4582 } 4583 }, 4584 "401" : { 4585 "description" : "Unauthorized", 4586 "schema" : { 4587 "$ref" : "#/definitions/ErrorResponse" 4588 } 4589 }, 4590 "403" : { 4591 "description" : "Forbidden - no permissions to access resource", 4592 "schema" : { 4593 "$ref" : "#/definitions/ErrorResponse" 4594 } 4595 }, 4596 "404" : { 4597 "description" : "Not found - resource not found", 4598 "schema" : { 4599 "$ref" : "#/definitions/ErrorResponse" 4600 } 4601 }, 4602 "500" : { 4603 "description" : "Server error - something went wrong on server side", 4604 "schema" : { 4605 "$ref" : "#/definitions/ErrorResponse" 4606 } 4607 } 4608 }, 4609 "security" : [ { 4610 "Authorization" : [ ] 4611 } ] 4612 } 4613 }, 4614 "/permissions" : { 4615 "get" : { 4616 "tags" : [ "workspaces :: permissions" ], 4617 "summary" : "Retrieve all workspace permissions according to search criteria", 4618 "description" : "It retrieves all workspace permissions according to several criteria:\n\nenvironment : One environment of the account\nworkspace : One workspace of one environment of the account\nuser : One user of the account", 4619 "operationId" : "getPermissions", 4620 "produces" : [ "application/json" ], 4621 "parameters" : [ { 4622 "name" : "environmentId", 4623 "in" : "query", 4624 "description" : "The environment id (Optional)\nExample Value: 6089228181ef4423736e47a8", 4625 "required" : false, 4626 "type" : "string" 4627 }, { 4628 "name" : "workspaceId", 4629 "in" : "query", 4630 "description" : "The workspace id (Optional)\nExample Value: 6089228181ef4423736e47a9", 4631 "required" : false, 4632 "type" : "string" 4633 }, { 4634 "name" : "userId", 4635 "in" : "query", 4636 "description" : "The user id (Optional)\nExample Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 4637 "required" : false, 4638 "type" : "string" 4639 } ], 4640 "responses" : { 4641 "200" : { 4642 "description" : "OK", 4643 "schema" : { 4644 "type" : "array", 4645 "items" : { 4646 "$ref" : "#/definitions/Permission" 4647 } 4648 } 4649 }, 4650 "400" : { 4651 "description" : "Invalid parameters", 4652 "schema" : { 4653 "$ref" : "#/definitions/ErrorResponse" 4654 } 4655 }, 4656 "401" : { 4657 "description" : "Unauthorized", 4658 "schema" : { 4659 "$ref" : "#/definitions/ErrorResponse" 4660 } 4661 }, 4662 "403" : { 4663 "description" : "Forbidden", 4664 "schema" : { 4665 "$ref" : "#/definitions/ErrorResponse" 4666 } 4667 }, 4668 "404" : { 4669 "description" : "The environment id or the workspace id or the user id does not exist", 4670 "schema" : { 4671 "$ref" : "#/definitions/ErrorResponse" 4672 } 4673 }, 4674 "500" : { 4675 "description" : "Internal server error", 4676 "schema" : { 4677 "$ref" : "#/definitions/ErrorResponse" 4678 } 4679 } 4680 }, 4681 "security" : [ { 4682 "Authorization" : [ ] 4683 } ] 4684 } 4685 }, 4686 "/permissions/batch" : { 4687 "post" : { 4688 "tags" : [ "workspaces :: permissions" ], 4689 "summary" : "Create sets of workspace permissions", 4690 "description" : "Create sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be created.Creation actions will be applied in the same order as defined in the list", 4691 "operationId" : "createPermissions", 4692 "consumes" : [ "application/json" ], 4693 "produces" : [ "application/json" ], 4694 "parameters" : [ { 4695 "in" : "body", 4696 "name" : "body", 4697 "description" : "The collection of permissions to create.", 4698 "required" : true, 4699 "schema" : { 4700 "type" : "array", 4701 "items" : { 4702 "$ref" : "#/definitions/Permission" 4703 } 4704 } 4705 } ], 4706 "responses" : { 4707 "204" : { 4708 "description" : "All changes on Permissions were successful" 4709 }, 4710 "207" : { 4711 "description" : "Execution result detailed status on elementary changes rejected.", 4712 "schema" : { 4713 "type" : "array", 4714 "items" : { 4715 "$ref" : "#/definitions/PermissionResult" 4716 } 4717 } 4718 }, 4719 "401" : { 4720 "description" : "Unauthorized", 4721 "schema" : { 4722 "$ref" : "#/definitions/ErrorResponse" 4723 } 4724 }, 4725 "403" : { 4726 "description" : "Not authorized to change permissions", 4727 "schema" : { 4728 "$ref" : "#/definitions/ErrorResponse" 4729 } 4730 }, 4731 "404" : { 4732 "description" : "The workspace id or the user does not exist", 4733 "schema" : { 4734 "$ref" : "#/definitions/ErrorResponse" 4735 } 4736 } 4737 }, 4738 "security" : [ { 4739 "Authorization" : [ ] 4740 } ] 4741 }, 4742 "put" : { 4743 "tags" : [ "workspaces :: permissions" ], 4744 "summary" : "Update sets of workspace permissions", 4745 "description" : "Update sets of workspace permissions on the current system. Allows to upload list of workspace permissions to be updated.Update actions will be applied in the same order as defined in the list", 4746 "operationId" : "updatePermissions", 4747 "consumes" : [ "application/json" ], 4748 "produces" : [ "application/json" ], 4749 "parameters" : [ { 4750 "in" : "body", 4751 "name" : "body", 4752 "description" : "The collection of permissions to update.", 4753 "required" : true, 4754 "schema" : { 4755 "type" : "array", 4756 "items" : { 4757 "$ref" : "#/definitions/Permission" 4758 } 4759 } 4760 } ], 4761 "responses" : { 4762 "204" : { 4763 "description" : "All changes on Permissions were successful" 4764 }, 4765 "207" : { 4766 "description" : "Execution result detailed status on elementary changes rejected.", 4767 "schema" : { 4768 "type" : "array", 4769 "items" : { 4770 "$ref" : "#/definitions/PermissionResult" 4771 } 4772 } 4773 }, 4774 "401" : { 4775 "description" : "Unauthorized", 4776 "schema" : { 4777 "$ref" : "#/definitions/ErrorResponse" 4778 } 4779 }, 4780 "403" : { 4781 "description" : "Not authorized to change permissions", 4782 "schema" : { 4783 "$ref" : "#/definitions/ErrorResponse" 4784 } 4785 }, 4786 "404" : { 4787 "description" : "The workspace id or the user does not exist", 4788 "schema" : { 4789 "$ref" : "#/definitions/ErrorResponse" 4790 } 4791 } 4792 }, 4793 "security" : [ { 4794 "Authorization" : [ ] 4795 } ] 4796 }, 4797 "delete" : { 4798 "tags" : [ "workspaces :: permissions" ], 4799 "summary" : "Delete workspace permissions", 4800 "description" : "Remove all permissions where user id is one from specified ones with request AND workspace is one from specified ones with request.\nSpecial case: empty collection for users means that permissions for all users and specified workspaces will be deleted (and vise versa).", 4801 "operationId" : "deletePermissions", 4802 "produces" : [ "application/json" ], 4803 "parameters" : [ { 4804 "name" : "workspaceIds", 4805 "in" : "query", 4806 "description" : "Workspace ids list used to compute permission intersections with specified users.", 4807 "required" : false, 4808 "type" : "array", 4809 "items" : { 4810 "type" : "string" 4811 }, 4812 "collectionFormat" : "multi" 4813 }, { 4814 "name" : "userIds", 4815 "in" : "query", 4816 "description" : "User ids list used to compute permission intersections with specified workspaces.", 4817 "required" : false, 4818 "type" : "array", 4819 "items" : { 4820 "type" : "string" 4821 }, 4822 "collectionFormat" : "multi" 4823 } ], 4824 "responses" : { 4825 "204" : { 4826 "description" : "All changes on Permissions were successful" 4827 }, 4828 "207" : { 4829 "description" : "Execution result detailed status on elementary changes rejected.", 4830 "schema" : { 4831 "type" : "array", 4832 "items" : { 4833 "$ref" : "#/definitions/PermissionDeleteResult" 4834 } 4835 } 4836 }, 4837 "401" : { 4838 "description" : "Unauthorized", 4839 "schema" : { 4840 "$ref" : "#/definitions/ErrorResponse" 4841 } 4842 }, 4843 "403" : { 4844 "description" : "Not authorized to change permissions", 4845 "schema" : { 4846 "$ref" : "#/definitions/ErrorResponse" 4847 } 4848 }, 4849 "404" : { 4850 "description" : "The workspace id or the user does not exist", 4851 "schema" : { 4852 "$ref" : "#/definitions/ErrorResponse" 4853 } 4854 } 4855 }, 4856 "security" : [ { 4857 "Authorization" : [ ] 4858 } ] 4859 } 4860 }, 4861 "/projects" : { 4862 "get" : { 4863 "tags" : [ "projects" ], 4864 "summary" : "Get Projects", 4865 "description" : "Get Projects", 4866 "operationId" : "getProjects", 4867 "produces" : [ "application/json" ], 4868 "parameters" : [ { 4869 "name" : "name", 4870 "in" : "query", 4871 "description" : "project name filter", 4872 "required" : false, 4873 "type" : "string" 4874 }, { 4875 "name" : "limit", 4876 "in" : "query", 4877 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 4878 "required" : false, 4879 "type" : "integer", 4880 "format" : "int32" 4881 }, { 4882 "name" : "offset", 4883 "in" : "query", 4884 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 4885 "required" : false, 4886 "type" : "integer", 4887 "format" : "int32" 4888 } ], 4889 "responses" : { 4890 "200" : { 4891 "description" : "OK", 4892 "schema" : { 4893 "$ref" : "#/definitions/Page" 4894 } 4895 }, 4896 "401" : { 4897 "description" : "Unauthorized", 4898 "schema" : { 4899 "$ref" : "#/definitions/ErrorResponse" 4900 } 4901 }, 4902 "403" : { 4903 "description" : "Forbidden", 4904 "schema" : { 4905 "$ref" : "#/definitions/ErrorResponse" 4906 } 4907 }, 4908 "500" : { 4909 "description" : "Internal Server Error", 4910 "schema" : { 4911 "$ref" : "#/definitions/ErrorResponse" 4912 } 4913 } 4914 }, 4915 "security" : [ { 4916 "Authorization" : [ ] 4917 } ] 4918 }, 4919 "post" : { 4920 "tags" : [ "projects" ], 4921 "summary" : "Create Project", 4922 "description" : "Create Project", 4923 "operationId" : "createProject", 4924 "consumes" : [ "application/json" ], 4925 "produces" : [ "application/json" ], 4926 "parameters" : [ { 4927 "in" : "body", 4928 "name" : "body", 4929 "description" : "project", 4930 "required" : true, 4931 "schema" : { 4932 "$ref" : "#/definitions/ProjectCreateRequest" 4933 } 4934 } ], 4935 "responses" : { 4936 "201" : { 4937 "description" : "Created", 4938 "schema" : { 4939 "$ref" : "#/definitions/ProjectView" 4940 } 4941 }, 4942 "400" : { 4943 "description" : "Bad Request", 4944 "schema" : { 4945 "$ref" : "#/definitions/ErrorResponse" 4946 } 4947 }, 4948 "401" : { 4949 "description" : "Unauthorized", 4950 "schema" : { 4951 "$ref" : "#/definitions/ErrorResponse" 4952 } 4953 }, 4954 "403" : { 4955 "description" : "Forbidden", 4956 "schema" : { 4957 "$ref" : "#/definitions/ErrorResponse" 4958 } 4959 }, 4960 "409" : { 4961 "description" : "Project already exists", 4962 "schema" : { 4963 "$ref" : "#/definitions/ErrorResponse" 4964 } 4965 }, 4966 "500" : { 4967 "description" : "Internal Server Error", 4968 "schema" : { 4969 "$ref" : "#/definitions/ErrorResponse" 4970 } 4971 } 4972 }, 4973 "security" : [ { 4974 "Authorization" : [ ] 4975 } ] 4976 } 4977 }, 4978 "/projects/{id}/groups" : { 4979 "get" : { 4980 "tags" : [ "projects :: authorization" ], 4981 "summary" : "Get group project authorizations", 4982 "description" : "Get group project authorizations", 4983 "operationId" : "getGroupProjectAuthorizations", 4984 "produces" : [ "application/json" ], 4985 "parameters" : [ { 4986 "name" : "id", 4987 "in" : "path", 4988 "description" : "project ID", 4989 "required" : true, 4990 "type" : "string" 4991 } ], 4992 "responses" : { 4993 "200" : { 4994 "description" : "OK", 4995 "schema" : { 4996 "$ref" : "#/definitions/ProjectGroupAuthResponse" 4997 } 4998 }, 4999 "400" : { 5000 "description" : "Bad Request", 5001 "schema" : { 5002 "$ref" : "#/definitions/ErrorResponse" 5003 } 5004 }, 5005 "401" : { 5006 "description" : "Unauthorized", 5007 "schema" : { 5008 "$ref" : "#/definitions/ErrorResponse" 5009 } 5010 }, 5011 "403" : { 5012 "description" : "Forbidden", 5013 "schema" : { 5014 "$ref" : "#/definitions/ErrorResponse" 5015 } 5016 }, 5017 "500" : { 5018 "description" : "Internal Server Error", 5019 "schema" : { 5020 "$ref" : "#/definitions/ErrorResponse" 5021 } 5022 } 5023 }, 5024 "security" : [ { 5025 "Authorization" : [ ] 5026 } ] 5027 } 5028 }, 5029 "/projects/{projectId}" : { 5030 "get" : { 5031 "tags" : [ "projects" ], 5032 "summary" : "Get Project by id", 5033 "description" : "Get Project by id", 5034 "operationId" : "getProject", 5035 "produces" : [ "application/json" ], 5036 "parameters" : [ { 5037 "name" : "projectId", 5038 "in" : "path", 5039 "description" : "project ID", 5040 "required" : true, 5041 "type" : "string" 5042 } ], 5043 "responses" : { 5044 "200" : { 5045 "description" : "OK", 5046 "schema" : { 5047 "$ref" : "#/definitions/ProjectView" 5048 } 5049 }, 5050 "400" : { 5051 "description" : "Project Id is not valid id.", 5052 "schema" : { 5053 "$ref" : "#/definitions/ErrorResponse" 5054 } 5055 }, 5056 "401" : { 5057 "description" : "Unauthorized", 5058 "schema" : { 5059 "$ref" : "#/definitions/ErrorResponse" 5060 } 5061 }, 5062 "403" : { 5063 "description" : "Forbidden", 5064 "schema" : { 5065 "$ref" : "#/definitions/ErrorResponse" 5066 } 5067 }, 5068 "404" : { 5069 "description" : "Not found", 5070 "schema" : { 5071 "$ref" : "#/definitions/ErrorResponse" 5072 } 5073 }, 5074 "500" : { 5075 "description" : "Internal Server Error", 5076 "schema" : { 5077 "$ref" : "#/definitions/ErrorResponse" 5078 } 5079 } 5080 }, 5081 "security" : [ { 5082 "Authorization" : [ ] 5083 } ] 5084 }, 5085 "put" : { 5086 "tags" : [ "projects" ], 5087 "summary" : "Update Project", 5088 "description" : "Update Project", 5089 "operationId" : "updateProject", 5090 "consumes" : [ "application/json" ], 5091 "produces" : [ "application/json" ], 5092 "parameters" : [ { 5093 "name" : "projectId", 5094 "in" : "path", 5095 "description" : "project ID", 5096 "required" : true, 5097 "type" : "string" 5098 }, { 5099 "in" : "body", 5100 "name" : "body", 5101 "description" : "project", 5102 "required" : true, 5103 "schema" : { 5104 "$ref" : "#/definitions/ProjectRequest" 5105 } 5106 } ], 5107 "responses" : { 5108 "200" : { 5109 "description" : "OK", 5110 "schema" : { 5111 "$ref" : "#/definitions/ProjectView" 5112 } 5113 }, 5114 "400" : { 5115 "description" : "Bad Request", 5116 "schema" : { 5117 "$ref" : "#/definitions/ErrorResponse" 5118 } 5119 }, 5120 "401" : { 5121 "description" : "Unauthorized", 5122 "schema" : { 5123 "$ref" : "#/definitions/ErrorResponse" 5124 } 5125 }, 5126 "403" : { 5127 "description" : "Forbidden", 5128 "schema" : { 5129 "$ref" : "#/definitions/ErrorResponse" 5130 } 5131 }, 5132 "404" : { 5133 "description" : "Not found", 5134 "schema" : { 5135 "$ref" : "#/definitions/ErrorResponse" 5136 } 5137 }, 5138 "409" : { 5139 "description" : "Project already exists", 5140 "schema" : { 5141 "$ref" : "#/definitions/ErrorResponse" 5142 } 5143 }, 5144 "500" : { 5145 "description" : "Internal Server Error", 5146 "schema" : { 5147 "$ref" : "#/definitions/ErrorResponse" 5148 } 5149 } 5150 }, 5151 "security" : [ { 5152 "Authorization" : [ ] 5153 } ] 5154 }, 5155 "delete" : { 5156 "tags" : [ "projects" ], 5157 "summary" : "Delete project", 5158 "description" : "Delete project", 5159 "operationId" : "deleteProject", 5160 "parameters" : [ { 5161 "name" : "projectId", 5162 "in" : "path", 5163 "description" : "project ID", 5164 "required" : true, 5165 "type" : "string" 5166 } ], 5167 "responses" : { 5168 "204" : { 5169 "description" : "No Content" 5170 }, 5171 "400" : { 5172 "description" : "Bad Request", 5173 "schema" : { 5174 "$ref" : "#/definitions/ErrorResponse" 5175 } 5176 }, 5177 "401" : { 5178 "description" : "Unauthorized", 5179 "schema" : { 5180 "$ref" : "#/definitions/ErrorResponse" 5181 } 5182 }, 5183 "403" : { 5184 "description" : "Forbidden", 5185 "schema" : { 5186 "$ref" : "#/definitions/ErrorResponse" 5187 } 5188 }, 5189 "404" : { 5190 "description" : "Not found", 5191 "schema" : { 5192 "$ref" : "#/definitions/ErrorResponse" 5193 } 5194 }, 5195 "500" : { 5196 "description" : "Internal Server Error", 5197 "schema" : { 5198 "$ref" : "#/definitions/ErrorResponse" 5199 } 5200 } 5201 }, 5202 "security" : [ { 5203 "Authorization" : [ ] 5204 } ] 5205 } 5206 }, 5207 "/projects/{projectId}/groups/{groupId}" : { 5208 "put" : { 5209 "tags" : [ "projects :: authorization" ], 5210 "summary" : "Add group project authorization", 5211 "description" : "Add group project authorization", 5212 "operationId" : "addGroupProjectAuthorization", 5213 "parameters" : [ { 5214 "name" : "projectId", 5215 "in" : "path", 5216 "description" : "project ID", 5217 "required" : true, 5218 "type" : "string" 5219 }, { 5220 "name" : "groupId", 5221 "in" : "path", 5222 "description" : "group ID", 5223 "required" : true, 5224 "type" : "string" 5225 } ], 5226 "responses" : { 5227 "204" : { 5228 "description" : "No Content" 5229 }, 5230 "400" : { 5231 "description" : "Bad Request", 5232 "schema" : { 5233 "$ref" : "#/definitions/ErrorResponse" 5234 } 5235 }, 5236 "401" : { 5237 "description" : "Unauthorized", 5238 "schema" : { 5239 "$ref" : "#/definitions/ErrorResponse" 5240 } 5241 }, 5242 "403" : { 5243 "description" : "Forbidden", 5244 "schema" : { 5245 "$ref" : "#/definitions/ErrorResponse" 5246 } 5247 }, 5248 "404" : { 5249 "description" : "Not found", 5250 "schema" : { 5251 "$ref" : "#/definitions/ErrorResponse" 5252 } 5253 }, 5254 "409" : { 5255 "description" : "Authorization already exists", 5256 "schema" : { 5257 "$ref" : "#/definitions/ErrorResponse" 5258 } 5259 }, 5260 "500" : { 5261 "description" : "Internal Server Error", 5262 "schema" : { 5263 "$ref" : "#/definitions/ErrorResponse" 5264 } 5265 } 5266 }, 5267 "security" : [ { 5268 "Authorization" : [ ] 5269 } ] 5270 }, 5271 "delete" : { 5272 "tags" : [ "projects :: authorization" ], 5273 "summary" : "Delete group project authorization", 5274 "description" : "Delete group project authorization", 5275 "operationId" : "deleteGroupProjectAuthorizations", 5276 "parameters" : [ { 5277 "name" : "projectId", 5278 "in" : "path", 5279 "description" : "project ID", 5280 "required" : true, 5281 "type" : "string" 5282 }, { 5283 "name" : "groupId", 5284 "in" : "path", 5285 "description" : "project ID", 5286 "required" : true, 5287 "type" : "string" 5288 } ], 5289 "responses" : { 5290 "204" : { 5291 "description" : "No Content" 5292 }, 5293 "400" : { 5294 "description" : "Bad Request", 5295 "schema" : { 5296 "$ref" : "#/definitions/ErrorResponse" 5297 } 5298 }, 5299 "401" : { 5300 "description" : "Unauthorized", 5301 "schema" : { 5302 "$ref" : "#/definitions/ErrorResponse" 5303 } 5304 }, 5305 "403" : { 5306 "description" : "Forbidden", 5307 "schema" : { 5308 "$ref" : "#/definitions/ErrorResponse" 5309 } 5310 }, 5311 "404" : { 5312 "description" : "Not found", 5313 "schema" : { 5314 "$ref" : "#/definitions/ErrorResponse" 5315 } 5316 }, 5317 "500" : { 5318 "description" : "Internal Server Error", 5319 "schema" : { 5320 "$ref" : "#/definitions/ErrorResponse" 5321 } 5322 } 5323 }, 5324 "security" : [ { 5325 "Authorization" : [ ] 5326 } ] 5327 } 5328 }, 5329 "/projects/{projectId}/users" : { 5330 "get" : { 5331 "tags" : [ "projects :: authorization" ], 5332 "summary" : "Get user project authorizations", 5333 "description" : "Get user project authorizations", 5334 "operationId" : "getUserProjectAuthorizations", 5335 "produces" : [ "application/json" ], 5336 "parameters" : [ { 5337 "name" : "projectId", 5338 "in" : "path", 5339 "description" : "project ID", 5340 "required" : true, 5341 "type" : "string" 5342 } ], 5343 "responses" : { 5344 "200" : { 5345 "description" : "OK", 5346 "schema" : { 5347 "$ref" : "#/definitions/ProjectUserAuthResponse" 5348 } 5349 }, 5350 "400" : { 5351 "description" : "Bad Request", 5352 "schema" : { 5353 "$ref" : "#/definitions/ErrorResponse" 5354 } 5355 }, 5356 "401" : { 5357 "description" : "Unauthorized", 5358 "schema" : { 5359 "$ref" : "#/definitions/ErrorResponse" 5360 } 5361 }, 5362 "403" : { 5363 "description" : "Forbidden", 5364 "schema" : { 5365 "$ref" : "#/definitions/ErrorResponse" 5366 } 5367 }, 5368 "500" : { 5369 "description" : "Internal Server Error", 5370 "schema" : { 5371 "$ref" : "#/definitions/ErrorResponse" 5372 } 5373 } 5374 }, 5375 "security" : [ { 5376 "Authorization" : [ ] 5377 } ] 5378 } 5379 }, 5380 "/projects/{projectId}/users/{userId}" : { 5381 "put" : { 5382 "tags" : [ "projects :: authorization" ], 5383 "summary" : "Add user project authorization", 5384 "description" : "Add user project authorization", 5385 "operationId" : "addUserProjectAuthorization", 5386 "parameters" : [ { 5387 "name" : "projectId", 5388 "in" : "path", 5389 "description" : "project ID", 5390 "required" : true, 5391 "type" : "string" 5392 }, { 5393 "name" : "userId", 5394 "in" : "path", 5395 "description" : "user ID", 5396 "required" : true, 5397 "type" : "string" 5398 } ], 5399 "responses" : { 5400 "204" : { 5401 "description" : "No Content" 5402 }, 5403 "400" : { 5404 "description" : "Bad Request", 5405 "schema" : { 5406 "$ref" : "#/definitions/ErrorResponse" 5407 } 5408 }, 5409 "401" : { 5410 "description" : "Unauthorized", 5411 "schema" : { 5412 "$ref" : "#/definitions/ErrorResponse" 5413 } 5414 }, 5415 "403" : { 5416 "description" : "Forbidden", 5417 "schema" : { 5418 "$ref" : "#/definitions/ErrorResponse" 5419 } 5420 }, 5421 "404" : { 5422 "description" : "Not found", 5423 "schema" : { 5424 "$ref" : "#/definitions/ErrorResponse" 5425 } 5426 }, 5427 "409" : { 5428 "description" : "Authorization already exists", 5429 "schema" : { 5430 "$ref" : "#/definitions/ErrorResponse" 5431 } 5432 }, 5433 "500" : { 5434 "description" : "Internal Server Error", 5435 "schema" : { 5436 "$ref" : "#/definitions/ErrorResponse" 5437 } 5438 } 5439 }, 5440 "security" : [ { 5441 "Authorization" : [ ] 5442 } ] 5443 }, 5444 "delete" : { 5445 "tags" : [ "projects :: authorization" ], 5446 "summary" : "Delete user project authorization", 5447 "description" : "Delete user project authorization", 5448 "operationId" : "deleteUserProjectAuthorizations", 5449 "parameters" : [ { 5450 "name" : "projectId", 5451 "in" : "path", 5452 "description" : "project ID", 5453 "required" : true, 5454 "type" : "string" 5455 }, { 5456 "name" : "userId", 5457 "in" : "path", 5458 "description" : "project ID", 5459 "required" : true, 5460 "type" : "string" 5461 } ], 5462 "responses" : { 5463 "204" : { 5464 "description" : "No Content" 5465 }, 5466 "400" : { 5467 "description" : "Bad Request", 5468 "schema" : { 5469 "$ref" : "#/definitions/ErrorResponse" 5470 } 5471 }, 5472 "401" : { 5473 "description" : "Unauthorized", 5474 "schema" : { 5475 "$ref" : "#/definitions/ErrorResponse" 5476 } 5477 }, 5478 "403" : { 5479 "description" : "Forbidden", 5480 "schema" : { 5481 "$ref" : "#/definitions/ErrorResponse" 5482 } 5483 }, 5484 "404" : { 5485 "description" : "Not found", 5486 "schema" : { 5487 "$ref" : "#/definitions/ErrorResponse" 5488 } 5489 }, 5490 "500" : { 5491 "description" : "Internal Server Error", 5492 "schema" : { 5493 "$ref" : "#/definitions/ErrorResponse" 5494 } 5495 } 5496 }, 5497 "security" : [ { 5498 "Authorization" : [ ] 5499 } ] 5500 } 5501 }, 5502 "/resources" : { 5503 "get" : { 5504 "tags" : [ "resources" ], 5505 "summary" : "Get Resources", 5506 "description" : "", 5507 "operationId" : "getResources", 5508 "produces" : [ "application/json" ], 5509 "parameters" : [ { 5510 "name" : "name", 5511 "in" : "query", 5512 "description" : "Resource name filter", 5513 "required" : false, 5514 "type" : "string" 5515 }, { 5516 "name" : "limit", 5517 "in" : "query", 5518 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 5519 "required" : false, 5520 "type" : "integer", 5521 "format" : "int32" 5522 }, { 5523 "name" : "offset", 5524 "in" : "query", 5525 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 5526 "required" : false, 5527 "type" : "integer", 5528 "format" : "int32" 5529 } ], 5530 "responses" : { 5531 "200" : { 5532 "description" : "OK", 5533 "schema" : { 5534 "$ref" : "#/definitions/Page" 5535 } 5536 }, 5537 "400" : { 5538 "description" : "Bad Request", 5539 "schema" : { 5540 "$ref" : "#/definitions/ErrorResponse" 5541 } 5542 }, 5543 "401" : { 5544 "description" : "Unauthorized", 5545 "schema" : { 5546 "$ref" : "#/definitions/ErrorResponse" 5547 } 5548 }, 5549 "403" : { 5550 "description" : "Forbidden", 5551 "schema" : { 5552 "$ref" : "#/definitions/ErrorResponse" 5553 } 5554 }, 5555 "404" : { 5556 "description" : "Not Found", 5557 "schema" : { 5558 "$ref" : "#/definitions/ErrorResponse" 5559 } 5560 }, 5561 "500" : { 5562 "description" : "Internal Server Error", 5563 "schema" : { 5564 "$ref" : "#/definitions/ErrorResponse" 5565 } 5566 } 5567 }, 5568 "security" : [ { 5569 "Authorization" : [ ] 5570 } ] 5571 }, 5572 "post" : { 5573 "tags" : [ "resources" ], 5574 "summary" : "Create a Resource", 5575 "description" : "", 5576 "operationId" : "createResource", 5577 "consumes" : [ "multipart/form-data" ], 5578 "produces" : [ "application/json" ], 5579 "parameters" : [ { 5580 "name" : "resource", 5581 "in" : "formData", 5582 "description" : "Resource detail", 5583 "required" : true, 5584 "type" : "string", 5585 "x-example" : "{ \"name\": \"resource name\", \"description\": \"resource description\", \"workspaceId\": \"workspace id\", \"file\": true}" 5586 }, { 5587 "name" : "file", 5588 "in" : "formData", 5589 "description" : "Resource file", 5590 "required" : true, 5591 "type" : "file" 5592 } ], 5593 "responses" : { 5594 "200" : { 5595 "description" : "successful operation", 5596 "schema" : { 5597 "$ref" : "#/definitions/Resource" 5598 } 5599 }, 5600 "201" : { 5601 "description" : "Created successfully", 5602 "schema" : { 5603 "$ref" : "#/definitions/Resource" 5604 } 5605 }, 5606 "400" : { 5607 "description" : "Bad Request", 5608 "schema" : { 5609 "$ref" : "#/definitions/ErrorResponse" 5610 } 5611 }, 5612 "401" : { 5613 "description" : "Unauthorized", 5614 "schema" : { 5615 "$ref" : "#/definitions/ErrorResponse" 5616 } 5617 }, 5618 "403" : { 5619 "description" : "Forbidden", 5620 "schema" : { 5621 "$ref" : "#/definitions/ErrorResponse" 5622 } 5623 }, 5624 "404" : { 5625 "description" : "Workspace id not found.", 5626 "schema" : { 5627 "$ref" : "#/definitions/ErrorResponse" 5628 } 5629 }, 5630 "409" : { 5631 "description" : "Duplicate name.", 5632 "schema" : { 5633 "$ref" : "#/definitions/ErrorResponse" 5634 } 5635 }, 5636 "413" : { 5637 "description" : "Upload limit exceeded", 5638 "schema" : { 5639 "$ref" : "#/definitions/ErrorResponse" 5640 } 5641 }, 5642 "500" : { 5643 "description" : "Internal Server Error", 5644 "schema" : { 5645 "$ref" : "#/definitions/ErrorResponse" 5646 } 5647 } 5648 }, 5649 "security" : [ { 5650 "Authorization" : [ ] 5651 } ] 5652 } 5653 }, 5654 "/resources/{id}" : { 5655 "get" : { 5656 "tags" : [ "resources" ], 5657 "summary" : "Get Resource by id", 5658 "description" : "Get Resource by id", 5659 "operationId" : "getResource", 5660 "produces" : [ "application/json" ], 5661 "parameters" : [ { 5662 "name" : "id", 5663 "in" : "path", 5664 "description" : "Resource id", 5665 "required" : true, 5666 "type" : "string" 5667 } ], 5668 "responses" : { 5669 "200" : { 5670 "description" : "Success", 5671 "schema" : { 5672 "$ref" : "#/definitions/Resource" 5673 } 5674 }, 5675 "400" : { 5676 "description" : "Bad Request", 5677 "schema" : { 5678 "$ref" : "#/definitions/ErrorResponse" 5679 } 5680 }, 5681 "401" : { 5682 "description" : "Unauthorized", 5683 "schema" : { 5684 "$ref" : "#/definitions/ErrorResponse" 5685 } 5686 }, 5687 "403" : { 5688 "description" : "Forbidden", 5689 "schema" : { 5690 "$ref" : "#/definitions/ErrorResponse" 5691 } 5692 }, 5693 "404" : { 5694 "description" : "Not Found", 5695 "schema" : { 5696 "$ref" : "#/definitions/ErrorResponse" 5697 } 5698 }, 5699 "500" : { 5700 "description" : "Internal Server Error", 5701 "schema" : { 5702 "$ref" : "#/definitions/ErrorResponse" 5703 } 5704 } 5705 }, 5706 "security" : [ { 5707 "Authorization" : [ ] 5708 } ] 5709 }, 5710 "put" : { 5711 "tags" : [ "resources" ], 5712 "summary" : "Update a Resource", 5713 "description" : "", 5714 "operationId" : "updateResource", 5715 "consumes" : [ "application/json" ], 5716 "parameters" : [ { 5717 "name" : "id", 5718 "in" : "path", 5719 "description" : "Resource ID", 5720 "required" : true, 5721 "type" : "string" 5722 }, { 5723 "in" : "body", 5724 "name" : "Resource detail", 5725 "description" : "Resource detail", 5726 "required" : true, 5727 "schema" : { 5728 "$ref" : "#/definitions/UpdateResourceRequest" 5729 } 5730 } ], 5731 "responses" : { 5732 "204" : { 5733 "description" : "no content" 5734 }, 5735 "400" : { 5736 "description" : "Bad Request", 5737 "schema" : { 5738 "$ref" : "#/definitions/ErrorResponse" 5739 } 5740 }, 5741 "401" : { 5742 "description" : "Unauthorized", 5743 "schema" : { 5744 "$ref" : "#/definitions/ErrorResponse" 5745 } 5746 }, 5747 "403" : { 5748 "description" : "Forbidden", 5749 "schema" : { 5750 "$ref" : "#/definitions/ErrorResponse" 5751 } 5752 }, 5753 "404" : { 5754 "description" : "Not Found", 5755 "schema" : { 5756 "$ref" : "#/definitions/ErrorResponse" 5757 } 5758 }, 5759 "500" : { 5760 "description" : "Internal Server Error", 5761 "schema" : { 5762 "$ref" : "#/definitions/ErrorResponse" 5763 } 5764 } 5765 }, 5766 "security" : [ { 5767 "Authorization" : [ ] 5768 } ] 5769 }, 5770 "delete" : { 5771 "tags" : [ "resources" ], 5772 "summary" : "Delete a Resource", 5773 "description" : "", 5774 "operationId" : "deleteResource", 5775 "parameters" : [ { 5776 "name" : "id", 5777 "in" : "path", 5778 "description" : "Resource ID", 5779 "required" : true, 5780 "type" : "string" 5781 } ], 5782 "responses" : { 5783 "204" : { 5784 "description" : "no content" 5785 }, 5786 "400" : { 5787 "description" : "Bad Request", 5788 "schema" : { 5789 "$ref" : "#/definitions/ErrorResponse" 5790 } 5791 }, 5792 "401" : { 5793 "description" : "Unauthorized", 5794 "schema" : { 5795 "$ref" : "#/definitions/ErrorResponse" 5796 } 5797 }, 5798 "403" : { 5799 "description" : "Forbidden", 5800 "schema" : { 5801 "$ref" : "#/definitions/ErrorResponse" 5802 } 5803 }, 5804 "404" : { 5805 "description" : "Not Found", 5806 "schema" : { 5807 "$ref" : "#/definitions/ErrorResponse" 5808 } 5809 }, 5810 "409" : { 5811 "description" : "Resource is in use", 5812 "schema" : { 5813 "$ref" : "#/definitions/ErrorResponse" 5814 } 5815 }, 5816 "500" : { 5817 "description" : "Internal Server Error", 5818 "schema" : { 5819 "$ref" : "#/definitions/ErrorResponse" 5820 } 5821 } 5822 }, 5823 "security" : [ { 5824 "Authorization" : [ ] 5825 } ] 5826 } 5827 }, 5828 "/resources/{id}/upload" : { 5829 "put" : { 5830 "tags" : [ "resources" ], 5831 "summary" : "Update a Resource attachment", 5832 "description" : "", 5833 "operationId" : "updateResourceAttachment", 5834 "consumes" : [ "multipart/form-data" ], 5835 "parameters" : [ { 5836 "name" : "id", 5837 "in" : "path", 5838 "description" : "Resource ID", 5839 "required" : true, 5840 "type" : "string" 5841 }, { 5842 "name" : "file", 5843 "in" : "formData", 5844 "description" : "Resource file", 5845 "required" : false, 5846 "type" : "file" 5847 } ], 5848 "responses" : { 5849 "204" : { 5850 "description" : "no content" 5851 }, 5852 "400" : { 5853 "description" : "Bad Request", 5854 "schema" : { 5855 "$ref" : "#/definitions/ErrorResponse" 5856 } 5857 }, 5858 "401" : { 5859 "description" : "Unauthorized", 5860 "schema" : { 5861 "$ref" : "#/definitions/ErrorResponse" 5862 } 5863 }, 5864 "403" : { 5865 "description" : "Forbidden", 5866 "schema" : { 5867 "$ref" : "#/definitions/ErrorResponse" 5868 } 5869 }, 5870 "404" : { 5871 "description" : "Not Found", 5872 "schema" : { 5873 "$ref" : "#/definitions/ErrorResponse" 5874 } 5875 }, 5876 "413" : { 5877 "description" : "Upload limit exceeded", 5878 "schema" : { 5879 "$ref" : "#/definitions/ErrorResponse" 5880 } 5881 }, 5882 "500" : { 5883 "description" : "Internal Server Error", 5884 "schema" : { 5885 "$ref" : "#/definitions/ErrorResponse" 5886 } 5887 } 5888 }, 5889 "security" : [ { 5890 "Authorization" : [ ] 5891 } ] 5892 } 5893 }, 5894 "/runtimes/pipeline-engines" : { 5895 "get" : { 5896 "tags" : [ "runtime :: pipeline engines" ], 5897 "summary" : "Get Pipeline Engines", 5898 "description" : "Get Pipeline Engines", 5899 "operationId" : "getPipelineEngines", 5900 "produces" : [ "application/json" ], 5901 "parameters" : [ { 5902 "name" : "query", 5903 "in" : "query", 5904 "description" : "search query (FIQL format), e.g. \"workspace.environment.id==5cb47ca4b1b5247f6006529e\",\"status==PAIRED\"", 5905 "required" : false, 5906 "type" : "string" 5907 } ], 5908 "responses" : { 5909 "200" : { 5910 "description" : "OK", 5911 "schema" : { 5912 "type" : "array", 5913 "items" : { 5914 "$ref" : "#/definitions/PipelineEngine" 5915 } 5916 } 5917 }, 5918 "401" : { 5919 "description" : "Unauthorized", 5920 "schema" : { 5921 "$ref" : "#/definitions/ErrorResponse" 5922 } 5923 }, 5924 "403" : { 5925 "description" : "Forbidden", 5926 "schema" : { 5927 "$ref" : "#/definitions/ErrorResponse" 5928 } 5929 }, 5930 "500" : { 5931 "description" : "Internal Server Error", 5932 "schema" : { 5933 "$ref" : "#/definitions/ErrorResponse" 5934 } 5935 } 5936 }, 5937 "security" : [ { 5938 "Authorization" : [ ] 5939 } ] 5940 }, 5941 "post" : { 5942 "tags" : [ "runtime :: pipeline engines" ], 5943 "summary" : "Create new Pipeline Engine", 5944 "description" : "Create new Pipeline Engine", 5945 "operationId" : "createPipelineEngine", 5946 "consumes" : [ "application/json" ], 5947 "produces" : [ "application/json" ], 5948 "parameters" : [ { 5949 "in" : "body", 5950 "name" : "body", 5951 "description" : "pipeline engine", 5952 "required" : true, 5953 "schema" : { 5954 "$ref" : "#/definitions/PipelineEngineRequest" 5955 } 5956 } ], 5957 "responses" : { 5958 "201" : { 5959 "description" : "Created", 5960 "schema" : { 5961 "$ref" : "#/definitions/PipelineEngine" 5962 } 5963 }, 5964 "400" : { 5965 "description" : "Bad Request", 5966 "schema" : { 5967 "$ref" : "#/definitions/ErrorResponse" 5968 } 5969 }, 5970 "401" : { 5971 "description" : "Unauthorized", 5972 "schema" : { 5973 "$ref" : "#/definitions/ErrorResponse" 5974 } 5975 }, 5976 "403" : { 5977 "description" : "Forbidden", 5978 "schema" : { 5979 "$ref" : "#/definitions/ErrorResponse" 5980 } 5981 }, 5982 "500" : { 5983 "description" : "Internal Server Error", 5984 "schema" : { 5985 "$ref" : "#/definitions/ErrorResponse" 5986 } 5987 } 5988 }, 5989 "security" : [ { 5990 "Authorization" : [ ] 5991 } ] 5992 } 5993 }, 5994 "/runtimes/pipeline-engines/{engineId}" : { 5995 "get" : { 5996 "tags" : [ "runtime :: pipeline engines" ], 5997 "summary" : "Get Pipeline Engine by id", 5998 "description" : "Get Pipeline Engine by id", 5999 "operationId" : "getPipelineEngine", 6000 "produces" : [ "application/json" ], 6001 "parameters" : [ { 6002 "name" : "engineId", 6003 "in" : "path", 6004 "description" : "pipeline engine id", 6005 "required" : true, 6006 "type" : "string" 6007 } ], 6008 "responses" : { 6009 "200" : { 6010 "description" : "OK", 6011 "schema" : { 6012 "$ref" : "#/definitions/PipelineEngine" 6013 } 6014 }, 6015 "401" : { 6016 "description" : "Unauthorized", 6017 "schema" : { 6018 "$ref" : "#/definitions/ErrorResponse" 6019 } 6020 }, 6021 "403" : { 6022 "description" : "Forbidden", 6023 "schema" : { 6024 "$ref" : "#/definitions/ErrorResponse" 6025 } 6026 }, 6027 "404" : { 6028 "description" : "Not Found", 6029 "schema" : { 6030 "$ref" : "#/definitions/ErrorResponse" 6031 } 6032 }, 6033 "500" : { 6034 "description" : "Internal Server Error", 6035 "schema" : { 6036 "$ref" : "#/definitions/ErrorResponse" 6037 } 6038 } 6039 }, 6040 "security" : [ { 6041 "Authorization" : [ ] 6042 } ] 6043 }, 6044 "delete" : { 6045 "tags" : [ "runtime :: pipeline engines" ], 6046 "summary" : "Delete Pipeline Engine by id", 6047 "description" : "Delete Pipeline Engine by id", 6048 "operationId" : "deletePipelineEngine", 6049 "parameters" : [ { 6050 "name" : "engineId", 6051 "in" : "path", 6052 "description" : "pipeline engine id", 6053 "required" : true, 6054 "type" : "string" 6055 } ], 6056 "responses" : { 6057 "204" : { 6058 "description" : "No Content" 6059 }, 6060 "400" : { 6061 "description" : "Bad Request", 6062 "schema" : { 6063 "$ref" : "#/definitions/ErrorResponse" 6064 } 6065 }, 6066 "401" : { 6067 "description" : "Unauthorized", 6068 "schema" : { 6069 "$ref" : "#/definitions/ErrorResponse" 6070 } 6071 }, 6072 "403" : { 6073 "description" : "Forbidden", 6074 "schema" : { 6075 "$ref" : "#/definitions/ErrorResponse" 6076 } 6077 }, 6078 "404" : { 6079 "description" : "Not Found", 6080 "schema" : { 6081 "$ref" : "#/definitions/ErrorResponse" 6082 } 6083 }, 6084 "409" : { 6085 "description" : "Conflict", 6086 "schema" : { 6087 "$ref" : "#/definitions/ErrorResponse" 6088 } 6089 }, 6090 "500" : { 6091 "description" : "Internal Server Error", 6092 "schema" : { 6093 "$ref" : "#/definitions/ErrorResponse" 6094 } 6095 } 6096 }, 6097 "security" : [ { 6098 "Authorization" : [ ] 6099 } ] 6100 } 6101 }, 6102 "/runtimes/pipeline-engines/{engineId}/pairing" : { 6103 "delete" : { 6104 "tags" : [ "runtime :: pipeline engines" ], 6105 "summary" : "Unpair Pipeline Engine", 6106 "description" : "Unpair Pipeline Engine", 6107 "operationId" : "unpairPipelineEngine", 6108 "produces" : [ "text/plain" ], 6109 "parameters" : [ { 6110 "name" : "engineId", 6111 "in" : "path", 6112 "description" : "pipeline engine id", 6113 "required" : true, 6114 "type" : "string" 6115 } ], 6116 "responses" : { 6117 "200" : { 6118 "description" : "OK", 6119 "schema" : { 6120 "type" : "string" 6121 } 6122 }, 6123 "400" : { 6124 "description" : "Bad Request", 6125 "schema" : { 6126 "$ref" : "#/definitions/ErrorResponse" 6127 } 6128 }, 6129 "401" : { 6130 "description" : "Unauthorized", 6131 "schema" : { 6132 "$ref" : "#/definitions/ErrorResponse" 6133 } 6134 }, 6135 "403" : { 6136 "description" : "Forbidden", 6137 "schema" : { 6138 "$ref" : "#/definitions/ErrorResponse" 6139 } 6140 }, 6141 "404" : { 6142 "description" : "Not Found", 6143 "schema" : { 6144 "$ref" : "#/definitions/ErrorResponse" 6145 } 6146 }, 6147 "500" : { 6148 "description" : "Internal Server Error", 6149 "schema" : { 6150 "$ref" : "#/definitions/ErrorResponse" 6151 } 6152 } 6153 }, 6154 "security" : [ { 6155 "Authorization" : [ ] 6156 } ] 6157 } 6158 }, 6159 "/runtimes/pipeline-engines/{engineId}/run-profiles" : { 6160 "get" : { 6161 "tags" : [ "runtime :: pipeline engines :: run profiles" ], 6162 "summary" : "Get run profile for engine", 6163 "description" : "", 6164 "operationId" : "getRunProfileByEngineId", 6165 "produces" : [ "application/json" ], 6166 "parameters" : [ { 6167 "name" : "engineId", 6168 "in" : "path", 6169 "description" : "run profile id", 6170 "required" : true, 6171 "type" : "string" 6172 } ], 6173 "responses" : { 6174 "200" : { 6175 "description" : "successful operation", 6176 "schema" : { 6177 "type" : "array", 6178 "items" : { 6179 "$ref" : "#/definitions/PipelineRunProfileResponse" 6180 } 6181 } 6182 }, 6183 "400" : { 6184 "description" : "Bad Request", 6185 "schema" : { 6186 "$ref" : "#/definitions/ErrorResponse" 6187 } 6188 }, 6189 "401" : { 6190 "description" : "Unauthorized", 6191 "schema" : { 6192 "$ref" : "#/definitions/ErrorResponse" 6193 } 6194 }, 6195 "404" : { 6196 "description" : "Not Found", 6197 "schema" : { 6198 "$ref" : "#/definitions/ErrorResponse" 6199 } 6200 }, 6201 "500" : { 6202 "description" : "Internal server error", 6203 "schema" : { 6204 "$ref" : "#/definitions/ErrorResponse" 6205 } 6206 } 6207 }, 6208 "security" : [ { 6209 "Authorization" : [ ] 6210 } ] 6211 } 6212 }, 6213 "/runtimes/pipeline-engines/{engineId}/run-profiles/advanced" : { 6214 "post" : { 6215 "tags" : [ "runtime :: pipeline engines :: run profiles :: advanced" ], 6216 "summary" : "Create new run profile", 6217 "description" : "", 6218 "operationId" : "createRunProfileAdvanced", 6219 "consumes" : [ "application/json" ], 6220 "produces" : [ "application/json" ], 6221 "parameters" : [ { 6222 "name" : "engineId", 6223 "in" : "path", 6224 "description" : "engine id", 6225 "required" : true, 6226 "type" : "string" 6227 }, { 6228 "in" : "body", 6229 "name" : "body", 6230 "required" : false, 6231 "schema" : { 6232 "$ref" : "#/definitions/AdvancedRunProfile" 6233 } 6234 } ], 6235 "responses" : { 6236 "201" : { 6237 "description" : "Created" 6238 }, 6239 "400" : { 6240 "description" : "Bad Request", 6241 "schema" : { 6242 "$ref" : "#/definitions/ErrorResponse" 6243 } 6244 }, 6245 "401" : { 6246 "description" : "Unauthorized", 6247 "schema" : { 6248 "$ref" : "#/definitions/ErrorResponse" 6249 } 6250 }, 6251 "403" : { 6252 "description" : "Forbidden", 6253 "schema" : { 6254 "$ref" : "#/definitions/ErrorResponse" 6255 } 6256 }, 6257 "404" : { 6258 "description" : "Not Found", 6259 "schema" : { 6260 "$ref" : "#/definitions/ErrorResponse" 6261 } 6262 }, 6263 "500" : { 6264 "description" : "Internal Server Error", 6265 "schema" : { 6266 "$ref" : "#/definitions/ErrorResponse" 6267 } 6268 } 6269 }, 6270 "security" : [ { 6271 "Authorization" : [ ] 6272 } ] 6273 } 6274 }, 6275 "/runtimes/pipeline-engines/{engineId}/run-profiles/advanced/{runProfileId}" : { 6276 "get" : { 6277 "tags" : [ "runtime :: pipeline engines :: run profiles :: advanced" ], 6278 "summary" : "Get run profile", 6279 "description" : "", 6280 "operationId" : "getAdvancedRunProfileById", 6281 "produces" : [ "application/json" ], 6282 "parameters" : [ { 6283 "name" : "engineId", 6284 "in" : "path", 6285 "description" : "engine id", 6286 "required" : true, 6287 "type" : "string" 6288 }, { 6289 "name" : "runProfileId", 6290 "in" : "path", 6291 "description" : "run profile id", 6292 "required" : true, 6293 "type" : "string" 6294 } ], 6295 "responses" : { 6296 "200" : { 6297 "description" : "OK", 6298 "schema" : { 6299 "$ref" : "#/definitions/AdvancedRunProfile" 6300 } 6301 }, 6302 "400" : { 6303 "description" : "Bad Request", 6304 "schema" : { 6305 "$ref" : "#/definitions/ErrorResponse" 6306 } 6307 }, 6308 "401" : { 6309 "description" : "Unauthorized", 6310 "schema" : { 6311 "$ref" : "#/definitions/ErrorResponse" 6312 } 6313 }, 6314 "403" : { 6315 "description" : "Forbidden", 6316 "schema" : { 6317 "$ref" : "#/definitions/ErrorResponse" 6318 } 6319 }, 6320 "404" : { 6321 "description" : "Not Found", 6322 "schema" : { 6323 "$ref" : "#/definitions/ErrorResponse" 6324 } 6325 }, 6326 "500" : { 6327 "description" : "Internal Server Error", 6328 "schema" : { 6329 "$ref" : "#/definitions/ErrorResponse" 6330 } 6331 } 6332 }, 6333 "security" : [ { 6334 "Authorization" : [ ] 6335 } ] 6336 }, 6337 "put" : { 6338 "tags" : [ "runtime :: pipeline engines :: run profiles :: advanced" ], 6339 "summary" : "Update run profile", 6340 "description" : "", 6341 "operationId" : "updateRunProfileAdvanced", 6342 "consumes" : [ "application/json" ], 6343 "parameters" : [ { 6344 "name" : "engineId", 6345 "in" : "path", 6346 "description" : "engine id", 6347 "required" : true, 6348 "type" : "string" 6349 }, { 6350 "name" : "runProfileId", 6351 "in" : "path", 6352 "description" : "run profile id", 6353 "required" : true, 6354 "type" : "string" 6355 }, { 6356 "in" : "body", 6357 "name" : "body", 6358 "description" : "run profile", 6359 "required" : true, 6360 "schema" : { 6361 "$ref" : "#/definitions/AdvancedRunProfile" 6362 } 6363 } ], 6364 "responses" : { 6365 "204" : { 6366 "description" : "No Content" 6367 }, 6368 "400" : { 6369 "description" : "Bad Request", 6370 "schema" : { 6371 "$ref" : "#/definitions/ErrorResponse" 6372 } 6373 }, 6374 "401" : { 6375 "description" : "Unauthorized", 6376 "schema" : { 6377 "$ref" : "#/definitions/ErrorResponse" 6378 } 6379 }, 6380 "403" : { 6381 "description" : "Forbidden", 6382 "schema" : { 6383 "$ref" : "#/definitions/ErrorResponse" 6384 } 6385 }, 6386 "404" : { 6387 "description" : "Not Found", 6388 "schema" : { 6389 "$ref" : "#/definitions/ErrorResponse" 6390 } 6391 }, 6392 "500" : { 6393 "description" : "Internal Server Error", 6394 "schema" : { 6395 "$ref" : "#/definitions/ErrorResponse" 6396 } 6397 } 6398 }, 6399 "security" : [ { 6400 "Authorization" : [ ] 6401 } ] 6402 } 6403 }, 6404 "/runtimes/pipeline-engines/{engineId}/run-profiles/big-data" : { 6405 "post" : { 6406 "tags" : [ "runtime :: pipeline engines :: run profiles :: big-data" ], 6407 "summary" : "Create new run profile", 6408 "description" : "", 6409 "operationId" : "createRunProfileBigData", 6410 "consumes" : [ "application/json" ], 6411 "produces" : [ "application/json" ], 6412 "parameters" : [ { 6413 "name" : "engineId", 6414 "in" : "path", 6415 "description" : "engine id", 6416 "required" : true, 6417 "type" : "string" 6418 }, { 6419 "in" : "body", 6420 "name" : "body", 6421 "required" : false, 6422 "schema" : { 6423 "$ref" : "#/definitions/BigDataRunProfile" 6424 } 6425 } ], 6426 "responses" : { 6427 "201" : { 6428 "description" : "Created" 6429 }, 6430 "400" : { 6431 "description" : "Bad Request", 6432 "schema" : { 6433 "$ref" : "#/definitions/ErrorResponse" 6434 } 6435 }, 6436 "401" : { 6437 "description" : "Unauthorized", 6438 "schema" : { 6439 "$ref" : "#/definitions/ErrorResponse" 6440 } 6441 }, 6442 "403" : { 6443 "description" : "Forbidden", 6444 "schema" : { 6445 "$ref" : "#/definitions/ErrorResponse" 6446 } 6447 }, 6448 "404" : { 6449 "description" : "Not Found", 6450 "schema" : { 6451 "$ref" : "#/definitions/ErrorResponse" 6452 } 6453 }, 6454 "500" : { 6455 "description" : "Internal Server Error", 6456 "schema" : { 6457 "$ref" : "#/definitions/ErrorResponse" 6458 } 6459 } 6460 }, 6461 "security" : [ { 6462 "Authorization" : [ ] 6463 } ] 6464 } 6465 }, 6466 "/runtimes/pipeline-engines/{engineId}/run-profiles/big-data/{runProfileId}" : { 6467 "get" : { 6468 "tags" : [ "runtime :: pipeline engines :: run profiles :: big-data" ], 6469 "summary" : "Get run profile", 6470 "description" : "", 6471 "operationId" : "getBigDataRunProfileById", 6472 "produces" : [ "application/json" ], 6473 "parameters" : [ { 6474 "name" : "engineId", 6475 "in" : "path", 6476 "description" : "engine id", 6477 "required" : true, 6478 "type" : "string" 6479 }, { 6480 "name" : "runProfileId", 6481 "in" : "path", 6482 "description" : "run profile id", 6483 "required" : true, 6484 "type" : "string" 6485 } ], 6486 "responses" : { 6487 "200" : { 6488 "description" : "OK", 6489 "schema" : { 6490 "$ref" : "#/definitions/BigDataRunProfile" 6491 } 6492 }, 6493 "400" : { 6494 "description" : "Bad Request", 6495 "schema" : { 6496 "$ref" : "#/definitions/ErrorResponse" 6497 } 6498 }, 6499 "401" : { 6500 "description" : "Unauthorized", 6501 "schema" : { 6502 "$ref" : "#/definitions/ErrorResponse" 6503 } 6504 }, 6505 "403" : { 6506 "description" : "Forbidden", 6507 "schema" : { 6508 "$ref" : "#/definitions/ErrorResponse" 6509 } 6510 }, 6511 "404" : { 6512 "description" : "Not Found", 6513 "schema" : { 6514 "$ref" : "#/definitions/ErrorResponse" 6515 } 6516 }, 6517 "500" : { 6518 "description" : "Internal Server Error", 6519 "schema" : { 6520 "$ref" : "#/definitions/ErrorResponse" 6521 } 6522 } 6523 }, 6524 "security" : [ { 6525 "Authorization" : [ ] 6526 } ] 6527 }, 6528 "put" : { 6529 "tags" : [ "runtime :: pipeline engines :: run profiles :: big-data" ], 6530 "summary" : "Update run profile", 6531 "description" : "", 6532 "operationId" : "updateRunProfileBigData", 6533 "consumes" : [ "application/json" ], 6534 "parameters" : [ { 6535 "name" : "engineId", 6536 "in" : "path", 6537 "description" : "engine id", 6538 "required" : true, 6539 "type" : "string" 6540 }, { 6541 "name" : "runProfileId", 6542 "in" : "path", 6543 "description" : "run profile id", 6544 "required" : true, 6545 "type" : "string" 6546 }, { 6547 "in" : "body", 6548 "name" : "body", 6549 "description" : "run profile", 6550 "required" : true, 6551 "schema" : { 6552 "$ref" : "#/definitions/BigDataRunProfile" 6553 } 6554 } ], 6555 "responses" : { 6556 "204" : { 6557 "description" : "No Content" 6558 }, 6559 "400" : { 6560 "description" : "Bad Request", 6561 "schema" : { 6562 "$ref" : "#/definitions/ErrorResponse" 6563 } 6564 }, 6565 "401" : { 6566 "description" : "Unauthorized", 6567 "schema" : { 6568 "$ref" : "#/definitions/ErrorResponse" 6569 } 6570 }, 6571 "403" : { 6572 "description" : "Forbidden", 6573 "schema" : { 6574 "$ref" : "#/definitions/ErrorResponse" 6575 } 6576 }, 6577 "404" : { 6578 "description" : "Not Found", 6579 "schema" : { 6580 "$ref" : "#/definitions/ErrorResponse" 6581 } 6582 }, 6583 "500" : { 6584 "description" : "Internal Server Error", 6585 "schema" : { 6586 "$ref" : "#/definitions/ErrorResponse" 6587 } 6588 } 6589 }, 6590 "security" : [ { 6591 "Authorization" : [ ] 6592 } ] 6593 } 6594 }, 6595 "/runtimes/pipeline-engines/{engineId}/run-profiles/data-integration" : { 6596 "post" : { 6597 "tags" : [ "runtime :: pipeline engines :: run profiles :: data-integration" ], 6598 "summary" : "Create new data integration run profile", 6599 "description" : "", 6600 "operationId" : "createDataIntegrationRunProfile", 6601 "consumes" : [ "application/json" ], 6602 "produces" : [ "application/json" ], 6603 "parameters" : [ { 6604 "name" : "engineId", 6605 "in" : "path", 6606 "description" : "engine id", 6607 "required" : true, 6608 "type" : "string" 6609 }, { 6610 "in" : "body", 6611 "name" : "body", 6612 "required" : false, 6613 "schema" : { 6614 "$ref" : "#/definitions/DataIntegrationRunProfile" 6615 } 6616 } ], 6617 "responses" : { 6618 "201" : { 6619 "description" : "Created" 6620 }, 6621 "400" : { 6622 "description" : "Bad Request", 6623 "schema" : { 6624 "$ref" : "#/definitions/ErrorResponse" 6625 } 6626 }, 6627 "401" : { 6628 "description" : "Unauthorized", 6629 "schema" : { 6630 "$ref" : "#/definitions/ErrorResponse" 6631 } 6632 }, 6633 "403" : { 6634 "description" : "Forbidden", 6635 "schema" : { 6636 "$ref" : "#/definitions/ErrorResponse" 6637 } 6638 }, 6639 "404" : { 6640 "description" : "Not Found", 6641 "schema" : { 6642 "$ref" : "#/definitions/ErrorResponse" 6643 } 6644 }, 6645 "500" : { 6646 "description" : "Internal Server Error", 6647 "schema" : { 6648 "$ref" : "#/definitions/ErrorResponse" 6649 } 6650 } 6651 }, 6652 "security" : [ { 6653 "Authorization" : [ ] 6654 } ] 6655 } 6656 }, 6657 "/runtimes/pipeline-engines/{engineId}/run-profiles/data-integration/{runProfileId}" : { 6658 "get" : { 6659 "tags" : [ "runtime :: pipeline engines :: run profiles :: data-integration" ], 6660 "summary" : "Get data integration run profile", 6661 "description" : "", 6662 "operationId" : "getDataIntegrationRunProfileById", 6663 "produces" : [ "application/json" ], 6664 "parameters" : [ { 6665 "name" : "engineId", 6666 "in" : "path", 6667 "description" : "engine id", 6668 "required" : true, 6669 "type" : "string" 6670 }, { 6671 "name" : "runProfileId", 6672 "in" : "path", 6673 "description" : "run profile id", 6674 "required" : true, 6675 "type" : "string" 6676 } ], 6677 "responses" : { 6678 "200" : { 6679 "description" : "OK", 6680 "schema" : { 6681 "$ref" : "#/definitions/DataIntegrationRunProfileResponse" 6682 } 6683 }, 6684 "400" : { 6685 "description" : "Bad Request", 6686 "schema" : { 6687 "$ref" : "#/definitions/ErrorResponse" 6688 } 6689 }, 6690 "401" : { 6691 "description" : "Unauthorized", 6692 "schema" : { 6693 "$ref" : "#/definitions/ErrorResponse" 6694 } 6695 }, 6696 "403" : { 6697 "description" : "Forbidden", 6698 "schema" : { 6699 "$ref" : "#/definitions/ErrorResponse" 6700 } 6701 }, 6702 "404" : { 6703 "description" : "Not Found", 6704 "schema" : { 6705 "$ref" : "#/definitions/ErrorResponse" 6706 } 6707 }, 6708 "500" : { 6709 "description" : "Internal Server Error", 6710 "schema" : { 6711 "$ref" : "#/definitions/ErrorResponse" 6712 } 6713 } 6714 }, 6715 "security" : [ { 6716 "Authorization" : [ ] 6717 } ] 6718 }, 6719 "put" : { 6720 "tags" : [ "runtime :: pipeline engines :: run profiles :: data-integration" ], 6721 "summary" : "Update data integration run profile", 6722 "description" : "", 6723 "operationId" : "updateRunProfileDataIntegration", 6724 "consumes" : [ "application/json" ], 6725 "parameters" : [ { 6726 "name" : "engineId", 6727 "in" : "path", 6728 "description" : "engine id", 6729 "required" : true, 6730 "type" : "string" 6731 }, { 6732 "name" : "runProfileId", 6733 "in" : "path", 6734 "description" : "run profile id", 6735 "required" : true, 6736 "type" : "string" 6737 }, { 6738 "in" : "body", 6739 "name" : "body", 6740 "description" : "run profile", 6741 "required" : true, 6742 "schema" : { 6743 "$ref" : "#/definitions/DataIntegrationRunProfile" 6744 } 6745 } ], 6746 "responses" : { 6747 "204" : { 6748 "description" : "No Content" 6749 }, 6750 "400" : { 6751 "description" : "Bad Request", 6752 "schema" : { 6753 "$ref" : "#/definitions/ErrorResponse" 6754 } 6755 }, 6756 "401" : { 6757 "description" : "Unauthorized", 6758 "schema" : { 6759 "$ref" : "#/definitions/ErrorResponse" 6760 } 6761 }, 6762 "403" : { 6763 "description" : "Forbidden", 6764 "schema" : { 6765 "$ref" : "#/definitions/ErrorResponse" 6766 } 6767 }, 6768 "404" : { 6769 "description" : "Not Found", 6770 "schema" : { 6771 "$ref" : "#/definitions/ErrorResponse" 6772 } 6773 }, 6774 "500" : { 6775 "description" : "Internal Server Error", 6776 "schema" : { 6777 "$ref" : "#/definitions/ErrorResponse" 6778 } 6779 } 6780 }, 6781 "security" : [ { 6782 "Authorization" : [ ] 6783 } ] 6784 } 6785 }, 6786 "/runtimes/pipeline-engines/{engineId}/run-profiles/databricks" : { 6787 "post" : { 6788 "tags" : [ "runtime :: pipeline engines :: run profiles :: databricks" ], 6789 "summary" : "Create new run profile", 6790 "description" : "", 6791 "operationId" : "createRunProfileDatabricks", 6792 "consumes" : [ "application/json" ], 6793 "produces" : [ "application/json" ], 6794 "parameters" : [ { 6795 "name" : "engineId", 6796 "in" : "path", 6797 "description" : "engine id", 6798 "required" : true, 6799 "type" : "string" 6800 }, { 6801 "in" : "body", 6802 "name" : "body", 6803 "required" : false, 6804 "schema" : { 6805 "$ref" : "#/definitions/DatabricksRunProfile" 6806 } 6807 } ], 6808 "responses" : { 6809 "201" : { 6810 "description" : "Created" 6811 }, 6812 "400" : { 6813 "description" : "Bad Request", 6814 "schema" : { 6815 "$ref" : "#/definitions/ErrorResponse" 6816 } 6817 }, 6818 "401" : { 6819 "description" : "Unauthorized", 6820 "schema" : { 6821 "$ref" : "#/definitions/ErrorResponse" 6822 } 6823 }, 6824 "403" : { 6825 "description" : "Forbidden", 6826 "schema" : { 6827 "$ref" : "#/definitions/ErrorResponse" 6828 } 6829 }, 6830 "404" : { 6831 "description" : "Not Found", 6832 "schema" : { 6833 "$ref" : "#/definitions/ErrorResponse" 6834 } 6835 }, 6836 "500" : { 6837 "description" : "Internal Server Error", 6838 "schema" : { 6839 "$ref" : "#/definitions/ErrorResponse" 6840 } 6841 } 6842 }, 6843 "security" : [ { 6844 "Authorization" : [ ] 6845 } ] 6846 } 6847 }, 6848 "/runtimes/pipeline-engines/{engineId}/run-profiles/databricks/{runProfileId}" : { 6849 "get" : { 6850 "tags" : [ "runtime :: pipeline engines :: run profiles :: databricks" ], 6851 "summary" : "Get run profile", 6852 "description" : "", 6853 "operationId" : "getDatabricksRunProfileById", 6854 "produces" : [ "application/json" ], 6855 "parameters" : [ { 6856 "name" : "engineId", 6857 "in" : "path", 6858 "description" : "engine id", 6859 "required" : true, 6860 "type" : "string" 6861 }, { 6862 "name" : "runProfileId", 6863 "in" : "path", 6864 "description" : "run profile id", 6865 "required" : true, 6866 "type" : "string" 6867 } ], 6868 "responses" : { 6869 "200" : { 6870 "description" : "OK", 6871 "schema" : { 6872 "$ref" : "#/definitions/DatabricksRunProfile" 6873 } 6874 }, 6875 "400" : { 6876 "description" : "Bad Request", 6877 "schema" : { 6878 "$ref" : "#/definitions/ErrorResponse" 6879 } 6880 }, 6881 "401" : { 6882 "description" : "Unauthorized", 6883 "schema" : { 6884 "$ref" : "#/definitions/ErrorResponse" 6885 } 6886 }, 6887 "403" : { 6888 "description" : "Forbidden", 6889 "schema" : { 6890 "$ref" : "#/definitions/ErrorResponse" 6891 } 6892 }, 6893 "404" : { 6894 "description" : "Not Found", 6895 "schema" : { 6896 "$ref" : "#/definitions/ErrorResponse" 6897 } 6898 }, 6899 "500" : { 6900 "description" : "Internal Server Error", 6901 "schema" : { 6902 "$ref" : "#/definitions/ErrorResponse" 6903 } 6904 } 6905 }, 6906 "security" : [ { 6907 "Authorization" : [ ] 6908 } ] 6909 }, 6910 "put" : { 6911 "tags" : [ "runtime :: pipeline engines :: run profiles :: databricks" ], 6912 "summary" : "Update run profile", 6913 "description" : "", 6914 "operationId" : "updateRunProfileDatabricks", 6915 "consumes" : [ "application/json" ], 6916 "parameters" : [ { 6917 "name" : "engineId", 6918 "in" : "path", 6919 "description" : "engine id", 6920 "required" : true, 6921 "type" : "string" 6922 }, { 6923 "name" : "runProfileId", 6924 "in" : "path", 6925 "description" : "run profile id", 6926 "required" : true, 6927 "type" : "string" 6928 }, { 6929 "in" : "body", 6930 "name" : "body", 6931 "description" : "run profile", 6932 "required" : true, 6933 "schema" : { 6934 "$ref" : "#/definitions/DatabricksRunProfile" 6935 } 6936 } ], 6937 "responses" : { 6938 "204" : { 6939 "description" : "No Content" 6940 }, 6941 "400" : { 6942 "description" : "Bad Request", 6943 "schema" : { 6944 "$ref" : "#/definitions/ErrorResponse" 6945 } 6946 }, 6947 "401" : { 6948 "description" : "Unauthorized", 6949 "schema" : { 6950 "$ref" : "#/definitions/ErrorResponse" 6951 } 6952 }, 6953 "403" : { 6954 "description" : "Forbidden", 6955 "schema" : { 6956 "$ref" : "#/definitions/ErrorResponse" 6957 } 6958 }, 6959 "404" : { 6960 "description" : "Not Found", 6961 "schema" : { 6962 "$ref" : "#/definitions/ErrorResponse" 6963 } 6964 }, 6965 "500" : { 6966 "description" : "Internal Server Error", 6967 "schema" : { 6968 "$ref" : "#/definitions/ErrorResponse" 6969 } 6970 } 6971 }, 6972 "security" : [ { 6973 "Authorization" : [ ] 6974 } ] 6975 } 6976 }, 6977 "/runtimes/pipeline-engines/{engineId}/run-profiles/standard" : { 6978 "post" : { 6979 "tags" : [ "runtime :: pipeline engines :: run profiles :: standard" ], 6980 "summary" : "Create new run profile", 6981 "description" : "", 6982 "operationId" : "createRunProfileStandard", 6983 "consumes" : [ "application/json" ], 6984 "produces" : [ "application/json" ], 6985 "parameters" : [ { 6986 "name" : "engineId", 6987 "in" : "path", 6988 "description" : "engine id", 6989 "required" : true, 6990 "type" : "string" 6991 }, { 6992 "in" : "body", 6993 "name" : "body", 6994 "required" : false, 6995 "schema" : { 6996 "$ref" : "#/definitions/StandardRunProfile" 6997 } 6998 } ], 6999 "responses" : { 7000 "201" : { 7001 "description" : "Created" 7002 }, 7003 "400" : { 7004 "description" : "Bad Request", 7005 "schema" : { 7006 "$ref" : "#/definitions/ErrorResponse" 7007 } 7008 }, 7009 "401" : { 7010 "description" : "Unauthorized", 7011 "schema" : { 7012 "$ref" : "#/definitions/ErrorResponse" 7013 } 7014 }, 7015 "403" : { 7016 "description" : "Forbidden", 7017 "schema" : { 7018 "$ref" : "#/definitions/ErrorResponse" 7019 } 7020 }, 7021 "404" : { 7022 "description" : "Not Found", 7023 "schema" : { 7024 "$ref" : "#/definitions/ErrorResponse" 7025 } 7026 }, 7027 "500" : { 7028 "description" : "Internal Server Error", 7029 "schema" : { 7030 "$ref" : "#/definitions/ErrorResponse" 7031 } 7032 } 7033 }, 7034 "security" : [ { 7035 "Authorization" : [ ] 7036 } ] 7037 } 7038 }, 7039 "/runtimes/pipeline-engines/{engineId}/run-profiles/standard/{runProfileId}" : { 7040 "get" : { 7041 "tags" : [ "runtime :: pipeline engines :: run profiles :: standard" ], 7042 "summary" : "Get run profile", 7043 "description" : "", 7044 "operationId" : "getStandardRunProfileById", 7045 "produces" : [ "application/json" ], 7046 "parameters" : [ { 7047 "name" : "engineId", 7048 "in" : "path", 7049 "description" : "engine id", 7050 "required" : true, 7051 "type" : "string" 7052 }, { 7053 "name" : "runProfileId", 7054 "in" : "path", 7055 "description" : "run profile id", 7056 "required" : true, 7057 "type" : "string" 7058 } ], 7059 "responses" : { 7060 "200" : { 7061 "description" : "OK", 7062 "schema" : { 7063 "$ref" : "#/definitions/StandardRunProfileResponse" 7064 } 7065 }, 7066 "400" : { 7067 "description" : "Bad Request", 7068 "schema" : { 7069 "$ref" : "#/definitions/ErrorResponse" 7070 } 7071 }, 7072 "401" : { 7073 "description" : "Unauthorized", 7074 "schema" : { 7075 "$ref" : "#/definitions/ErrorResponse" 7076 } 7077 }, 7078 "403" : { 7079 "description" : "Forbidden", 7080 "schema" : { 7081 "$ref" : "#/definitions/ErrorResponse" 7082 } 7083 }, 7084 "404" : { 7085 "description" : "Not Found", 7086 "schema" : { 7087 "$ref" : "#/definitions/ErrorResponse" 7088 } 7089 }, 7090 "500" : { 7091 "description" : "Internal Server Error", 7092 "schema" : { 7093 "$ref" : "#/definitions/ErrorResponse" 7094 } 7095 } 7096 }, 7097 "security" : [ { 7098 "Authorization" : [ ] 7099 } ] 7100 }, 7101 "put" : { 7102 "tags" : [ "runtime :: pipeline engines :: run profiles :: standard" ], 7103 "summary" : "Update run profile", 7104 "description" : "", 7105 "operationId" : "updateRunProfileStandard", 7106 "consumes" : [ "application/json" ], 7107 "parameters" : [ { 7108 "name" : "engineId", 7109 "in" : "path", 7110 "description" : "engine id", 7111 "required" : true, 7112 "type" : "string" 7113 }, { 7114 "name" : "runProfileId", 7115 "in" : "path", 7116 "description" : "run profile id", 7117 "required" : true, 7118 "type" : "string" 7119 }, { 7120 "in" : "body", 7121 "name" : "body", 7122 "description" : "run profile", 7123 "required" : true, 7124 "schema" : { 7125 "$ref" : "#/definitions/StandardRunProfile" 7126 } 7127 } ], 7128 "responses" : { 7129 "204" : { 7130 "description" : "No Content" 7131 }, 7132 "400" : { 7133 "description" : "Bad Request", 7134 "schema" : { 7135 "$ref" : "#/definitions/ErrorResponse" 7136 } 7137 }, 7138 "401" : { 7139 "description" : "Unauthorized", 7140 "schema" : { 7141 "$ref" : "#/definitions/ErrorResponse" 7142 } 7143 }, 7144 "403" : { 7145 "description" : "Forbidden", 7146 "schema" : { 7147 "$ref" : "#/definitions/ErrorResponse" 7148 } 7149 }, 7150 "404" : { 7151 "description" : "Not Found", 7152 "schema" : { 7153 "$ref" : "#/definitions/ErrorResponse" 7154 } 7155 }, 7156 "500" : { 7157 "description" : "Internal Server Error", 7158 "schema" : { 7159 "$ref" : "#/definitions/ErrorResponse" 7160 } 7161 } 7162 }, 7163 "security" : [ { 7164 "Authorization" : [ ] 7165 } ] 7166 } 7167 }, 7168 "/runtimes/pipeline-engines/{engineId}/run-profiles/{type}/{runProfileId}" : { 7169 "delete" : { 7170 "tags" : [ "runtime :: pipeline engines :: run profiles" ], 7171 "summary" : "Delete run profile", 7172 "description" : "", 7173 "operationId" : "deletePipelineRunProfile", 7174 "parameters" : [ { 7175 "name" : "engineId", 7176 "in" : "path", 7177 "description" : "engine id", 7178 "required" : true, 7179 "type" : "string" 7180 }, { 7181 "name" : "type", 7182 "in" : "path", 7183 "description" : "run profile type", 7184 "required" : true, 7185 "type" : "string" 7186 }, { 7187 "name" : "runProfileId", 7188 "in" : "path", 7189 "description" : "run profile id", 7190 "required" : true, 7191 "type" : "string" 7192 }, { 7193 "name" : "newRunProfileId", 7194 "in" : "query", 7195 "description" : "run profile for replacement id", 7196 "required" : false, 7197 "type" : "string" 7198 } ], 7199 "responses" : { 7200 "204" : { 7201 "description" : "No Content" 7202 }, 7203 "400" : { 7204 "description" : "Bad Request", 7205 "schema" : { 7206 "$ref" : "#/definitions/ErrorResponse" 7207 } 7208 }, 7209 "401" : { 7210 "description" : "Unauthorized", 7211 "schema" : { 7212 "$ref" : "#/definitions/ErrorResponse" 7213 } 7214 }, 7215 "403" : { 7216 "description" : "Forbidden", 7217 "schema" : { 7218 "$ref" : "#/definitions/ErrorResponse" 7219 } 7220 }, 7221 "404" : { 7222 "description" : "Not Found", 7223 "schema" : { 7224 "$ref" : "#/definitions/ErrorResponse" 7225 } 7226 }, 7227 "500" : { 7228 "description" : "Internal Server Error", 7229 "schema" : { 7230 "$ref" : "#/definitions/ErrorResponse" 7231 } 7232 } 7233 }, 7234 "security" : [ { 7235 "Authorization" : [ ] 7236 } ] 7237 } 7238 }, 7239 "/runtimes/remote-engine-clusters" : { 7240 "get" : { 7241 "tags" : [ "runtime :: clusters" ], 7242 "summary" : "Get all (available) Remote Engine Clusters", 7243 "description" : "Get all (available) Remote Engine Clusters", 7244 "operationId" : "getEngineClustersAvailable", 7245 "produces" : [ "application/json" ], 7246 "parameters" : [ { 7247 "name" : "_s", 7248 "in" : "query", 7249 "description" : "search query (FIQL format), e.g. \"workspace.environment.id==5cb47ca4b1b5247f6006529e\",\"name==NewCluster\"", 7250 "required" : false, 7251 "type" : "string" 7252 } ], 7253 "responses" : { 7254 "200" : { 7255 "description" : "OK", 7256 "schema" : { 7257 "type" : "array", 7258 "items" : { 7259 "$ref" : "#/definitions/BaseEngine" 7260 } 7261 } 7262 }, 7263 "401" : { 7264 "description" : "Unauthorized", 7265 "schema" : { 7266 "$ref" : "#/definitions/ErrorResponse" 7267 } 7268 }, 7269 "403" : { 7270 "description" : "Forbidden", 7271 "schema" : { 7272 "$ref" : "#/definitions/ErrorResponse" 7273 } 7274 }, 7275 "500" : { 7276 "description" : "Internal Server Error", 7277 "schema" : { 7278 "$ref" : "#/definitions/ErrorResponse" 7279 } 7280 } 7281 }, 7282 "security" : [ { 7283 "Authorization" : [ ] 7284 } ] 7285 }, 7286 "post" : { 7287 "tags" : [ "runtime :: clusters" ], 7288 "summary" : "Create Remote Engine Cluster", 7289 "description" : "Create Remote Engine Cluster", 7290 "operationId" : "createRemoteEngineCluster", 7291 "consumes" : [ "application/json" ], 7292 "produces" : [ "application/json" ], 7293 "parameters" : [ { 7294 "in" : "body", 7295 "name" : "body", 7296 "description" : "Remote Engine Cluster", 7297 "required" : true, 7298 "schema" : { 7299 "$ref" : "#/definitions/ClusterRequest" 7300 } 7301 } ], 7302 "responses" : { 7303 "201" : { 7304 "description" : "Created", 7305 "schema" : { 7306 "$ref" : "#/definitions/EngineCluster" 7307 } 7308 }, 7309 "400" : { 7310 "description" : "Bad Request", 7311 "schema" : { 7312 "$ref" : "#/definitions/ErrorResponse" 7313 } 7314 }, 7315 "401" : { 7316 "description" : "Unauthorized", 7317 "schema" : { 7318 "$ref" : "#/definitions/ErrorResponse" 7319 } 7320 }, 7321 "403" : { 7322 "description" : "Forbidden", 7323 "schema" : { 7324 "$ref" : "#/definitions/ErrorResponse" 7325 } 7326 }, 7327 "500" : { 7328 "description" : "Internal Server Error", 7329 "schema" : { 7330 "$ref" : "#/definitions/ErrorResponse" 7331 } 7332 } 7333 }, 7334 "security" : [ { 7335 "Authorization" : [ ] 7336 } ] 7337 } 7338 }, 7339 "/runtimes/remote-engine-clusters/{clusterId}" : { 7340 "get" : { 7341 "tags" : [ "runtime :: clusters" ], 7342 "summary" : "Get Remote Engine Cluster by id", 7343 "description" : "Get Remote Engine Cluster by id", 7344 "operationId" : "getRemoteEngineCluster", 7345 "produces" : [ "application/json" ], 7346 "parameters" : [ { 7347 "name" : "clusterId", 7348 "in" : "path", 7349 "description" : "remote engine cluster id", 7350 "required" : true, 7351 "type" : "string" 7352 } ], 7353 "responses" : { 7354 "200" : { 7355 "description" : "OK", 7356 "schema" : { 7357 "$ref" : "#/definitions/EngineCluster" 7358 } 7359 }, 7360 "401" : { 7361 "description" : "Unauthorized", 7362 "schema" : { 7363 "$ref" : "#/definitions/ErrorResponse" 7364 } 7365 }, 7366 "403" : { 7367 "description" : "Forbidden", 7368 "schema" : { 7369 "$ref" : "#/definitions/ErrorResponse" 7370 } 7371 }, 7372 "404" : { 7373 "description" : "Not Found", 7374 "schema" : { 7375 "$ref" : "#/definitions/ErrorResponse" 7376 } 7377 }, 7378 "500" : { 7379 "description" : "Internal Server Error", 7380 "schema" : { 7381 "$ref" : "#/definitions/ErrorResponse" 7382 } 7383 } 7384 }, 7385 "security" : [ { 7386 "Authorization" : [ ] 7387 } ] 7388 }, 7389 "delete" : { 7390 "tags" : [ "runtime :: clusters" ], 7391 "summary" : "Delete Remote Engine Cluster by id", 7392 "description" : "Delete Remote Engine Cluster by id", 7393 "operationId" : "deleteRemoteEngineCluster", 7394 "parameters" : [ { 7395 "name" : "clusterId", 7396 "in" : "path", 7397 "description" : "remote engine cluster id", 7398 "required" : true, 7399 "type" : "string" 7400 } ], 7401 "responses" : { 7402 "204" : { 7403 "description" : "No Content" 7404 }, 7405 "400" : { 7406 "description" : "Bad Request", 7407 "schema" : { 7408 "$ref" : "#/definitions/ErrorResponse" 7409 } 7410 }, 7411 "401" : { 7412 "description" : "Unauthorized", 7413 "schema" : { 7414 "$ref" : "#/definitions/ErrorResponse" 7415 } 7416 }, 7417 "403" : { 7418 "description" : "Forbidden", 7419 "schema" : { 7420 "$ref" : "#/definitions/ErrorResponse" 7421 } 7422 }, 7423 "404" : { 7424 "description" : "Not Found", 7425 "schema" : { 7426 "$ref" : "#/definitions/ErrorResponse" 7427 } 7428 }, 7429 "500" : { 7430 "description" : "Internal Server Error", 7431 "schema" : { 7432 "$ref" : "#/definitions/ErrorResponse" 7433 } 7434 } 7435 }, 7436 "security" : [ { 7437 "Authorization" : [ ] 7438 } ] 7439 } 7440 }, 7441 "/runtimes/remote-engine-clusters/{clusterId}/engines/{engineId}" : { 7442 "put" : { 7443 "tags" : [ "runtime :: clusters" ], 7444 "summary" : "Add Remote Engine to Remote Engine Cluster with reschedule", 7445 "description" : "Add Remote Engine to Remote Engine Cluster with reschedule", 7446 "operationId" : "addRemoteEngineToCluster", 7447 "consumes" : [ "application/json" ], 7448 "parameters" : [ { 7449 "name" : "clusterId", 7450 "in" : "path", 7451 "description" : "remote engine cluster id", 7452 "required" : true, 7453 "type" : "string" 7454 }, { 7455 "name" : "engineId", 7456 "in" : "path", 7457 "description" : "remote engine id", 7458 "required" : true, 7459 "type" : "string" 7460 }, { 7461 "in" : "body", 7462 "name" : "body", 7463 "description" : "run profile reschedule options", 7464 "required" : false, 7465 "schema" : { 7466 "$ref" : "#/definitions/RunProfileRescheduleOptions" 7467 } 7468 } ], 7469 "responses" : { 7470 "204" : { 7471 "description" : "No Content" 7472 }, 7473 "400" : { 7474 "description" : "Bad Request", 7475 "schema" : { 7476 "$ref" : "#/definitions/ErrorResponse" 7477 } 7478 }, 7479 "401" : { 7480 "description" : "Unauthorized", 7481 "schema" : { 7482 "$ref" : "#/definitions/ErrorResponse" 7483 } 7484 }, 7485 "403" : { 7486 "description" : "Forbidden", 7487 "schema" : { 7488 "$ref" : "#/definitions/ErrorResponse" 7489 } 7490 }, 7491 "404" : { 7492 "description" : "Not Found", 7493 "schema" : { 7494 "$ref" : "#/definitions/ErrorResponse" 7495 } 7496 }, 7497 "409" : { 7498 "description" : "Conflict", 7499 "schema" : { 7500 "$ref" : "#/definitions/ErrorResponse" 7501 } 7502 }, 7503 "500" : { 7504 "description" : "Internal Server Error", 7505 "schema" : { 7506 "$ref" : "#/definitions/ErrorResponse" 7507 } 7508 } 7509 }, 7510 "security" : [ { 7511 "Authorization" : [ ] 7512 } ] 7513 }, 7514 "delete" : { 7515 "tags" : [ "runtime :: clusters" ], 7516 "summary" : "Remove Remote Engine from Remote Engine Cluster", 7517 "description" : "Remove Remote Engine from Remote Engine Cluster", 7518 "operationId" : "removeRemoteEngineFromCluster", 7519 "produces" : [ "application/json" ], 7520 "parameters" : [ { 7521 "name" : "clusterId", 7522 "in" : "path", 7523 "description" : "remote engine cluster id", 7524 "required" : true, 7525 "type" : "string" 7526 }, { 7527 "name" : "engineId", 7528 "in" : "path", 7529 "description" : "remote engine id", 7530 "required" : true, 7531 "type" : "string" 7532 } ], 7533 "responses" : { 7534 "204" : { 7535 "description" : "No Content" 7536 }, 7537 "400" : { 7538 "description" : "Bad Request", 7539 "schema" : { 7540 "$ref" : "#/definitions/ErrorResponse" 7541 } 7542 }, 7543 "401" : { 7544 "description" : "Unauthorized", 7545 "schema" : { 7546 "$ref" : "#/definitions/ErrorResponse" 7547 } 7548 }, 7549 "403" : { 7550 "description" : "Forbidden", 7551 "schema" : { 7552 "$ref" : "#/definitions/ErrorResponse" 7553 } 7554 }, 7555 "404" : { 7556 "description" : "Not Found", 7557 "schema" : { 7558 "$ref" : "#/definitions/ErrorResponse" 7559 } 7560 }, 7561 "500" : { 7562 "description" : "Internal Server Error", 7563 "schema" : { 7564 "$ref" : "#/definitions/ErrorResponse" 7565 } 7566 } 7567 }, 7568 "security" : [ { 7569 "Authorization" : [ ] 7570 } ] 7571 } 7572 }, 7573 "/runtimes/remote-engine-clusters/{clusterId}/run-profiles" : { 7574 "get" : { 7575 "tags" : [ "runtime :: clusters :: run-profiles" ], 7576 "summary" : "Get cluster run profiles", 7577 "description" : "Get cluster run profiles", 7578 "operationId" : "getClusterRunProfiles", 7579 "produces" : [ "application/json" ], 7580 "parameters" : [ { 7581 "name" : "clusterId", 7582 "in" : "path", 7583 "description" : "cluster id", 7584 "required" : true, 7585 "type" : "string" 7586 }, { 7587 "name" : "type", 7588 "in" : "query", 7589 "description" : "Type of run profiles to be returned. By default returns all", 7590 "required" : false, 7591 "type" : "string", 7592 "enum" : [ "JOB_SERVER", "MICROSERVICE", "TALEND_RUNTIME" ] 7593 } ], 7594 "responses" : { 7595 "200" : { 7596 "description" : "OK", 7597 "schema" : { 7598 "type" : "array", 7599 "items" : { 7600 "$ref" : "#/definitions/RuntimeRunProfile" 7601 } 7602 } 7603 }, 7604 "403" : { 7605 "description" : "Forbidden", 7606 "schema" : { 7607 "$ref" : "#/definitions/ErrorResponse" 7608 } 7609 }, 7610 "404" : { 7611 "description" : "Cluster not found", 7612 "schema" : { 7613 "$ref" : "#/definitions/ErrorResponse" 7614 } 7615 } 7616 }, 7617 "security" : [ { 7618 "Authorization" : [ ] 7619 } ] 7620 }, 7621 "post" : { 7622 "tags" : [ "runtime :: clusters :: run-profiles" ], 7623 "summary" : "Create cluster run profile", 7624 "description" : "Create cluster run profile", 7625 "operationId" : "createClusterRunProfile", 7626 "consumes" : [ "application/json" ], 7627 "produces" : [ "application/json" ], 7628 "parameters" : [ { 7629 "name" : "clusterId", 7630 "in" : "path", 7631 "description" : "cluster id", 7632 "required" : true, 7633 "type" : "string" 7634 }, { 7635 "in" : "body", 7636 "name" : "body", 7637 "description" : "run profile", 7638 "required" : true, 7639 "schema" : { 7640 "$ref" : "#/definitions/RunProfileRequest" 7641 } 7642 } ], 7643 "responses" : { 7644 "201" : { 7645 "description" : "Created", 7646 "schema" : { 7647 "$ref" : "#/definitions/RuntimeRunProfile" 7648 } 7649 }, 7650 "400" : { 7651 "description" : "Bad run profile definition", 7652 "schema" : { 7653 "$ref" : "#/definitions/RuntimeRunProfile" 7654 } 7655 }, 7656 "403" : { 7657 "description" : "Forbidden", 7658 "schema" : { 7659 "$ref" : "#/definitions/ErrorResponse" 7660 } 7661 }, 7662 "404" : { 7663 "description" : "No cluster can be found by provided", 7664 "schema" : { 7665 "$ref" : "#/definitions/ErrorResponse" 7666 } 7667 }, 7668 "409" : { 7669 "description" : "Run profile with corresponding name already exists for given runtime", 7670 "schema" : { 7671 "$ref" : "#/definitions/ErrorResponse" 7672 } 7673 }, 7674 "500" : { 7675 "description" : "Internal server error", 7676 "schema" : { 7677 "$ref" : "#/definitions/ErrorResponse" 7678 } 7679 } 7680 }, 7681 "security" : [ { 7682 "Authorization" : [ ] 7683 } ] 7684 } 7685 }, 7686 "/runtimes/remote-engine-clusters/{clusterId}/run-profiles/{runProfileId}" : { 7687 "get" : { 7688 "tags" : [ "runtime :: clusters :: run-profiles" ], 7689 "summary" : "Get cluster run profile", 7690 "description" : "Get cluster run profile", 7691 "operationId" : "getClusterRunProfile", 7692 "produces" : [ "application/json" ], 7693 "parameters" : [ { 7694 "name" : "clusterId", 7695 "in" : "path", 7696 "description" : "cluster id", 7697 "required" : true, 7698 "type" : "string" 7699 }, { 7700 "name" : "runProfileId", 7701 "in" : "path", 7702 "description" : "run profile id", 7703 "required" : true, 7704 "type" : "string" 7705 } ], 7706 "responses" : { 7707 "200" : { 7708 "description" : "OK", 7709 "schema" : { 7710 "type" : "array", 7711 "items" : { 7712 "$ref" : "#/definitions/RuntimeRunProfile" 7713 } 7714 } 7715 }, 7716 "403" : { 7717 "description" : "Forbidden", 7718 "schema" : { 7719 "$ref" : "#/definitions/ErrorResponse" 7720 } 7721 }, 7722 "404" : { 7723 "description" : "Run profle not found", 7724 "schema" : { 7725 "$ref" : "#/definitions/ErrorResponse" 7726 } 7727 } 7728 }, 7729 "security" : [ { 7730 "Authorization" : [ ] 7731 } ] 7732 }, 7733 "put" : { 7734 "tags" : [ "runtime :: clusters :: run-profiles" ], 7735 "summary" : "Update cluster run profile", 7736 "description" : "Update cluster run profile", 7737 "operationId" : "updateClusterRunProfile", 7738 "consumes" : [ "application/json" ], 7739 "produces" : [ "application/json" ], 7740 "parameters" : [ { 7741 "name" : "clusterId", 7742 "in" : "path", 7743 "description" : "cluster id", 7744 "required" : true, 7745 "type" : "string" 7746 }, { 7747 "name" : "runProfileId", 7748 "in" : "path", 7749 "description" : "run profile id", 7750 "required" : true, 7751 "type" : "string" 7752 }, { 7753 "in" : "body", 7754 "name" : "body", 7755 "description" : "run profile", 7756 "required" : true, 7757 "schema" : { 7758 "$ref" : "#/definitions/RunProfileUpdateRequest" 7759 } 7760 } ], 7761 "responses" : { 7762 "200" : { 7763 "description" : "OK", 7764 "schema" : { 7765 "$ref" : "#/definitions/RuntimeRunProfile" 7766 } 7767 }, 7768 "403" : { 7769 "description" : "Forbidden", 7770 "schema" : { 7771 "$ref" : "#/definitions/ErrorResponse" 7772 } 7773 }, 7774 "404" : { 7775 "description" : "No run profile can be found", 7776 "schema" : { 7777 "$ref" : "#/definitions/ErrorResponse" 7778 } 7779 }, 7780 "500" : { 7781 "description" : "Internal server error", 7782 "schema" : { 7783 "$ref" : "#/definitions/ErrorResponse" 7784 } 7785 } 7786 }, 7787 "security" : [ { 7788 "Authorization" : [ ] 7789 } ] 7790 }, 7791 "delete" : { 7792 "tags" : [ "runtime :: clusters :: run-profiles" ], 7793 "summary" : "Delete cluster run profile", 7794 "description" : "Delete cluster run profile", 7795 "operationId" : "deleteClusterRunProfile", 7796 "parameters" : [ { 7797 "name" : "clusterId", 7798 "in" : "path", 7799 "description" : "cluster id", 7800 "required" : true, 7801 "type" : "string" 7802 }, { 7803 "name" : "runProfileId", 7804 "in" : "path", 7805 "description" : "run profile id", 7806 "required" : true, 7807 "type" : "string" 7808 }, { 7809 "name" : "newRunProfileId", 7810 "in" : "query", 7811 "description" : "new run profile id", 7812 "required" : false, 7813 "type" : "string" 7814 } ], 7815 "responses" : { 7816 "204" : { 7817 "description" : "No Content" 7818 }, 7819 "403" : { 7820 "description" : "Forbidden", 7821 "schema" : { 7822 "$ref" : "#/definitions/ErrorResponse" 7823 } 7824 }, 7825 "404" : { 7826 "description" : "No run profile can be found", 7827 "schema" : { 7828 "$ref" : "#/definitions/ErrorResponse" 7829 } 7830 }, 7831 "500" : { 7832 "description" : "Internal server error", 7833 "schema" : { 7834 "$ref" : "#/definitions/ErrorResponse" 7835 } 7836 } 7837 }, 7838 "security" : [ { 7839 "Authorization" : [ ] 7840 } ] 7841 } 7842 }, 7843 "/runtimes/remote-engines" : { 7844 "get" : { 7845 "tags" : [ "runtime :: engines" ], 7846 "summary" : "Get all (available) Remote Engines", 7847 "description" : "Get all (available) Remote Engines", 7848 "operationId" : "getRemoteEngines", 7849 "produces" : [ "application/json" ], 7850 "parameters" : [ { 7851 "name" : "query", 7852 "in" : "query", 7853 "description" : "search query (FIQL format), e.g. \"workspace.environment.id==5cb47ca4b1b5247f6006529e\",\"status==PAIRED\"", 7854 "required" : false, 7855 "type" : "string" 7856 } ], 7857 "responses" : { 7858 "200" : { 7859 "description" : "OK", 7860 "schema" : { 7861 "type" : "array", 7862 "items" : { 7863 "$ref" : "#/definitions/Engine" 7864 } 7865 } 7866 }, 7867 "401" : { 7868 "description" : "Unauthorized", 7869 "schema" : { 7870 "$ref" : "#/definitions/ErrorResponse" 7871 } 7872 }, 7873 "403" : { 7874 "description" : "Forbidden", 7875 "schema" : { 7876 "$ref" : "#/definitions/ErrorResponse" 7877 } 7878 }, 7879 "404" : { 7880 "description" : "Not Found", 7881 "schema" : { 7882 "$ref" : "#/definitions/ErrorResponse" 7883 } 7884 }, 7885 "500" : { 7886 "description" : "Internal Server Error", 7887 "schema" : { 7888 "$ref" : "#/definitions/ErrorResponse" 7889 } 7890 } 7891 }, 7892 "security" : [ { 7893 "Authorization" : [ ] 7894 } ] 7895 }, 7896 "post" : { 7897 "tags" : [ "runtime :: engines" ], 7898 "summary" : "Create new Remote Engine", 7899 "description" : "Create new Remote Engine", 7900 "operationId" : "createRemoteEngine", 7901 "produces" : [ "application/json" ], 7902 "parameters" : [ { 7903 "in" : "body", 7904 "name" : "body", 7905 "description" : "remote engine", 7906 "required" : true, 7907 "schema" : { 7908 "$ref" : "#/definitions/EngineRequest" 7909 } 7910 } ], 7911 "responses" : { 7912 "201" : { 7913 "description" : "Created", 7914 "schema" : { 7915 "$ref" : "#/definitions/Engine" 7916 } 7917 }, 7918 "400" : { 7919 "description" : "Bad Request", 7920 "schema" : { 7921 "$ref" : "#/definitions/ErrorResponse" 7922 } 7923 }, 7924 "401" : { 7925 "description" : "Unauthorized", 7926 "schema" : { 7927 "$ref" : "#/definitions/ErrorResponse" 7928 } 7929 }, 7930 "403" : { 7931 "description" : "Forbidden", 7932 "schema" : { 7933 "$ref" : "#/definitions/ErrorResponse" 7934 } 7935 }, 7936 "500" : { 7937 "description" : "Internal Server Error", 7938 "schema" : { 7939 "$ref" : "#/definitions/ErrorResponse" 7940 } 7941 } 7942 }, 7943 "security" : [ { 7944 "Authorization" : [ ] 7945 } ] 7946 } 7947 }, 7948 "/runtimes/remote-engines/{engineId}/run-profiles" : { 7949 "get" : { 7950 "tags" : [ "runtime :: engines :: run-profiles" ], 7951 "summary" : "Get all engine run profiles", 7952 "description" : "Get all engine run profiles", 7953 "operationId" : "getEngineRunProfiles", 7954 "produces" : [ "application/json" ], 7955 "parameters" : [ { 7956 "name" : "engineId", 7957 "in" : "path", 7958 "description" : "remote engine id", 7959 "required" : true, 7960 "type" : "string" 7961 }, { 7962 "name" : "type", 7963 "in" : "query", 7964 "description" : "Type of run profiles to be returned. By default returns all", 7965 "required" : false, 7966 "type" : "string", 7967 "enum" : [ "JOB_SERVER", "MICROSERVICE", "TALEND_RUNTIME" ] 7968 } ], 7969 "responses" : { 7970 "200" : { 7971 "description" : "OK", 7972 "schema" : { 7973 "type" : "array", 7974 "items" : { 7975 "$ref" : "#/definitions/RuntimeRunProfile" 7976 } 7977 } 7978 }, 7979 "403" : { 7980 "description" : "Forbidden", 7981 "schema" : { 7982 "$ref" : "#/definitions/ErrorResponse" 7983 } 7984 }, 7985 "404" : { 7986 "description" : "Engine not found", 7987 "schema" : { 7988 "$ref" : "#/definitions/ErrorResponse" 7989 } 7990 } 7991 }, 7992 "security" : [ { 7993 "Authorization" : [ ] 7994 } ] 7995 }, 7996 "post" : { 7997 "tags" : [ "runtime :: engines :: run-profiles" ], 7998 "summary" : "Create engine run profile", 7999 "description" : "Create engine run profile", 8000 "operationId" : "createEngineRunProfile", 8001 "consumes" : [ "application/json" ], 8002 "produces" : [ "application/json" ], 8003 "parameters" : [ { 8004 "name" : "engineId", 8005 "in" : "path", 8006 "description" : "remote engine id", 8007 "required" : true, 8008 "type" : "string" 8009 }, { 8010 "in" : "body", 8011 "name" : "body", 8012 "description" : "run profile", 8013 "required" : true, 8014 "schema" : { 8015 "$ref" : "#/definitions/RunProfileRequest" 8016 } 8017 } ], 8018 "responses" : { 8019 "201" : { 8020 "description" : "Created", 8021 "schema" : { 8022 "$ref" : "#/definitions/RuntimeRunProfile" 8023 } 8024 }, 8025 "400" : { 8026 "description" : "Bad run profile definition", 8027 "schema" : { 8028 "$ref" : "#/definitions/ErrorResponse" 8029 } 8030 }, 8031 "403" : { 8032 "description" : "Forbidden", 8033 "schema" : { 8034 "$ref" : "#/definitions/ErrorResponse" 8035 } 8036 }, 8037 "404" : { 8038 "description" : "No engine can be found by provided", 8039 "schema" : { 8040 "$ref" : "#/definitions/ErrorResponse" 8041 } 8042 }, 8043 "409" : { 8044 "description" : "Run profile with corresponding name already exists for given runtime", 8045 "schema" : { 8046 "$ref" : "#/definitions/ErrorResponse" 8047 } 8048 }, 8049 "500" : { 8050 "description" : "Internal server error", 8051 "schema" : { 8052 "$ref" : "#/definitions/ErrorResponse" 8053 } 8054 } 8055 }, 8056 "security" : [ { 8057 "Authorization" : [ ] 8058 } ] 8059 } 8060 }, 8061 "/runtimes/remote-engines/{engineId}/run-profiles/{runProfileId}" : { 8062 "get" : { 8063 "tags" : [ "runtime :: engines :: run-profiles" ], 8064 "summary" : "Get engine run profile by id", 8065 "description" : "Get engine run profile by id", 8066 "operationId" : "getEngineRunProfile", 8067 "produces" : [ "application/json" ], 8068 "parameters" : [ { 8069 "name" : "engineId", 8070 "in" : "path", 8071 "description" : "remote engine id", 8072 "required" : true, 8073 "type" : "string" 8074 }, { 8075 "name" : "runProfileId", 8076 "in" : "path", 8077 "description" : "run profile id", 8078 "required" : true, 8079 "type" : "string" 8080 } ], 8081 "responses" : { 8082 "200" : { 8083 "description" : "OK", 8084 "schema" : { 8085 "$ref" : "#/definitions/RuntimeRunProfile" 8086 } 8087 }, 8088 "403" : { 8089 "description" : "Forbidden", 8090 "schema" : { 8091 "$ref" : "#/definitions/ErrorResponse" 8092 } 8093 }, 8094 "404" : { 8095 "description" : "Run profile not found", 8096 "schema" : { 8097 "$ref" : "#/definitions/ErrorResponse" 8098 } 8099 } 8100 }, 8101 "security" : [ { 8102 "Authorization" : [ ] 8103 } ] 8104 }, 8105 "put" : { 8106 "tags" : [ "runtime :: engines :: run-profiles" ], 8107 "summary" : "Update engine run profile", 8108 "description" : "Update engine run profile", 8109 "operationId" : "updateEngineRunProfile", 8110 "consumes" : [ "application/json" ], 8111 "produces" : [ "application/json" ], 8112 "parameters" : [ { 8113 "name" : "engineId", 8114 "in" : "path", 8115 "description" : "remote engine id", 8116 "required" : true, 8117 "type" : "string" 8118 }, { 8119 "name" : "runProfileId", 8120 "in" : "path", 8121 "description" : "run profile id", 8122 "required" : true, 8123 "type" : "string" 8124 }, { 8125 "in" : "body", 8126 "name" : "body", 8127 "description" : "update run profile", 8128 "required" : true, 8129 "schema" : { 8130 "$ref" : "#/definitions/RunProfileUpdateRequest" 8131 } 8132 } ], 8133 "responses" : { 8134 "200" : { 8135 "description" : "OK", 8136 "schema" : { 8137 "$ref" : "#/definitions/RuntimeRunProfile" 8138 } 8139 }, 8140 "403" : { 8141 "description" : "Forbidden", 8142 "schema" : { 8143 "$ref" : "#/definitions/ErrorResponse" 8144 } 8145 }, 8146 "404" : { 8147 "description" : "Run profile not found", 8148 "schema" : { 8149 "$ref" : "#/definitions/ErrorResponse" 8150 } 8151 }, 8152 "500" : { 8153 "description" : "Internal server error", 8154 "schema" : { 8155 "$ref" : "#/definitions/ErrorResponse" 8156 } 8157 } 8158 }, 8159 "security" : [ { 8160 "Authorization" : [ ] 8161 } ] 8162 }, 8163 "delete" : { 8164 "tags" : [ "runtime :: engines :: run-profiles" ], 8165 "summary" : "Delete engine run profile", 8166 "description" : "Delete engine run profile", 8167 "operationId" : "deleteEngineRunProfile", 8168 "consumes" : [ "application/json" ], 8169 "parameters" : [ { 8170 "name" : "engineId", 8171 "in" : "path", 8172 "description" : "remote engine id", 8173 "required" : true, 8174 "type" : "string" 8175 }, { 8176 "name" : "runProfileId", 8177 "in" : "path", 8178 "description" : "run profile id to delete", 8179 "required" : true, 8180 "type" : "string" 8181 }, { 8182 "name" : "newRunProfileId", 8183 "in" : "query", 8184 "description" : "new run profile id", 8185 "required" : false, 8186 "type" : "string" 8187 } ], 8188 "responses" : { 8189 "202" : { 8190 "description" : "Run Profile deleted." 8191 }, 8192 "403" : { 8193 "description" : "Forbidden", 8194 "schema" : { 8195 "$ref" : "#/definitions/ErrorResponse" 8196 } 8197 }, 8198 "404" : { 8199 "description" : "No run profile can be found", 8200 "schema" : { 8201 "$ref" : "#/definitions/ErrorResponse" 8202 } 8203 }, 8204 "500" : { 8205 "description" : "Internal server error", 8206 "schema" : { 8207 "$ref" : "#/definitions/ErrorResponse" 8208 } 8209 } 8210 }, 8211 "security" : [ { 8212 "Authorization" : [ ] 8213 } ] 8214 } 8215 }, 8216 "/runtimes/remote-engines/{id}" : { 8217 "get" : { 8218 "tags" : [ "runtime :: engines" ], 8219 "summary" : "Get Remote Engine by id", 8220 "description" : "Get Remote Engine by id", 8221 "operationId" : "getRemoteEngine", 8222 "produces" : [ "application/json" ], 8223 "parameters" : [ { 8224 "name" : "id", 8225 "in" : "path", 8226 "description" : "remote engine id", 8227 "required" : true, 8228 "type" : "string" 8229 } ], 8230 "responses" : { 8231 "200" : { 8232 "description" : "OK", 8233 "schema" : { 8234 "$ref" : "#/definitions/Engine" 8235 } 8236 }, 8237 "401" : { 8238 "description" : "Unauthorized", 8239 "schema" : { 8240 "$ref" : "#/definitions/ErrorResponse" 8241 } 8242 }, 8243 "403" : { 8244 "description" : "Forbidden", 8245 "schema" : { 8246 "$ref" : "#/definitions/ErrorResponse" 8247 } 8248 }, 8249 "404" : { 8250 "description" : "Not Found", 8251 "schema" : { 8252 "$ref" : "#/definitions/ErrorResponse" 8253 } 8254 }, 8255 "500" : { 8256 "description" : "Internal Server Error", 8257 "schema" : { 8258 "$ref" : "#/definitions/ErrorResponse" 8259 } 8260 } 8261 }, 8262 "security" : [ { 8263 "Authorization" : [ ] 8264 } ] 8265 }, 8266 "delete" : { 8267 "tags" : [ "runtime :: engines" ], 8268 "summary" : "Delete Remote Engine by id", 8269 "description" : "Delete Remote Engine by id", 8270 "operationId" : "deleteRemoteEngine", 8271 "produces" : [ "application/json" ], 8272 "parameters" : [ { 8273 "name" : "id", 8274 "in" : "path", 8275 "description" : "remote engine id", 8276 "required" : true, 8277 "type" : "string" 8278 } ], 8279 "responses" : { 8280 "204" : { 8281 "description" : "No Content" 8282 }, 8283 "400" : { 8284 "description" : "Bad Request", 8285 "schema" : { 8286 "$ref" : "#/definitions/ErrorResponse" 8287 } 8288 }, 8289 "401" : { 8290 "description" : "Unauthorized", 8291 "schema" : { 8292 "$ref" : "#/definitions/ErrorResponse" 8293 } 8294 }, 8295 "403" : { 8296 "description" : "Forbidden", 8297 "schema" : { 8298 "$ref" : "#/definitions/ErrorResponse" 8299 } 8300 }, 8301 "404" : { 8302 "description" : "Not Found", 8303 "schema" : { 8304 "$ref" : "#/definitions/ErrorResponse" 8305 } 8306 }, 8307 "409" : { 8308 "description" : "Conflict", 8309 "schema" : { 8310 "$ref" : "#/definitions/ErrorResponse" 8311 } 8312 }, 8313 "500" : { 8314 "description" : "Internal Server Error", 8315 "schema" : { 8316 "$ref" : "#/definitions/ErrorResponse" 8317 } 8318 } 8319 }, 8320 "security" : [ { 8321 "Authorization" : [ ] 8322 } ] 8323 } 8324 }, 8325 "/runtimes/remote-engines/{id}/pairing" : { 8326 "delete" : { 8327 "tags" : [ "runtime :: engines" ], 8328 "summary" : "Unpair Remote Engine", 8329 "description" : "Unpair Remote Engine", 8330 "operationId" : "unpairRemoteEngine", 8331 "produces" : [ "text/plain" ], 8332 "parameters" : [ { 8333 "name" : "id", 8334 "in" : "path", 8335 "description" : "remote engine id", 8336 "required" : true, 8337 "type" : "string" 8338 } ], 8339 "responses" : { 8340 "200" : { 8341 "description" : "OK", 8342 "schema" : { 8343 "type" : "string" 8344 } 8345 }, 8346 "400" : { 8347 "description" : "Bad Request", 8348 "schema" : { 8349 "$ref" : "#/definitions/ErrorResponse" 8350 } 8351 }, 8352 "401" : { 8353 "description" : "Unauthorized", 8354 "schema" : { 8355 "$ref" : "#/definitions/ErrorResponse" 8356 } 8357 }, 8358 "403" : { 8359 "description" : "Forbidden", 8360 "schema" : { 8361 "$ref" : "#/definitions/ErrorResponse" 8362 } 8363 }, 8364 "404" : { 8365 "description" : "Not Found", 8366 "schema" : { 8367 "$ref" : "#/definitions/ErrorResponse" 8368 } 8369 }, 8370 "500" : { 8371 "description" : "Internal Server Error", 8372 "schema" : { 8373 "$ref" : "#/definitions/ErrorResponse" 8374 } 8375 } 8376 }, 8377 "security" : [ { 8378 "Authorization" : [ ] 8379 } ] 8380 } 8381 }, 8382 "/runtimes/remote-engines/{remoteEngineId}/debug" : { 8383 "put" : { 8384 "tags" : [ "runtime :: engines" ], 8385 "summary" : "Debug Remote Engine", 8386 "description" : "Debug Remote Engine", 8387 "operationId" : "debugRemoteEngine", 8388 "consumes" : [ "application/json" ], 8389 "produces" : [ "application/json" ], 8390 "parameters" : [ { 8391 "name" : "remoteEngineId", 8392 "in" : "path", 8393 "description" : "Remote Engine ID", 8394 "required" : true, 8395 "type" : "string" 8396 }, { 8397 "in" : "body", 8398 "name" : "body", 8399 "description" : "Debug Remote Engine Parameters", 8400 "required" : true, 8401 "schema" : { 8402 "$ref" : "#/definitions/DebugRemoteEngineModel" 8403 } 8404 } ], 8405 "responses" : { 8406 "200" : { 8407 "description" : "Updated", 8408 "schema" : { 8409 "$ref" : "#/definitions/Engine" 8410 } 8411 }, 8412 "400" : { 8413 "description" : "Bad Request", 8414 "schema" : { 8415 "$ref" : "#/definitions/ErrorResponse" 8416 } 8417 }, 8418 "401" : { 8419 "description" : "Unauthorized", 8420 "schema" : { 8421 "$ref" : "#/definitions/ErrorResponse" 8422 } 8423 }, 8424 "403" : { 8425 "description" : "Forbidden", 8426 "schema" : { 8427 "$ref" : "#/definitions/ErrorResponse" 8428 } 8429 }, 8430 "500" : { 8431 "description" : "Internal Server Error", 8432 "schema" : { 8433 "$ref" : "#/definitions/ErrorResponse" 8434 } 8435 } 8436 }, 8437 "security" : [ { 8438 "Authorization" : [ ] 8439 } ] 8440 } 8441 }, 8442 "/schedules" : { 8443 "get" : { 8444 "tags" : [ "schedules" ], 8445 "summary" : "Get schedules list", 8446 "description" : "", 8447 "operationId" : "getAllSchedulesMultipleTriggers", 8448 "produces" : [ "application/json" ], 8449 "parameters" : [ { 8450 "name" : "environmentId", 8451 "in" : "query", 8452 "description" : "Schedulers matching environmentId", 8453 "required" : false, 8454 "type" : "string" 8455 }, { 8456 "name" : "descriptionFilter", 8457 "in" : "query", 8458 "description" : "Schedulers matching description filter (regular expression)", 8459 "required" : false, 8460 "type" : "string" 8461 }, { 8462 "name" : "onlyBound", 8463 "in" : "query", 8464 "description" : "Only bound schedulers", 8465 "required" : false, 8466 "type" : "boolean" 8467 }, { 8468 "name" : "limit", 8469 "in" : "query", 8470 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 8471 "required" : false, 8472 "type" : "integer", 8473 "format" : "int32" 8474 }, { 8475 "name" : "offset", 8476 "in" : "query", 8477 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 8478 "required" : false, 8479 "type" : "integer", 8480 "format" : "int32" 8481 } ], 8482 "responses" : { 8483 "200" : { 8484 "description" : "OK", 8485 "schema" : { 8486 "$ref" : "#/definitions/Page" 8487 } 8488 }, 8489 "400" : { 8490 "description" : "Bad Request", 8491 "schema" : { 8492 "$ref" : "#/definitions/ErrorResponse" 8493 } 8494 }, 8495 "401" : { 8496 "description" : "Unauthorized", 8497 "schema" : { 8498 "$ref" : "#/definitions/ErrorResponse" 8499 } 8500 }, 8501 "403" : { 8502 "description" : "Forbidden", 8503 "schema" : { 8504 "$ref" : "#/definitions/ErrorResponse" 8505 } 8506 }, 8507 "500" : { 8508 "description" : "Internal Server Error", 8509 "schema" : { 8510 "$ref" : "#/definitions/ErrorResponse" 8511 } 8512 } 8513 }, 8514 "security" : [ { 8515 "Authorization" : [ ] 8516 } ] 8517 }, 8518 "post" : { 8519 "tags" : [ "schedules" ], 8520 "summary" : "Create schedule for multiple triggers", 8521 "description" : "", 8522 "operationId" : "createScheduleMultipleTriggers", 8523 "consumes" : [ "application/json" ], 8524 "produces" : [ "application/json" ], 8525 "parameters" : [ { 8526 "in" : "body", 8527 "name" : "body", 8528 "description" : "Schedule with first trigger", 8529 "required" : false, 8530 "schema" : { 8531 "$ref" : "#/definitions/CreateScheduleMultipleTriggerRequest" 8532 } 8533 } ], 8534 "responses" : { 8535 "201" : { 8536 "description" : "Created" 8537 }, 8538 "400" : { 8539 "description" : "Bad Request", 8540 "schema" : { 8541 "$ref" : "#/definitions/ErrorResponse" 8542 } 8543 }, 8544 "401" : { 8545 "description" : "Unauthorized", 8546 "schema" : { 8547 "$ref" : "#/definitions/ErrorResponse" 8548 } 8549 }, 8550 "403" : { 8551 "description" : "Forbidden", 8552 "schema" : { 8553 "$ref" : "#/definitions/ErrorResponse" 8554 } 8555 }, 8556 "500" : { 8557 "description" : "Internal Server Error", 8558 "schema" : { 8559 "$ref" : "#/definitions/ErrorResponse" 8560 } 8561 } 8562 }, 8563 "security" : [ { 8564 "Authorization" : [ ] 8565 } ] 8566 } 8567 }, 8568 "/schedules/{scheduleId}" : { 8569 "get" : { 8570 "tags" : [ "schedules" ], 8571 "summary" : "Get schedule by id", 8572 "description" : "", 8573 "operationId" : "getScheduleMultipleTriggers", 8574 "produces" : [ "application/json" ], 8575 "parameters" : [ { 8576 "name" : "scheduleId", 8577 "in" : "path", 8578 "description" : "schedule id", 8579 "required" : true, 8580 "type" : "string" 8581 } ], 8582 "responses" : { 8583 "200" : { 8584 "description" : "OK", 8585 "schema" : { 8586 "$ref" : "#/definitions/Schedule" 8587 } 8588 }, 8589 "400" : { 8590 "description" : "Bad Request", 8591 "schema" : { 8592 "$ref" : "#/definitions/ErrorResponse" 8593 } 8594 }, 8595 "401" : { 8596 "description" : "Unauthorized", 8597 "schema" : { 8598 "$ref" : "#/definitions/ErrorResponse" 8599 } 8600 }, 8601 "403" : { 8602 "description" : "Forbidden", 8603 "schema" : { 8604 "$ref" : "#/definitions/ErrorResponse" 8605 } 8606 }, 8607 "404" : { 8608 "description" : "Not Found", 8609 "schema" : { 8610 "$ref" : "#/definitions/ErrorResponse" 8611 } 8612 }, 8613 "500" : { 8614 "description" : "Internal Server Error", 8615 "schema" : { 8616 "$ref" : "#/definitions/ErrorResponse" 8617 } 8618 } 8619 }, 8620 "security" : [ { 8621 "Authorization" : [ ] 8622 } ] 8623 }, 8624 "post" : { 8625 "tags" : [ "schedules" ], 8626 "summary" : "Clone schedule multiple triggers", 8627 "description" : "", 8628 "operationId" : "cloneScheduleMultipleTriggers", 8629 "consumes" : [ "application/json" ], 8630 "produces" : [ "application/json" ], 8631 "parameters" : [ { 8632 "name" : "scheduleId", 8633 "in" : "path", 8634 "description" : "schedule id", 8635 "required" : true, 8636 "type" : "string" 8637 }, { 8638 "in" : "body", 8639 "name" : "body", 8640 "description" : "Target name of the schedule", 8641 "required" : false, 8642 "schema" : { 8643 "$ref" : "#/definitions/UpdateScheduleMultipleTriggerRequest" 8644 } 8645 } ], 8646 "responses" : { 8647 "201" : { 8648 "description" : "Created" 8649 }, 8650 "400" : { 8651 "description" : "Bad Request", 8652 "schema" : { 8653 "$ref" : "#/definitions/ErrorResponse" 8654 } 8655 }, 8656 "401" : { 8657 "description" : "Unauthorized", 8658 "schema" : { 8659 "$ref" : "#/definitions/ErrorResponse" 8660 } 8661 }, 8662 "403" : { 8663 "description" : "Forbidden", 8664 "schema" : { 8665 "$ref" : "#/definitions/ErrorResponse" 8666 } 8667 }, 8668 "404" : { 8669 "description" : "Not Found", 8670 "schema" : { 8671 "$ref" : "#/definitions/ErrorResponse" 8672 } 8673 }, 8674 "500" : { 8675 "description" : "Internal Server Error", 8676 "schema" : { 8677 "$ref" : "#/definitions/ErrorResponse" 8678 } 8679 } 8680 }, 8681 "security" : [ { 8682 "Authorization" : [ ] 8683 } ] 8684 }, 8685 "delete" : { 8686 "tags" : [ "schedules" ], 8687 "summary" : "Delete schedule by id", 8688 "description" : "", 8689 "operationId" : "deleteScheduleMultipleTriggers", 8690 "parameters" : [ { 8691 "name" : "scheduleId", 8692 "in" : "path", 8693 "description" : "schedule id", 8694 "required" : true, 8695 "type" : "string" 8696 } ], 8697 "responses" : { 8698 "204" : { 8699 "description" : "No content" 8700 }, 8701 "400" : { 8702 "description" : "Bad request", 8703 "schema" : { 8704 "$ref" : "#/definitions/ErrorResponse" 8705 } 8706 }, 8707 "401" : { 8708 "description" : "Unauthorized", 8709 "schema" : { 8710 "$ref" : "#/definitions/ErrorResponse" 8711 } 8712 }, 8713 "403" : { 8714 "description" : "Forbidden", 8715 "schema" : { 8716 "$ref" : "#/definitions/ErrorResponse" 8717 } 8718 }, 8719 "404" : { 8720 "description" : "Not Found", 8721 "schema" : { 8722 "$ref" : "#/definitions/ErrorResponse" 8723 } 8724 }, 8725 "409" : { 8726 "description" : "The schedule is currently used by an executable", 8727 "schema" : { 8728 "$ref" : "#/definitions/ErrorResponse" 8729 } 8730 }, 8731 "500" : { 8732 "description" : "Internal Server Error", 8733 "schema" : { 8734 "$ref" : "#/definitions/ErrorResponse" 8735 } 8736 } 8737 }, 8738 "security" : [ { 8739 "Authorization" : [ ] 8740 } ] 8741 }, 8742 "patch" : { 8743 "tags" : [ "schedules" ], 8744 "summary" : "Apply partial changes to a schedule", 8745 "description" : "", 8746 "operationId" : "updateScheduleMultipleTriggers", 8747 "consumes" : [ "application/json" ], 8748 "parameters" : [ { 8749 "name" : "scheduleId", 8750 "in" : "path", 8751 "description" : "schedules id", 8752 "required" : true, 8753 "type" : "string" 8754 }, { 8755 "in" : "body", 8756 "name" : "body", 8757 "description" : "Description update", 8758 "required" : false, 8759 "schema" : { 8760 "$ref" : "#/definitions/UpdateScheduleMultipleTriggerRequest" 8761 } 8762 } ], 8763 "responses" : { 8764 "204" : { 8765 "description" : "No Content" 8766 }, 8767 "400" : { 8768 "description" : "Bad Request", 8769 "schema" : { 8770 "$ref" : "#/definitions/ErrorResponse" 8771 } 8772 }, 8773 "401" : { 8774 "description" : "Unauthorized", 8775 "schema" : { 8776 "$ref" : "#/definitions/ErrorResponse" 8777 } 8778 }, 8779 "403" : { 8780 "description" : "Forbidden", 8781 "schema" : { 8782 "$ref" : "#/definitions/ErrorResponse" 8783 } 8784 }, 8785 "404" : { 8786 "description" : "Not Found", 8787 "schema" : { 8788 "$ref" : "#/definitions/ErrorResponse" 8789 } 8790 }, 8791 "409" : { 8792 "description" : "Conflict", 8793 "schema" : { 8794 "$ref" : "#/definitions/ErrorResponse" 8795 } 8796 }, 8797 "428" : { 8798 "description" : "Precondition Required", 8799 "schema" : { 8800 "$ref" : "#/definitions/ErrorResponse" 8801 } 8802 }, 8803 "500" : { 8804 "description" : "Internal Server Error", 8805 "schema" : { 8806 "$ref" : "#/definitions/ErrorResponse" 8807 } 8808 } 8809 }, 8810 "security" : [ { 8811 "Authorization" : [ ] 8812 } ] 8813 } 8814 }, 8815 "/schedules/{scheduleId}/events" : { 8816 "get" : { 8817 "tags" : [ "schedules" ], 8818 "summary" : "Simulate schedule events", 8819 "description" : "", 8820 "operationId" : "simulateNextTriggeredEvents", 8821 "consumes" : [ "application/json" ], 8822 "produces" : [ "application/json" ], 8823 "parameters" : [ { 8824 "name" : "scheduleId", 8825 "in" : "path", 8826 "description" : "schedules id", 8827 "required" : true, 8828 "type" : "string" 8829 }, { 8830 "name" : "from", 8831 "in" : "query", 8832 "description" : "from date time (milliseconds)", 8833 "required" : false, 8834 "type" : "integer", 8835 "format" : "int64" 8836 }, { 8837 "name" : "to", 8838 "in" : "query", 8839 "description" : "to date time (milliseconds)", 8840 "required" : true, 8841 "type" : "integer", 8842 "format" : "int64" 8843 }, { 8844 "name" : "limit", 8845 "in" : "query", 8846 "description" : "the number of items to return. Must be in range [1, 100]. Default value - 100", 8847 "required" : false, 8848 "type" : "integer", 8849 "format" : "int32" 8850 }, { 8851 "name" : "offset", 8852 "in" : "query", 8853 "description" : "the position of the first item. Must be greater than or equal to 0. Default value - 0", 8854 "required" : false, 8855 "type" : "integer", 8856 "format" : "int32" 8857 } ], 8858 "responses" : { 8859 "200" : { 8860 "description" : "OK", 8861 "schema" : { 8862 "$ref" : "#/definitions/Page" 8863 } 8864 }, 8865 "400" : { 8866 "description" : "Bad request", 8867 "schema" : { 8868 "$ref" : "#/definitions/ErrorResponse" 8869 } 8870 }, 8871 "401" : { 8872 "description" : "Unauthorized", 8873 "schema" : { 8874 "$ref" : "#/definitions/ErrorResponse" 8875 } 8876 }, 8877 "403" : { 8878 "description" : "Forbidden", 8879 "schema" : { 8880 "$ref" : "#/definitions/ErrorResponse" 8881 } 8882 }, 8883 "404" : { 8884 "description" : "Not Found", 8885 "schema" : { 8886 "$ref" : "#/definitions/ErrorResponse" 8887 } 8888 }, 8889 "409" : { 8890 "description" : "Conflict", 8891 "schema" : { 8892 "$ref" : "#/definitions/ErrorResponse" 8893 } 8894 }, 8895 "428" : { 8896 "description" : "Precondition Required", 8897 "schema" : { 8898 "$ref" : "#/definitions/ErrorResponse" 8899 } 8900 }, 8901 "500" : { 8902 "description" : "Internal Server Error", 8903 "schema" : { 8904 "$ref" : "#/definitions/ErrorResponse" 8905 } 8906 } 8907 }, 8908 "security" : [ { 8909 "Authorization" : [ ] 8910 } ] 8911 } 8912 }, 8913 "/schedules/{scheduleId}/triggers" : { 8914 "post" : { 8915 "tags" : [ "schedules" ], 8916 "summary" : "Append a trigger to a schedule ", 8917 "description" : "", 8918 "operationId" : "appendTriggerToScheduleMultiple", 8919 "consumes" : [ "application/json" ], 8920 "parameters" : [ { 8921 "name" : "scheduleId", 8922 "in" : "path", 8923 "description" : "schedules id", 8924 "required" : true, 8925 "type" : "string" 8926 }, { 8927 "in" : "body", 8928 "name" : "body", 8929 "description" : "Trigger", 8930 "required" : false, 8931 "schema" : { 8932 "$ref" : "#/definitions/MultipleTrigger" 8933 } 8934 } ], 8935 "responses" : { 8936 "200" : { 8937 "description" : "OK" 8938 }, 8939 "400" : { 8940 "description" : "Bad request", 8941 "schema" : { 8942 "$ref" : "#/definitions/ErrorResponse" 8943 } 8944 }, 8945 "401" : { 8946 "description" : "Unauthorized", 8947 "schema" : { 8948 "$ref" : "#/definitions/ErrorResponse" 8949 } 8950 }, 8951 "403" : { 8952 "description" : "Forbidden", 8953 "schema" : { 8954 "$ref" : "#/definitions/ErrorResponse" 8955 } 8956 }, 8957 "404" : { 8958 "description" : "Not Found", 8959 "schema" : { 8960 "$ref" : "#/definitions/ErrorResponse" 8961 } 8962 }, 8963 "409" : { 8964 "description" : "Conflict", 8965 "schema" : { 8966 "$ref" : "#/definitions/ErrorResponse" 8967 } 8968 }, 8969 "428" : { 8970 "description" : "Precondition Required", 8971 "schema" : { 8972 "$ref" : "#/definitions/ErrorResponse" 8973 } 8974 }, 8975 "500" : { 8976 "description" : "Internal Server Error", 8977 "schema" : { 8978 "$ref" : "#/definitions/ErrorResponse" 8979 } 8980 } 8981 }, 8982 "security" : [ { 8983 "Authorization" : [ ] 8984 } ] 8985 }, 8986 "put" : { 8987 "tags" : [ "schedules" ], 8988 "summary" : "Update a trigger within a schedule ", 8989 "description" : "", 8990 "operationId" : "updateTriggerInScheduleMultiple", 8991 "consumes" : [ "application/json" ], 8992 "parameters" : [ { 8993 "name" : "scheduleId", 8994 "in" : "path", 8995 "description" : "schedules id", 8996 "required" : true, 8997 "type" : "string" 8998 }, { 8999 "in" : "body", 9000 "name" : "body", 9001 "description" : "Trigger", 9002 "required" : false, 9003 "schema" : { 9004 "$ref" : "#/definitions/MultipleTrigger" 9005 } 9006 } ], 9007 "responses" : { 9008 "200" : { 9009 "description" : "OK" 9010 }, 9011 "400" : { 9012 "description" : "Bad request", 9013 "schema" : { 9014 "$ref" : "#/definitions/ErrorResponse" 9015 } 9016 }, 9017 "401" : { 9018 "description" : "Unauthorized", 9019 "schema" : { 9020 "$ref" : "#/definitions/ErrorResponse" 9021 } 9022 }, 9023 "403" : { 9024 "description" : "Forbidden", 9025 "schema" : { 9026 "$ref" : "#/definitions/ErrorResponse" 9027 } 9028 }, 9029 "404" : { 9030 "description" : "Not Found", 9031 "schema" : { 9032 "$ref" : "#/definitions/ErrorResponse" 9033 } 9034 }, 9035 "409" : { 9036 "description" : "Conflict", 9037 "schema" : { 9038 "$ref" : "#/definitions/ErrorResponse" 9039 } 9040 }, 9041 "428" : { 9042 "description" : "Precondition Required", 9043 "schema" : { 9044 "$ref" : "#/definitions/ErrorResponse" 9045 } 9046 }, 9047 "500" : { 9048 "description" : "Internal Server Error", 9049 "schema" : { 9050 "$ref" : "#/definitions/ErrorResponse" 9051 } 9052 } 9053 }, 9054 "security" : [ { 9055 "Authorization" : [ ] 9056 } ] 9057 }, 9058 "delete" : { 9059 "tags" : [ "schedules" ], 9060 "summary" : "Delete schedule trigger by name", 9061 "description" : "", 9062 "operationId" : "deleteTriggerFromScheduleMultiple", 9063 "parameters" : [ { 9064 "name" : "scheduleId", 9065 "in" : "path", 9066 "description" : "schedule id", 9067 "required" : true, 9068 "type" : "string" 9069 }, { 9070 "name" : "name", 9071 "in" : "query", 9072 "description" : "name", 9073 "required" : false, 9074 "type" : "string" 9075 } ], 9076 "responses" : { 9077 "204" : { 9078 "description" : "No content" 9079 }, 9080 "400" : { 9081 "description" : "Bad Request", 9082 "schema" : { 9083 "$ref" : "#/definitions/ErrorResponse" 9084 } 9085 }, 9086 "401" : { 9087 "description" : "Unauthorized", 9088 "schema" : { 9089 "$ref" : "#/definitions/ErrorResponse" 9090 } 9091 }, 9092 "403" : { 9093 "description" : "Forbidden", 9094 "schema" : { 9095 "$ref" : "#/definitions/ErrorResponse" 9096 } 9097 }, 9098 "404" : { 9099 "description" : "Not Found", 9100 "schema" : { 9101 "$ref" : "#/definitions/ErrorResponse" 9102 } 9103 }, 9104 "500" : { 9105 "description" : "Internal Server Error", 9106 "schema" : { 9107 "$ref" : "#/definitions/ErrorResponse" 9108 } 9109 } 9110 }, 9111 "security" : [ { 9112 "Authorization" : [ ] 9113 } ] 9114 } 9115 }, 9116 "/subscription" : { 9117 "get" : { 9118 "tags" : [ "account :: subscription " ], 9119 "summary" : "Get account subscription information", 9120 "description" : "", 9121 "operationId" : "subscriptionGet", 9122 "consumes" : [ "application/json" ], 9123 "produces" : [ "application/json" ], 9124 "responses" : { 9125 "200" : { 9126 "description" : "Status 200", 9127 "schema" : { 9128 "$ref" : "#/definitions/Subscription" 9129 } 9130 }, 9131 "401" : { 9132 "description" : "Unauthorized" 9133 }, 9134 "403" : { 9135 "description" : "Forbidden - no permissions to access resource" 9136 }, 9137 "404" : { 9138 "description" : "Subscription not found" 9139 }, 9140 "500" : { 9141 "description" : "Internal server error" 9142 } 9143 }, 9144 "security" : [ { 9145 "Authorization" : [ ] 9146 } ] 9147 } 9148 }, 9149 "/workspaces" : { 9150 "get" : { 9151 "tags" : [ "workspaces" ], 9152 "summary" : "Get available Workspaces", 9153 "description" : "Get available Workspaces", 9154 "operationId" : "getWorkspaces", 9155 "produces" : [ "application/json" ], 9156 "parameters" : [ { 9157 "name" : "query", 9158 "in" : "query", 9159 "description" : "search query (FIQL format), e.g. name==TestWorkspace,environment.name==TestEnvironment", 9160 "required" : false, 9161 "type" : "string" 9162 } ], 9163 "responses" : { 9164 "200" : { 9165 "description" : "OK", 9166 "schema" : { 9167 "type" : "array", 9168 "items" : { 9169 "$ref" : "#/definitions/WorkspaceInfo" 9170 } 9171 } 9172 }, 9173 "401" : { 9174 "description" : "Unauthorized", 9175 "schema" : { 9176 "$ref" : "#/definitions/ErrorResponse" 9177 } 9178 }, 9179 "403" : { 9180 "description" : "Forbidden", 9181 "schema" : { 9182 "$ref" : "#/definitions/ErrorResponse" 9183 } 9184 }, 9185 "500" : { 9186 "description" : "Internal Server Error", 9187 "schema" : { 9188 "$ref" : "#/definitions/ErrorResponse" 9189 } 9190 } 9191 }, 9192 "security" : [ { 9193 "Authorization" : [ ] 9194 } ] 9195 }, 9196 "post" : { 9197 "tags" : [ "workspaces" ], 9198 "summary" : "Create a workspace ", 9199 "description" : "Create a workspace.", 9200 "operationId" : "createCustomWorkspace", 9201 "consumes" : [ "application/json" ], 9202 "produces" : [ "application/json" ], 9203 "parameters" : [ { 9204 "in" : "body", 9205 "name" : "body", 9206 "required" : false, 9207 "schema" : { 9208 "$ref" : "#/definitions/CreateWorkspaceRequest" 9209 } 9210 } ], 9211 "responses" : { 9212 "200" : { 9213 "description" : "successful operation", 9214 "schema" : { 9215 "$ref" : "#/definitions/Workspace" 9216 } 9217 }, 9218 "201" : { 9219 "description" : "Workspace successfully created", 9220 "schema" : { 9221 "$ref" : "#/definitions/Workspace" 9222 } 9223 }, 9224 "400" : { 9225 "description" : "Parameters not valid", 9226 "schema" : { 9227 "$ref" : "#/definitions/ErrorResponse" 9228 } 9229 }, 9230 "401" : { 9231 "description" : "Unauthorized", 9232 "schema" : { 9233 "$ref" : "#/definitions/ErrorResponse" 9234 } 9235 }, 9236 "403" : { 9237 "description" : "Not authorized to create the workspace", 9238 "schema" : { 9239 "$ref" : "#/definitions/ErrorResponse" 9240 } 9241 }, 9242 "409" : { 9243 "description" : "Workspace with the same name already exists", 9244 "schema" : { 9245 "$ref" : "#/definitions/ErrorResponse" 9246 } 9247 }, 9248 "500" : { 9249 "description" : "Internal server error", 9250 "schema" : { 9251 "$ref" : "#/definitions/ErrorResponse" 9252 } 9253 } 9254 }, 9255 "security" : [ { 9256 "Authorization" : [ ] 9257 } ] 9258 } 9259 }, 9260 "/workspaces/{workspaceId}" : { 9261 "put" : { 9262 "tags" : [ "workspaces" ], 9263 "summary" : "Update workspace", 9264 "description" : "", 9265 "operationId" : "updateCustomWorkspace", 9266 "consumes" : [ "application/json" ], 9267 "parameters" : [ { 9268 "name" : "workspaceId", 9269 "in" : "path", 9270 "required" : true, 9271 "type" : "string" 9272 }, { 9273 "in" : "body", 9274 "name" : "body", 9275 "description" : "Workspace to update", 9276 "required" : true, 9277 "schema" : { 9278 "$ref" : "#/definitions/UpdateWorkspaceRequest" 9279 } 9280 } ], 9281 "responses" : { 9282 "204" : { 9283 "description" : "Workspace successfully updated" 9284 }, 9285 "400" : { 9286 "description" : "Parameters not valid", 9287 "schema" : { 9288 "$ref" : "#/definitions/ErrorResponse" 9289 } 9290 }, 9291 "401" : { 9292 "description" : "Unauthorized", 9293 "schema" : { 9294 "$ref" : "#/definitions/ErrorResponse" 9295 } 9296 }, 9297 "403" : { 9298 "description" : "Not authorized to update the environment", 9299 "schema" : { 9300 "$ref" : "#/definitions/ErrorResponse" 9301 } 9302 }, 9303 "500" : { 9304 "description" : "Internal server error", 9305 "schema" : { 9306 "$ref" : "#/definitions/Response" 9307 } 9308 } 9309 }, 9310 "security" : [ { 9311 "Authorization" : [ ] 9312 } ] 9313 }, 9314 "delete" : { 9315 "tags" : [ "workspaces" ], 9316 "summary" : "Delete the workspace for a given id", 9317 "description" : "", 9318 "operationId" : "deleteWorkspace", 9319 "parameters" : [ { 9320 "name" : "workspaceId", 9321 "in" : "path", 9322 "required" : true, 9323 "type" : "string" 9324 } ], 9325 "responses" : { 9326 "401" : { 9327 "description" : "Unauthorized", 9328 "schema" : { 9329 "$ref" : "#/definitions/ErrorResponse" 9330 } 9331 }, 9332 "403" : { 9333 "description" : "Not authorized to delete the workspace", 9334 "schema" : { 9335 "$ref" : "#/definitions/ErrorResponse" 9336 } 9337 }, 9338 "404" : { 9339 "description" : "Workspace does not exist" 9340 }, 9341 "409" : { 9342 "description" : "There are objects in custom workspace that could not be removed" 9343 }, 9344 "500" : { 9345 "description" : "Internal server error" 9346 } 9347 }, 9348 "security" : [ { 9349 "Authorization" : [ ] 9350 } ] 9351 } 9352 }, 9353 "/workspaces/{workspaceId}/users/{userId}/permissions" : { 9354 "get" : { 9355 "tags" : [ "workspaces :: permissions" ], 9356 "summary" : "Read a workspace permission", 9357 "description" : "Read a permission of a user on a workspace.", 9358 "operationId" : "getWorkspacePermission", 9359 "produces" : [ "application/json" ], 9360 "parameters" : [ { 9361 "name" : "workspaceId", 9362 "in" : "path", 9363 "description" : "The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9", 9364 "required" : true, 9365 "type" : "string" 9366 }, { 9367 "name" : "userId", 9368 "in" : "path", 9369 "description" : "The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 9370 "required" : true, 9371 "type" : "string" 9372 } ], 9373 "responses" : { 9374 "200" : { 9375 "description" : "OK", 9376 "schema" : { 9377 "$ref" : "#/definitions/Permission" 9378 } 9379 }, 9380 "400" : { 9381 "description" : "Parameters not valid", 9382 "schema" : { 9383 "$ref" : "#/definitions/ErrorResponse" 9384 } 9385 }, 9386 "401" : { 9387 "description" : "Unauthorized", 9388 "schema" : { 9389 "$ref" : "#/definitions/ErrorResponse" 9390 } 9391 }, 9392 "403" : { 9393 "description" : "Not authorized to change permission", 9394 "schema" : { 9395 "$ref" : "#/definitions/ErrorResponse" 9396 } 9397 }, 9398 "404" : { 9399 "description" : "Permission not found", 9400 "schema" : { 9401 "$ref" : "#/definitions/ErrorResponse" 9402 } 9403 }, 9404 "500" : { 9405 "description" : "Internal server error", 9406 "schema" : { 9407 "$ref" : "#/definitions/ErrorResponse" 9408 } 9409 } 9410 }, 9411 "security" : [ { 9412 "Authorization" : [ ] 9413 } ] 9414 }, 9415 "post" : { 9416 "tags" : [ "workspaces :: permissions" ], 9417 "summary" : "Create a workspace permission", 9418 "description" : "Create a permission of a user on a workspace.", 9419 "operationId" : "createWorkspacePermissions", 9420 "consumes" : [ "application/json" ], 9421 "produces" : [ "application/json" ], 9422 "parameters" : [ { 9423 "name" : "workspaceId", 9424 "in" : "path", 9425 "description" : "The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9", 9426 "required" : true, 9427 "type" : "string" 9428 }, { 9429 "name" : "userId", 9430 "in" : "path", 9431 "description" : "The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 9432 "required" : true, 9433 "type" : "string" 9434 }, { 9435 "in" : "body", 9436 "name" : "body", 9437 "description" : "Rights to add on the permission.\nExample: [\"AUTHOR\",\"EXECUTE\"]", 9438 "required" : false, 9439 "schema" : { 9440 "type" : "array", 9441 "items" : { 9442 "type" : "string", 9443 "enum" : [ "AUTHOR", "EXECUTE", "VIEW", "MANAGE", "PUBLISH" ] 9444 } 9445 } 9446 } ], 9447 "responses" : { 9448 "201" : { 9449 "description" : "Permission successfully created" 9450 }, 9451 "400" : { 9452 "description" : "Parameters not valid", 9453 "schema" : { 9454 "$ref" : "#/definitions/ErrorResponse" 9455 } 9456 }, 9457 "401" : { 9458 "description" : "Unauthorized", 9459 "schema" : { 9460 "$ref" : "#/definitions/ErrorResponse" 9461 } 9462 }, 9463 "403" : { 9464 "description" : "Not authorized to update the permission", 9465 "schema" : { 9466 "$ref" : "#/definitions/ErrorResponse" 9467 } 9468 }, 9469 "404" : { 9470 "description" : "The workspace or the user does not exist", 9471 "schema" : { 9472 "$ref" : "#/definitions/ErrorResponse" 9473 } 9474 }, 9475 "500" : { 9476 "description" : "Internal server error", 9477 "schema" : { 9478 "$ref" : "#/definitions/ErrorResponse" 9479 } 9480 } 9481 }, 9482 "security" : [ { 9483 "Authorization" : [ ] 9484 } ] 9485 }, 9486 "put" : { 9487 "tags" : [ "workspaces :: permissions" ], 9488 "summary" : "Update a workspace permission", 9489 "description" : "Update a permission of a user on a workspace.", 9490 "operationId" : "updateWorkspacePermissions", 9491 "consumes" : [ "application/json" ], 9492 "produces" : [ "application/json" ], 9493 "parameters" : [ { 9494 "name" : "workspaceId", 9495 "in" : "path", 9496 "description" : "The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9", 9497 "required" : true, 9498 "type" : "string" 9499 }, { 9500 "name" : "userId", 9501 "in" : "path", 9502 "description" : "The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 9503 "required" : true, 9504 "type" : "string" 9505 }, { 9506 "in" : "body", 9507 "name" : "body", 9508 "description" : "Rights to update on the permission.\nExample: [\"AUTHOR\",\"EXECUTE\"]", 9509 "required" : false, 9510 "schema" : { 9511 "type" : "array", 9512 "items" : { 9513 "type" : "string", 9514 "enum" : [ "AUTHOR", "EXECUTE", "VIEW", "MANAGE", "PUBLISH" ] 9515 } 9516 } 9517 } ], 9518 "responses" : { 9519 "204" : { 9520 "description" : "No Content" 9521 }, 9522 "400" : { 9523 "description" : "Parameters not valid", 9524 "schema" : { 9525 "$ref" : "#/definitions/ErrorResponse" 9526 } 9527 }, 9528 "401" : { 9529 "description" : "Unauthorized", 9530 "schema" : { 9531 "$ref" : "#/definitions/ErrorResponse" 9532 } 9533 }, 9534 "403" : { 9535 "description" : "Not authorized to update the permission", 9536 "schema" : { 9537 "$ref" : "#/definitions/ErrorResponse" 9538 } 9539 }, 9540 "404" : { 9541 "description" : "The permission to update doesn’t exist", 9542 "schema" : { 9543 "$ref" : "#/definitions/ErrorResponse" 9544 } 9545 }, 9546 "500" : { 9547 "description" : "Internal server error", 9548 "schema" : { 9549 "$ref" : "#/definitions/ErrorResponse" 9550 } 9551 } 9552 }, 9553 "security" : [ { 9554 "Authorization" : [ ] 9555 } ] 9556 }, 9557 "delete" : { 9558 "tags" : [ "workspaces :: permissions" ], 9559 "summary" : "Delete a workspace permission", 9560 "description" : "Delete a permission of a user on a workspace.", 9561 "operationId" : "deleteWorkspacePermissions", 9562 "produces" : [ "application/json" ], 9563 "parameters" : [ { 9564 "name" : "workspaceId", 9565 "in" : "path", 9566 "description" : "The workspace where rights will be applied. Example Value: 6089228181ef4423736e47a9", 9567 "required" : true, 9568 "type" : "string" 9569 }, { 9570 "name" : "userId", 9571 "in" : "path", 9572 "description" : "The user for which rights will be applied. Example Value: b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 9573 "required" : true, 9574 "type" : "string" 9575 } ], 9576 "responses" : { 9577 "204" : { 9578 "description" : "No Content" 9579 }, 9580 "400" : { 9581 "description" : "Parameters not valid", 9582 "schema" : { 9583 "$ref" : "#/definitions/ErrorResponse" 9584 } 9585 }, 9586 "401" : { 9587 "description" : "Unauthorized", 9588 "schema" : { 9589 "$ref" : "#/definitions/ErrorResponse" 9590 } 9591 }, 9592 "403" : { 9593 "description" : "Not authorized to delete permission", 9594 "schema" : { 9595 "$ref" : "#/definitions/ErrorResponse" 9596 } 9597 }, 9598 "404" : { 9599 "description" : "The permission to delete doesn’t exist", 9600 "schema" : { 9601 "$ref" : "#/definitions/ErrorResponse" 9602 } 9603 }, 9604 "500" : { 9605 "description" : "Internal server error", 9606 "schema" : { 9607 "$ref" : "#/definitions/ErrorResponse" 9608 } 9609 } 9610 }, 9611 "security" : [ { 9612 "Authorization" : [ ] 9613 } ] 9614 } 9615 } 9616 }, 9617 "securityDefinitions" : { 9618 "Authorization" : { 9619 "type" : "apiKey", 9620 "name" : "Authorization", 9621 "in" : "header" 9622 } 9623 }, 9624 "definitions" : { 9625 "AdvancedPromotionSpec" : { 9626 "type" : "object", 9627 "properties" : { 9628 "artifactId" : { 9629 "type" : "string", 9630 "example" : "57f64991e4b0b689a64feed0", 9631 "description" : "Advanced Promotion Artifact Id" 9632 }, 9633 "artifactType" : { 9634 "type" : "string", 9635 "example" : "WORKSPACE", 9636 "description" : "Advanced Promotion Artifact Type. In the following list of allowed values, 'ACTION' refers to Artifacts, 'FLOW' refers to Tasks, 'PLAN' refers to Plans and 'WORKSPACE' refers to Workspaces", 9637 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION" ] 9638 } 9639 } 9640 }, 9641 "AdvancedRunProfile" : { 9642 "type" : "object", 9643 "required" : [ "name" ], 9644 "properties" : { 9645 "name" : { 9646 "type" : "string", 9647 "example" : "Default run profile", 9648 "description" : "Name" 9649 }, 9650 "description" : { 9651 "type" : "string", 9652 "example" : "Run profile used by default", 9653 "description" : "Description" 9654 }, 9655 "engineId" : { 9656 "type" : "string", 9657 "example" : "5f7eff3245ecf259a1c56daa", 9658 "description" : "Pipeline engine id" 9659 }, 9660 "pushdownPreferenceEnabled" : { 9661 "type" : "boolean", 9662 "example" : true, 9663 "description" : "Pushdown enable" 9664 }, 9665 "warehouseName" : { 9666 "type" : "string", 9667 "example" : "DWH name", 9668 "description" : "Data warehouse name" 9669 }, 9670 "definition" : { 9671 "type" : "string", 9672 "example" : "{\"id\": 1}", 9673 "description" : "Json with definition" 9674 } 9675 }, 9676 "description" : "Pipeline run profile of type 'Advanced'" 9677 }, 9678 "Artifact" : { 9679 "type" : "object", 9680 "required" : [ "id", "name", "type", "versions", "workspace" ], 9681 "properties" : { 9682 "id" : { 9683 "type" : "string", 9684 "example" : "5cdd2ce2c737973f9d581b99", 9685 "description" : "Artifact identifier" 9686 }, 9687 "name" : { 9688 "type" : "string", 9689 "example" : "Test Artifact", 9690 "description" : "Artifact name" 9691 }, 9692 "type" : { 9693 "type" : "string", 9694 "example" : "standard", 9695 "description" : "Artifact type", 9696 "enum" : [ "standard", "big_data_streaming", "big_data_batch", "route", "data-service" ] 9697 }, 9698 "versions" : { 9699 "type" : "array", 9700 "example" : ["0.1.0", "0.1.1"], 9701 "description" : "Available artifact versions", 9702 "items" : { 9703 "type" : "string" 9704 } 9705 }, 9706 "workspace" : { 9707 "description" : "Artifact workspace", 9708 "$ref" : "#/definitions/WorkspaceInfo" 9709 } 9710 } 9711 }, 9712 "ArtifactParameter" : { 9713 "type" : "object", 9714 "required" : [ "name", "required", "type" ], 9715 "properties" : { 9716 "name" : { 9717 "type" : "string", 9718 "example" : "parameter_url", 9719 "description" : "Parameter name" 9720 }, 9721 "value" : { 9722 "type" : "string", 9723 "example" : "localhost", 9724 "description" : "Parameter value" 9725 }, 9726 "type" : { 9727 "type" : "string", 9728 "example" : "String", 9729 "description" : "Parameter value" 9730 }, 9731 "required" : { 9732 "type" : "boolean", 9733 "example" : false, 9734 "description" : "Is parameter required or not" 9735 }, 9736 "comment" : { 9737 "type" : "string", 9738 "example" : "parameter for test", 9739 "description" : "Comment about parameter" 9740 } 9741 } 9742 }, 9743 "ArtifactPromotionResult" : { 9744 "type" : "object", 9745 "properties" : { 9746 "id" : { 9747 "type" : "string", 9748 "description" : "Artifact ID" 9749 }, 9750 "targetId" : { 9751 "type" : "string", 9752 "description" : "Target Artifact ID" 9753 }, 9754 "name" : { 9755 "type" : "string", 9756 "description" : "Artifact Name" 9757 }, 9758 "type" : { 9759 "type" : "string", 9760 "example" : "WORKSPACE", 9761 "description" : "Artifact Type", 9762 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 9763 }, 9764 "analyzeReport" : { 9765 "description" : "Promotion Analyze Report", 9766 "$ref" : "#/definitions/Report" 9767 }, 9768 "promotionReport" : { 9769 "description" : "Promotion Report", 9770 "$ref" : "#/definitions/Report" 9771 }, 9772 "workspaceId" : { 9773 "type" : "string", 9774 "description" : "Workspace id" 9775 }, 9776 "targetVersion" : { 9777 "type" : "string", 9778 "description" : "Artifact target version" 9779 }, 9780 "version" : { 9781 "type" : "string", 9782 "description" : "Artifact version" 9783 }, 9784 "jobType" : { 9785 "type" : "string", 9786 "description" : "Job type" 9787 }, 9788 "usedBy" : { 9789 "type" : "array", 9790 "description" : "Used by Artifacts", 9791 "items" : { 9792 "$ref" : "#/definitions/PromotionResultInfo" 9793 } 9794 }, 9795 "versions" : { 9796 "type" : "array", 9797 "description" : "Artifact versions", 9798 "items" : { 9799 "$ref" : "#/definitions/ArtifactVersionPromotionResult" 9800 } 9801 } 9802 } 9803 }, 9804 "ArtifactRequest" : { 9805 "type" : "object", 9806 "required" : [ "id", "version" ], 9807 "properties" : { 9808 "id" : { 9809 "type" : "string", 9810 "example" : "5c1111d7a4186a4eafed0587", 9811 "description" : "Id of artifact" 9812 }, 9813 "version" : { 9814 "type" : "string", 9815 "example" : "0.1.0", 9816 "description" : "Artifact version" 9817 } 9818 } 9819 }, 9820 "ArtifactVersion" : { 9821 "type" : "object", 9822 "required" : [ "id", "marketplaceProduct", "parameters", "publisher", "type", "version", "workspace" ], 9823 "properties" : { 9824 "createDate" : { 9825 "type" : "string", 9826 "format" : "date-time", 9827 "description" : "Created on", 9828 "readOnly" : true 9829 }, 9830 "updateDate" : { 9831 "type" : "string", 9832 "format" : "date-time", 9833 "description" : "Updated on", 9834 "readOnly" : true 9835 }, 9836 "id" : { 9837 "type" : "string", 9838 "example" : "5c1111d7a4186a4eafed0587", 9839 "description" : "Id of artifact" 9840 }, 9841 "name" : { 9842 "type" : "string", 9843 "example" : "Hello world artifact", 9844 "description" : "Name of artifact" 9845 }, 9846 "version" : { 9847 "type" : "string", 9848 "example" : "0.1.0", 9849 "description" : "Artifact version" 9850 }, 9851 "type" : { 9852 "type" : "string", 9853 "example" : "standard", 9854 "description" : "Artifact type", 9855 "enum" : [ "standard", "big_data_streaming", "big_data_batch", "route", "data-service" ] 9856 }, 9857 "publisher" : { 9858 "type" : "string", 9859 "example" : "admin", 9860 "description" : "Artifact publisher" 9861 }, 9862 "marketplaceProduct" : { 9863 "type" : "string", 9864 "example" : "Talend Data Fabric (tp_bd_7.2.1.20190612_1410)", 9865 "description" : "Marketplace product" 9866 }, 9867 "parameters" : { 9868 "type" : "array", 9869 "description" : "Artifact parameters", 9870 "items" : { 9871 "$ref" : "#/definitions/ArtifactParameter" 9872 } 9873 }, 9874 "workspace" : { 9875 "description" : "Artifact workspace", 9876 "$ref" : "#/definitions/WorkspaceInfo" 9877 }, 9878 "description" : { 9879 "type" : "string", 9880 "example" : "This is test artifact", 9881 "description" : "Artifact description" 9882 }, 9883 "repository" : { 9884 "description" : "Artifact git info", 9885 "$ref" : "#/definitions/SourcesRepositoryData" 9886 } 9887 } 9888 }, 9889 "ArtifactVersionPromotionResult" : { 9890 "type" : "object", 9891 "properties" : { 9892 "id" : { 9893 "type" : "string", 9894 "description" : "Artifact ID" 9895 }, 9896 "targetId" : { 9897 "type" : "string", 9898 "description" : "Target Artifact ID" 9899 }, 9900 "name" : { 9901 "type" : "string", 9902 "description" : "Artifact Name" 9903 }, 9904 "type" : { 9905 "type" : "string", 9906 "example" : "WORKSPACE", 9907 "description" : "Artifact Type", 9908 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 9909 }, 9910 "analyzeReport" : { 9911 "description" : "Promotion Analyze Report", 9912 "$ref" : "#/definitions/Report" 9913 }, 9914 "promotionReport" : { 9915 "description" : "Promotion Report", 9916 "$ref" : "#/definitions/Report" 9917 }, 9918 "workspaceId" : { 9919 "type" : "string", 9920 "description" : "Workspace id" 9921 }, 9922 "targetVersion" : { 9923 "type" : "string", 9924 "description" : "Artifact target version" 9925 }, 9926 "version" : { 9927 "type" : "string", 9928 "description" : "Artifact version" 9929 }, 9930 "jobType" : { 9931 "type" : "string", 9932 "description" : "Job type" 9933 }, 9934 "usedBy" : { 9935 "type" : "array", 9936 "description" : "Used by Artifacts", 9937 "items" : { 9938 "$ref" : "#/definitions/PromotionResultInfo" 9939 } 9940 }, 9941 "versions" : { 9942 "type" : "array", 9943 "description" : "Artifact versions", 9944 "items" : { 9945 "$ref" : "#/definitions/ArtifactVersionPromotionResult" 9946 } 9947 }, 9948 "artifactId" : { 9949 "type" : "string", 9950 "description" : "Artifact ID" 9951 } 9952 } 9953 }, 9954 "AutoUpgradeInfo" : { 9955 "type" : "object", 9956 "properties" : { 9957 "autoUpgradable" : { 9958 "type" : "boolean", 9959 "example" : false, 9960 "description" : "Indicates whether to automatically upgrade task after publishing new artifact version" 9961 }, 9962 "overrideWithDefaultParameters" : { 9963 "type" : "boolean", 9964 "example" : false, 9965 "description" : "Indicates whether to override task parameters with artifact default parameters during auto upgrade" 9966 } 9967 } 9968 }, 9969 "BaseArtifactVersion" : { 9970 "type" : "object", 9971 "required" : [ "id", "version" ], 9972 "properties" : { 9973 "createDate" : { 9974 "type" : "string", 9975 "format" : "date-time", 9976 "description" : "Created on", 9977 "readOnly" : true 9978 }, 9979 "updateDate" : { 9980 "type" : "string", 9981 "format" : "date-time", 9982 "description" : "Updated on", 9983 "readOnly" : true 9984 }, 9985 "id" : { 9986 "type" : "string", 9987 "example" : "5c1111d7a4186a4eafed0587", 9988 "description" : "Id of artifact" 9989 }, 9990 "name" : { 9991 "type" : "string", 9992 "example" : "Hello world artifact", 9993 "description" : "Name of artifact" 9994 }, 9995 "version" : { 9996 "type" : "string", 9997 "example" : "0.1.0", 9998 "description" : "Artifact version" 9999 } 10000 } 10001 }, 10002 "BaseEngine" : { 10003 "type" : "object", 10004 "required" : [ "id", "name", "runtimeId" ], 10005 "properties" : { 10006 "createDate" : { 10007 "type" : "string", 10008 "format" : "date-time", 10009 "description" : "Created on", 10010 "readOnly" : true 10011 }, 10012 "updateDate" : { 10013 "type" : "string", 10014 "format" : "date-time", 10015 "description" : "Updated on", 10016 "readOnly" : true 10017 }, 10018 "id" : { 10019 "type" : "string", 10020 "example" : "5cdd2ce2c737973f9d581b98", 10021 "description" : "Resource id" 10022 }, 10023 "name" : { 10024 "type" : "string", 10025 "example" : "Remote Engine", 10026 "description" : "Resource name" 10027 }, 10028 "description" : { 10029 "type" : "string", 10030 "example" : "Some description", 10031 "description" : "Resource description" 10032 }, 10033 "workspace" : { 10034 "description" : "Resource workspace", 10035 "$ref" : "#/definitions/WorkspaceInfo" 10036 }, 10037 "runtimeId" : { 10038 "type" : "string", 10039 "example" : "9e8acf72-00d5-451b-9175-97bd44cd6b13", 10040 "description" : "Resource runtime id" 10041 }, 10042 "availability" : { 10043 "type" : "string", 10044 "example" : "NOT_AVAILABLE", 10045 "description" : "Availability status of engine|cluster", 10046 "enum" : [ "AVAILABLE", "NOT_AVAILABLE", "RETIRED" ] 10047 }, 10048 "managed" : { 10049 "type" : "boolean", 10050 "description" : "Indicates whether target runtime (engine/cluster) is managed or not" 10051 } 10052 } 10053 }, 10054 "BigDataRunProfile" : { 10055 "type" : "object", 10056 "required" : [ "executorMemoryOverhead", "microBatchInterval", "name", "streamingTimeout", "temporaryStorage", "yarnStrategy" ], 10057 "properties" : { 10058 "name" : { 10059 "type" : "string", 10060 "example" : "Default run profile", 10061 "description" : "Name" 10062 }, 10063 "description" : { 10064 "type" : "string", 10065 "example" : "Run profile used by default", 10066 "description" : "Description" 10067 }, 10068 "engineId" : { 10069 "type" : "string", 10070 "example" : "5f7eff3245ecf259a1c56daa", 10071 "description" : "Pipeline engine id" 10072 }, 10073 "distribution" : { 10074 "type" : "string", 10075 "example" : "EMR 5.x (Hadoop 2.7)", 10076 "description" : "Distribution" 10077 }, 10078 "executionFramework" : { 10079 "type" : "string", 10080 "example" : "Spark on Yarn", 10081 "description" : "Execution framework" 10082 }, 10083 "microBatchInterval" : { 10084 "type" : "integer", 10085 "format" : "int32", 10086 "example" : 1000, 10087 "description" : "Micro-batch interval (in ms)" 10088 }, 10089 "streamingTimeout" : { 10090 "type" : "integer", 10091 "format" : "int32", 10092 "example" : 10, 10093 "description" : "Streaming timeout (in ms)" 10094 }, 10095 "yarnQueue" : { 10096 "type" : "string", 10097 "example" : "q1", 10098 "description" : "Yarn queue" 10099 }, 10100 "driverCores" : { 10101 "type" : "integer", 10102 "format" : "int32", 10103 "example" : 1, 10104 "description" : "Driver cores" 10105 }, 10106 "driverMemory" : { 10107 "type" : "integer", 10108 "format" : "int32", 10109 "example" : 512, 10110 "description" : "Driver cores (in MB)" 10111 }, 10112 "temporaryStorage" : { 10113 "type" : "string", 10114 "example" : "/tmp-storage", 10115 "description" : "Temporary storage" 10116 }, 10117 "yarnStrategy" : { 10118 "description" : "Yarn strategy", 10119 "$ref" : "#/definitions/YarnStrategy" 10120 }, 10121 "executorMemoryOverhead" : { 10122 "type" : "integer", 10123 "format" : "int32", 10124 "example" : 384, 10125 "description" : "Execution memory overhead (MB)" 10126 }, 10127 "isCheckpointingEnabled" : { 10128 "type" : "boolean", 10129 "example" : true, 10130 "description" : "Checkpointing" 10131 }, 10132 "checkPointFilePath" : { 10133 "type" : "string", 10134 "example" : "/file-path", 10135 "description" : "Checkpoint file path. Required if checkpointing enabled" 10136 }, 10137 "parameters" : { 10138 "type" : "object", 10139 "example" : {"memory":"512","cpu":"1"}, 10140 "description" : "Parameters", 10141 "additionalProperties" : { 10142 "type" : "string" 10143 } 10144 } 10145 }, 10146 "description" : "Pipeline run profile of type 'Big Data'" 10147 }, 10148 "CloudStorageLog" : { 10149 "type" : "object", 10150 "properties" : { 10151 "severity" : { 10152 "type" : "string" 10153 }, 10154 "logType" : { 10155 "type" : "string" 10156 }, 10157 "logTimestamp" : { 10158 "type" : "integer", 10159 "format" : "int64" 10160 }, 10161 "logMessage" : { 10162 "type" : "string" 10163 }, 10164 "bundleName" : { 10165 "type" : "string" 10166 }, 10167 "bundleVersion" : { 10168 "type" : "string" 10169 } 10170 } 10171 }, 10172 "ClusterRequest" : { 10173 "type" : "object", 10174 "required" : [ "description", "environmentId", "name", "remoteEngines", "workspaceId" ], 10175 "properties" : { 10176 "name" : { 10177 "type" : "string", 10178 "example" : "Some cluster name", 10179 "description" : "Cluster name" 10180 }, 10181 "workspaceId" : { 10182 "type" : "string", 10183 "example" : "5c935c8ba4186a4eafed0592", 10184 "description" : "Workspace identifier" 10185 }, 10186 "environmentId" : { 10187 "type" : "string", 10188 "example" : "5c935c8ba4186a4eafed0592", 10189 "description" : "Environment identifier" 10190 }, 10191 "description" : { 10192 "type" : "string", 10193 "example" : "some description", 10194 "description" : "Cluster description" 10195 }, 10196 "remoteEngines" : { 10197 "type" : "array", 10198 "example" : ["5d3039de65ff7d3583840bc0", "5d3039de65ff7d3583840bk1"], 10199 "description" : "List of remote engine ids", 10200 "items" : { 10201 "type" : "string" 10202 } 10203 } 10204 } 10205 }, 10206 "Configuration" : { 10207 "type" : "object", 10208 "required" : [ "microBatchInterval", "numberOfThreads" ], 10209 "properties" : { 10210 "parameters" : { 10211 "type" : "object", 10212 "example" : {"memory":"512","cpu":"1"}, 10213 "description" : "Parameters", 10214 "additionalProperties" : { 10215 "type" : "string" 10216 } 10217 }, 10218 "numberOfThreads" : { 10219 "type" : "integer", 10220 "format" : "int32", 10221 "example" : 1, 10222 "description" : "Number of threads" 10223 }, 10224 "microBatchInterval" : { 10225 "type" : "integer", 10226 "format" : "int32", 10227 "example" : 1000, 10228 "description" : "Micro-batch interval (in ms)" 10229 } 10230 } 10231 }, 10232 "ConnectionDetails" : { 10233 "type" : "object", 10234 "required" : [ "app", "createDate", "id", "name", "parameters", "workspace" ], 10235 "properties" : { 10236 "createDate" : { 10237 "type" : "string", 10238 "format" : "date-time", 10239 "description" : "Creation Date of Connection" 10240 }, 10241 "updateDate" : { 10242 "type" : "string", 10243 "format" : "date-time", 10244 "description" : "Updated on", 10245 "readOnly" : true 10246 }, 10247 "id" : { 10248 "type" : "string", 10249 "description" : "Connection ID" 10250 }, 10251 "name" : { 10252 "type" : "string", 10253 "description" : "Connection name" 10254 }, 10255 "app" : { 10256 "type" : "string", 10257 "description" : "Application name" 10258 }, 10259 "parameters" : { 10260 "type" : "array", 10261 "description" : "Connection parameters", 10262 "items" : { 10263 "$ref" : "#/definitions/ConnectionParameter" 10264 } 10265 }, 10266 "workspace" : { 10267 "$ref" : "#/definitions/WorkspaceInfo" 10268 } 10269 } 10270 }, 10271 "ConnectionParameter" : { 10272 "type" : "object", 10273 "required" : [ "name" ], 10274 "properties" : { 10275 "name" : { 10276 "type" : "string", 10277 "example" : "param1", 10278 "description" : "Parameter name" 10279 }, 10280 "value" : { 10281 "type" : "string", 10282 "example" : "value1", 10283 "description" : "Parameter value" 10284 }, 10285 "encrypted" : { 10286 "type" : "boolean", 10287 "example" : true, 10288 "description" : "If encrypted or not" 10289 } 10290 } 10291 }, 10292 "CreateConnectionRequest" : { 10293 "type" : "object", 10294 "required" : [ "app", "name", "parameters", "workspaceId" ], 10295 "properties" : { 10296 "name" : { 10297 "type" : "string", 10298 "example" : "testConnection", 10299 "description" : "Connection name" 10300 }, 10301 "workspaceId" : { 10302 "type" : "string", 10303 "example" : "5b3ee8676e8f510dbb3fa806", 10304 "description" : "Workspace ID" 10305 }, 10306 "app" : { 10307 "type" : "string", 10308 "example" : "Custom", 10309 "description" : "Application name" 10310 }, 10311 "parameters" : { 10312 "type" : "array", 10313 "description" : "Connection parameters", 10314 "items" : { 10315 "$ref" : "#/definitions/ConnectionParameter" 10316 } 10317 } 10318 } 10319 }, 10320 "CreateEnvironmentRequest" : { 10321 "type" : "object", 10322 "required" : [ "name", "owner", "workspaceName" ], 10323 "properties" : { 10324 "name" : { 10325 "type" : "string", 10326 "example" : "Development", 10327 "description" : "Environment name" 10328 }, 10329 "description" : { 10330 "type" : "string", 10331 "example" : "environment detail description", 10332 "description" : "Environment description" 10333 }, 10334 "maxCloudContainers" : { 10335 "type" : "integer", 10336 "format" : "int32", 10337 "description" : "The max cloud containers count" 10338 }, 10339 "owner" : { 10340 "type" : "string", 10341 "description" : "The owner of the workspace" 10342 }, 10343 "workspaceName" : { 10344 "type" : "string", 10345 "example" : "Personal", 10346 "description" : "Workspace name" 10347 } 10348 } 10349 }, 10350 "CreatePromotionRequest" : { 10351 "type" : "object", 10352 "required" : [ "sourceEnvironmentId", "targetEnvironmentId" ], 10353 "properties" : { 10354 "sourceEnvironmentId" : { 10355 "type" : "string", 10356 "example" : "5b3ee8676e8f510dbb3fa806", 10357 "description" : "Source environment ID" 10358 }, 10359 "targetEnvironmentId" : { 10360 "type" : "string", 10361 "example" : "5b3ee8676e8f510dbb3fa807", 10362 "description" : "Target environment ID" 10363 }, 10364 "description" : { 10365 "type" : "string", 10366 "example" : "This is description", 10367 "description" : "Promotion description" 10368 } 10369 } 10370 }, 10371 "CreateScheduleMultipleTriggerRequest" : { 10372 "type" : "object", 10373 "required" : [ "environmentId", "trigger" ], 10374 "properties" : { 10375 "description" : { 10376 "type" : "string", 10377 "example" : "Schedule with five triggers", 10378 "description" : "Some description related to the usage of the scheduler" 10379 }, 10380 "environmentId" : { 10381 "type" : "string", 10382 "example" : "6089228181ef4423736e47a8", 10383 "description" : "Environment where this schedule will be available" 10384 }, 10385 "trigger" : { 10386 "description" : "Initial trigger to define in the schedule", 10387 "$ref" : "#/definitions/MultipleTrigger" 10388 } 10389 } 10390 }, 10391 "CreateWorkspaceRequest" : { 10392 "type" : "object", 10393 "required" : [ "environmentId", "name" ], 10394 "properties" : { 10395 "name" : { 10396 "type" : "string", 10397 "example" : "Personal", 10398 "description" : "Workspace name" 10399 }, 10400 "description" : { 10401 "type" : "string", 10402 "example" : "Workspace detail description", 10403 "description" : "Workspace description " 10404 }, 10405 "owner" : { 10406 "type" : "string", 10407 "description" : "The owner of the workspace" 10408 }, 10409 "environmentId" : { 10410 "type" : "string", 10411 "description" : "The environment identifier of the workspace" 10412 } 10413 } 10414 }, 10415 "DataIntegrationRunProfile" : { 10416 "type" : "object", 10417 "required" : [ "name" ], 10418 "properties" : { 10419 "name" : { 10420 "type" : "string", 10421 "example" : "Default run profile", 10422 "description" : "Name" 10423 }, 10424 "description" : { 10425 "type" : "string", 10426 "example" : "Run profile used by default", 10427 "description" : "Description" 10428 }, 10429 "jvmArguments" : { 10430 "type" : "array", 10431 "example" : [ "-XX:MaxHeapFreeRatio=70", "-XX:PermSize=128m" ], 10432 "description" : "JVM arguments", 10433 "uniqueItems" : true, 10434 "items" : { 10435 "type" : "string" 10436 } 10437 }, 10438 "runtimeId" : { 10439 "type" : "string", 10440 "readOnly" : true 10441 } 10442 }, 10443 "description" : "Pipeline run profile of type 'Data-integration'" 10444 }, 10445 "DataIntegrationRunProfileResponse" : { 10446 "type" : "object", 10447 "required" : [ "name" ], 10448 "properties" : { 10449 "name" : { 10450 "type" : "string", 10451 "example" : "Default run profile", 10452 "description" : "Name" 10453 }, 10454 "description" : { 10455 "type" : "string", 10456 "example" : "Run profile used by default", 10457 "description" : "Description" 10458 }, 10459 "jvmArguments" : { 10460 "type" : "array", 10461 "example" : [ "-XX:MaxHeapFreeRatio=70", "-XX:PermSize=128m" ], 10462 "description" : "JVM arguments", 10463 "uniqueItems" : true, 10464 "items" : { 10465 "type" : "string" 10466 } 10467 }, 10468 "runtimeId" : { 10469 "type" : "string", 10470 "readOnly" : true 10471 }, 10472 "createDate" : { 10473 "type" : "string", 10474 "format" : "date-time", 10475 "description" : "Created on", 10476 "readOnly" : true 10477 }, 10478 "updateDate" : { 10479 "type" : "string", 10480 "format" : "date-time", 10481 "description" : "Updated on", 10482 "readOnly" : true 10483 }, 10484 "id" : { 10485 "type" : "string", 10486 "example" : "57f64991e4b0b689a64feed0", 10487 "description" : "Run profile id", 10488 "readOnly" : true 10489 }, 10490 "type" : { 10491 "type" : "string", 10492 "description" : "Type", 10493 "readOnly" : true, 10494 "enum" : [ "standard", "big-data", "databricks", "advanced" ] 10495 } 10496 }, 10497 "description" : "Pipeline run profile response for type 'Data-Integration'" 10498 }, 10499 "Databrick" : { 10500 "type" : "object", 10501 "required" : [ "cloudProvider", "endpoint", "stagingLocation", "target" ], 10502 "properties" : { 10503 "endpoint" : { 10504 "type" : "string", 10505 "example" : "https://endpoint", 10506 "description" : "Endpoint" 10507 }, 10508 "token" : { 10509 "type" : "string", 10510 "example" : "44e128a5", 10511 "description" : "Token (can also be provided in the Remote Engine configuration)" 10512 }, 10513 "stagingLocation" : { 10514 "type" : "string", 10515 "example" : "dbfs:/staging/", 10516 "description" : "DBFS library staging directory" 10517 }, 10518 "target" : { 10519 "description" : "Target definition", 10520 "$ref" : "#/definitions/DatabricksCluster" 10521 }, 10522 "cloudProvider" : { 10523 "type" : "string", 10524 "example" : "AWS", 10525 "description" : "Cloud provider", 10526 "enum" : [ "AWS", "Azure" ] 10527 } 10528 } 10529 }, 10530 "DatabricksCluster" : { 10531 "type" : "object", 10532 "required" : [ "cluster", "logsDestination", "nodeTypeId", "workersNumber" ], 10533 "properties" : { 10534 "cluster" : { 10535 "type" : "string", 10536 "example" : "new", 10537 "description" : "New or existing cluster", 10538 "enum" : [ "new", "old" ] 10539 }, 10540 "id" : { 10541 "type" : "string", 10542 "example" : "132553", 10543 "description" : "ID of existing cluster. Required for 'old' cluster" 10544 }, 10545 "sparkVersion" : { 10546 "type" : "string", 10547 "example" : "5.5.x-scala2.11", 10548 "description" : "Databricks runtime version. Required for 'new' cluster" 10549 }, 10550 "nodeTypeId" : { 10551 "type" : "string", 10552 "example" : "m4.large", 10553 "description" : "Node type ID. Required for 'new' cluster" 10554 }, 10555 "logsDestination" : { 10556 "type" : "string", 10557 "example" : "dbfs:/cluster-logs", 10558 "description" : "Logs destination. Required for 'new' cluster" 10559 }, 10560 "workersNumber" : { 10561 "type" : "integer", 10562 "format" : "int32", 10563 "example" : 2, 10564 "description" : "Number of workers. Required for 'new' cluster" 10565 } 10566 } 10567 }, 10568 "DatabricksRunProfile" : { 10569 "type" : "object", 10570 "required" : [ "microBatchInterval", "name" ], 10571 "properties" : { 10572 "name" : { 10573 "type" : "string", 10574 "example" : "Default run profile", 10575 "description" : "Name" 10576 }, 10577 "description" : { 10578 "type" : "string", 10579 "example" : "Run profile used by default", 10580 "description" : "Description" 10581 }, 10582 "engineId" : { 10583 "type" : "string", 10584 "example" : "5f7eff3245ecf259a1c56daa", 10585 "description" : "Pipeline engine id" 10586 }, 10587 "microBatchInterval" : { 10588 "type" : "integer", 10589 "format" : "int32", 10590 "example" : 1000, 10591 "description" : "Micro-batch interval (in ms)" 10592 }, 10593 "databricks" : { 10594 "$ref" : "#/definitions/Databrick" 10595 }, 10596 "parameters" : { 10597 "type" : "object", 10598 "example" : {"memory":"512","cpu":"1"}, 10599 "description" : "Parameters", 10600 "additionalProperties" : { 10601 "type" : "string" 10602 } 10603 } 10604 }, 10605 "description" : "Pipeline run profile of type 'Databricks'" 10606 }, 10607 "DaySchedule" : { 10608 "type" : "object", 10609 "required" : [ "type" ], 10610 "properties" : { 10611 "type" : { 10612 "type" : "string", 10613 "example" : "DAY_OF_WEEK", 10614 "description" : "Type of schedule at days", 10615 "enum" : [ "DAY_OF_WEEK", "DAY_OF_MONTH" ] 10616 }, 10617 "day" : { 10618 "type" : "integer", 10619 "format" : "int32", 10620 "example" : 3, 10621 "description" : "Day of month to run task/plan, required only if type of schedule at days is equal to DAY_OF_MONTH" 10622 }, 10623 "days" : { 10624 "type" : "array", 10625 "example" : ["MONDAY", "WEDNESDAY", "FRIDAY"], 10626 "description" : "List of days of week to run task/plan, required only if type of schedule at days is equal to DAY_OF_WEEK", 10627 "items" : { 10628 "type" : "string" 10629 } 10630 } 10631 } 10632 }, 10633 "DebugRemoteEngineModel" : { 10634 "type" : "object", 10635 "properties" : { 10636 "host" : { 10637 "type" : "string", 10638 "description" : "Host/ip" 10639 }, 10640 "isDebugModeOn" : { 10641 "type" : "boolean", 10642 "description" : "Is debug mode on" 10643 } 10644 } 10645 }, 10646 "DownloadLogs" : { 10647 "type" : "object", 10648 "properties" : { 10649 "size" : { 10650 "type" : "integer", 10651 "format" : "int32" 10652 }, 10653 "token" : { 10654 "type" : "string" 10655 } 10656 } 10657 }, 10658 "DownloadLogsStatus" : { 10659 "type" : "object", 10660 "properties" : { 10661 "presignedURL" : { 10662 "type" : "string" 10663 }, 10664 "status" : { 10665 "type" : "string", 10666 "enum" : [ "READY", "IN_PROGRESS" ] 10667 } 10668 } 10669 }, 10670 "Engine" : { 10671 "type" : "object", 10672 "required" : [ "id", "name", "runProfiles", "runtimeId", "status" ], 10673 "properties" : { 10674 "createDate" : { 10675 "type" : "string", 10676 "format" : "date-time", 10677 "description" : "Created on", 10678 "readOnly" : true 10679 }, 10680 "updateDate" : { 10681 "type" : "string", 10682 "format" : "date-time", 10683 "description" : "Updated on", 10684 "readOnly" : true 10685 }, 10686 "id" : { 10687 "type" : "string", 10688 "example" : "5cdd2ce2c737973f9d581b98", 10689 "description" : "Resource id" 10690 }, 10691 "name" : { 10692 "type" : "string", 10693 "example" : "Remote Engine", 10694 "description" : "Resource name" 10695 }, 10696 "description" : { 10697 "type" : "string", 10698 "example" : "Some description", 10699 "description" : "Resource description" 10700 }, 10701 "workspace" : { 10702 "description" : "Resource workspace", 10703 "$ref" : "#/definitions/WorkspaceInfo" 10704 }, 10705 "runtimeId" : { 10706 "type" : "string", 10707 "example" : "9e8acf72-00d5-451b-9175-97bd44cd6b13", 10708 "description" : "Resource runtime id" 10709 }, 10710 "availability" : { 10711 "type" : "string", 10712 "example" : "NOT_AVAILABLE", 10713 "description" : "Availability status of engine|cluster", 10714 "enum" : [ "AVAILABLE", "NOT_AVAILABLE", "RETIRED" ] 10715 }, 10716 "managed" : { 10717 "type" : "boolean", 10718 "description" : "Indicates whether target runtime (engine/cluster) is managed or not" 10719 }, 10720 "status" : { 10721 "type" : "string", 10722 "example" : "NOT_PAIRED", 10723 "description" : "Engine status", 10724 "enum" : [ "PAIRED", "NOT_PAIRED" ] 10725 }, 10726 "runProfiles" : { 10727 "type" : "array", 10728 "example" : ["MICROSERVICE"], 10729 "description" : "Run profiles of engine", 10730 "items" : { 10731 "type" : "string" 10732 } 10733 }, 10734 "debug" : { 10735 "description" : "Remote Run/Debug configuration", 10736 "$ref" : "#/definitions/EngineDebug" 10737 }, 10738 "clusterId" : { 10739 "type" : "string", 10740 "description" : "cluster that this engine is part of" 10741 }, 10742 "preAuthorizedKey" : { 10743 "type" : "string", 10744 "example" : "123A822BF26DF49045C90D94CD269F3850BFB308B2606019CC63EDADE55B4391", 10745 "description" : "Preauthorized key (only for not paired engine)" 10746 }, 10747 "esbCompatibilityVersion" : { 10748 "type" : "string", 10749 "example" : "7.3.1", 10750 "description" : "ESB compatibility version" 10751 } 10752 } 10753 }, 10754 "EngineCluster" : { 10755 "type" : "object", 10756 "required" : [ "id", "name", "runtimeId" ], 10757 "properties" : { 10758 "createDate" : { 10759 "type" : "string", 10760 "format" : "date-time", 10761 "description" : "Created on", 10762 "readOnly" : true 10763 }, 10764 "updateDate" : { 10765 "type" : "string", 10766 "format" : "date-time", 10767 "description" : "Updated on", 10768 "readOnly" : true 10769 }, 10770 "id" : { 10771 "type" : "string", 10772 "example" : "5cdd2ce2c737973f9d581b98", 10773 "description" : "Resource id" 10774 }, 10775 "name" : { 10776 "type" : "string", 10777 "example" : "Remote Engine", 10778 "description" : "Resource name" 10779 }, 10780 "description" : { 10781 "type" : "string", 10782 "example" : "Some description", 10783 "description" : "Resource description" 10784 }, 10785 "workspace" : { 10786 "description" : "Resource workspace", 10787 "$ref" : "#/definitions/WorkspaceInfo" 10788 }, 10789 "runtimeId" : { 10790 "type" : "string", 10791 "example" : "9e8acf72-00d5-451b-9175-97bd44cd6b13", 10792 "description" : "Resource runtime id" 10793 }, 10794 "availability" : { 10795 "type" : "string", 10796 "example" : "NOT_AVAILABLE", 10797 "description" : "Availability status of engine|cluster", 10798 "enum" : [ "AVAILABLE", "NOT_AVAILABLE", "RETIRED" ] 10799 }, 10800 "managed" : { 10801 "type" : "boolean", 10802 "description" : "Indicates whether target runtime (engine/cluster) is managed or not" 10803 }, 10804 "engines" : { 10805 "type" : "array", 10806 "example" : ["5d3039de65ff7d3583840bc0", "5d3039de65ff7d3583840bk1"], 10807 "description" : "Engines in cluster", 10808 "items" : { 10809 "type" : "string" 10810 } 10811 } 10812 } 10813 }, 10814 "EngineDebug" : { 10815 "type" : "object", 10816 "required" : [ "host" ], 10817 "properties" : { 10818 "host" : { 10819 "type" : "string", 10820 "example" : "192.168.0.1", 10821 "description" : "Debug host of engine" 10822 } 10823 } 10824 }, 10825 "EngineRequest" : { 10826 "type" : "object", 10827 "required" : [ "environmentId", "name" ], 10828 "properties" : { 10829 "name" : { 10830 "type" : "string", 10831 "example" : "Remote Engine", 10832 "description" : "Engine name" 10833 }, 10834 "environmentId" : { 10835 "type" : "string", 10836 "example" : "5c1111d7a4186a4eafed0587", 10837 "description" : "Id of engine environment" 10838 }, 10839 "workspaceId" : { 10840 "type" : "string", 10841 "example" : "5c2222d7a4186a4eafed0587", 10842 "description" : "Id of engine workspace", 10843 "readOnly" : true 10844 }, 10845 "runProfiles" : { 10846 "type" : "array", 10847 "example" : ["MICROSERVICE"], 10848 "description" : "Run profiles of engine", 10849 "readOnly" : true, 10850 "items" : { 10851 "type" : "string" 10852 } 10853 }, 10854 "debug" : { 10855 "description" : "Remote Run/Debug configuration", 10856 "readOnly" : true, 10857 "$ref" : "#/definitions/EngineDebug" 10858 }, 10859 "description" : { 10860 "type" : "string", 10861 "example" : "Some description", 10862 "description" : "Engine|cluster description", 10863 "readOnly" : true 10864 }, 10865 "esbCompatibilityVersion" : { 10866 "type" : "string", 10867 "example" : "7.2.1", 10868 "description" : "Data Service Runner/Talend Runtime version. Mandatory if TALEND_RUNTIME or MICROSERVICE profile selected", 10869 "readOnly" : true 10870 } 10871 } 10872 }, 10873 "EngineStatus" : { 10874 "type" : "object", 10875 "required" : [ "consumed", "type" ], 10876 "properties" : { 10877 "type" : { 10878 "type" : "string", 10879 "description" : "Engine type" 10880 }, 10881 "consumed" : { 10882 "type" : "integer", 10883 "format" : "int32", 10884 "description" : "Number of engines used by type" 10885 } 10886 }, 10887 "description" : "Information about engine status" 10888 }, 10889 "EnvironmentInfo" : { 10890 "type" : "object", 10891 "required" : [ "id", "name" ], 10892 "properties" : { 10893 "id" : { 10894 "type" : "string", 10895 "example" : "57f64991e4b0b689a64feed3", 10896 "description" : "Environment identifier" 10897 }, 10898 "name" : { 10899 "type" : "string", 10900 "example" : "Development", 10901 "description" : "Environment name" 10902 }, 10903 "description" : { 10904 "type" : "string", 10905 "example" : "environment detail description", 10906 "description" : "Environment description (not returned when querying a list of objects)" 10907 }, 10908 "maxCloudContainers" : { 10909 "type" : "integer", 10910 "format" : "int32", 10911 "description" : "Max cloud containers" 10912 }, 10913 "default" : { 10914 "type" : "boolean", 10915 "description" : "Default environment flag" 10916 } 10917 } 10918 }, 10919 "ErrorResponse" : { 10920 "type" : "object", 10921 "required" : [ "message", "status" ], 10922 "properties" : { 10923 "status" : { 10924 "type" : "integer", 10925 "format" : "int32", 10926 "example" : "400, 401, 403, 404, 409, 500, 502, 503, etc.", 10927 "description" : "Status code" 10928 }, 10929 "message" : { 10930 "type" : "string", 10931 "example" : "something went wrong", 10932 "description" : "Error message (multilanguage). Info about error for user." 10933 }, 10934 "details" : { 10935 "type" : "string", 10936 "example" : "more descriptive info about something went wrong", 10937 "description" : "Developer message (not translated). Info about error for developer." 10938 }, 10939 "code" : { 10940 "type" : "string", 10941 "example" : "TIPASS-SCHED-123", 10942 "description" : "Internal error code" 10943 }, 10944 "url" : { 10945 "type" : "string", 10946 "example" : "https://error.talend.com/details/tic?code=SCHED-123", 10947 "description" : "URL provided detailed info about error" 10948 }, 10949 "requestId" : { 10950 "type" : "string", 10951 "example" : "16fefb53-035a-4249-af9d-f80a3b47b132", 10952 "description" : "The unique identification of the request involved with this error" 10953 } 10954 }, 10955 "description" : "Error response object" 10956 }, 10957 "Executableinfo" : { 10958 "type" : "object", 10959 "required" : [ "executable", "name" ], 10960 "properties" : { 10961 "executable" : { 10962 "type" : "string", 10963 "example" : "57f64991e4b0b689a64feed0", 10964 "description" : "Executable identifier" 10965 }, 10966 "name" : { 10967 "type" : "string", 10968 "example" : "simple executable", 10969 "description" : "Executable name" 10970 }, 10971 "workspace" : { 10972 "description" : "Executable workspace", 10973 "$ref" : "#/definitions/WorkspaceInfo" 10974 } 10975 } 10976 }, 10977 "Executabletask" : { 10978 "type" : "object", 10979 "required" : [ "executable" ], 10980 "properties" : { 10981 "executable" : { 10982 "type" : "string", 10983 "example" : "57f64991e4b0b689a64feed0", 10984 "description" : "Executable identifier" 10985 }, 10986 "parameters" : { 10987 "type" : "object", 10988 "example" : {"parameter_boss":"fupton","boss":"was"}, 10989 "description" : "Executable parameters", 10990 "additionalProperties" : { 10991 "type" : "string" 10992 } 10993 }, 10994 "logLevel" : { 10995 "type" : "string", 10996 "example" : "WARN", 10997 "description" : "Execution log level", 10998 "enum" : [ "OFF", "ERROR", "WARN", "INFO" ] 10999 } 11000 } 11001 }, 11002 "ExecutionFlow" : { 11003 "type" : "object", 11004 "properties" : { 11005 "id" : { 11006 "type" : "string" 11007 }, 11008 "name" : { 11009 "type" : "string" 11010 }, 11011 "version" : { 11012 "type" : "string" 11013 }, 11014 "description" : { 11015 "type" : "string" 11016 }, 11017 "destination" : { 11018 "type" : "string" 11019 }, 11020 "workspaceId" : { 11021 "type" : "string" 11022 }, 11023 "abstractPlanId" : { 11024 "type" : "string" 11025 }, 11026 "pauseDetails" : { 11027 "$ref" : "#/definitions/ExecutionPauseDetails" 11028 }, 11029 "plan" : { 11030 "type" : "boolean" 11031 }, 11032 "artifactShortVersion" : { 11033 "$ref" : "#/definitions/ArtifactVersion" 11034 }, 11035 "upgradeInfo" : { 11036 "$ref" : "#/definitions/UpgradeInfo" 11037 }, 11038 "jobType" : { 11039 "type" : "string", 11040 "enum" : [ "STANDARD", "BIG_DATA_STREAMING", "BIG_DATA_BATCH", "ROUTE", "DATA_SERVICE", "PIPELINE", "DATA_FABRIC" ] 11041 } 11042 } 11043 }, 11044 "ExecutionLogs" : { 11045 "type" : "object", 11046 "properties" : { 11047 "size" : { 11048 "type" : "integer", 11049 "format" : "int32" 11050 }, 11051 "totalSize" : { 11052 "type" : "integer", 11053 "format" : "int32" 11054 }, 11055 "totalSizeFiltered" : { 11056 "type" : "integer", 11057 "format" : "int32" 11058 }, 11059 "data" : { 11060 "type" : "array", 11061 "items" : { 11062 "$ref" : "#/definitions/CloudStorageLog" 11063 } 11064 }, 11065 "nextIndex" : { 11066 "type" : "integer", 11067 "format" : "int32" 11068 } 11069 } 11070 }, 11071 "ExecutionPauseDetails" : { 11072 "type" : "object", 11073 "properties" : { 11074 "pause" : { 11075 "type" : "boolean" 11076 }, 11077 "pauseContext" : { 11078 "type" : "string" 11079 }, 11080 "pauseDate" : { 11081 "type" : "string", 11082 "format" : "date-time", 11083 "readOnly" : true 11084 }, 11085 "user" : { 11086 "type" : "string", 11087 "readOnly" : true 11088 }, 11089 "userType" : { 11090 "type" : "string", 11091 "readOnly" : true, 11092 "enum" : [ "HUMAN", "SERVICE" ] 11093 } 11094 } 11095 }, 11096 "ExecutionStep" : { 11097 "type" : "object", 11098 "properties" : { 11099 "stepId" : { 11100 "type" : "string" 11101 }, 11102 "abstractStepId" : { 11103 "type" : "string" 11104 }, 11105 "stepName" : { 11106 "type" : "string" 11107 }, 11108 "status" : { 11109 "type" : "string", 11110 "enum" : [ "SUCCESS", "PARTIAL_SUCCESS", "FAIL" ] 11111 }, 11112 "stepOnException" : { 11113 "$ref" : "#/definitions/ExecutionStep" 11114 }, 11115 "nextStep" : { 11116 "$ref" : "#/definitions/ExecutionStep" 11117 }, 11118 "flows" : { 11119 "type" : "array", 11120 "items" : { 11121 "$ref" : "#/definitions/ExecutionFlow" 11122 } 11123 }, 11124 "stepNote" : { 11125 "type" : "string" 11126 } 11127 } 11128 }, 11129 "Executionidentifier" : { 11130 "type" : "object", 11131 "required" : [ "executionId" ], 11132 "properties" : { 11133 "executionId" : { 11134 "type" : "string", 11135 "example" : "16fefb53-035a-4249-af9d-f80a3b47b132", 11136 "description" : "Execution identifier" 11137 } 11138 } 11139 }, 11140 "FetchTasksModel" : { 11141 "type" : "object", 11142 "properties" : { 11143 "name" : { 11144 "type" : "string", 11145 "example" : "task1", 11146 "description" : "tasks name filter" 11147 }, 11148 "environmentId" : { 11149 "type" : "string", 11150 "example" : "6148511d6ccc6d41563574e5", 11151 "description" : "tasks environment id filter" 11152 }, 11153 "workspaceId" : { 11154 "type" : "string", 11155 "example" : "614851d46ccc6d41563574ea", 11156 "description" : "tasks workspace id filter" 11157 }, 11158 "artifactId" : { 11159 "type" : "string", 11160 "example" : "623aafbe61a28314065704b6", 11161 "description" : "tasks artifact id filter" 11162 }, 11163 "runtimeType" : { 11164 "type" : "string", 11165 "example" : "CLOUD", 11166 "description" : "tasks runtime type filter", 11167 "enum" : [ "CLOUD", "CLOUD_EXCLUSIVE", "CLOUD_SANDBOX", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER", "ELASTIC_ENGINE" ] 11168 }, 11169 "runtimeId" : { 11170 "type" : "string", 11171 "example" : "623aafbe61a28314065704b8", 11172 "description" : "tasks runtime id filter" 11173 }, 11174 "runtimeRunProfileId" : { 11175 "type" : "string", 11176 "example" : "626f7d424fe73f1084416c68", 11177 "description" : "tasks runtime run profile id filter" 11178 }, 11179 "tags" : { 11180 "type" : "array", 11181 "example" : ["tag1", "tag2"], 11182 "description" : "tasks tags filter", 11183 "items" : { 11184 "type" : "string" 11185 } 11186 }, 11187 "triggerType" : { 11188 "type" : "string", 11189 "example" : "daily", 11190 "description" : "tasks trigger type filter", 11191 "enum" : [ "no_trigger", "daily", "weekly", "monthly", "once", "webhook", "cron", "multiple" ] 11192 }, 11193 "limit" : { 11194 "type" : "integer", 11195 "format" : "int32", 11196 "example" : 100, 11197 "description" : "tasks limit filter" 11198 }, 11199 "offset" : { 11200 "type" : "integer", 11201 "format" : "int32", 11202 "example" : 0, 11203 "description" : "tasks offset filter" 11204 } 11205 } 11206 }, 11207 "FlowPromotionResult" : { 11208 "type" : "object", 11209 "properties" : { 11210 "id" : { 11211 "type" : "string", 11212 "description" : "Artifact ID" 11213 }, 11214 "targetId" : { 11215 "type" : "string", 11216 "description" : "Target Artifact ID" 11217 }, 11218 "name" : { 11219 "type" : "string", 11220 "description" : "Artifact Name" 11221 }, 11222 "type" : { 11223 "type" : "string", 11224 "example" : "WORKSPACE", 11225 "description" : "Artifact Type", 11226 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 11227 }, 11228 "analyzeReport" : { 11229 "description" : "Promotion Analyze Report", 11230 "$ref" : "#/definitions/Report" 11231 }, 11232 "promotionReport" : { 11233 "description" : "Promotion Report", 11234 "$ref" : "#/definitions/Report" 11235 }, 11236 "workspaceId" : { 11237 "type" : "string", 11238 "description" : "Workspace id" 11239 }, 11240 "targetVersion" : { 11241 "type" : "string", 11242 "description" : "Artifact target version" 11243 }, 11244 "version" : { 11245 "type" : "integer", 11246 "format" : "int32" 11247 }, 11248 "jobType" : { 11249 "type" : "string", 11250 "description" : "Job type" 11251 }, 11252 "usedBy" : { 11253 "type" : "array", 11254 "description" : "Used by Artifacts", 11255 "items" : { 11256 "$ref" : "#/definitions/PromotionResultInfo" 11257 } 11258 }, 11259 "versions" : { 11260 "type" : "array", 11261 "description" : "Artifact versions", 11262 "items" : { 11263 "$ref" : "#/definitions/ArtifactVersionPromotionResult" 11264 } 11265 } 11266 } 11267 }, 11268 "JobExecutionStatus" : { 11269 "type" : "object", 11270 "required" : [ "accountId", "environmentVersion", "executionDestination", "executionId", "executionStatus", "executionType", "jobId", "jobVersion", "startTimestamp", "triggerTimestamp", "userId", "userType", "workspaceId" ], 11271 "properties" : { 11272 "executionId" : { 11273 "type" : "string", 11274 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 11275 "description" : "Job execution ID" 11276 }, 11277 "startTimestamp" : { 11278 "type" : "string", 11279 "format" : "date-time", 11280 "description" : "Start time of job execution (UTC)" 11281 }, 11282 "triggerTimestamp" : { 11283 "type" : "string", 11284 "format" : "date-time", 11285 "description" : "Trigger time of job execution (UTC)" 11286 }, 11287 "finishTimestamp" : { 11288 "type" : "string", 11289 "format" : "date-time", 11290 "description" : "End time of job execution (UTC)" 11291 }, 11292 "userId" : { 11293 "type" : "string", 11294 "example" : "fupton", 11295 "description" : "User who triggered or scheduled the execution" 11296 }, 11297 "userType" : { 11298 "type" : "string", 11299 "example" : "HUMAN", 11300 "description" : "Type of user who triggered or scheduled the execution", 11301 "enum" : [ "HUMAN", "SERVICE" ] 11302 }, 11303 "jobId" : { 11304 "type" : "string", 11305 "example" : "57f64991e4b0b689a64feed0", 11306 "description" : "Job ID" 11307 }, 11308 "jobVersion" : { 11309 "type" : "string", 11310 "example" : "5.2", 11311 "description" : "The version of the executed job" 11312 }, 11313 "environmentVersion" : { 11314 "type" : "string", 11315 "example" : "1.3", 11316 "description" : "Execution environment version", 11317 "enum" : [ "1.2", "1.3" ] 11318 }, 11319 "executionStatus" : { 11320 "type" : "string", 11321 "description" : "Execution status", 11322 "enum" : [ "EXECUTION_EVENT_RECEIVED", "DISPATCHING_FLOW", "STARTING_FLOW_EXECUTION", "STOPPING_FLOW_EXECUTION", "EXECUTION_TERMINATED", "EXECUTION_TERMINATED_TIMEOUT", "DEPLOY_FAILED", "EXECUTION_FAILED", "EXECUTION_REJECTED", "EXECUTION_SUCCESS" ] 11323 }, 11324 "executionType" : { 11325 "type" : "string", 11326 "example" : "SCHEDULED", 11327 "description" : "Execution type", 11328 "enum" : [ "MANUAL", "SCHEDULED", "WEBHOOK", "PLAN" ] 11329 }, 11330 "executionDestination" : { 11331 "type" : "string", 11332 "example" : "REMOTE_ENGINE", 11333 "description" : "Destination of execution", 11334 "enum" : [ "CLOUD", "CLOUD_EXCLUSIVE", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER" ] 11335 }, 11336 "containerId" : { 11337 "type" : "string", 11338 "description" : "Container ID" 11339 }, 11340 "runProfileId" : { 11341 "type" : "string", 11342 "example" : "157f818f-a901-4425-b592-0f9282687784", 11343 "description" : "Run profile ID" 11344 }, 11345 "remoteEngineId" : { 11346 "type" : "string", 11347 "example" : "157f818f-a901-4425-b592-0f9282687784", 11348 "description" : "Remote engine ID" 11349 }, 11350 "remoteEngineClusterId" : { 11351 "type" : "string", 11352 "description" : "Remote engine cluster ID" 11353 }, 11354 "numberOfProcessedRows" : { 11355 "type" : "integer", 11356 "format" : "int64", 11357 "example" : 1234567890, 11358 "description" : "Number of processed rows" 11359 }, 11360 "numberOfRejectedRows" : { 11361 "type" : "integer", 11362 "format" : "int64", 11363 "example" : 0, 11364 "description" : "Number of rejected rows" 11365 }, 11366 "accountId" : { 11367 "type" : "string", 11368 "example" : "8494b016-b5ef-4b9c-b16d-8b1f824d7616", 11369 "description" : "Account ID" 11370 }, 11371 "workspaceId" : { 11372 "type" : "string", 11373 "example" : "57ce63d3e4b0681c36d1a1c4", 11374 "description" : "Workspace ID" 11375 }, 11376 "planId" : { 11377 "type" : "string", 11378 "description" : "Plan execution ID" 11379 }, 11380 "errorType" : { 11381 "type" : "string", 11382 "description" : "Error type if error occurs" 11383 }, 11384 "errorMessage" : { 11385 "type" : "string", 11386 "description" : "Error message if error occurs" 11387 } 11388 }, 11389 "description" : "Execution info" 11390 }, 11391 "JobExecutionStatusV21" : { 11392 "type" : "object", 11393 "required" : [ "accountId", "environmentVersion", "executionDestination", "executionId", "executionStatus", "executionType", "jobId", "jobVersion", "startTimestamp", "status", "triggerTimestamp", "userId", "userType", "workspaceId" ], 11394 "properties" : { 11395 "executionId" : { 11396 "type" : "string", 11397 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 11398 "description" : "Job execution ID" 11399 }, 11400 "startTimestamp" : { 11401 "type" : "string", 11402 "format" : "date-time", 11403 "description" : "Start time of job execution (UTC)" 11404 }, 11405 "triggerTimestamp" : { 11406 "type" : "string", 11407 "format" : "date-time", 11408 "description" : "Trigger time of job execution (UTC)" 11409 }, 11410 "finishTimestamp" : { 11411 "type" : "string", 11412 "format" : "date-time", 11413 "description" : "End time of job execution (UTC)" 11414 }, 11415 "userId" : { 11416 "type" : "string", 11417 "example" : "fupton", 11418 "description" : "User who triggered or scheduled the execution" 11419 }, 11420 "userType" : { 11421 "type" : "string", 11422 "example" : "HUMAN", 11423 "description" : "Type of user who triggered or scheduled the execution", 11424 "enum" : [ "HUMAN", "SERVICE" ] 11425 }, 11426 "jobId" : { 11427 "type" : "string", 11428 "example" : "57f64991e4b0b689a64feed0", 11429 "description" : "Job ID" 11430 }, 11431 "jobVersion" : { 11432 "type" : "string", 11433 "example" : "5.2", 11434 "description" : "The version of the executed job" 11435 }, 11436 "environmentVersion" : { 11437 "type" : "string", 11438 "example" : "1.3", 11439 "description" : "Execution environment version", 11440 "enum" : [ "1.2", "1.3" ] 11441 }, 11442 "executionStatus" : { 11443 "type" : "string", 11444 "description" : "Execution status", 11445 "enum" : [ "EXECUTION_EVENT_RECEIVED", "DISPATCHING_FLOW", "STARTING_FLOW_EXECUTION", "STOPPING_FLOW_EXECUTION", "EXECUTION_TERMINATED", "EXECUTION_TERMINATED_TIMEOUT", "DEPLOY_FAILED", "EXECUTION_FAILED", "EXECUTION_REJECTED", "EXECUTION_SUCCESS" ] 11446 }, 11447 "executionType" : { 11448 "type" : "string", 11449 "example" : "SCHEDULED", 11450 "description" : "Execution type", 11451 "enum" : [ "MANUAL", "SCHEDULED", "WEBHOOK", "PLAN" ] 11452 }, 11453 "executionDestination" : { 11454 "type" : "string", 11455 "example" : "REMOTE_ENGINE", 11456 "description" : "Destination of execution", 11457 "enum" : [ "CLOUD", "CLOUD_EXCLUSIVE", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER" ] 11458 }, 11459 "containerId" : { 11460 "type" : "string", 11461 "description" : "Container ID" 11462 }, 11463 "runProfileId" : { 11464 "type" : "string", 11465 "example" : "157f818f-a901-4425-b592-0f9282687784", 11466 "description" : "Run profile ID" 11467 }, 11468 "remoteEngineId" : { 11469 "type" : "string", 11470 "example" : "157f818f-a901-4425-b592-0f9282687784", 11471 "description" : "Remote engine ID" 11472 }, 11473 "remoteEngineClusterId" : { 11474 "type" : "string", 11475 "description" : "Remote engine cluster ID" 11476 }, 11477 "numberOfProcessedRows" : { 11478 "type" : "integer", 11479 "format" : "int64", 11480 "example" : 1234567890, 11481 "description" : "Number of processed rows" 11482 }, 11483 "numberOfRejectedRows" : { 11484 "type" : "integer", 11485 "format" : "int64", 11486 "example" : 0, 11487 "description" : "Number of rejected rows" 11488 }, 11489 "accountId" : { 11490 "type" : "string", 11491 "example" : "8494b016-b5ef-4b9c-b16d-8b1f824d7616", 11492 "description" : "Account ID" 11493 }, 11494 "workspaceId" : { 11495 "type" : "string", 11496 "example" : "57ce63d3e4b0681c36d1a1c4", 11497 "description" : "Workspace ID" 11498 }, 11499 "planId" : { 11500 "type" : "string", 11501 "description" : "Plan execution ID" 11502 }, 11503 "errorType" : { 11504 "type" : "string", 11505 "description" : "Error type if error occurs" 11506 }, 11507 "errorMessage" : { 11508 "type" : "string", 11509 "description" : "Error message if error occurs" 11510 }, 11511 "status" : { 11512 "type" : "string", 11513 "example" : "execution_successful", 11514 "description" : "Task execution status", 11515 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_rejected", "execution_successful", "execution_failed", "terminated" ] 11516 } 11517 }, 11518 "description" : "Execution info" 11519 }, 11520 "LinkScheduleMultipleTriggerRequest" : { 11521 "type" : "object", 11522 "required" : [ "scheduleId" ], 11523 "properties" : { 11524 "scheduleId" : { 11525 "type" : "string", 11526 "description" : "Id of the schedule to associate with the task/plan" 11527 } 11528 } 11529 }, 11530 "Message" : { 11531 "type" : "object", 11532 "properties" : { 11533 "info" : { 11534 "type" : "string", 11535 "readOnly" : true 11536 }, 11537 "level" : { 11538 "type" : "string", 11539 "readOnly" : true, 11540 "enum" : [ "INFO", "WARN", "ERROR" ] 11541 } 11542 } 11543 }, 11544 "MultipleTrigger" : { 11545 "type" : "object", 11546 "required" : [ "name", "startDate", "timeZone", "type" ], 11547 "properties" : { 11548 "type" : { 11549 "type" : "string", 11550 "example" : "ONCE", 11551 "description" : "Type of schedule", 11552 "enum" : [ "ONCE", "DAILY", "WEEKLY", "MONTHLY", "CRON" ] 11553 }, 11554 "interval" : { 11555 "type" : "integer", 11556 "format" : "int32", 11557 "example" : 1, 11558 "description" : "Interval between task/plan running in days/weeks/months, required only if type of schedule is not equal to 'ONCE')" 11559 }, 11560 "startDate" : { 11561 "type" : "string", 11562 "example" : "2019-09-25", 11563 "description" : "Date when the task should start to run/when the cron trigger is enabled" 11564 }, 11565 "timeZone" : { 11566 "type" : "string", 11567 "example" : "Europe/London", 11568 "description" : "Time zone for task schedule" 11569 }, 11570 "atTimes" : { 11571 "$ref" : "#/definitions/TimeSchedule" 11572 }, 11573 "atDays" : { 11574 "$ref" : "#/definitions/DaySchedule" 11575 }, 11576 "cronExpression" : { 11577 "type" : "string", 11578 "example" : "*/5 12-14 * * ?", 11579 "description" : "cron expression - available from v2.6" 11580 }, 11581 "name" : { 11582 "type" : "string", 11583 "example" : "Trigger_#1_Daily_at_6pm", 11584 "description" : "Name of the trigger" 11585 }, 11586 "timeout" : { 11587 "type" : "integer", 11588 "format" : "int32", 11589 "description" : "Execution timeout in minutes (only for tasks)" 11590 } 11591 } 11592 }, 11593 "Page" : { 11594 "type" : "object", 11595 "properties" : { 11596 "items" : { 11597 "type" : "array", 11598 "items" : { 11599 "type" : "object" 11600 } 11601 }, 11602 "limit" : { 11603 "type" : "integer", 11604 "format" : "int32" 11605 }, 11606 "offset" : { 11607 "type" : "integer", 11608 "format" : "int32" 11609 }, 11610 "total" : { 11611 "type" : "integer", 11612 "format" : "int32" 11613 } 11614 } 11615 }, 11616 "PageArtifact" : { 11617 "type" : "object", 11618 "properties" : { 11619 "items" : { 11620 "type" : "array", 11621 "items" : { 11622 "$ref" : "#/definitions/Artifact" 11623 } 11624 }, 11625 "limit" : { 11626 "type" : "integer", 11627 "format" : "int32" 11628 }, 11629 "offset" : { 11630 "type" : "integer", 11631 "format" : "int32" 11632 }, 11633 "total" : { 11634 "type" : "integer", 11635 "format" : "int32" 11636 } 11637 } 11638 }, 11639 "PageConnectionDetails" : { 11640 "type" : "object", 11641 "properties" : { 11642 "items" : { 11643 "type" : "array", 11644 "items" : { 11645 "$ref" : "#/definitions/ConnectionDetails" 11646 } 11647 }, 11648 "limit" : { 11649 "type" : "integer", 11650 "format" : "int32" 11651 }, 11652 "offset" : { 11653 "type" : "integer", 11654 "format" : "int32" 11655 }, 11656 "total" : { 11657 "type" : "integer", 11658 "format" : "int32" 11659 } 11660 } 11661 }, 11662 "PageDate" : { 11663 "type" : "object", 11664 "properties" : { 11665 "items" : { 11666 "type" : "array", 11667 "items" : { 11668 "type" : "string", 11669 "format" : "date-time" 11670 } 11671 }, 11672 "limit" : { 11673 "type" : "integer", 11674 "format" : "int32" 11675 }, 11676 "offset" : { 11677 "type" : "integer", 11678 "format" : "int32" 11679 }, 11680 "total" : { 11681 "type" : "integer", 11682 "format" : "int32" 11683 } 11684 } 11685 }, 11686 "PageExecutableinfo" : { 11687 "type" : "object", 11688 "properties" : { 11689 "items" : { 11690 "type" : "array", 11691 "items" : { 11692 "$ref" : "#/definitions/Executableinfo" 11693 } 11694 }, 11695 "limit" : { 11696 "type" : "integer", 11697 "format" : "int32" 11698 }, 11699 "offset" : { 11700 "type" : "integer", 11701 "format" : "int32" 11702 }, 11703 "total" : { 11704 "type" : "integer", 11705 "format" : "int32" 11706 } 11707 } 11708 }, 11709 "PagePlanExecutionStatusV21" : { 11710 "type" : "object", 11711 "properties" : { 11712 "items" : { 11713 "type" : "array", 11714 "items" : { 11715 "$ref" : "#/definitions/PlanExecutionStatusV21" 11716 } 11717 }, 11718 "limit" : { 11719 "type" : "integer", 11720 "format" : "int32" 11721 }, 11722 "offset" : { 11723 "type" : "integer", 11724 "format" : "int32" 11725 }, 11726 "total" : { 11727 "type" : "integer", 11728 "format" : "int32" 11729 } 11730 } 11731 }, 11732 "PageProjectView" : { 11733 "type" : "object", 11734 "properties" : { 11735 "items" : { 11736 "type" : "array", 11737 "items" : { 11738 "$ref" : "#/definitions/ProjectView" 11739 } 11740 }, 11741 "limit" : { 11742 "type" : "integer", 11743 "format" : "int32" 11744 }, 11745 "offset" : { 11746 "type" : "integer", 11747 "format" : "int32" 11748 }, 11749 "total" : { 11750 "type" : "integer", 11751 "format" : "int32" 11752 } 11753 } 11754 }, 11755 "PageResource" : { 11756 "type" : "object", 11757 "properties" : { 11758 "items" : { 11759 "type" : "array", 11760 "items" : { 11761 "$ref" : "#/definitions/Resource" 11762 } 11763 }, 11764 "limit" : { 11765 "type" : "integer", 11766 "format" : "int32" 11767 }, 11768 "offset" : { 11769 "type" : "integer", 11770 "format" : "int32" 11771 }, 11772 "total" : { 11773 "type" : "integer", 11774 "format" : "int32" 11775 } 11776 } 11777 }, 11778 "PageScheduledEventsResponse" : { 11779 "type" : "object", 11780 "properties" : { 11781 "items" : { 11782 "type" : "array", 11783 "items" : { 11784 "$ref" : "#/definitions/ScheduledEventsResponse" 11785 } 11786 }, 11787 "limit" : { 11788 "type" : "integer", 11789 "format" : "int32" 11790 }, 11791 "offset" : { 11792 "type" : "integer", 11793 "format" : "int32" 11794 }, 11795 "total" : { 11796 "type" : "integer", 11797 "format" : "int32" 11798 } 11799 } 11800 }, 11801 "PageTaskExecutionStatusV21" : { 11802 "type" : "object", 11803 "properties" : { 11804 "items" : { 11805 "type" : "array", 11806 "items" : { 11807 "$ref" : "#/definitions/TaskExecutionStatusV21" 11808 } 11809 }, 11810 "limit" : { 11811 "type" : "integer", 11812 "format" : "int32" 11813 }, 11814 "offset" : { 11815 "type" : "integer", 11816 "format" : "int32" 11817 }, 11818 "total" : { 11819 "type" : "integer", 11820 "format" : "int32" 11821 } 11822 } 11823 }, 11824 "PageTaskExecutionStatusV26" : { 11825 "type" : "object", 11826 "properties" : { 11827 "items" : { 11828 "type" : "array", 11829 "items" : { 11830 "$ref" : "#/definitions/TaskExecutionStatusV26" 11831 } 11832 }, 11833 "limit" : { 11834 "type" : "integer", 11835 "format" : "int32" 11836 }, 11837 "offset" : { 11838 "type" : "integer", 11839 "format" : "int32" 11840 }, 11841 "total" : { 11842 "type" : "integer", 11843 "format" : "int32" 11844 } 11845 } 11846 }, 11847 "Permission" : { 11848 "type" : "object", 11849 "required" : [ "permissions", "userId", "workspaceId" ], 11850 "properties" : { 11851 "workspaceId" : { 11852 "type" : "string", 11853 "example" : "57f64991e4b0b689a64feed2", 11854 "description" : "The workspace id" 11855 }, 11856 "userId" : { 11857 "type" : "string", 11858 "example" : "b9e10a3f-9d68-44bb-862f-b2aa56dc7191", 11859 "description" : "The user id" 11860 }, 11861 "permissions" : { 11862 "type" : "array", 11863 "description" : "The list of permission types", 11864 "items" : { 11865 "type" : "string", 11866 "enum" : [ "AUTHOR", "EXECUTE", "VIEW", "MANAGE", "PUBLISH" ] 11867 } 11868 } 11869 } 11870 }, 11871 "PermissionDeleteResult" : { 11872 "type" : "object", 11873 "properties" : { 11874 "status" : { 11875 "type" : "integer", 11876 "format" : "int32" 11877 }, 11878 "message" : { 11879 "type" : "string" 11880 }, 11881 "permissionId" : { 11882 "$ref" : "#/definitions/PermissionId" 11883 } 11884 } 11885 }, 11886 "PermissionId" : { 11887 "type" : "object", 11888 "required" : [ "userId", "workspaceId" ], 11889 "properties" : { 11890 "workspaceId" : { 11891 "type" : "string", 11892 "example" : "57f64991e4b0b689a64feed2", 11893 "description" : "The workspace id" 11894 }, 11895 "userId" : { 11896 "type" : "string", 11897 "example" : "9f1634e7-d791-4be4-9aed-2970f8d804dd", 11898 "description" : "The user id" 11899 } 11900 } 11901 }, 11902 "PermissionResult" : { 11903 "type" : "object", 11904 "properties" : { 11905 "status" : { 11906 "type" : "integer", 11907 "format" : "int32" 11908 }, 11909 "message" : { 11910 "type" : "string" 11911 }, 11912 "permission" : { 11913 "$ref" : "#/definitions/Permission" 11914 } 11915 } 11916 }, 11917 "PipelineEngine" : { 11918 "type" : "object", 11919 "required" : [ "id", "name", "runtimeId" ], 11920 "properties" : { 11921 "createDate" : { 11922 "type" : "string", 11923 "format" : "date-time", 11924 "description" : "Created on", 11925 "readOnly" : true 11926 }, 11927 "updateDate" : { 11928 "type" : "string", 11929 "format" : "date-time", 11930 "description" : "Updated on", 11931 "readOnly" : true 11932 }, 11933 "id" : { 11934 "type" : "string", 11935 "example" : "5cdd2ce2c737973f9d581b98", 11936 "description" : "Resource id" 11937 }, 11938 "name" : { 11939 "type" : "string", 11940 "example" : "Remote Engine", 11941 "description" : "Resource name" 11942 }, 11943 "description" : { 11944 "type" : "string", 11945 "example" : "Some description", 11946 "description" : "Resource description" 11947 }, 11948 "workspace" : { 11949 "description" : "Resource workspace", 11950 "$ref" : "#/definitions/WorkspaceInfo" 11951 }, 11952 "runtimeId" : { 11953 "type" : "string", 11954 "example" : "9e8acf72-00d5-451b-9175-97bd44cd6b13", 11955 "description" : "Resource runtime id" 11956 }, 11957 "availability" : { 11958 "type" : "string", 11959 "example" : "NOT_AVAILABLE", 11960 "description" : "Availability status of engine|cluster", 11961 "enum" : [ "AVAILABLE", "NOT_AVAILABLE", "RETIRED" ] 11962 }, 11963 "managed" : { 11964 "type" : "boolean", 11965 "description" : "Indicates whether target runtime (engine/cluster) is managed or not" 11966 }, 11967 "status" : { 11968 "type" : "string", 11969 "enum" : [ "PAIRED", "NOT_PAIRED" ] 11970 }, 11971 "runStatus" : { 11972 "type" : "string", 11973 "enum" : [ "STARTING", "RUNNING", "STOPPING", "STOPPED", "START_FAILED", "STOP_FAILED", "ERROR", "NOT_FOUND" ] 11974 }, 11975 "preAuthorizedKey" : { 11976 "type" : "string" 11977 }, 11978 "cloudRunner" : { 11979 "type" : "boolean" 11980 } 11981 } 11982 }, 11983 "PipelineEngineRequest" : { 11984 "type" : "object", 11985 "required" : [ "environmentId", "name" ], 11986 "properties" : { 11987 "name" : { 11988 "type" : "string", 11989 "example" : "Remote Engine", 11990 "description" : "Engine name" 11991 }, 11992 "environmentId" : { 11993 "type" : "string", 11994 "example" : "5c1111d7a4186a4eafed0587", 11995 "description" : "Id of engine environment" 11996 }, 11997 "workspaceId" : { 11998 "type" : "string", 11999 "example" : "5c2222d7a4186a4eafed0587", 12000 "description" : "Id of engine workspace", 12001 "readOnly" : true 12002 }, 12003 "description" : { 12004 "type" : "string", 12005 "example" : "Some description", 12006 "description" : "Engine|cluster description", 12007 "readOnly" : true 12008 } 12009 } 12010 }, 12011 "PipelineRunProfileReadOnlyAttributes" : { 12012 "type" : "object", 12013 "properties" : { 12014 "createDate" : { 12015 "type" : "string", 12016 "format" : "date-time", 12017 "description" : "Created on", 12018 "readOnly" : true 12019 }, 12020 "updateDate" : { 12021 "type" : "string", 12022 "format" : "date-time", 12023 "description" : "Updated on", 12024 "readOnly" : true 12025 }, 12026 "id" : { 12027 "type" : "string", 12028 "example" : "57f64991e4b0b689a64feed0", 12029 "description" : "Run profile id", 12030 "readOnly" : true 12031 }, 12032 "type" : { 12033 "type" : "string", 12034 "description" : "Type", 12035 "readOnly" : true, 12036 "enum" : [ "standard", "big-data", "databricks", "advanced" ] 12037 } 12038 } 12039 }, 12040 "PipelineRunProfileResponse" : { 12041 "type" : "object", 12042 "required" : [ "name" ], 12043 "properties" : { 12044 "name" : { 12045 "type" : "string", 12046 "example" : "Default run profile", 12047 "description" : "Name" 12048 }, 12049 "description" : { 12050 "type" : "string", 12051 "example" : "Run profile used by default", 12052 "description" : "Description" 12053 }, 12054 "engineId" : { 12055 "type" : "string", 12056 "example" : "5f7eff3245ecf259a1c56daa", 12057 "description" : "Pipeline engine id" 12058 }, 12059 "createDate" : { 12060 "type" : "string", 12061 "format" : "date-time", 12062 "description" : "Created on", 12063 "readOnly" : true 12064 }, 12065 "updateDate" : { 12066 "type" : "string", 12067 "format" : "date-time", 12068 "description" : "Updated on", 12069 "readOnly" : true 12070 }, 12071 "id" : { 12072 "type" : "string", 12073 "example" : "57f64991e4b0b689a64feed0", 12074 "description" : "Run profile id", 12075 "readOnly" : true 12076 }, 12077 "type" : { 12078 "type" : "string", 12079 "description" : "Type", 12080 "readOnly" : true, 12081 "enum" : [ "standard", "big-data", "databricks", "advanced" ] 12082 } 12083 }, 12084 "description" : "Pipeline run profile response object." 12085 }, 12086 "Plan" : { 12087 "type" : "object", 12088 "required" : [ "author", "authorType", "id", "name", "steps" ], 12089 "properties" : { 12090 "createDate" : { 12091 "type" : "string", 12092 "format" : "date-time", 12093 "description" : "Created on", 12094 "readOnly" : true 12095 }, 12096 "updateDate" : { 12097 "type" : "string", 12098 "format" : "date-time", 12099 "description" : "Updated on", 12100 "readOnly" : true 12101 }, 12102 "id" : { 12103 "type" : "string", 12104 "example" : "5cdd2ce2c737973f9d581b98", 12105 "description" : "Resource id" 12106 }, 12107 "name" : { 12108 "type" : "string", 12109 "example" : "Remote Engine", 12110 "description" : "Resource name" 12111 }, 12112 "description" : { 12113 "type" : "string", 12114 "example" : "Some description", 12115 "description" : "Resource description" 12116 }, 12117 "workspace" : { 12118 "description" : "Resource workspace", 12119 "$ref" : "#/definitions/WorkspaceInfo" 12120 }, 12121 "author" : { 12122 "type" : "string", 12123 "example" : "operator123", 12124 "description" : "Plan author" 12125 }, 12126 "authorType" : { 12127 "type" : "string", 12128 "example" : "HUMAN", 12129 "description" : "Plan author type (HUMAN or SERVICE)", 12130 "enum" : [ "HUMAN", "SERVICE" ] 12131 }, 12132 "steps" : { 12133 "type" : "array", 12134 "description" : "Plan steps", 12135 "items" : { 12136 "$ref" : "#/definitions/Step" 12137 } 12138 } 12139 } 12140 }, 12141 "PlanExecutable" : { 12142 "type" : "object", 12143 "required" : [ "executable" ], 12144 "properties" : { 12145 "executable" : { 12146 "type" : "string", 12147 "example" : "b91cf8b2-5dd1-4b18-915b-4c447cee5267", 12148 "description" : "Executable identifier" 12149 }, 12150 "executionPlanId" : { 12151 "type" : "string", 12152 "example" : "0798b8d1-0e12-472f-be02-a0f04e792daa", 12153 "description" : "The plan execution identifier in case of re-execution (available from V2.4)" 12154 }, 12155 "stepId" : { 12156 "type" : "string", 12157 "example" : "09043c9f-02d0-41f6-b3cb-0ea53ffde377", 12158 "description" : "The execution step identifier (executionStepId) from which restart plan execution (available from V2.4)" 12159 }, 12160 "rerunOnlyFailedTasks" : { 12161 "type" : "boolean", 12162 "example" : true, 12163 "description" : "Optionally run only failing tasks (available from V2.4)" 12164 } 12165 } 12166 }, 12167 "PlanExecutabledetails" : { 12168 "type" : "object", 12169 "required" : [ "executable", "name" ], 12170 "properties" : { 12171 "executable" : { 12172 "type" : "string", 12173 "example" : "57f64991e4b0b689a64feed0", 12174 "description" : "Executable identifier" 12175 }, 12176 "name" : { 12177 "type" : "string", 12178 "example" : "simple executable", 12179 "description" : "Executable name" 12180 }, 12181 "workspace" : { 12182 "description" : "Executable workspace", 12183 "$ref" : "#/definitions/WorkspaceInfo" 12184 }, 12185 "description" : { 12186 "type" : "string", 12187 "example" : "plan detail description", 12188 "description" : "Executable description" 12189 }, 12190 "chart" : { 12191 "description" : "Plan execution hierarchy", 12192 "$ref" : "#/definitions/ExecutionStep" 12193 }, 12194 "planPauseDetails" : { 12195 "description" : "Pause details of Plan (available from V2.6)", 12196 "$ref" : "#/definitions/PlanPauseDetails" 12197 }, 12198 "status" : { 12199 "type" : "string", 12200 "description" : "Plan execution status", 12201 "enum" : [ "executing", "execution_successful", "execution_failed" ] 12202 } 12203 } 12204 }, 12205 "PlanExecutionStatus" : { 12206 "type" : "object", 12207 "required" : [ "executionId", "executionStatus", "planId", "startTimestamp", "userId", "userType" ], 12208 "properties" : { 12209 "executionId" : { 12210 "type" : "string", 12211 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 12212 "description" : "Job execution ID" 12213 }, 12214 "startTimestamp" : { 12215 "type" : "string", 12216 "format" : "date-time", 12217 "description" : "Start time of job execution (UTC)" 12218 }, 12219 "finishTimestamp" : { 12220 "type" : "string", 12221 "format" : "date-time", 12222 "description" : "End time of job execution (UTC)" 12223 }, 12224 "userId" : { 12225 "type" : "string", 12226 "example" : "fupton", 12227 "description" : "User who triggered or scheduled the execution" 12228 }, 12229 "userType" : { 12230 "type" : "string", 12231 "example" : "HUMAN", 12232 "description" : "Type of user who triggered or scheduled the execution (HUMAN or SERVICE)", 12233 "enum" : [ "HUMAN", "SERVICE" ] 12234 }, 12235 "planId" : { 12236 "type" : "string", 12237 "example" : "b91cf8b2-5dd1-4b18-915b-4c447cee5267", 12238 "description" : "Plan ID" 12239 }, 12240 "executionStatus" : { 12241 "type" : "string", 12242 "example" : "FINISHED", 12243 "description" : "Execution (detailed) status", 12244 "enum" : [ "UNDEFINED", "STARTED", "FINISHED", "EXECUTION_FAILED", "EXECUTION_SUCCESS" ] 12245 }, 12246 "plannedExecutableCount" : { 12247 "type" : "integer", 12248 "format" : "int32", 12249 "example" : 2, 12250 "description" : "Number of planned executables" 12251 }, 12252 "doneExecutableCount" : { 12253 "type" : "integer", 12254 "format" : "int32", 12255 "example" : 1, 12256 "description" : "Number of done executables" 12257 }, 12258 "doneExecutableDetails" : { 12259 "type" : "array", 12260 "description" : "Execution activity info", 12261 "items" : { 12262 "$ref" : "#/definitions/JobExecutionStatus" 12263 } 12264 } 12265 }, 12266 "description" : "Plan Execution info" 12267 }, 12268 "PlanExecutionStatusV21" : { 12269 "type" : "object", 12270 "required" : [ "executionId", "executionStatus", "planId", "startTimestamp", "status", "userId", "userType" ], 12271 "properties" : { 12272 "executionId" : { 12273 "type" : "string", 12274 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 12275 "description" : "Job execution ID" 12276 }, 12277 "startTimestamp" : { 12278 "type" : "string", 12279 "format" : "date-time", 12280 "description" : "Start time of job execution" 12281 }, 12282 "finishTimestamp" : { 12283 "type" : "string", 12284 "format" : "date-time", 12285 "description" : "End time of job execution" 12286 }, 12287 "userId" : { 12288 "type" : "string", 12289 "example" : "fupton", 12290 "description" : "User who triggered or scheduled the execution" 12291 }, 12292 "userType" : { 12293 "type" : "string", 12294 "example" : "HUMAN", 12295 "description" : "Type of user who triggered or scheduled the execution (HUMAN or SERVICE)", 12296 "enum" : [ "HUMAN", "SERVICE" ] 12297 }, 12298 "planId" : { 12299 "type" : "string", 12300 "example" : "b91cf8b2-5dd1-4b18-915b-4c447cee5267", 12301 "description" : "Plan ID" 12302 }, 12303 "executionStatus" : { 12304 "type" : "string", 12305 "example" : "FINISHED", 12306 "description" : "Execution (detailed) status", 12307 "enum" : [ "UNDEFINED", "STARTED", "FINISHED", "EXECUTION_FAILED", "EXECUTION_SUCCESS" ] 12308 }, 12309 "plannedExecutableCount" : { 12310 "type" : "integer", 12311 "format" : "int32", 12312 "example" : 2, 12313 "description" : "Number of planned executables" 12314 }, 12315 "doneExecutableCount" : { 12316 "type" : "integer", 12317 "format" : "int32", 12318 "example" : 1, 12319 "description" : "Number of done executables" 12320 }, 12321 "doneExecutableDetails" : { 12322 "type" : "array", 12323 "description" : "Execution activity info", 12324 "items" : { 12325 "$ref" : "#/definitions/JobExecutionStatus" 12326 } 12327 }, 12328 "status" : { 12329 "type" : "string", 12330 "example" : "executing", 12331 "description" : "Execution status", 12332 "enum" : [ "executing", "execution_successful", "execution_failed" ] 12333 } 12334 }, 12335 "description" : "Plan Execution info" 12336 }, 12337 "PlanPauseDetails" : { 12338 "type" : "object", 12339 "properties" : { 12340 "pause" : { 12341 "type" : "boolean" 12342 }, 12343 "pauseContext" : { 12344 "type" : "string" 12345 }, 12346 "pauseDate" : { 12347 "type" : "string", 12348 "format" : "date-time", 12349 "readOnly" : true 12350 }, 12351 "user" : { 12352 "type" : "string", 12353 "readOnly" : true 12354 }, 12355 "userType" : { 12356 "type" : "string", 12357 "readOnly" : true, 12358 "enum" : [ "HUMAN", "SERVICE" ] 12359 } 12360 } 12361 }, 12362 "PlanRequest" : { 12363 "type" : "object", 12364 "required" : [ "name", "steps", "workspaceId" ], 12365 "properties" : { 12366 "name" : { 12367 "type" : "string", 12368 "example" : "Plan 1", 12369 "description" : "Plan name" 12370 }, 12371 "workspaceId" : { 12372 "type" : "string", 12373 "example" : "57f64991e4b0b689a64feed2", 12374 "description" : "Plan workspace" 12375 }, 12376 "description" : { 12377 "type" : "string", 12378 "example" : "Some description", 12379 "description" : "Plan description" 12380 }, 12381 "steps" : { 12382 "type" : "array", 12383 "description" : "Plan steps", 12384 "items" : { 12385 "$ref" : "#/definitions/Step" 12386 } 12387 } 12388 } 12389 }, 12390 "PlanRunConfig" : { 12391 "type" : "object", 12392 "required" : [ "runtime", "trigger" ], 12393 "properties" : { 12394 "trigger" : { 12395 "$ref" : "#/definitions/Trigger" 12396 }, 12397 "runtime" : { 12398 "$ref" : "#/definitions/Runtime" 12399 }, 12400 "parallelExecutionAllowed" : { 12401 "type" : "boolean", 12402 "example" : false, 12403 "description" : "Indicates whether this executable is allowed to run in parallel (for REMOTE_ENGINE available from V2.6). 'false' by default" 12404 } 12405 } 12406 }, 12407 "ProjectCreateRequest" : { 12408 "type" : "object", 12409 "required" : [ "name", "owner", "url" ], 12410 "properties" : { 12411 "owner" : { 12412 "type" : "string", 12413 "example" : "John Doe", 12414 "description" : "Owner name" 12415 }, 12416 "description" : { 12417 "type" : "string", 12418 "example" : "John Doe", 12419 "description" : "Project description" 12420 }, 12421 "url" : { 12422 "type" : "string", 12423 "example" : "https://github.com/example/Example.git", 12424 "description" : "Project url" 12425 }, 12426 "name" : { 12427 "type" : "string", 12428 "example" : "Hello world project", 12429 "description" : "Project name" 12430 } 12431 } 12432 }, 12433 "ProjectGroupAuthResponse" : { 12434 "type" : "object", 12435 "properties" : { 12436 "projectId" : { 12437 "type" : "string" 12438 }, 12439 "groupIds" : { 12440 "type" : "array", 12441 "items" : { 12442 "type" : "string" 12443 } 12444 } 12445 } 12446 }, 12447 "ProjectRequest" : { 12448 "type" : "object", 12449 "properties" : { 12450 "owner" : { 12451 "type" : "string", 12452 "example" : "John Doe", 12453 "description" : "Owner name" 12454 }, 12455 "description" : { 12456 "type" : "string", 12457 "example" : "John Doe", 12458 "description" : "Project description" 12459 }, 12460 "url" : { 12461 "type" : "string", 12462 "example" : "https://github.com/example/Example.git", 12463 "description" : "Project url" 12464 } 12465 } 12466 }, 12467 "ProjectUserAuthResponse" : { 12468 "type" : "object", 12469 "properties" : { 12470 "projectId" : { 12471 "type" : "string" 12472 }, 12473 "userIds" : { 12474 "type" : "array", 12475 "items" : { 12476 "type" : "string" 12477 } 12478 } 12479 } 12480 }, 12481 "ProjectView" : { 12482 "type" : "object", 12483 "properties" : { 12484 "id" : { 12485 "type" : "string" 12486 }, 12487 "name" : { 12488 "type" : "string" 12489 }, 12490 "technicalLabel" : { 12491 "type" : "string" 12492 }, 12493 "description" : { 12494 "type" : "string" 12495 }, 12496 "url" : { 12497 "type" : "string" 12498 }, 12499 "author" : { 12500 "type" : "string" 12501 }, 12502 "owner" : { 12503 "type" : "string" 12504 }, 12505 "projectType" : { 12506 "type" : "string", 12507 "enum" : [ "MDM", "DQ", "DI" ] 12508 }, 12509 "repoType" : { 12510 "type" : "string", 12511 "enum" : [ "GIT", "SVN", "NONE" ] 12512 }, 12513 "createDate" : { 12514 "type" : "string", 12515 "format" : "date-time" 12516 }, 12517 "updateDate" : { 12518 "type" : "string", 12519 "format" : "date-time" 12520 } 12521 } 12522 }, 12523 "PromotionAdvancedInfo" : { 12524 "type" : "object", 12525 "properties" : { 12526 "type" : { 12527 "type" : "string", 12528 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER", "PIPELINE_ENGINE", "RUNPROFILE" ] 12529 }, 12530 "id" : { 12531 "type" : "string" 12532 }, 12533 "name" : { 12534 "type" : "string" 12535 }, 12536 "workspaceId" : { 12537 "type" : "string" 12538 } 12539 } 12540 }, 12541 "PromotionExecutableDetails" : { 12542 "type" : "object", 12543 "required" : [ "executable", "name" ], 12544 "properties" : { 12545 "executable" : { 12546 "type" : "string", 12547 "example" : "57f64991e4b0b689a64feed0", 12548 "description" : "Executable identifier" 12549 }, 12550 "name" : { 12551 "type" : "string", 12552 "example" : "simple executable", 12553 "description" : "Executable name" 12554 }, 12555 "sourceEnvironment" : { 12556 "description" : "Promotion Source Environment", 12557 "$ref" : "#/definitions/EnvironmentInfo" 12558 }, 12559 "targetEnvironment" : { 12560 "description" : "Promotion Target Environment", 12561 "$ref" : "#/definitions/EnvironmentInfo" 12562 }, 12563 "description" : { 12564 "type" : "string", 12565 "example" : "promotion detail description", 12566 "description" : "Promotion description (not returned when querying a list of objects)" 12567 } 12568 } 12569 }, 12570 "PromotionExecutableTask" : { 12571 "type" : "object", 12572 "required" : [ "executable" ], 12573 "properties" : { 12574 "executable" : { 12575 "type" : "string", 12576 "example" : "57f64991e4b0b689a64feed0", 12577 "description" : "Executable identifier" 12578 }, 12579 "keepTargetResources" : { 12580 "type" : "boolean", 12581 "description" : "Keep Target Resources flag" 12582 }, 12583 "keepTargetRunProfiles" : { 12584 "type" : "boolean", 12585 "description" : "Keep Target Run Profiles flag (works starting from V2.2)" 12586 }, 12587 "advanced" : { 12588 "description" : "Advanced Promotion specification", 12589 "$ref" : "#/definitions/AdvancedPromotionSpec" 12590 }, 12591 "context" : { 12592 "type" : "string", 12593 "description" : "Execution context message" 12594 } 12595 } 12596 }, 12597 "PromotionExecutionDetails" : { 12598 "type" : "object", 12599 "properties" : { 12600 "keepTargetResources" : { 12601 "type" : "boolean" 12602 }, 12603 "keepTargetRunProfiles" : { 12604 "type" : "boolean" 12605 }, 12606 "context" : { 12607 "type" : "string" 12608 }, 12609 "promotionAdvancedInfo" : { 12610 "$ref" : "#/definitions/PromotionAdvancedInfo" 12611 } 12612 } 12613 }, 12614 "PromotionExecutionReport" : { 12615 "type" : "object", 12616 "required" : [ "executionId" ], 12617 "properties" : { 12618 "executionId" : { 12619 "type" : "string", 12620 "example" : "16fefb53-035a-4249-af9d-f80a3b47b132", 12621 "description" : "Execution identifier" 12622 }, 12623 "executionReport" : { 12624 "description" : "Promotion execution report", 12625 "$ref" : "#/definitions/PromotionExecutionStatus" 12626 } 12627 } 12628 }, 12629 "PromotionExecutionStatus" : { 12630 "type" : "object", 12631 "required" : [ "executionId", "startTimestamp", "triggerTimestamp", "userId", "userType" ], 12632 "properties" : { 12633 "executionId" : { 12634 "type" : "string", 12635 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 12636 "description" : "Job execution ID" 12637 }, 12638 "startTimestamp" : { 12639 "type" : "string", 12640 "format" : "date-time", 12641 "description" : "Start time of job execution (UTC)" 12642 }, 12643 "triggerTimestamp" : { 12644 "type" : "string", 12645 "format" : "date-time", 12646 "description" : "Trigger time of job execution (UTC)" 12647 }, 12648 "finishTimestamp" : { 12649 "type" : "string", 12650 "format" : "date-time", 12651 "description" : "End time of job execution (UTC)" 12652 }, 12653 "userId" : { 12654 "type" : "string", 12655 "example" : "fupton", 12656 "description" : "User who triggered or scheduled the execution" 12657 }, 12658 "userType" : { 12659 "type" : "string", 12660 "example" : "HUMAN", 12661 "description" : "Type of user who triggered or scheduled the execution", 12662 "enum" : [ "HUMAN", "SERVICE" ] 12663 }, 12664 "promotionId" : { 12665 "type" : "string", 12666 "description" : "Promotion ID" 12667 }, 12668 "pipelineId" : { 12669 "type" : "string", 12670 "description" : "Deprecated! Use Promotion ID instead" 12671 }, 12672 "keepTargetResources" : { 12673 "type" : "boolean", 12674 "description" : "Keep Target Resources flag" 12675 }, 12676 "keepTargetRunProfiles" : { 12677 "type" : "boolean", 12678 "description" : "Keep Target Run Profiles flag (not returned for API versions earlier V2.2)" 12679 }, 12680 "advanced" : { 12681 "description" : "Advanced Promotion specification", 12682 "$ref" : "#/definitions/AdvancedPromotionSpec" 12683 }, 12684 "defective" : { 12685 "type" : "boolean", 12686 "description" : "Defective Promotion flag" 12687 }, 12688 "status" : { 12689 "type" : "string", 12690 "example" : "PROMOTED", 12691 "description" : "Execution status", 12692 "enum" : [ "ANALIZED", "PROMOTION_STARTED", "PROMOTION_WARNING", "PROMOTION_FAILED", "PROMOTED" ] 12693 }, 12694 "statusMessage" : { 12695 "type" : "string", 12696 "description" : "Execution status message" 12697 }, 12698 "workspaces" : { 12699 "type" : "array", 12700 "description" : "Workspace Promotion Execution Info", 12701 "items" : { 12702 "$ref" : "#/definitions/WorkspacePromotionResult" 12703 } 12704 }, 12705 "engines" : { 12706 "type" : "array", 12707 "description" : "Remote Engines Promotion Execution Info", 12708 "items" : { 12709 "$ref" : "#/definitions/RuntimePromotionResult" 12710 } 12711 }, 12712 "clusters" : { 12713 "type" : "array", 12714 "description" : "Remote Engine Clusters Promotion Execution Info", 12715 "items" : { 12716 "$ref" : "#/definitions/RuntimePromotionResult" 12717 } 12718 }, 12719 "context" : { 12720 "type" : "string", 12721 "description" : "Execution context message" 12722 } 12723 } 12724 }, 12725 "PromotionResultInfo" : { 12726 "type" : "object", 12727 "properties" : { 12728 "id" : { 12729 "type" : "string", 12730 "description" : "Artifact ID" 12731 }, 12732 "targetId" : { 12733 "type" : "string", 12734 "description" : "Target Artifact ID" 12735 }, 12736 "name" : { 12737 "type" : "string", 12738 "description" : "Artifact Name" 12739 }, 12740 "type" : { 12741 "type" : "string", 12742 "example" : "WORKSPACE", 12743 "description" : "Artifact Type", 12744 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 12745 }, 12746 "analyzeReport" : { 12747 "description" : "Promotion Analyze Report", 12748 "$ref" : "#/definitions/Report" 12749 }, 12750 "promotionReport" : { 12751 "description" : "Promotion Report", 12752 "$ref" : "#/definitions/Report" 12753 }, 12754 "workspaceId" : { 12755 "type" : "string", 12756 "description" : "Workspace id" 12757 }, 12758 "targetVersion" : { 12759 "type" : "string", 12760 "description" : "Artifact target version" 12761 }, 12762 "version" : { 12763 "type" : "string", 12764 "description" : "Artifact version" 12765 } 12766 } 12767 }, 12768 "PromotionUsersResponse" : { 12769 "type" : "object", 12770 "required" : [ "executable", "userIds" ], 12771 "properties" : { 12772 "executable" : { 12773 "type" : "string", 12774 "example" : "5d3039de65ff7d3583840bk1", 12775 "description" : "Promotion ID" 12776 }, 12777 "userIds" : { 12778 "type" : "array", 12779 "example" : ["64af766b-a8d9-40c6-ba75-1509d1ee6dad", "64af766b-a8d9-40c6-ba75-1509d1ee6dac"], 12780 "description" : "Assigned users", 12781 "items" : { 12782 "type" : "string" 12783 } 12784 } 12785 } 12786 }, 12787 "Report" : { 12788 "type" : "object", 12789 "properties" : { 12790 "status" : { 12791 "type" : "string", 12792 "enum" : [ "CREATED", "REPLACED", "REUSED", "FAILED", "SKIPPED" ] 12793 }, 12794 "messages" : { 12795 "type" : "array", 12796 "readOnly" : true, 12797 "items" : { 12798 "$ref" : "#/definitions/Message" 12799 } 12800 } 12801 } 12802 }, 12803 "RepositoryCommitData" : { 12804 "type" : "object", 12805 "required" : [ "author", "date", "id" ], 12806 "properties" : { 12807 "id" : { 12808 "type" : "string", 12809 "description" : "commit id" 12810 }, 12811 "date" : { 12812 "type" : "string", 12813 "format" : "date-time", 12814 "description" : "commit date time" 12815 }, 12816 "author" : { 12817 "type" : "string", 12818 "description" : "commit author" 12819 } 12820 } 12821 }, 12822 "Resource" : { 12823 "type" : "object", 12824 "required" : [ "file", "id", "name", "workspaceInfo" ], 12825 "properties" : { 12826 "id" : { 12827 "type" : "string", 12828 "example" : "5c1111d7a4186a4eafed0587", 12829 "description" : "Id of resource" 12830 }, 12831 "name" : { 12832 "type" : "string", 12833 "example" : "Hello world task", 12834 "description" : "Name of resource" 12835 }, 12836 "description" : { 12837 "type" : "string", 12838 "example" : "task detail description", 12839 "description" : "Description of resource" 12840 }, 12841 "workspaceInfo" : { 12842 "description" : "Workspace of resource", 12843 "$ref" : "#/definitions/WorkspaceInfo" 12844 }, 12845 "file" : { 12846 "type" : "boolean", 12847 "description" : "Boolean value which indicates that resource is file" 12848 } 12849 } 12850 }, 12851 "Response" : { 12852 "type" : "object", 12853 "properties" : { 12854 "entity" : { 12855 "type" : "object" 12856 }, 12857 "status" : { 12858 "type" : "integer", 12859 "format" : "int32" 12860 }, 12861 "metadata" : { 12862 "type" : "object", 12863 "additionalProperties" : { 12864 "type" : "array", 12865 "items" : { 12866 "type" : "object" 12867 } 12868 } 12869 } 12870 } 12871 }, 12872 "RunProfileRequest" : { 12873 "type" : "object", 12874 "required" : [ "jvmArguments", "name", "runtimeId", "type" ], 12875 "properties" : { 12876 "name" : { 12877 "type" : "string", 12878 "example" : "Run profile", 12879 "description" : "Run profile name" 12880 }, 12881 "description" : { 12882 "type" : "string", 12883 "example" : "Run profile with default options", 12884 "description" : "Description" 12885 }, 12886 "jvmArguments" : { 12887 "type" : "array", 12888 "example" : ["-Xms128m", "-Xmx256m"], 12889 "description" : "Jvm arguments", 12890 "items" : { 12891 "type" : "string" 12892 } 12893 }, 12894 "type" : { 12895 "type" : "string", 12896 "example" : "JOB_SERVER", 12897 "description" : "Run profile type", 12898 "enum" : [ "JOB_SERVER", "MICROSERVICE", "TALEND_RUNTIME" ] 12899 }, 12900 "runtimeId" : { 12901 "type" : "string", 12902 "example" : "5e713618de3c75a450447262", 12903 "description" : "Runtime id" 12904 } 12905 } 12906 }, 12907 "RunProfileRescheduleOptions" : { 12908 "type" : "object", 12909 "properties" : { 12910 "method" : { 12911 "type" : "string", 12912 "description" : "Run profile reschedule method", 12913 "enum" : [ "DEFAULT", "DUPLICATE_RUN_PROFILES", "CLUSTER_RUN_PROFILE" ] 12914 }, 12915 "runProfileId" : { 12916 "type" : "string", 12917 "description" : "Run profile to be used from cluster" 12918 } 12919 } 12920 }, 12921 "RunProfileUpdateRequest" : { 12922 "type" : "object", 12923 "required" : [ "jvmArguments", "name" ], 12924 "properties" : { 12925 "name" : { 12926 "type" : "string", 12927 "example" : "Run profile", 12928 "description" : "Run profile name" 12929 }, 12930 "description" : { 12931 "type" : "string", 12932 "example" : "Run profile with default options", 12933 "description" : "Description" 12934 }, 12935 "jvmArguments" : { 12936 "type" : "array", 12937 "example" : ["-Xms128m", "-Xmx256m"], 12938 "description" : "Jvm arguments", 12939 "items" : { 12940 "type" : "string" 12941 } 12942 } 12943 } 12944 }, 12945 "Runtime" : { 12946 "type" : "object", 12947 "properties" : { 12948 "type" : { 12949 "type" : "string", 12950 "example" : "CLOUD", 12951 "description" : "Type of runtime", 12952 "enum" : [ "CLOUD", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER", "CLOUD_EXCLUSIVE" ] 12953 }, 12954 "id" : { 12955 "type" : "string", 12956 "example" : "5c9a51dc7b353e43c7fc787c", 12957 "description" : "Runtime id" 12958 }, 12959 "engineId" : { 12960 "type" : "string", 12961 "example" : "5c9a51dc7b353e43c7fc787c", 12962 "description" : "Remote engine id" 12963 }, 12964 "clusterId" : { 12965 "type" : "string", 12966 "example" : "5c9a51dc7b353e43c7fc787c", 12967 "description" : "Remote engine cluster id" 12968 }, 12969 "runProfileId" : { 12970 "type" : "string", 12971 "example" : "5c9a51dc7b353e43c7fc783c", 12972 "description" : "Engine run profile ID" 12973 } 12974 } 12975 }, 12976 "RuntimePromotionResult" : { 12977 "type" : "object", 12978 "properties" : { 12979 "id" : { 12980 "type" : "string", 12981 "description" : "Artifact ID" 12982 }, 12983 "targetId" : { 12984 "type" : "string", 12985 "description" : "Target Artifact ID" 12986 }, 12987 "name" : { 12988 "type" : "string", 12989 "description" : "Artifact Name" 12990 }, 12991 "type" : { 12992 "type" : "string", 12993 "example" : "WORKSPACE", 12994 "description" : "Artifact Type", 12995 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 12996 }, 12997 "analyzeReport" : { 12998 "description" : "Promotion Analyze Report", 12999 "$ref" : "#/definitions/Report" 13000 }, 13001 "promotionReport" : { 13002 "description" : "Promotion Report", 13003 "$ref" : "#/definitions/Report" 13004 }, 13005 "workspaceId" : { 13006 "type" : "string", 13007 "description" : "Workspace id" 13008 }, 13009 "targetVersion" : { 13010 "type" : "string", 13011 "description" : "Artifact target version" 13012 }, 13013 "version" : { 13014 "type" : "string", 13015 "description" : "Artifact version" 13016 }, 13017 "jobType" : { 13018 "type" : "string", 13019 "description" : "Job type" 13020 }, 13021 "usedBy" : { 13022 "type" : "array", 13023 "description" : "Used by Artifacts", 13024 "items" : { 13025 "$ref" : "#/definitions/PromotionResultInfo" 13026 } 13027 }, 13028 "versions" : { 13029 "type" : "array", 13030 "description" : "Artifact versions", 13031 "items" : { 13032 "$ref" : "#/definitions/ArtifactVersionPromotionResult" 13033 } 13034 }, 13035 "runProfiles" : { 13036 "type" : "array", 13037 "description" : "Run profiles", 13038 "items" : { 13039 "$ref" : "#/definitions/ArtifactPromotionResult" 13040 } 13041 } 13042 } 13043 }, 13044 "RuntimeRunProfile" : { 13045 "type" : "object", 13046 "properties" : { 13047 "id" : { 13048 "type" : "string" 13049 }, 13050 "name" : { 13051 "type" : "string" 13052 }, 13053 "description" : { 13054 "type" : "string" 13055 }, 13056 "createDate" : { 13057 "type" : "string", 13058 "format" : "date-time" 13059 }, 13060 "updateDate" : { 13061 "type" : "string", 13062 "format" : "date-time" 13063 }, 13064 "type" : { 13065 "type" : "string", 13066 "description" : "Run profile type", 13067 "enum" : [ "JOB_SERVER", "MICROSERVICE", "TALEND_RUNTIME" ] 13068 }, 13069 "jvmArguments" : { 13070 "type" : "array", 13071 "description" : "Jvm arguments", 13072 "items" : { 13073 "type" : "string" 13074 } 13075 }, 13076 "runtimeId" : { 13077 "type" : "string" 13078 }, 13079 "version" : { 13080 "type" : "integer", 13081 "format" : "int32", 13082 "description" : "Run profile version" 13083 } 13084 } 13085 }, 13086 "RuntimeRunProfileResponse" : { 13087 "type" : "object", 13088 "properties" : { 13089 "createDate" : { 13090 "type" : "string", 13091 "format" : "date-time", 13092 "description" : "Created on", 13093 "readOnly" : true 13094 }, 13095 "updateDate" : { 13096 "type" : "string", 13097 "format" : "date-time", 13098 "description" : "Updated on", 13099 "readOnly" : true 13100 }, 13101 "id" : { 13102 "type" : "string" 13103 }, 13104 "name" : { 13105 "type" : "string" 13106 }, 13107 "description" : { 13108 "type" : "string" 13109 }, 13110 "type" : { 13111 "type" : "string", 13112 "description" : "Run profile type", 13113 "enum" : [ "JOB_SERVER", "MICROSERVICE", "TALEND_RUNTIME" ] 13114 }, 13115 "jvmArguments" : { 13116 "type" : "array", 13117 "description" : "Jvm arguments", 13118 "items" : { 13119 "type" : "string" 13120 } 13121 }, 13122 "runtimeId" : { 13123 "type" : "string" 13124 }, 13125 "version" : { 13126 "type" : "integer", 13127 "format" : "int32", 13128 "description" : "Run profile version" 13129 } 13130 } 13131 }, 13132 "Schedule" : { 13133 "type" : "object", 13134 "properties" : { 13135 "id" : { 13136 "type" : "string" 13137 }, 13138 "description" : { 13139 "type" : "string" 13140 }, 13141 "triggers" : { 13142 "type" : "array", 13143 "items" : { 13144 "$ref" : "#/definitions/MultipleTrigger" 13145 } 13146 }, 13147 "environmentId" : { 13148 "type" : "string" 13149 }, 13150 "executableId" : { 13151 "type" : "string" 13152 }, 13153 "executableType" : { 13154 "type" : "string" 13155 } 13156 } 13157 }, 13158 "ScheduledEventsRequest" : { 13159 "type" : "object", 13160 "required" : [ "environmentId", "to" ], 13161 "properties" : { 13162 "environmentId" : { 13163 "type" : "string", 13164 "description" : "Environment id" 13165 }, 13166 "workspaceIds" : { 13167 "type" : "array", 13168 "description" : "Workspace ids. If empty, will return events for all workspaces in the environment", 13169 "items" : { 13170 "type" : "string" 13171 } 13172 }, 13173 "from" : { 13174 "type" : "integer", 13175 "format" : "int64", 13176 "description" : "From date time (milliseconds).Default value - now" 13177 }, 13178 "to" : { 13179 "type" : "integer", 13180 "format" : "int64", 13181 "description" : "To date time (milliseconds)" 13182 }, 13183 "tags" : { 13184 "type" : "array", 13185 "description" : "Tags", 13186 "items" : { 13187 "type" : "string" 13188 } 13189 }, 13190 "runtime" : { 13191 "description" : "Runtime", 13192 "$ref" : "#/definitions/ScheduledEventsRequestRuntime" 13193 }, 13194 "limit" : { 13195 "type" : "integer", 13196 "format" : "int32", 13197 "description" : "The number of items to return. Must be in range [1, 100]. Default value - 100" 13198 }, 13199 "offset" : { 13200 "type" : "integer", 13201 "format" : "int32", 13202 "description" : "The position of the first item. Must be greater than or equal to 0. Default value - 0" 13203 } 13204 } 13205 }, 13206 "ScheduledEventsRequestRuntime" : { 13207 "type" : "object", 13208 "properties" : { 13209 "type" : { 13210 "type" : "string", 13211 "example" : "CLOUD", 13212 "description" : "Type of runtime", 13213 "enum" : [ "CLOUD", "REMOTE_ENGINE", "REMOTE_ENGINE_CLUSTER", "CLOUD_EXCLUSIVE", "PIPELINE_ENGINE" ] 13214 }, 13215 "id" : { 13216 "type" : "string", 13217 "example" : "5c9a51dc7b353e43c7fc787c", 13218 "description" : "Runtime id" 13219 } 13220 } 13221 }, 13222 "ScheduledEventsResponse" : { 13223 "type" : "object", 13224 "properties" : { 13225 "id" : { 13226 "type" : "string", 13227 "description" : "The entity's id for this event" 13228 }, 13229 "sourceTriggerName" : { 13230 "type" : "string", 13231 "description" : "The source trigger's name (only for schedule for multiple triggers)" 13232 }, 13233 "date" : { 13234 "type" : "string", 13235 "format" : "date-time", 13236 "description" : "The Trigger's date for the event" 13237 }, 13238 "type" : { 13239 "type" : "string", 13240 "description" : "The entity's type for the event", 13241 "enum" : [ "TASK", "PLAN" ] 13242 } 13243 } 13244 }, 13245 "Seat" : { 13246 "type" : "object", 13247 "required" : [ "application", "currentUsers", "maxUsers" ], 13248 "properties" : { 13249 "application" : { 13250 "type" : "string", 13251 "example" : ["Data Inventory", "Data Preparation", "Data Stewardship", "Pipeline Designer", "Dictionary service", "API Designer / API Tester", "Management Console", "Studio", "Service Accounts"], 13252 "description" : "Name of application" 13253 }, 13254 "maxUsers" : { 13255 "type" : "integer", 13256 "format" : "int32", 13257 "description" : "Maximum of users allowed to use the application" 13258 }, 13259 "currentUsers" : { 13260 "type" : "integer", 13261 "format" : "int32", 13262 "description" : "Count of users currently using the application" 13263 } 13264 }, 13265 "description" : "Seat information" 13266 }, 13267 "SourcesRepositoryData" : { 13268 "type" : "object", 13269 "required" : [ "project" ], 13270 "properties" : { 13271 "project" : { 13272 "type" : "string", 13273 "description" : "project name" 13274 }, 13275 "branch" : { 13276 "type" : "string", 13277 "description" : "repository branch" 13278 }, 13279 "commit" : { 13280 "description" : "repository commit info", 13281 "$ref" : "#/definitions/RepositoryCommitData" 13282 } 13283 } 13284 }, 13285 "StandardRunProfile" : { 13286 "type" : "object", 13287 "required" : [ "configuration", "executionFramework", "name" ], 13288 "properties" : { 13289 "name" : { 13290 "type" : "string", 13291 "example" : "Default run profile", 13292 "description" : "Name" 13293 }, 13294 "description" : { 13295 "type" : "string", 13296 "example" : "Run profile used by default", 13297 "description" : "Description" 13298 }, 13299 "engineId" : { 13300 "type" : "string", 13301 "example" : "5f7eff3245ecf259a1c56daa", 13302 "description" : "Pipeline engine id" 13303 }, 13304 "pushdownPreferenceEnabled" : { 13305 "type" : "boolean", 13306 "example" : true, 13307 "description" : "Pushdown enable" 13308 }, 13309 "warehouseName" : { 13310 "type" : "string", 13311 "example" : "DWH name", 13312 "description" : "Data warehouse name" 13313 }, 13314 "configuration" : { 13315 "description" : "Configuration", 13316 "$ref" : "#/definitions/Configuration" 13317 }, 13318 "executionFramework" : { 13319 "type" : "string", 13320 "example" : "Spark local", 13321 "description" : "Execution framework" 13322 } 13323 }, 13324 "description" : "Pipeline run profile of type 'Standard'" 13325 }, 13326 "StandardRunProfileResponse" : { 13327 "type" : "object", 13328 "required" : [ "configuration", "executionFramework", "name" ], 13329 "properties" : { 13330 "name" : { 13331 "type" : "string", 13332 "example" : "Default run profile", 13333 "description" : "Name" 13334 }, 13335 "description" : { 13336 "type" : "string", 13337 "example" : "Run profile used by default", 13338 "description" : "Description" 13339 }, 13340 "engineId" : { 13341 "type" : "string", 13342 "example" : "5f7eff3245ecf259a1c56daa", 13343 "description" : "Pipeline engine id" 13344 }, 13345 "pushdownPreferenceEnabled" : { 13346 "type" : "boolean", 13347 "example" : true, 13348 "description" : "Pushdown enable" 13349 }, 13350 "warehouseName" : { 13351 "type" : "string", 13352 "example" : "DWH name", 13353 "description" : "Data warehouse name" 13354 }, 13355 "configuration" : { 13356 "description" : "Configuration", 13357 "$ref" : "#/definitions/Configuration" 13358 }, 13359 "executionFramework" : { 13360 "type" : "string", 13361 "example" : "Spark local", 13362 "description" : "Execution framework" 13363 }, 13364 "createDate" : { 13365 "type" : "string", 13366 "format" : "date-time", 13367 "description" : "Created on", 13368 "readOnly" : true 13369 }, 13370 "updateDate" : { 13371 "type" : "string", 13372 "format" : "date-time", 13373 "description" : "Updated on", 13374 "readOnly" : true 13375 }, 13376 "id" : { 13377 "type" : "string", 13378 "example" : "57f64991e4b0b689a64feed0", 13379 "description" : "Run profile id", 13380 "readOnly" : true 13381 }, 13382 "type" : { 13383 "type" : "string", 13384 "description" : "Type", 13385 "readOnly" : true, 13386 "enum" : [ "standard", "big-data", "databricks", "advanced" ] 13387 } 13388 }, 13389 "description" : "Pipeline run profile of type 'Standard'" 13390 }, 13391 "Step" : { 13392 "type" : "object", 13393 "required" : [ "condition", "name", "taskIds" ], 13394 "properties" : { 13395 "id" : { 13396 "type" : "string", 13397 "example" : "9af64991e4b0b689a64feed0", 13398 "description" : "Step id" 13399 }, 13400 "name" : { 13401 "type" : "string", 13402 "example" : "Step 1", 13403 "description" : "Step name" 13404 }, 13405 "condition" : { 13406 "type" : "string", 13407 "description" : "Expected status of successful step", 13408 "enum" : [ "ALL_SUCCEEDED", "AT_LEAST_ONE_SUCCEEDED" ] 13409 }, 13410 "taskIds" : { 13411 "type" : "array", 13412 "example" : ["5d5fc81f79bc197d2483a100", "5d5fc81f79bc197d2483a101"], 13413 "description" : "List of step tasks", 13414 "items" : { 13415 "type" : "string" 13416 } 13417 }, 13418 "handlerOnFailure" : { 13419 "description" : "Handler of step errors", 13420 "$ref" : "#/definitions/StepErrorHandler" 13421 }, 13422 "note" : { 13423 "type" : "string", 13424 "example" : "Clear the database for users", 13425 "description" : "Description to rerun a plan execution from this step" 13426 } 13427 } 13428 }, 13429 "StepErrorHandler" : { 13430 "type" : "object", 13431 "properties" : { 13432 "taskIds" : { 13433 "type" : "array", 13434 "example" : ["5d5fc81f79bc197d2483a102", "5d5fc81f79bc197d2483a103"], 13435 "description" : "List of handler tasks", 13436 "items" : { 13437 "type" : "string" 13438 } 13439 }, 13440 "planIds" : { 13441 "type" : "array", 13442 "example" : ["5d5fc81f79bc197d2483a104"], 13443 "description" : "List of handler plans", 13444 "items" : { 13445 "type" : "string" 13446 } 13447 } 13448 } 13449 }, 13450 "StepExecution" : { 13451 "type" : "object", 13452 "properties" : { 13453 "id" : { 13454 "type" : "string" 13455 }, 13456 "executionId" : { 13457 "type" : "string" 13458 }, 13459 "startTimestamp" : { 13460 "type" : "string", 13461 "format" : "date-time" 13462 }, 13463 "finishTimestamp" : { 13464 "type" : "string", 13465 "format" : "date-time" 13466 }, 13467 "executionStatus" : { 13468 "type" : "string" 13469 } 13470 } 13471 }, 13472 "StepExecutionDetails" : { 13473 "type" : "object", 13474 "properties" : { 13475 "id" : { 13476 "type" : "string" 13477 }, 13478 "executionId" : { 13479 "type" : "string" 13480 }, 13481 "startTimestamp" : { 13482 "type" : "string", 13483 "format" : "date-time" 13484 }, 13485 "finishTimestamp" : { 13486 "type" : "string", 13487 "format" : "date-time" 13488 }, 13489 "executionStatus" : { 13490 "type" : "string" 13491 }, 13492 "plannedExecutableCount" : { 13493 "type" : "integer", 13494 "format" : "int32" 13495 }, 13496 "doneExecutableCount" : { 13497 "type" : "integer", 13498 "format" : "int32" 13499 }, 13500 "doneTaskExecutableDetails" : { 13501 "type" : "array", 13502 "items" : { 13503 "$ref" : "#/definitions/JobExecutionStatus" 13504 } 13505 }, 13506 "donePlanExecutableDetails" : { 13507 "type" : "array", 13508 "items" : { 13509 "$ref" : "#/definitions/PlanExecutionStatus" 13510 } 13511 } 13512 } 13513 }, 13514 "Subscription" : { 13515 "type" : "object", 13516 "required" : [ "applications", "endDate", "enginesStatus", "licenseType", "seats", "startDate", "supportLevel", "tokensStatus" ], 13517 "properties" : { 13518 "startDate" : { 13519 "type" : "string", 13520 "example" : "2019-09-25", 13521 "description" : "Subscription start date" 13522 }, 13523 "endDate" : { 13524 "type" : "string", 13525 "example" : "2019-09-25", 13526 "description" : "Subscription end date" 13527 }, 13528 "licenseType" : { 13529 "type" : "string", 13530 "description" : "License type" 13531 }, 13532 "applications" : { 13533 "type" : "array", 13534 "description" : "Available applications", 13535 "items" : { 13536 "type" : "string" 13537 } 13538 }, 13539 "supportLevel" : { 13540 "type" : "string", 13541 "description" : "Level of support" 13542 }, 13543 "tokensStatus" : { 13544 "$ref" : "#/definitions/TokensStatus" 13545 }, 13546 "enginesStatus" : { 13547 "type" : "array", 13548 "description" : "Give number of engines used by type", 13549 "items" : { 13550 "$ref" : "#/definitions/EngineStatus" 13551 } 13552 }, 13553 "seats" : { 13554 "type" : "array", 13555 "description" : "Seats information by application", 13556 "items" : { 13557 "$ref" : "#/definitions/Seat" 13558 } 13559 } 13560 }, 13561 "description" : "Contains information related to token consumption, engines statuses and seat usages" 13562 }, 13563 "TaskAutoUpgradeRequest" : { 13564 "type" : "object", 13565 "required" : [ "artifact", "description", "name", "workspaceId" ], 13566 "properties" : { 13567 "workspaceId" : { 13568 "type" : "string", 13569 "example" : "57f64991e4b0b689a64feed2", 13570 "description" : "Workspace id of task to create" 13571 }, 13572 "name" : { 13573 "type" : "string", 13574 "example" : "Hello world task", 13575 "description" : "Task name" 13576 }, 13577 "description" : { 13578 "type" : "string", 13579 "example" : "Task detail description", 13580 "description" : "Task description" 13581 }, 13582 "tags" : { 13583 "type" : "array", 13584 "example" : ["tag1", "tag2"], 13585 "description" : "Task tags", 13586 "items" : { 13587 "type" : "string" 13588 } 13589 }, 13590 "connections" : { 13591 "type" : "object", 13592 "example" : {"aws":"5d405e381f40e07fbab6757c","googledrive":"5d405e831f40e07fbab6757d"}, 13593 "description" : "Task connections", 13594 "additionalProperties" : { 13595 "type" : "string" 13596 } 13597 }, 13598 "parameters" : { 13599 "type" : "object", 13600 "example" : {"parameter_p1":"1111","custom_parameter":"custom"}, 13601 "description" : "Task parameters", 13602 "additionalProperties" : { 13603 "type" : "string" 13604 } 13605 }, 13606 "resources" : { 13607 "type" : "object", 13608 "example" : {"resource_file_f1":"5d84adcf38907f16498d5d74"}, 13609 "description" : "Task resources", 13610 "additionalProperties" : { 13611 "type" : "string" 13612 } 13613 }, 13614 "artifact" : { 13615 "description" : "Artifact used in task", 13616 "$ref" : "#/definitions/ArtifactRequest" 13617 }, 13618 "autoUpgradeInfo" : { 13619 "description" : "Auto upgrade", 13620 "$ref" : "#/definitions/AutoUpgradeInfo" 13621 } 13622 } 13623 }, 13624 "TaskExecutionStatusV21" : { 13625 "type" : "object", 13626 "required" : [ "executionId", "executionStatus", "executionType", "startTimestamp", "status", "taskId", "taskVersion", "triggerTimestamp", "userId", "userType" ], 13627 "properties" : { 13628 "executionId" : { 13629 "type" : "string", 13630 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 13631 "description" : "Job execution ID" 13632 }, 13633 "startTimestamp" : { 13634 "type" : "string", 13635 "format" : "date-time", 13636 "description" : "Start time of job execution" 13637 }, 13638 "triggerTimestamp" : { 13639 "type" : "string", 13640 "format" : "date-time", 13641 "description" : "Trigger time of job execution" 13642 }, 13643 "finishTimestamp" : { 13644 "type" : "string", 13645 "format" : "date-time", 13646 "description" : "End time of job execution" 13647 }, 13648 "userId" : { 13649 "type" : "string", 13650 "example" : "fupton", 13651 "description" : "User who triggered or scheduled the execution" 13652 }, 13653 "userType" : { 13654 "type" : "string", 13655 "example" : "HUMAN", 13656 "description" : "Type of user who triggered or scheduled the execution", 13657 "enum" : [ "HUMAN", "SERVICE" ] 13658 }, 13659 "taskId" : { 13660 "type" : "string", 13661 "example" : "57f64991e4b0b689a64feed0", 13662 "description" : "Task Id" 13663 }, 13664 "taskVersion" : { 13665 "type" : "string", 13666 "description" : "Task version" 13667 }, 13668 "executionType" : { 13669 "type" : "string", 13670 "example" : "SCHEDULED", 13671 "description" : "Execution type", 13672 "enum" : [ "MANUAL", "SCHEDULED", "WEBHOOK", "PLAN" ] 13673 }, 13674 "status" : { 13675 "type" : "string", 13676 "example" : "executing", 13677 "description" : "Execution status", 13678 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_successful", "execution_rejected", "execution_failed", "terminated", "terminated_timeout" ] 13679 }, 13680 "runtime" : { 13681 "description" : "Executable runtime", 13682 "$ref" : "#/definitions/Runtime" 13683 }, 13684 "errorMessage" : { 13685 "type" : "string", 13686 "description" : "Error message if error occurs" 13687 }, 13688 "executionStatus" : { 13689 "type" : "string", 13690 "example" : "DEPLOY_FAILED", 13691 "description" : "Execution (detailed) status", 13692 "enum" : [ "DEPLOY_FAILED", "EXECUTION_SUCCESS", "EXECUTION_FAILED", "EXECUTION_TERMINATED", "EXECUTION_TERMINATED_TIMEOUT", "EXECUTION_REJECTED", "EXECUTION_EVENT_RECEIVED", "DISPATCHING_FLOW", "STARTING_FLOW_EXECUTION", "STOPPING_FLOW_EXECUTION", "UNKNOWN" ] 13693 }, 13694 "timeout" : { 13695 "type" : "integer", 13696 "format" : "int32", 13697 "description" : "Execution timeout if set (in minutes)" 13698 } 13699 }, 13700 "description" : "Task Execution info" 13701 }, 13702 "TaskExecutionStatusV26" : { 13703 "type" : "object", 13704 "required" : [ "executionId", "executionStatus", "executionType", "startTimestamp", "status", "taskId", "taskVersion", "triggerTimestamp", "userId", "userType" ], 13705 "properties" : { 13706 "executionId" : { 13707 "type" : "string", 13708 "example" : "7b2b122e-d6b8-42de-b0ba-fa2f0d36306e", 13709 "description" : "Job execution ID" 13710 }, 13711 "startTimestamp" : { 13712 "type" : "string", 13713 "format" : "date-time", 13714 "description" : "Start time of job execution" 13715 }, 13716 "triggerTimestamp" : { 13717 "type" : "string", 13718 "format" : "date-time", 13719 "description" : "Trigger time of job execution" 13720 }, 13721 "finishTimestamp" : { 13722 "type" : "string", 13723 "format" : "date-time", 13724 "description" : "End time of job execution" 13725 }, 13726 "userId" : { 13727 "type" : "string", 13728 "example" : "fupton", 13729 "description" : "User who triggered or scheduled the execution" 13730 }, 13731 "userType" : { 13732 "type" : "string", 13733 "example" : "HUMAN", 13734 "description" : "Type of user who triggered or scheduled the execution", 13735 "enum" : [ "HUMAN", "SERVICE" ] 13736 }, 13737 "taskId" : { 13738 "type" : "string", 13739 "example" : "57f64991e4b0b689a64feed0", 13740 "description" : "Task Id" 13741 }, 13742 "taskVersion" : { 13743 "type" : "string", 13744 "description" : "Task version" 13745 }, 13746 "executionType" : { 13747 "type" : "string", 13748 "example" : "SCHEDULED", 13749 "description" : "Execution type", 13750 "enum" : [ "MANUAL", "SCHEDULED", "WEBHOOK", "PLAN" ] 13751 }, 13752 "status" : { 13753 "type" : "string", 13754 "example" : "executing", 13755 "description" : "Execution status", 13756 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_successful", "execution_rejected", "execution_failed", "terminated", "terminated_timeout" ] 13757 }, 13758 "runtime" : { 13759 "description" : "Executable runtime", 13760 "$ref" : "#/definitions/Runtime" 13761 }, 13762 "errorMessage" : { 13763 "type" : "string", 13764 "description" : "Error message if error occurs" 13765 }, 13766 "executionStatus" : { 13767 "type" : "string", 13768 "example" : "DEPLOY_FAILED", 13769 "description" : "Execution (detailed) status", 13770 "enum" : [ "DEPLOY_FAILED", "EXECUTION_SUCCESS", "EXECUTION_FAILED", "EXECUTION_TERMINATED", "EXECUTION_TERMINATED_TIMEOUT", "EXECUTION_REJECTED", "EXECUTION_EVENT_RECEIVED", "DISPATCHING_FLOW", "STARTING_FLOW_EXECUTION", "STOPPING_FLOW_EXECUTION", "UNKNOWN" ] 13771 }, 13772 "timeout" : { 13773 "type" : "integer", 13774 "format" : "int32", 13775 "description" : "Execution timeout if set (in minutes)" 13776 }, 13777 "parallelExecutionAllowed" : { 13778 "type" : "boolean", 13779 "description" : "Whether parallel run was allowed for the execution" 13780 } 13781 }, 13782 "description" : "Task Execution info" 13783 }, 13784 "TaskExecutionsRequest" : { 13785 "type" : "object", 13786 "properties" : { 13787 "status" : { 13788 "type" : "string", 13789 "example" : "executing", 13790 "description" : "tasks execution status", 13791 "enum" : [ "dispatching", "deploy_failed", "executing", "execution_successful", "execution_rejected", "execution_failed", "terminated", "terminated_timeout" ] 13792 }, 13793 "from" : { 13794 "type" : "integer", 13795 "format" : "int64", 13796 "example" : "1646159400000", 13797 "description" : "from date time (milliseconds)" 13798 }, 13799 "to" : { 13800 "type" : "integer", 13801 "format" : "int64", 13802 "example" : "1649183400000", 13803 "description" : "to date time (milliseconds)" 13804 }, 13805 "lastDays" : { 13806 "type" : "integer", 13807 "format" : "int32", 13808 "example" : 20, 13809 "description" : "lastDays" 13810 }, 13811 "environmentId" : { 13812 "type" : "string", 13813 "example" : "6148511d6ccc6d41563574e5", 13814 "description" : "tasks environment id" 13815 }, 13816 "workspaceId" : { 13817 "type" : "string", 13818 "example" : "614851d46ccc6d41563574ea", 13819 "description" : "tasks workspace id" 13820 }, 13821 "tags" : { 13822 "type" : "array", 13823 "example" : ["tag1", "tag2"], 13824 "description" : "tasks tag", 13825 "items" : { 13826 "type" : "string" 13827 } 13828 }, 13829 "limit" : { 13830 "type" : "integer", 13831 "format" : "int32", 13832 "example" : 100, 13833 "description" : "tasks limit" 13834 }, 13835 "offset" : { 13836 "type" : "integer", 13837 "format" : "int32", 13838 "example" : 0, 13839 "description" : "tasks offset" 13840 } 13841 } 13842 }, 13843 "TaskPauseDetails" : { 13844 "type" : "object", 13845 "properties" : { 13846 "pause" : { 13847 "type" : "boolean" 13848 }, 13849 "pauseContext" : { 13850 "type" : "string" 13851 }, 13852 "pauseDate" : { 13853 "type" : "string", 13854 "format" : "date-time", 13855 "readOnly" : true 13856 }, 13857 "user" : { 13858 "type" : "string", 13859 "readOnly" : true 13860 }, 13861 "userType" : { 13862 "type" : "string", 13863 "readOnly" : true, 13864 "enum" : [ "HUMAN", "SERVICE" ] 13865 } 13866 } 13867 }, 13868 "TaskRunConfig" : { 13869 "type" : "object", 13870 "required" : [ "runtime", "trigger" ], 13871 "properties" : { 13872 "trigger" : { 13873 "$ref" : "#/definitions/Trigger" 13874 }, 13875 "runtime" : { 13876 "$ref" : "#/definitions/Runtime" 13877 }, 13878 "parallelExecutionAllowed" : { 13879 "type" : "boolean", 13880 "example" : false, 13881 "description" : "Indicates whether this executable is allowed to run in parallel (for REMOTE_ENGINE available from V2.6). 'false' by default" 13882 }, 13883 "logLevel" : { 13884 "type" : "string", 13885 "example" : "ERROR", 13886 "description" : "Execution log level. 'WARN' by default", 13887 "enum" : [ "OFF", "ERROR", "WARN", "INFO" ] 13888 }, 13889 "remoteRunAsUser" : { 13890 "type" : "string", 13891 "description" : "Remote run user" 13892 } 13893 } 13894 }, 13895 "TaskV21" : { 13896 "type" : "object", 13897 "required" : [ "artifact", "id", "name", "version" ], 13898 "properties" : { 13899 "id" : { 13900 "type" : "string", 13901 "example" : "5c1111d7a4186a4eafed0587", 13902 "description" : "Id of task" 13903 }, 13904 "name" : { 13905 "type" : "string", 13906 "example" : "Hello world task", 13907 "description" : "Name of task" 13908 }, 13909 "description" : { 13910 "type" : "string", 13911 "example" : "task detail description", 13912 "description" : "Task description" 13913 }, 13914 "workspace" : { 13915 "description" : "Task workspace", 13916 "$ref" : "#/definitions/WorkspaceInfo" 13917 }, 13918 "version" : { 13919 "type" : "string", 13920 "example" : "0.1", 13921 "description" : "Task version" 13922 }, 13923 "artifact" : { 13924 "description" : "Artifact used in task", 13925 "$ref" : "#/definitions/BaseArtifactVersion" 13926 }, 13927 "tags" : { 13928 "type" : "array", 13929 "example" : ["tag1", "tag2"], 13930 "description" : "Task tags", 13931 "items" : { 13932 "type" : "string" 13933 } 13934 }, 13935 "connections" : { 13936 "type" : "object", 13937 "example" : {"aws":"5d405e381f40e07fbab6757c","googledrive":"5d405e831f40e07fbab6757d"}, 13938 "description" : "Task connections", 13939 "additionalProperties" : { 13940 "type" : "string" 13941 } 13942 }, 13943 "parameters" : { 13944 "type" : "object", 13945 "example" : {"parameter_p1":"1111","custom_parameter":"custom"}, 13946 "description" : "Task parameters", 13947 "additionalProperties" : { 13948 "type" : "string" 13949 } 13950 }, 13951 "resources" : { 13952 "type" : "object", 13953 "example" : {"resource_file_f1":"5d567ad48f68ae1a1e16e4a4"}, 13954 "description" : "Task resources", 13955 "additionalProperties" : { 13956 "type" : "string" 13957 } 13958 }, 13959 "taskPauseDetails" : { 13960 "description" : "Pause details of task", 13961 "$ref" : "#/definitions/TaskPauseDetails" 13962 }, 13963 "autoUpgradeInfo" : { 13964 "description" : "Task auto update info", 13965 "$ref" : "#/definitions/AutoUpgradeInfo" 13966 } 13967 } 13968 }, 13969 "TaskV21CreateRequest" : { 13970 "type" : "object", 13971 "required" : [ "artifact", "description", "environmentId", "name", "workspaceId" ], 13972 "properties" : { 13973 "workspaceId" : { 13974 "type" : "string", 13975 "example" : "57f64991e4b0b689a64feed2", 13976 "description" : "Workspace id of task to create" 13977 }, 13978 "name" : { 13979 "type" : "string", 13980 "example" : "Hello world task", 13981 "description" : "Task name" 13982 }, 13983 "description" : { 13984 "type" : "string", 13985 "example" : "Task detail description", 13986 "description" : "Task description" 13987 }, 13988 "tags" : { 13989 "type" : "array", 13990 "example" : ["tag1", "tag2"], 13991 "description" : "Task tags", 13992 "items" : { 13993 "type" : "string" 13994 } 13995 }, 13996 "connections" : { 13997 "type" : "object", 13998 "example" : {"aws":"5d405e381f40e07fbab6757c","googledrive":"5d405e831f40e07fbab6757d"}, 13999 "description" : "Task connections", 14000 "additionalProperties" : { 14001 "type" : "string" 14002 } 14003 }, 14004 "parameters" : { 14005 "type" : "object", 14006 "example" : {"parameter_p1":"1111","custom_parameter":"custom"}, 14007 "description" : "Task parameters", 14008 "additionalProperties" : { 14009 "type" : "string" 14010 } 14011 }, 14012 "resources" : { 14013 "type" : "object", 14014 "example" : {"resource_file_f1":"5d84adcf38907f16498d5d74"}, 14015 "description" : "Task resources", 14016 "additionalProperties" : { 14017 "type" : "string" 14018 } 14019 }, 14020 "artifact" : { 14021 "description" : "Artifact used in task", 14022 "$ref" : "#/definitions/ArtifactRequest" 14023 }, 14024 "autoUpgradeInfo" : { 14025 "description" : "Auto upgrade", 14026 "$ref" : "#/definitions/AutoUpgradeInfo" 14027 }, 14028 "environmentId" : { 14029 "type" : "string", 14030 "example" : "5d7a3d082d909b386943787e", 14031 "description" : "Environment id of task to create" 14032 } 14033 } 14034 }, 14035 "TimeSchedule" : { 14036 "type" : "object", 14037 "required" : [ "type" ], 14038 "properties" : { 14039 "type" : { 14040 "type" : "string", 14041 "example" : "AT_TIME", 14042 "description" : "Type of schedule at times", 14043 "enum" : [ "AT_TIME", "AT_SPECIFIC_TIMES", "AT_INTERVALS" ] 14044 }, 14045 "times" : { 14046 "type" : "array", 14047 "example" : ["10:00"], 14048 "description" : "Timestamps to run task/plan, required only if type of schedule at times equal to AT_SPECIFIC_TIMES", 14049 "items" : { 14050 "type" : "string" 14051 } 14052 }, 14053 "time" : { 14054 "type" : "string", 14055 "example" : "10:00", 14056 "description" : "Timestamp to run task/plan, required only if type of schedule at times equal to AT_TIME" 14057 }, 14058 "startTime" : { 14059 "type" : "string", 14060 "example" : "10:00", 14061 "description" : "Interval start timestamp, required only if type of schedule at times equal to AT_INTERVALS" 14062 }, 14063 "endTime" : { 14064 "type" : "string", 14065 "example" : "23:00", 14066 "description" : "Interval end timestamp, required only if type of schedule at times equal to AT_INTERVALS" 14067 }, 14068 "interval" : { 14069 "type" : "integer", 14070 "format" : "int32", 14071 "example" : "10", 14072 "description" : "Duration of interval in minutes, required only if type of schedule at times equal to AT_INTERVALS" 14073 } 14074 } 14075 }, 14076 "TokensStatus" : { 14077 "type" : "object", 14078 "required" : [ "consumed", "total" ], 14079 "properties" : { 14080 "total" : { 14081 "type" : "integer", 14082 "format" : "int32", 14083 "description" : "Number of token allowed for the account" 14084 }, 14085 "consumed" : { 14086 "type" : "integer", 14087 "format" : "int32", 14088 "description" : "Number of token currently consumed by the account" 14089 } 14090 }, 14091 "description" : "Information about tokens" 14092 }, 14093 "Trigger" : { 14094 "type" : "object", 14095 "required" : [ "startDate", "timeZone", "type" ], 14096 "properties" : { 14097 "type" : { 14098 "type" : "string", 14099 "example" : "ONCE", 14100 "description" : "Type of schedule", 14101 "enum" : [ "ONCE", "DAILY", "WEEKLY", "MONTHLY", "WEBHOOK", "MANUAL", "CRON" ] 14102 }, 14103 "interval" : { 14104 "type" : "integer", 14105 "format" : "int32", 14106 "example" : 1, 14107 "description" : "Interval between task/plan running in days/weeks/months, required only if type of schedule is not equal to 'ONCE')" 14108 }, 14109 "startDate" : { 14110 "type" : "string", 14111 "example" : "2019-09-25", 14112 "description" : "Date when the task should start to run/when the cron trigger is enabled" 14113 }, 14114 "timeZone" : { 14115 "type" : "string", 14116 "example" : "Europe/London", 14117 "description" : "Time zone for task schedule" 14118 }, 14119 "atTimes" : { 14120 "$ref" : "#/definitions/TimeSchedule" 14121 }, 14122 "atDays" : { 14123 "$ref" : "#/definitions/DaySchedule" 14124 }, 14125 "webhook" : { 14126 "$ref" : "#/definitions/Webhook" 14127 }, 14128 "cronExpression" : { 14129 "type" : "string", 14130 "example" : "*/5 12-14 * * ?", 14131 "description" : "cron expression - available from v2.6" 14132 } 14133 } 14134 }, 14135 "UpdateConnectionRequest" : { 14136 "type" : "object", 14137 "properties" : { 14138 "name" : { 14139 "type" : "string", 14140 "example" : "testConnection", 14141 "description" : "Connection name" 14142 }, 14143 "parameters" : { 14144 "type" : "array", 14145 "description" : "Connection parameters", 14146 "items" : { 14147 "$ref" : "#/definitions/ConnectionParameter" 14148 } 14149 } 14150 } 14151 }, 14152 "UpdateDescriptionRequest" : { 14153 "type" : "object", 14154 "required" : [ "description" ], 14155 "properties" : { 14156 "description" : { 14157 "type" : "string", 14158 "example" : "This is new description", 14159 "description" : "Promotion description" 14160 } 14161 } 14162 }, 14163 "UpdateEnvironmentRequest" : { 14164 "type" : "object", 14165 "required" : [ "name" ], 14166 "properties" : { 14167 "name" : { 14168 "type" : "string", 14169 "example" : "Development", 14170 "description" : "Environment name" 14171 }, 14172 "description" : { 14173 "type" : "string", 14174 "example" : "environment detail description", 14175 "description" : "Environment description" 14176 }, 14177 "maxCloudContainers" : { 14178 "type" : "integer", 14179 "format" : "int32", 14180 "description" : "The max cloud containers count" 14181 } 14182 } 14183 }, 14184 "UpdateResourceRequest" : { 14185 "type" : "object", 14186 "properties" : { 14187 "name" : { 14188 "type" : "string", 14189 "description" : "Resource name" 14190 }, 14191 "description" : { 14192 "type" : "string", 14193 "description" : "Resource description" 14194 } 14195 } 14196 }, 14197 "UpdateScheduleMultipleTriggerRequest" : { 14198 "type" : "object", 14199 "properties" : { 14200 "description" : { 14201 "type" : "string", 14202 "example" : "Schedule with five triggers", 14203 "description" : "Some description related to the usage of the scheduler" 14204 } 14205 } 14206 }, 14207 "UpdateWorkspaceRequest" : { 14208 "type" : "object", 14209 "required" : [ "name" ], 14210 "properties" : { 14211 "name" : { 14212 "type" : "string", 14213 "example" : "Personal", 14214 "description" : "Workspace name" 14215 }, 14216 "description" : { 14217 "type" : "string", 14218 "example" : "Workspace detail description", 14219 "description" : "Workspace description" 14220 }, 14221 "owner" : { 14222 "type" : "string", 14223 "description" : "The owner of the workspace" 14224 }, 14225 "protectedArtifactUpdate" : { 14226 "type" : "boolean", 14227 "description" : "Update tasks only with workspace artifacts" 14228 } 14229 } 14230 }, 14231 "UpgradeInfo" : { 14232 "type" : "object", 14233 "properties" : { 14234 "upgradable" : { 14235 "type" : "boolean" 14236 }, 14237 "autoUpgradeFailed" : { 14238 "type" : "boolean" 14239 } 14240 } 14241 }, 14242 "Webhook" : { 14243 "type" : "object", 14244 "required" : [ "name" ], 14245 "properties" : { 14246 "name" : { 14247 "type" : "string", 14248 "example" : "NewWebhook", 14249 "description" : "Webhook name" 14250 }, 14251 "description" : { 14252 "type" : "string", 14253 "example" : "Webhook description", 14254 "description" : "Webhook description" 14255 }, 14256 "triggerCalls" : { 14257 "type" : "integer", 14258 "format" : "int64", 14259 "example" : 5, 14260 "description" : "Endpoint call count to run task|plan " 14261 }, 14262 "triggerTimeout" : { 14263 "type" : "integer", 14264 "format" : "int64", 14265 "example" : 30000, 14266 "description" : "Time after which the task will starts from the moment the endpoint is first called " 14267 }, 14268 "runAsUser" : { 14269 "type" : "string", 14270 "example" : "admin", 14271 "description" : "The user on behalf of whom the task will be launched" 14272 }, 14273 "newUrl" : { 14274 "type" : "boolean", 14275 "example" : true, 14276 "description" : "Indicates whether to generate new url" 14277 }, 14278 "url" : { 14279 "type" : "string", 14280 "description" : "Webhook url" 14281 } 14282 } 14283 }, 14284 "Workspace" : { 14285 "type" : "object", 14286 "properties" : { 14287 "id" : { 14288 "type" : "string" 14289 }, 14290 "name" : { 14291 "type" : "string" 14292 }, 14293 "description" : { 14294 "type" : "string" 14295 }, 14296 "createDate" : { 14297 "type" : "string", 14298 "format" : "date-time" 14299 }, 14300 "updateDate" : { 14301 "type" : "string", 14302 "format" : "date-time" 14303 }, 14304 "type" : { 14305 "type" : "string", 14306 "enum" : [ "Shared", "Personal", "Custom" ] 14307 }, 14308 "owner" : { 14309 "type" : "string" 14310 }, 14311 "ownerFullName" : { 14312 "type" : "string" 14313 }, 14314 "environmentId" : { 14315 "type" : "string" 14316 }, 14317 "protectedTaskArtifactUpdate" : { 14318 "type" : "boolean" 14319 } 14320 } 14321 }, 14322 "WorkspaceInfo" : { 14323 "type" : "object", 14324 "properties" : { 14325 "id" : { 14326 "type" : "string", 14327 "example" : "57f64991e4b0b689a64feed2", 14328 "description" : "Workspace identifier" 14329 }, 14330 "name" : { 14331 "type" : "string", 14332 "example" : "Personal", 14333 "description" : "Workspace name" 14334 }, 14335 "description" : { 14336 "type" : "string", 14337 "example" : "workspace detail description", 14338 "description" : "Workspace description" 14339 }, 14340 "owner" : { 14341 "type" : "string", 14342 "example" : "admin", 14343 "description" : "Workspace owner" 14344 }, 14345 "type" : { 14346 "type" : "string", 14347 "example" : "custom", 14348 "description" : "Workspace type", 14349 "enum" : [ "shared", "personal", "custom" ] 14350 }, 14351 "environment" : { 14352 "description" : "Workspace environment", 14353 "$ref" : "#/definitions/EnvironmentInfo" 14354 }, 14355 "protectedArtifactUpdate" : { 14356 "type" : "boolean", 14357 "example" : false, 14358 "description" : "Task update with workspace artifact only" 14359 } 14360 } 14361 }, 14362 "WorkspacePromotionResult" : { 14363 "type" : "object", 14364 "properties" : { 14365 "id" : { 14366 "type" : "string", 14367 "description" : "Artifact ID" 14368 }, 14369 "targetId" : { 14370 "type" : "string", 14371 "description" : "Target Artifact ID" 14372 }, 14373 "name" : { 14374 "type" : "string", 14375 "description" : "Artifact Name" 14376 }, 14377 "type" : { 14378 "type" : "string", 14379 "example" : "WORKSPACE", 14380 "description" : "Artifact Type", 14381 "enum" : [ "WORKSPACE", "PLAN", "FLOW", "ACTION", "CONNECTION", "RESOURCE", "ENGINE", "CLUSTER" ] 14382 }, 14383 "analyzeReport" : { 14384 "description" : "Promotion Analyze Report", 14385 "$ref" : "#/definitions/Report" 14386 }, 14387 "promotionReport" : { 14388 "description" : "Promotion Report", 14389 "$ref" : "#/definitions/Report" 14390 }, 14391 "workspaceId" : { 14392 "type" : "string", 14393 "description" : "Workspace id" 14394 }, 14395 "targetVersion" : { 14396 "type" : "string", 14397 "description" : "Artifact target version" 14398 }, 14399 "version" : { 14400 "type" : "string", 14401 "description" : "Artifact version" 14402 }, 14403 "flows" : { 14404 "type" : "array", 14405 "description" : "Flows Promotion Execution Info", 14406 "items" : { 14407 "$ref" : "#/definitions/FlowPromotionResult" 14408 } 14409 }, 14410 "plans" : { 14411 "type" : "array", 14412 "description" : "Plans Promotion Execution Info", 14413 "items" : { 14414 "$ref" : "#/definitions/ArtifactPromotionResult" 14415 } 14416 }, 14417 "actions" : { 14418 "type" : "array", 14419 "description" : "Actions Promotion Execution Info", 14420 "items" : { 14421 "$ref" : "#/definitions/ArtifactPromotionResult" 14422 } 14423 }, 14424 "connections" : { 14425 "type" : "array", 14426 "description" : "Connections Promotion Execution Info", 14427 "items" : { 14428 "$ref" : "#/definitions/ArtifactPromotionResult" 14429 } 14430 }, 14431 "resources" : { 14432 "type" : "array", 14433 "description" : "Resources Promotion Execution Info", 14434 "items" : { 14435 "$ref" : "#/definitions/ArtifactPromotionResult" 14436 } 14437 }, 14438 "engines" : { 14439 "type" : "array", 14440 "description" : "Engines Promotion Execution Info", 14441 "items" : { 14442 "$ref" : "#/definitions/RuntimePromotionResult" 14443 } 14444 }, 14445 "clusters" : { 14446 "type" : "array", 14447 "description" : "Clusters Promotion Execution Info", 14448 "items" : { 14449 "$ref" : "#/definitions/RuntimePromotionResult" 14450 } 14451 }, 14452 "workspaceType" : { 14453 "type" : "string", 14454 "description" : "Workspace type" 14455 } 14456 } 14457 }, 14458 "YarnStrategy" : { 14459 "type" : "object", 14460 "required" : [ "type" ], 14461 "properties" : { 14462 "type" : { 14463 "type" : "string", 14464 "description" : "Yarn strategy type", 14465 "enum" : [ "Fixed", "Dynamic" ] 14466 }, 14467 "initialExecutors" : { 14468 "type" : "integer", 14469 "format" : "int32", 14470 "description" : "Initial number of executors (for Dynamic strategy)" 14471 }, 14472 "minExecutors" : { 14473 "type" : "integer", 14474 "format" : "int32", 14475 "description" : "Min. number of executors (for Dynamic strategy)" 14476 }, 14477 "maxExecutors" : { 14478 "type" : "integer", 14479 "format" : "int32", 14480 "description" : "Max. number of executors (for Dynamic strategy)" 14481 }, 14482 "coresPerExecutor" : { 14483 "type" : "integer", 14484 "format" : "int32", 14485 "description" : "Cores per executor" 14486 }, 14487 "executorMemory" : { 14488 "type" : "integer", 14489 "format" : "int32", 14490 "description" : "Executor memory (in MB)" 14491 }, 14492 "executorsNumber" : { 14493 "type" : "integer", 14494 "format" : "int32", 14495 "description" : "Number of executors (for Fixed strategy)" 14496 } 14497 } 14498 } 14499 } 14500 }