OBJECT
Mutation
Mutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.
link GraphQL Schema definition
1 type Mutation { 2 3 # Create a new temporal data object 4 # Example: 5 # Request: 6 # mutation { 7 # 8 # createTDO(input: { 9 # 10 # startDateTime: 1623253937, 11 # 12 # stopDateTime: 1623259000, 13 # 14 # source: "123", 15 # 16 # name: "example", 17 # 18 # description: "example", 19 # 20 # isPublic: false, 21 # 22 # applicationId: "123"}) { 23 # 24 # id 25 # 26 # name 27 # 28 # } 29 # } 30 # Response: 31 # { 32 # 33 # "data": { 34 # 35 # "createTDO": { 36 # 37 # "id": "1570654874", 38 # 39 # "name": "example" 40 # 41 # } 42 # 43 # } 44 # } 45 # 46 # Arguments 47 # input: Fields required to create a TDO 48 CreateTDO): TemporalDataObject ( : 49 50 # Update a temporal data object 51 # Example: 52 # Request: 53 # mutation { 54 # 55 # updateTDO(input:{ 56 # 57 # id: "1570654874", 58 # 59 # status: "example", 60 # 61 # name: "example"}) { 62 # 63 # id 64 # 65 # name 66 # 67 # description 68 # 69 # } 70 # } 71 # Result: 72 # { 73 # 74 # "data": { 75 # 76 # "updateTDO": { 77 # 78 # "id": "1570654874", 79 # 80 # "name": "example", 81 # 82 # "description": null 83 # 84 # } 85 # 86 # } 87 # } 88 # 89 # Arguments 90 # input: Fields required to update a TDO 91 UpdateTDO): TemporalDataObject ( : 92 93 # Delete a temporal data object. The TDO metadata, its assets and 94 # all storage objects, and search index data are deleted. 95 # Engine results stored in related task objects are not. 96 # cleanupTDO can be used to selectively delete certain data on the TDO. 97 # Example: 98 # Request: 99 # mutation { 100 # 101 # deleteTDO( 102 # 103 # id: "1570654874") { 104 # 105 # id 106 # 107 # message 108 # 109 # } 110 # } 111 # Response: 112 # 113 # { 114 # 115 # "data": { 116 # 117 # "deleteTDO": { 118 # 119 # "id": "1570654874", 120 # 121 # "message": "TemporalDataObject 1570654874 and all associated asset content was 122 # deleted." 123 # 124 # } 125 # 126 # } 127 # } 128 # 129 # Arguments 130 # id: Supply the ID of the TDO to delete 131 ID!): DeletePayload ( : 132 133 # Delete partial information from a temporal data object. 134 # Use the delete options to control exactly which data is deleted. 135 # The default is to delete objects from storage and the search index, 136 # while leaving TDO-level metadata and task engine results intact. 137 # To permanently delete the TDO, use delete TDO. 138 # Example: 139 # Request: 140 # mutation { 141 # 142 # cleanupTDO( 143 # 144 # id: "1570705980") { 145 # 146 # id 147 # 148 # message 149 # 150 # } 151 # } 152 # Response: 153 # { 154 # 155 # "data": { 156 # 157 # "cleanupTDO": { 158 # 159 # "id": "1570705980", 160 # 161 # "message": null 162 # 163 # } 164 # 165 # } 166 # } 167 # 168 # Arguments 169 # id: Supply the ID of the TDO to clean up. 170 # options: Supply a list of cleanup options. See TDOCleanupOption 171 # for details. If not provided, the server will use default settings. 172 ID!, : [TDOCleanupOption!]): DeletePayload ( : 173 174 # Create a task log by using 175 # multipart form POST. 176 # 177 # Arguments 178 # input: Fields needed to create a task log. 179 CreateTaskLog!): TaskLog ( : 180 181 # Create a media asset. Optionally, upload content using 182 # multipart form POST. 183 # example: 184 # Request: 185 # mutation { 186 # 187 # createAsset(input: { 188 # 189 # containerId: "1570654874", 190 # 191 # contentType: "application/json", 192 # 193 # description: "example", 194 # 195 # file: null, 196 # 197 # assetType: "text", 198 # 199 # uri: "example" 200 # 201 # name: "example"}) { 202 # 203 # id 204 # 205 # name 206 # 207 # description 208 # 209 # } 210 # } 211 # Response: 212 # { 213 # 214 # "data": { 215 # 216 # "createAsset": { 217 # 218 # "id": "1570654874_4hJtNKSUXD", 219 # 220 # "name": "example", 221 # 222 # "description": "example" 223 # 224 # } 225 # 226 # } 227 # } 228 # 229 # Arguments 230 # input: Fields needed to create an asset. 231 CreateAsset!): Asset ( : 232 233 # Delete an asset 234 # Example: 235 # Request: 236 # mutation { 237 # 238 # deleteAsset( 239 # 240 # id: "1570705980_w4ZLCPU7Dk") { 241 # 242 # id 243 # 244 # message 245 # 246 # } 247 # } 248 # Response: 249 # { 250 # 251 # "data": { 252 # 253 # "deleteAsset": { 254 # 255 # "id": "1570705980_w4ZLCPU7Dk", 256 # 257 # "message": "No storage objects deleted for example" 258 # 259 # } 260 # 261 # } 262 # } 263 # 264 # Arguments 265 # id: Provide the ID of the asset to delete. 266 ID!): DeletePayload ( : 267 268 # Update an asset 269 # Example: 270 # Request: 271 # mutation { 272 # 273 # updateAsset(input: { 274 # 275 # id: "1570705980_w4ZLCPU7Dk", 276 # 277 # description: "example", 278 # 279 # name: "example", 280 # 281 # fileData: null, 282 # 283 # sourceData: null, 284 # 285 # details: null}) { 286 # 287 # id 288 # 289 # name 290 # 291 # contentType 292 # 293 # } 294 # } 295 # Result: 296 # { 297 # 298 # "data": { 299 # 300 # "updateAsset": { 301 # 302 # "id": "1570705980_w4ZLCPU7Dk", 303 # 304 # "name": "example", 305 # 306 # "contentType": "application/json" 307 # 308 # } 309 # 310 # } 311 # } 312 # 313 # Arguments 314 # input: Fields needed to update an asset. 315 UpdateAsset!): Asset ( : 316 317 # Add a single media segment to a TemporalDataObject. 318 # This mutation will update the manifest asset (`media-mdp`) 319 # for the TemporalDataObject. 320 # Example: 321 # Request: 322 # mutation { 323 # 324 # addMediaSegment(input: { 325 # 326 # containerId: "1570705980", 327 # 328 # details: [], 329 # 330 # url: 331 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg", 332 # 333 # segmentGroupId: "123"}) { 334 # 335 # id 336 # 337 # name 338 # 339 # createdBy 340 # 341 # } 342 # } 343 # Response: 344 # { 345 # 346 # "data": { 347 # 348 # "addMediaSegment": { 349 # 350 # "id": "1570705980", 351 # 352 # "name": "example", 353 # 354 # "createdBy": null 355 # 356 # } 357 # 358 # } 359 # } 360 # 361 # Arguments 362 # input: Fields necesary to create the segment. 363 AddMediaSegment!): TemporalDataObject! ( : 364 365 # Add a media segments to a TemporalDataObject. 366 # This mutation will update the manifest asset (`media-mdp`) 367 # for the TemporalDataObject. 368 # Example: 369 # Request: 370 # mutation { 371 # 372 # addMediaSegments( 373 # 374 # containerId: "1570705980", 375 # 376 # segments: [ 377 # 378 # { 379 # 380 # details: [], 381 # 382 # url: 383 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg", 384 # 385 # }, 386 # 387 # { 388 # 389 # details: [], 390 # 391 # url: 392 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg" 393 # 394 # } 395 # 396 # ] 397 # 398 # segmentGroupId: "123") { 399 # 400 # id 401 # 402 # name 403 # 404 # 405 # } 406 # } 407 # Response: 408 # { 409 # 410 # "data": { 411 # 412 # "addMediaSegments": { 413 # 414 # "id": "1570705980", 415 # 416 # "name": "example" 417 # 418 # } 419 # 420 # } 421 # } 422 # 423 # Arguments 424 # containerId: ID of the TemporalDataObject container for the 425 # segment 426 # segments: Fields necesary to create the segment. 427 # segmentGroupId: ID of the segment group (Optional) 428 ( 429 ID!, : 430 AddMediaSegments]!, : [ 431 ID : 432 ): TemporalDataObject! 433 434 # Start a clone job. A clone creates a new TDO 435 # that links back to an existing TDO's assets 436 # instead of creating new ones and is used 437 # primarily to handle sample media. 438 # Only for internal platform components. 439 # Example: 440 # Request: 441 # mutation { 442 # 443 # requestClone(input: { 444 # 445 # sourceApplicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", 446 # 447 # destinationApplicationId:"5908703b-51b4-4291-9787-b54bada73b0a", 448 # 449 # cloneBlobs: true}) { 450 # 451 # id 452 # 453 # status 454 # 455 # } 456 # } 457 # Response: 458 # { 459 # 460 # "data": { 461 # 462 # "requestClone": null 463 # 464 # } 465 # } 466 # 467 # Arguments 468 # input: Fields needed to request a new clone job. 469 RequestClone): CloneRequest ( : 470 471 # Create a new engine. The engine will need to go 472 # through a sequence of workflow steps before 473 # use in production. See VDA documentation for details. 474 # Example: 475 # Request: 476 # mutation { 477 # 478 # createEngine(input: { 479 # 480 # id: "123", 481 # 482 # name: "example", 483 # 484 # categoryId: "581dbb32-ea5b-4458-bd15-8094942345e3", 485 # 486 # deploymentModel: FullyNetworkIsolated 487 # 488 # useCases: [], 489 # 490 # industries: []}) { 491 # 492 # id 493 # 494 # ownerOrganizationId 495 # 496 # } 497 # } 498 # Response: 499 # { 500 # 501 # "data": { 502 # 503 # "createEngine": { 504 # 505 # "id": "123", 506 # 507 # "ownerOrganizationId": "35521" 508 # 509 # } 510 # 511 # } 512 # } 513 # 514 # Arguments 515 # input: Fields needed to create a new engine 516 CreateEngine): Engine ( : 517 518 # Update an engine. Engines are subject to specific 519 # workflow steps. An engine's state determines what 520 # updates can be made to it. See VDA documentation for 521 # details. 522 # Example: 523 # Request: 524 # mutation { 525 # 526 # updateEngine(input: { 527 # 528 # id:"123", 529 # 530 # isPublic: false, 531 # 532 # name: "example", 533 # 534 # deploymentModel: FullyNetworkIsolated, 535 # 536 # price: 1}) { 537 # 538 # id 539 # 540 # ownerOrganizationId 541 # 542 # name 543 # 544 # price 545 # 546 # } 547 # } 548 # Response: 549 # { 550 # 551 # "data": { 552 # 553 # "updateEngine": { 554 # 555 # "id": "123", 556 # 557 # "ownerOrganizationId": "35521", 558 # 559 # "name": "example", 560 # 561 # "price": 1 562 # 563 # } 564 # 565 # } 566 # } 567 # 568 # Arguments 569 # input: Fields needed to update an engine 570 UpdateEngine): Engine ( : 571 572 # Delete an engine 573 # Example: 574 # Request: 575 # mutation { 576 # 577 # deleteEngine( 578 # 579 # id: "123") { 580 # 581 # id 582 # 583 # message 584 # 585 # } 586 # } 587 # Response: 588 # { 589 # 590 # "data": { 591 # 592 # "deleteEngine": { 593 # 594 # "id": "123", 595 # 596 # "message": "engine 123 deleted" 597 # 598 # } 599 # 600 # } 601 # } 602 # 603 # Arguments 604 # id: Provide the ID of the engine to delete 605 ID!): DeletePayload ( : 606 607 # Create an engine build. 608 # Example: 609 # Request: 610 # 611 # mutation { 612 # 613 # createEngineBuild(input: { 614 # 615 # engineId: "1", 616 # 617 # taskRuntime: [], 618 # 619 # dockerImage: "build", 620 # 621 # manifest: [] }) { 622 # 623 # id 624 # 625 # name 626 # 627 # engineId 628 # 629 # 630 # } 631 # } 632 # Response: 633 # { 634 # 635 # "data": { 636 # 637 # "createEngineBuild": { 638 # 639 # "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a", 640 # 641 # "name": "example Version 1", 642 # 643 # "engineId": "1" 644 # 645 # } 646 # 647 # } 648 # } 649 # 650 # Arguments 651 # input: Fields needed to create an engine build. 652 CreateBuild!): Build ( : 653 654 # Update an engine build. Engine builds are subject to 655 # specific workflow steps. A build's state determines what 656 # updates can be made to it. See VDA documentation for details. 657 # Example: 658 # Request: 659 # mutation { 660 # 661 # updateEngineBuild(input: { 662 # 663 # id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c", 664 # 665 # engineId: "1", 666 # 667 # action: update, 668 # 669 # taskRuntime: []}) { 670 # 671 # id 672 # 673 # name 674 # 675 # } 676 # } 677 # Response: 678 # { 679 # 680 # "data": { 681 # 682 # "updateEngineBuild": { 683 # 684 # "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c", 685 # 686 # "name": "example Version 3" 687 # 688 # } 689 # 690 # } 691 # } 692 # 693 # Arguments 694 # input: Fields needed to update an engine build. 695 UpdateBuild!): Build ( : 696 697 # Delete an engine build 698 # Example: 699 # Request: 700 # mutation { 701 # 702 # deleteEngineBuild(input: { 703 # 704 # id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c", 705 # 706 # engineId: "1"}) { 707 # 708 # id 709 # 710 # message 711 # 712 # } 713 # } 714 # Response: 715 # { 716 # 717 # "data": { 718 # 719 # "deleteEngineBuild": { 720 # 721 # "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c", 722 # 723 # "message": "Engine build 6f766576-03a9-42c4-8a96-f4cd932e7c6c deleted" 724 # 725 # } 726 # 727 # } 728 # } 729 # 730 # Arguments 731 # input: Fields needed to delete an engine build. 732 DeleteBuild!): DeletePayload ( : 733 734 # Update a task 735 # 736 # Arguments 737 # input: Fields required to update a task. 738 UpdateTask): Task ( : 739 740 # Arguments 741 # reason: Short string describing the warning 742 # message: Optional: the actual problem 743 # referenceId: Optional: Reference ID for the warning, such as 744 # assetId, or sourceId 745 ( 746 ID, : 747 String!, : 748 String, : 749 ID : 750 ): ID 751 752 AddTasksToJobs): AddTasksToJobsResponse ( : 753 754 # Create a job 755 # 756 # Arguments 757 # input: Fields required to create a job. 758 CreateJob): Job ( : 759 760 # Cancel a job. This action effectively deletes the job, 761 # although a records of job and task execution remains in 762 # Veritone's database. 763 # 764 # Arguments 765 # id: Supply the ID of the job to delete. 766 ID!): DeletePayload ( : 767 768 # Retry a job. This action applies only to jobs 769 # that are in a failure state. The task sequence 770 # for the job will be restarted in its original 771 # configuration. 772 # 773 # Arguments 774 # id: Supply the ID of the job to retry. 775 ID!): Job ( : 776 777 # Create and launch a job executing a single engine, 778 # using the default engine DAG definition modified with the 779 # supplied field values 780 SingleEngineJobInput!): Job ( : 781 782 UpdateJobs!): JobList ( : 783 784 # Create a new application. An application must 785 # go through a sequence of workflow steps before 786 # it is available in production. See the VDA documentation 787 # for details. 788 # Example: 789 # Request: 790 # mutation { 791 # 792 # createApplication(input: { 793 # 794 # name: "example123", 795 # 796 # key: "example123", 797 # 798 # category: "example", 799 # 800 # url: "www.veritone.com", 801 # 802 # checkPermissions: true}) { 803 # 804 # id 805 # 806 # name 807 # 808 # } 809 # } 810 # Response: 811 # { 812 # 813 # "data": { 814 # 815 # "createApplication": { 816 # 817 # "id": "7e863365-94de-4ac9-8826-df1a398c9a21", 818 # 819 # "name": "example123" 820 # 821 # } 822 # 823 # } 824 # } 825 # 826 # Arguments 827 # input: Fields needed to create a new custom application. 828 CreateApplication): Application ( : 829 830 # Delete an application 831 # Example: 832 # Request: 833 # mutation { 834 # 835 # deleteApplication( 836 # 837 # id: "7e863365-94de-4ac9-8826-df1a398c9a21") { 838 # 839 # id 840 # 841 # message 842 # 843 # } 844 # } 845 # Response: 846 # { 847 # 848 # "data": { 849 # 850 # "deleteApplication": { 851 # 852 # "id": "7e863365-94de-4ac9-8826-df1a398c9a21", 853 # 854 # "message": null 855 # 856 # } 857 # 858 # } 859 # } 860 # 861 # Arguments 862 # id: Supply the ID of the application to delete. 863 ID!): DeletePayload ( : 864 865 # Update a custom application. Applications are subject to 866 # specific workflows. The current application state determines 867 # what updates can be made to it. See VDA documentation for details. 868 # Example: 869 # Request: 870 # mutation { 871 # 872 # updateApplication(input: { 873 # 874 # name: "example123", 875 # 876 # id: "7e863365-94de-4ac9-8826-df1a398c9a21" 877 # 878 # category: "example", 879 # 880 # url: "www.veritone.com", 881 # 882 # checkPermissions: true, 883 # 884 # oauth2RedirectUrls: [], 885 # 886 # permissionsRequired: []}) { 887 # 888 # id 889 # 890 # name 891 # 892 # url 893 # 894 # } 895 # } 896 # Response: 897 # { 898 # 899 # "data": { 900 # 901 # "updateApplication": { 902 # 903 # "id": "7e863365-94de-4ac9-8826-df1a398c9a21", 904 # 905 # "name": "example123", 906 # 907 # "url": "www.veritone.com" 908 # 909 # } 910 # 911 # } 912 # } 913 # 914 # Arguments 915 # input: Fields required to update a custom application. 916 UpdateApplication): Application ( : 917 918 # Update an application by adding or removing components 919 # Example: 920 # Request: 921 # mutation { 922 # 923 # updateApplicationComponent(input: { 924 # 925 # id: "5908703b-51b4-4291-9787-b54bada73b0a", 926 # 927 # componentIds: ["1"], 928 # 929 # type: engines, 930 # 931 # action: add}) { 932 # 933 # engines{ 934 # 935 # records{ 936 # 937 # id 938 # 939 # } 940 # 941 # } 942 # 943 # } 944 # } 945 # Response: 946 # { 947 # 948 # "data": { 949 # 950 # "updateApplicationComponent": { 951 # 952 # "engines": { 953 # 954 # "records": [ 955 # 956 # { 957 # 958 # "id": "1" 959 # 960 # } 961 # 962 # ] 963 # 964 # } 965 # 966 # } 967 # 968 # } 969 # } 970 ( 971 UpdateApplicationComponent! : 972 ): ApplicationComponent! 973 974 # Update an application's billing plan id for an organization. 975 # Example: 976 # Request: 977 # mutation { 978 # 979 # updateApplicationBillingPlanId( 980 # 981 # applicationId:"32babe30-fb42-11e4-89bc-27b69865858a", 982 # 983 # organizationId: "35521", 984 # 985 # billingPlanId: "123") { 986 # 987 # applicationId 988 # 989 # billingDirty 990 # 991 # } 992 # } 993 # Response: 994 # { 995 # 996 # "data": { 997 # 998 # "updateApplicationBillingPlanId": { 999 # 1000 # "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a", 1001 # 1002 # "billingDirty": true 1003 # 1004 # } 1005 # 1006 # } 1007 # } 1008 ( 1009 ID!, : 1010 ID!, : 1011 String! : 1012 ): ApplicationBillingPlanId! 1013 1014 # Update an application's billing dirty for an organization. 1015 # Example: 1016 # Request: 1017 # mutation { 1018 # 1019 # updateApplicationBillingDirty( 1020 # 1021 # applicationId: "32babe30-fb42-11e4-89bc-27b69865858a", 1022 # 1023 # organizationId: "35521", 1024 # 1025 # billingDirty: false) { 1026 # 1027 # applicationId 1028 # 1029 # billingDirty 1030 # 1031 # } 1032 # } 1033 # Response: 1034 # { 1035 # 1036 # "data": { 1037 # 1038 # "updateApplicationBillingDirty": { 1039 # 1040 # "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a", 1041 # 1042 # "billingDirty": false 1043 # 1044 # } 1045 # 1046 # } 1047 # } 1048 ( 1049 ID!, : 1050 ID!, : 1051 Boolean! : 1052 ): ApplicationBillingDirty! 1053 1054 # Bulk delete context menu extensions. 1055 # Example: 1056 # Request: 1057 # mutation { 1058 # 1059 # bulkDeleteContextMenuExtensions(input: { 1060 # 1061 # ids: []}) { 1062 # 1063 # mentions{ 1064 # 1065 # id 1066 # 1067 # } 1068 # 1069 # } 1070 # } 1071 # Response: 1072 # { 1073 # 1074 # "data": { 1075 # 1076 # "bulkDeleteContextMenuExtensions": { 1077 # 1078 # "mentions": [] 1079 # 1080 # } 1081 # 1082 # } 1083 # } 1084 ( 1085 BulkDeleteContextMenuExtensions : 1086 ): ContextMenuExtensionList 1087 1088 # Update an organization 1089 # Example: 1090 # Request: 1091 # mutation { 1092 # 1093 # updateOrganization(input: { 1094 # 1095 # id: "35521", 1096 # 1097 # indexTDOsByDefault: true}) { 1098 # 1099 # id 1100 # 1101 # status 1102 # 1103 # } 1104 # } 1105 # Response: 1106 # { 1107 # 1108 # "data": { 1109 # 1110 # "updateOrganization": { 1111 # 1112 # "id": "35521", 1113 # 1114 # "status": "active" 1115 # 1116 # } 1117 # 1118 # } 1119 # } 1120 # 1121 # Arguments 1122 # input: Fields required to update an organization. 1123 UpdateOrganization!): Organization ( : 1124 1125 # Update organization billing policy. Requires superadmin 1126 # 1127 # Arguments 1128 # planId: External billing plan id. 1129 # targetOrganizationId: Optional organization id, to use when the 1130 # caller is a superadmin from a different org 1131 ( 1132 String!, : 1133 ID : 1134 ): OrganizationBilling 1135 1136 SetEngineWhitelist!): EngineWhitelist ( : 1137 1138 SetEngineBlacklist!): EngineBlacklist ( : 1139 1140 ( 1141 SetEngineBlacklist! : 1142 ): EngineBlacklist 1143 1144 ( 1145 SetEngineBlacklist! : 1146 ): EngineWhitelist 1147 1148 # Create an entity identifier type, such as "face" or "image". 1149 # Entity identifier types are typically created or modified 1150 # only by Veritone engineering. Most libraries and 1151 # entities will use existing entity identifier types. 1152 # Example: 1153 # Request: 1154 # mutation { 1155 # 1156 # createEntityIdentifierType(input: { 1157 # 1158 # label: "example" 1159 # 1160 # labelPlural: "example" 1161 # 1162 # iconClass: null 1163 # 1164 # description: "example" 1165 # 1166 # dataType: text 1167 # 1168 # id: "123"}) { 1169 # 1170 # id 1171 # 1172 # description 1173 # 1174 # } 1175 # } 1176 # Response: 1177 # { 1178 # 1179 # "data": { 1180 # 1181 # "createEntityIdentifierType": { 1182 # 1183 # "id": "123", 1184 # 1185 # "description": null 1186 # 1187 # } 1188 # 1189 # } 1190 # } 1191 # 1192 # Arguments 1193 # input: Fields required to create an entity identifier type. 1194 ( 1195 CreateEntityIdentifierType! : 1196 ): EntityIdentifierType 1197 1198 # Update an entity identifier type. 1199 # Example: 1200 # Request: 1201 # mutation { 1202 # 1203 # updateEntityIdentifierType(input: { 1204 # 1205 # id: "123", 1206 # 1207 # label: "example", 1208 # 1209 # labelPlural: "example" 1210 # 1211 # description: "new description", 1212 # 1213 # dataType: image}) { 1214 # 1215 # id 1216 # 1217 # description 1218 # 1219 # } 1220 # } 1221 # Response: 1222 # { 1223 # 1224 # "data": { 1225 # 1226 # "updateEntityIdentifierType": null 1227 # 1228 # } 1229 # } 1230 # 1231 # Arguments 1232 # input: Fields required to update an entity identifier type. 1233 ( 1234 UpdateEntityIdentifierType! : 1235 ): EntityIdentifierType 1236 1237 # Create a library type, such as "ad" or "people". 1238 # Entity identifier types are typically created or modified 1239 # only by Veritone engineering. Most libraries 1240 # will use existing entity identifier types. 1241 # Example: 1242 # Request: 1243 # mutation { 1244 # 1245 # createLibraryType(input: { 1246 # 1247 # id: "123", 1248 # 1249 # label: "example", 1250 # 1251 # entityIdentifierTypeIds: ["123"], 1252 # 1253 # entityType: { 1254 # 1255 # name: "example", 1256 # 1257 # namePlural: "example", 1258 # 1259 # schema: { 1260 # 1261 # example: "example" }}}) { 1262 # 1263 # id 1264 # 1265 # label 1266 # 1267 # } 1268 # } 1269 # Response: 1270 # { 1271 # 1272 # "data": { 1273 # 1274 # "createLibraryType": { 1275 # 1276 # "id": "123", 1277 # 1278 # "label": "example" 1279 # 1280 # } 1281 # 1282 # } 1283 # } 1284 # 1285 # Arguments 1286 # input: Fields needed to create a new library type. 1287 CreateLibraryType!): LibraryType ( : 1288 1289 # Update a library type. 1290 # Example: 1291 # Request: 1292 # mutation { 1293 # 1294 # updateLibraryType(input: { 1295 # 1296 # id: "123", 1297 # 1298 # label: "example", 1299 # 1300 # entityIdentifierTypeIds: ["123"], 1301 # 1302 # entityType: { 1303 # 1304 # name: "example", 1305 # 1306 # namePlural: "example", 1307 # 1308 # schema: { 1309 # 1310 # example: "new example" }}}) { 1311 # 1312 # id 1313 # 1314 # label 1315 # 1316 # } 1317 # } 1318 # Response: 1319 # { 1320 # 1321 # "data": { 1322 # 1323 # "updateLibraryType": null 1324 # 1325 # } 1326 # } 1327 # 1328 # Arguments 1329 # input: Fields needed to update a library type. 1330 UpdateLibraryType!): LibraryType ( : 1331 1332 # Create a new library. 1333 # Once the library is created, the client can add 1334 # entities and entity identifiers. Note that the 1335 # library type determines what types of entity identifiers 1336 # can be used within the library. 1337 # Example: 1338 # Request: 1339 # mutation { 1340 # 1341 # createLibrary(input: { 1342 # 1343 # name: "example" 1344 # 1345 # applicationId: "32babe30-fb42-11e4-89bc-27b69865858a" 1346 # 1347 # organizationId: "35521" 1348 # 1349 # libraryTypeId: "123" 1350 # 1351 # coverImageUrl: 1352 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg" 1353 # 1354 # description: "example"}) { 1355 # 1356 # id 1357 # 1358 # name 1359 # 1360 # } 1361 # } 1362 # Response: 1363 # { 1364 # 1365 # "data": { 1366 # 1367 # "createLibrary": { 1368 # 1369 # "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1370 # 1371 # "name": "example" 1372 # 1373 # } 1374 # 1375 # } 1376 # } 1377 # 1378 # Arguments 1379 # input: Fields needed to create a new library. 1380 CreateLibrary!): Library ( : 1381 1382 # Update an existing library. 1383 # Example: 1384 # Request: 1385 # mutation { 1386 # 1387 # updateLibrary(input: { 1388 # 1389 # id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1390 # 1391 # name: "example" 1392 # 1393 # coverImageUrl: 1394 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg" 1395 # 1396 # description: "new description" 1397 # 1398 # libraryTypeId: "123" 1399 # 1400 # version: 2}) { 1401 # 1402 # id 1403 # 1404 # name 1405 # 1406 # description 1407 # 1408 # } 1409 # } 1410 # Response: 1411 # { 1412 # 1413 # "data": { 1414 # 1415 # "updateLibrary": { 1416 # 1417 # "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1418 # 1419 # "name": "example", 1420 # 1421 # "description": "new description" 1422 # 1423 # } 1424 # 1425 # } 1426 # } 1427 # 1428 # Arguments 1429 # input: Fields needed to update a library 1430 UpdateLibrary!): Library ( : 1431 1432 # Delete a library. This mutation will also delete all entities, 1433 # entity identifiers, library engine models, and associated objects. 1434 # Example: 1435 # Request: 1436 # mutation { 1437 # 1438 # deleteLibrary(id:"d232c90f-ae47-4125-b884-0d35fbed7e5f") { 1439 # 1440 # message 1441 # 1442 # } 1443 # } 1444 # Response: 1445 # { 1446 # 1447 # "data": { 1448 # 1449 # "deleteLibrary": { 1450 # 1451 # "message": "d232c90f-ae47-4125-b884-0d35fbed7e5f deleted" 1452 # 1453 # } 1454 # 1455 # } 1456 # } 1457 # 1458 # Arguments 1459 # id: Provide the ID of the library to delete. 1460 ID!): DeletePayload ( : 1461 1462 # Publish a new version of a library. 1463 # Increments library version by one and trains compatible engines. 1464 # Example: 1465 # Request: 1466 # mutation { 1467 # 1468 # publishLibrary( 1469 # 1470 # id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") { 1471 # 1472 # name 1473 # 1474 # description 1475 # 1476 # version 1477 # 1478 # } 1479 # } 1480 # Response: 1481 # { 1482 # 1483 # "data": { 1484 # 1485 # "publishLibrary": { 1486 # 1487 # "name": "example", 1488 # 1489 # "description": "new description", 1490 # 1491 # "version": 2 1492 # 1493 # } 1494 # 1495 # } 1496 # } 1497 # 1498 # Arguments 1499 # id: ID of the library to publish 1500 ID!): Library ( : 1501 1502 # Create a new entity. 1503 # Example: 1504 # Request: 1505 # mutation { 1506 # 1507 # createEntity(input: { 1508 # 1509 # name: "example", 1510 # 1511 # description: "example", 1512 # 1513 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1514 # 1515 # jsondata: { 1516 # 1517 # example: "new example" }}) { 1518 # 1519 # id 1520 # 1521 # name 1522 # 1523 # } 1524 # } 1525 # Response: 1526 # { 1527 # 1528 # "data": { 1529 # 1530 # "createEntity": { 1531 # 1532 # "id": "85b700fa-f327-4fea-b94b-ed83054170db", 1533 # 1534 # "name": "example" 1535 # 1536 # } 1537 # 1538 # } 1539 # } 1540 # 1541 # Arguments 1542 # input: Fields required to create a new entity. 1543 CreateEntity!): Entity ( : 1544 1545 # Update an entity. 1546 # Example: 1547 # Request: 1548 # mutation { 1549 # 1550 # updateEntity(input: { 1551 # 1552 # id: "85b700fa-f327-4fea-b94b-ed83054170db", 1553 # 1554 # name: "example", 1555 # 1556 # description: "example", 1557 # 1558 # jsondata: { 1559 # 1560 # example: "updated example" }}) { 1561 # 1562 # id 1563 # 1564 # name 1565 # 1566 # jsondata 1567 # 1568 # } 1569 # } 1570 # Response: 1571 # { 1572 # 1573 # "data": { 1574 # 1575 # "updateEntity": { 1576 # 1577 # "id": "85b700fa-f327-4fea-b94b-ed83054170db", 1578 # 1579 # "name": "example", 1580 # 1581 # "jsondata": { 1582 # 1583 # "example": "updated example" 1584 # 1585 # } 1586 # 1587 # } 1588 # 1589 # } 1590 # } 1591 # 1592 # Arguments 1593 # input: Fields required to update an entity. 1594 UpdateEntity!): Entity ( : 1595 1596 # Delete an entity. This mutation will also delete all associated 1597 # entity identifiers and associated objects. 1598 # Example: 1599 # Request: 1600 # mutation { 1601 # 1602 # deleteEntity(id: "522bc6cf-5b7c-47bd-bd30-10cd77016a49") { 1603 # 1604 # message 1605 # 1606 # } 1607 # } 1608 # Response: 1609 # { 1610 # 1611 # "data": { 1612 # 1613 # "deleteEntity": { 1614 # 1615 # "message": "Entity 522bc6cf-5b7c-47bd-bd30-10cd77016a49 deleted." 1616 # 1617 # } 1618 # 1619 # } 1620 # } 1621 # 1622 # Arguments 1623 # id: Supply the ID of the entity to delete. 1624 ID!): DeletePayload ( : 1625 1626 # Create an entity identifier. 1627 # This mutation accepts file uploads. To use this mutation and upload a file, 1628 # send a multipart form POST containing two parameters: `query`, with the 1629 # GraphQL query, and `file` containing the file itself. 1630 # For more information see the documentation at 1631 # https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL. 1632 # Example: 1633 # Request: 1634 # mutation { 1635 # 1636 # createEntityIdentifier(input: { 1637 # 1638 # entityId: "85b700fa-f327-4fea-b94b-ed83054170db", 1639 # 1640 # identifierTypeId: "123", 1641 # 1642 # title: "example", 1643 # 1644 # isPriority: false, 1645 # 1646 # contentType: "example", 1647 # 1648 # url: 1649 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"}) 1650 # { 1651 # 1652 # id 1653 # 1654 # isPriority 1655 # 1656 # } 1657 # } 1658 # Result: 1659 # { 1660 # 1661 # "data": { 1662 # 1663 # "createEntityIdentifier": { 1664 # 1665 # "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe", 1666 # 1667 # "isPriority": false, 1668 # 1669 # } 1670 # 1671 # } 1672 # } 1673 # 1674 # Arguments 1675 # input: Fields needed to create an entity identifier. 1676 CreateEntityIdentifier!): EntityIdentifier ( : 1677 1678 # Updates an entity identifier. 1679 # Example: 1680 # Request: 1681 # mutation { 1682 # 1683 # updateEntityIdentifier(input: { 1684 # 1685 # id: "bf67e595-3666-4a0c-9f4b-0ad99a1770fe", 1686 # 1687 # title: "example", 1688 # 1689 # isPriority: true, 1690 # 1691 # url: 1692 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"}) 1693 # { 1694 # 1695 # id 1696 # 1697 # isPriority 1698 # 1699 # } 1700 # } 1701 # Response: 1702 # { 1703 # 1704 # "data": { 1705 # 1706 # "updateEntityIdentifier": { 1707 # 1708 # "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe", 1709 # 1710 # "isPriority": true 1711 # 1712 # } 1713 # 1714 # } 1715 # } 1716 # 1717 # Arguments 1718 # input: Fields required to update an entity identifier. 1719 UpdateEntityIdentifier!): EntityIdentifier ( : 1720 1721 # Delete an entity identifier 1722 # Example: 1723 # Request: 1724 # mutation { 1725 # 1726 # deleteEntityIdentifier(id: "0bda9fa6-9fad-4025-8f03-07cc73321050") { 1727 # 1728 # message 1729 # 1730 # } 1731 # } 1732 # Response: 1733 # { 1734 # 1735 # "data": { 1736 # 1737 # "deleteEntityIdentifier": { 1738 # 1739 # "message": "Entity identifier0bda9fa6-9fad-4025-8f03-07cc73321050 deleted." 1740 # 1741 # } 1742 # 1743 # } 1744 # } 1745 # 1746 # Arguments 1747 # id: Supply the ID of the entity identifier to delete. 1748 ID!): DeletePayload ( : 1749 1750 # Create a library engine model. 1751 # Example: 1752 # Request: 1753 # mutation { 1754 # 1755 # createLibraryEngineModel(input: { 1756 # 1757 # engineId: "1", 1758 # 1759 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1760 # 1761 # trainJobId: "123", 1762 # 1763 # dataUrl: 1764 # "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"}) 1765 # { 1766 # 1767 # id 1768 # 1769 # engineId 1770 # 1771 # } 1772 # } 1773 # Response: 1774 # { 1775 # 1776 # "data": { 1777 # 1778 # "createLibraryEngineModel": { 1779 # 1780 # "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b", 1781 # 1782 # "engineId": "1" 1783 # 1784 # } 1785 # 1786 # } 1787 # } 1788 # 1789 # Arguments 1790 # input: Fields required to create a library engine model. 1791 ( 1792 CreateLibraryEngineModel! : 1793 ): LibraryEngineModel 1794 1795 # Update a library engine model 1796 # Example: 1797 # Request: 1798 # mutation { 1799 # 1800 # updateLibraryEngineModel(input: { 1801 # 1802 # id: "0e9c25f7-d994-4363-af41-c00b37de9a1b", 1803 # 1804 # trainJobId: "1234"}) { 1805 # 1806 # trainJobId 1807 # 1808 # } 1809 # } 1810 # Response: 1811 # { 1812 # 1813 # "data": { 1814 # 1815 # "updateLibraryEngineModel": { 1816 # 1817 # "trainJobId": "1234" 1818 # 1819 # } 1820 # 1821 # } 1822 # } 1823 # 1824 # Arguments 1825 # input: Fields required to update a library engine model 1826 ( 1827 UpdateLibraryEngineModel! : 1828 ): LibraryEngineModel 1829 1830 # Delete a library engine model 1831 # Example: 1832 # Request: 1833 # mutation { 1834 # 1835 # deleteLibraryEngineModel( 1836 # 1837 # id: "0e9c25f7-d994-4363-af41-c00b37de9a1b") { 1838 # 1839 # id 1840 # 1841 # message 1842 # 1843 # } 1844 # } 1845 # Response: 1846 # { 1847 # 1848 # "data": { 1849 # 1850 # "deleteLibraryEngineModel": { 1851 # 1852 # "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b", 1853 # 1854 # "message": "library engine model 0e9c25f7-d994-4363-af41-c00b37de9a1b deleted." 1855 # 1856 # } 1857 # 1858 # } 1859 # } 1860 # 1861 # Arguments 1862 # id: Supply the ID of the library engine model to delete. 1863 ID!): DeletePayload ( : 1864 1865 # Create a library collaborator. 1866 # Example: 1867 # Request: 1868 # mutation { 1869 # 1870 # createLibraryCollaborator(input: { 1871 # 1872 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1873 # 1874 # organizationId: 35521, 1875 # 1876 # permissions: ["job.create"]}) { 1877 # 1878 # organizationId 1879 # 1880 # status 1881 # 1882 # } 1883 # } 1884 # Response: 1885 # { 1886 # 1887 # "data": { 1888 # 1889 # "createLibraryCollaborator": { 1890 # 1891 # "organizationId": "35521", 1892 # 1893 # "status": "active" 1894 # 1895 # } 1896 # 1897 # } 1898 # } 1899 # 1900 # Arguments 1901 # input: Fields required to create a library collaborator. 1902 ( 1903 CreateLibraryCollaborator! : 1904 ): LibraryCollaborator 1905 1906 # Update a library collaborator 1907 # Example: 1908 # Request: 1909 # mutation { 1910 # 1911 # updateLibraryCollaborator(input: { 1912 # 1913 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1914 # 1915 # organizationId: 35521, 1916 # 1917 # permissions: ["job.create", "job.read"]}) { 1918 # 1919 # status 1920 # 1921 # permissions 1922 # 1923 # } 1924 # } 1925 # Response: 1926 # { 1927 # 1928 # "data": { 1929 # 1930 # "updateLibraryCollaborator": { 1931 # 1932 # "status": "active", 1933 # 1934 # "permissions": [ 1935 # 1936 # "job.create" 1937 # 1938 # ] 1939 # 1940 # } 1941 # 1942 # } 1943 # } 1944 # 1945 # Arguments 1946 # input: Fields required to update a library collaborator 1947 ( 1948 UpdateLibraryCollaborator! : 1949 ): LibraryCollaborator 1950 1951 # Delete a library collaborator 1952 # Example: 1953 # Request: 1954 # mutation { 1955 # 1956 # deleteLibraryCollaborator( 1957 # 1958 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 1959 # 1960 # organizationId: "35521") { 1961 # 1962 # id 1963 # 1964 # message 1965 # 1966 # } 1967 # } 1968 # Response: 1969 # { 1970 # 1971 # "data": { 1972 # 1973 # "deleteLibraryCollaborator": { 1974 # 1975 # "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599 - 35521", 1976 # 1977 # "message": "library collaborator model libraryId: 1978 # e0a6e5ad-dec8-49a1-ad33-3f1194c2e599, organizationId: 35521 deleted." 1979 # 1980 # } 1981 # 1982 # } 1983 # } 1984 # 1985 # Arguments 1986 # libraryId: Supply the ID of the library collaborator to delete. 1987 # organizationId: Supply the ID of the library collaborator to 1988 # delete. 1989 ( 1990 ID!, : 1991 ID! : 1992 ): DeletePayload 1993 1994 # Create Dataset Library Configuration 1995 # Example 1996 # Request: 1997 # mutation { 1998 # 1999 # createLibraryConfiguration(input: { 2000 # 2001 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 2002 # 2003 # engineCategoryId: "c1e5f177-ca10-433a-a155-bb5e4872cf9a", 2004 # 2005 # targetEngineIds: ["1"], 2006 # 2007 # confidence: {}}) { 2008 # 2009 # id 2010 # 2011 # } 2012 # } 2013 # Response: 2014 # { 2015 # 2016 # "data": { 2017 # 2018 # "createLibraryConfiguration": { 2019 # 2020 # "id": "7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7" 2021 # 2022 # } 2023 # 2024 # } 2025 # } 2026 # 2027 # Arguments 2028 # input: Fields required to create library configuration 2029 ( 2030 CreateLibraryConfiguration! : 2031 ): LibraryConfiguration 2032 2033 # Update Dataset Library Configuration 2034 # 2035 # Arguments 2036 # input: Fields required to create library configuration 2037 ( 2038 UpdateLibraryConfiguration! : 2039 ): LibraryConfiguration 2040 2041 # Delete Dataset Library Configuration 2042 # 2043 # Arguments 2044 # id: Supply configuration ID to delete. 2045 ID!): DeletePayload ( : 2046 2047 # Add recordings to a dataset library 2048 # Example: 2049 # Request: 2050 # mutation { 2051 # 2052 # addLibraryDataset(input: { 2053 # 2054 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 2055 # 2056 # tdoIds: ["1570899328"]}) { 2057 # 2058 # tdoIds 2059 # 2060 # } 2061 # } 2062 # Response: 2063 # { 2064 # 2065 # "data": { 2066 # 2067 # "addLibraryDataset": { 2068 # 2069 # "tdoIds": [ 2070 # 2071 # "1570899328" 2072 # 2073 # ] 2074 # 2075 # } 2076 # 2077 # } 2078 # } 2079 AddLibraryDataset!): LibraryDataset ( : 2080 2081 # Remove recordings from a dataset library 2082 # Example: 2083 # Request: 2084 # mutation { 2085 # 2086 # deleteLibraryDataset(input: { 2087 # 2088 # libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599", 2089 # 2090 # tdoIds: ["1570899328"]}) { 2091 # 2092 # tdoIds 2093 # 2094 # message 2095 # 2096 # } 2097 # } 2098 # Response: 2099 # { 2100 # 2101 # "data": { 2102 # 2103 # "deleteLibraryDataset": { 2104 # 2105 # "tdoIds": [ 2106 # 2107 # "1570899328" 2108 # 2109 # ], 2110 # 2111 # "message": "[1570899328] are removed from e0a6e5ad-dec8-49a1-ad33-3f1194c2e599" 2112 # 2113 # } 2114 # 2115 # } 2116 # } 2117 DeleteLibraryDataset!): DeleteLibraryDatasetPayload ( : 2118 2119 # Apply an application workflow step, such as "submit" or "approve" 2120 # Example: 2121 # Request: 2122 # mutation { 2123 # 2124 # applicationWorkflow(input: { 2125 # 2126 # id: "dcc6a08e-1114-43e9-b74a-2b469a32f437", 2127 # 2128 # action: submit}) { 2129 # 2130 # id 2131 # 2132 # name 2133 # 2134 # } 2135 # } 2136 # Response: 2137 # { 2138 # 2139 # "data": { 2140 # 2141 # "applicationWorkflow": { 2142 # 2143 # "id": "dcc6a08e-1114-43e9-b74a-2b469a32f437", 2144 # 2145 # "name": "appexamplebill2" 2146 # 2147 # } 2148 # 2149 # } 2150 # } 2151 # 2152 # Arguments 2153 # input: Fields required to apply a application workflow step 2154 ApplicationWorkflow): Application ( : 2155 2156 # Apply an engine workflow step, such as "submit" or "approve" 2157 # 2158 # Arguments 2159 # input: Fields required to apply a engine workflow step 2160 EngineWorkflow): Engine ( : 2161 2162 # Creates a widget associated with a collection 2163 # Example: 2164 # Request: 2165 # mutation { 2166 # 2167 # createWidget(input:{ 2168 # 2169 # collectionId: "242361", 2170 # 2171 # name: "example", 2172 # 2173 # nextButtonColor: "000000"}) { 2174 # 2175 # id 2176 # 2177 # name 2178 # 2179 # } 2180 # } 2181 # Response: 2182 # { 2183 # 2184 # "data": { 2185 # 2186 # "createWidget": { 2187 # 2188 # "id": "fwSwWdRWTm2fdFMoPQDKkg", 2189 # 2190 # "name": "" 2191 # 2192 # } 2193 # 2194 # } 2195 # } 2196 # 2197 # Arguments 2198 # input: Fields needed to create a new widget 2199 CreateWidget): Widget ( : 2200 2201 # Updates a widget 2202 # Example: 2203 # Request: 2204 # mutation { 2205 # 2206 # updateWidget(input: { 2207 # 2208 # id: "fwSwWdRWTm2fdFMoPQDKkg", 2209 # 2210 # name: "new example name"}) { 2211 # 2212 # id 2213 # 2214 # name 2215 # 2216 # } 2217 # } 2218 # Response: 2219 # { 2220 # 2221 # "data": { 2222 # 2223 # "updateWidget": { 2224 # 2225 # "id": "fwSwWdRWTm2fdFMoPQDKkg", 2226 # 2227 # "name": "new example name" 2228 # 2229 # } 2230 # 2231 # } 2232 # } 2233 # 2234 # Arguments 2235 # input: Fields needed to update a widget 2236 UpdateWidget): Widget ( : 2237 2238 # Create a new user within an organization. 2239 # Example: 2240 # Request: 2241 # mutation { 2242 # 2243 # createUser(input: { 2244 # 2245 # name: "example", 2246 # 2247 # password: "example", 2248 # 2249 # organizationId: "35521"}) { 2250 # 2251 # id 2252 # 2253 # } 2254 # } 2255 # Response: 2256 # { 2257 # 2258 # "data": { 2259 # 2260 # "createUser": { 2261 # 2262 # "id": "267de7e1-efb2-444a-a524-210328b78503" 2263 # 2264 # } 2265 # 2266 # } 2267 # } 2268 # 2269 # Arguments 2270 # input: Fields needed to create a user. 2271 CreateUser): User ( : 2272 2273 # Create a new organization. 2274 # 2275 # Arguments 2276 # input: Fields needed to create an organization. Requires 2277 # superadmin 2278 CreateOrganization!): Organization ( : 2279 2280 # Update an existing user' 2281 # Example: 2282 # Request: 2283 # mutation { 2284 # 2285 # updateUser(input: { 2286 # 2287 # id: "267de7e1-efb2-444a-a524-210328b78503", 2288 # 2289 # firstName: "example", 2290 # 2291 # lastName: "example"}) { 2292 # 2293 # firstName 2294 # 2295 # lastName 2296 # 2297 # } 2298 # } 2299 # Response: 2300 # { 2301 # 2302 # "data": { 2303 # 2304 # "updateUser": { 2305 # 2306 # "firstName": "example", 2307 # 2308 # "lastName": "example" 2309 # 2310 # } 2311 # 2312 # } 2313 # } 2314 # 2315 # Arguments 2316 # input: Fields needed to update a user 2317 UpdateUser): User ( : 2318 2319 # Add an existing user to an organization. 2320 # One of the user identifiers (userId or userName) has to be specified. 2321 # 2322 # Arguments 2323 # userId: UUID of user 2324 # userName: User name to uniquely identify a user 2325 # organizationGuid: UUID of organization 2326 # roleIds: Role Ids. 2327 # priority: Priority of the organization. If not provided, max 2328 # priority plus one will be used. 2329 ( 2330 ID, : 2331 String, : 2332 ID!, : 2333 ID], : [ 2334 Int : 2335 ): User 2336 2337 # Remove an existing user for organization. 2338 # One of the user identifiers (userId or userName) has to be specified. 2339 # The operation fails if the organization is the last one to which user belongs. 2340 # 2341 # Arguments 2342 # userId: UUID of user 2343 # userName: User name to uniquely identify a user 2344 # organizationGuid: UUID of organization 2345 ( 2346 ID, : 2347 String, : 2348 ID! : 2349 ): User 2350 2351 # #Switch user to organization 2352 # 2353 # Arguments 2354 # token: User token that should be logout 2355 # userName: The user login name -- typically, email address. 2356 # organizationGuid: GUID of organization. 2357 ( 2358 String!, : 2359 String!, : 2360 ID! : 2361 ): LoginInfo 2362 2363 # Force a user to update password on next login. 2364 # This mutation is used by administrators. 2365 # Example: 2366 # Request: 2367 # mutation { 2368 # 2369 # createPasswordUpdateRequest(input: { 2370 # 2371 # id: "267de7e1-efb2-444a-a524-210328b78503", 2372 # 2373 # skipPasswordResetEmail: true}) { 2374 # 2375 # id 2376 # 2377 # name 2378 # 2379 # } 2380 # } 2381 # Response: 2382 # { 2383 # 2384 # "data": { 2385 # 2386 # "createPasswordUpdateRequest": { 2387 # 2388 # "id": "267de7e1-efb2-444a-a524-210328b78503", 2389 # 2390 # "name": "example" 2391 # 2392 # } 2393 # 2394 # } 2395 # } 2396 # 2397 # Arguments 2398 # input: Fields needed to create a password update request 2399 ( 2400 CreatePasswordUpdateRequest : 2401 ): User 2402 2403 # Create a password reset request. This mutation is used on behalf 2404 # of a user who needs to reset their password. It operates only on 2405 # the currently authenicated user (based on the authentication token provided). 2406 # Example: 2407 # Request: 2408 # mutation { 2409 # 2410 # createPasswordResetRequest(input: { 2411 # 2412 # userName: "example", 2413 # 2414 # skipPasswordResetEmail:true}) { 2415 # 2416 # message 2417 # 2418 # } 2419 # } 2420 # Response: 2421 # { 2422 # 2423 # "data": { 2424 # 2425 # "createPasswordResetRequest": { 2426 # 2427 # "message": "Reset request issued for example. Email will not be sent." 2428 # 2429 # } 2430 # 2431 # } 2432 # } 2433 ( 2434 CreatePasswordResetRequest : 2435 ): CreatePasswordResetRequestPayload 2436 2437 # Update the current authenticated user 2438 # Example: 2439 # Request: 2440 # mutation { 2441 # 2442 # updateCurrentUser(input: { 2443 # 2444 # title: "undefined"}) { 2445 # 2446 # id 2447 # 2448 # } 2449 # } 2450 # Response: 2451 # { 2452 # 2453 # "data": { 2454 # 2455 # "updateCurrentUser": { 2456 # 2457 # "id": "59cb4e74-7c31-4267-b91e-d4600bc08008" 2458 # 2459 # } 2460 # 2461 # } 2462 # } 2463 UpdateCurrentUser!): User! ( : 2464 2465 # Get password token info for current user 2466 # Example: 2467 # Request: 2468 # mutation { 2469 # 2470 # getCurrentUserPasswordToken(input: { 2471 # 2472 # password: "Example password"}) { 2473 # 2474 # passwordToken 2475 # 2476 # } 2477 # } 2478 # Response: 2479 # { 2480 # 2481 # "data": { 2482 # 2483 # "getCurrentUserPasswordToken": { 2484 # 2485 # "passwordToken": "e4cb86c7-34a4-4a52-b458-3ebbb2cca9c3" 2486 # 2487 # } 2488 # 2489 # } 2490 # } 2491 ( 2492 GetCurrentUserPasswordToken! : 2493 ): PasswordTokenInfo! 2494 2495 # Change the current authenticated user's password 2496 # 2497 # Arguments 2498 # input: Fields needed to change password 2499 ChangePassword!): User ( : 2500 2501 # Delete a user 2502 # Example: 2503 # Request: 2504 # mutation { 2505 # 2506 # deleteUser( 2507 # 2508 # id: "267de7e1-efb2-444a-a524-210328b78503") { 2509 # 2510 # message 2511 # 2512 # } 2513 # } 2514 # Response: 2515 # { 2516 # 2517 # "data": { 2518 # 2519 # "deleteUser": { 2520 # 2521 # "message": null 2522 # 2523 # } 2524 # 2525 # } 2526 # } 2527 # 2528 # Arguments 2529 # id: Supply the ID of the user to delete. 2530 ID!): DeletePayload ( : 2531 2532 # Create a structured data registry schema metadata. 2533 # Example: 2534 # Request: 2535 # mutation { 2536 # 2537 # createDataRegistry(input: { 2538 # 2539 # name: "example", 2540 # 2541 # description: "example" 2542 # 2543 # source: "example"}) { 2544 # 2545 # id 2546 # 2547 # organizationId 2548 # 2549 # } 2550 # } 2551 # Response: 2552 # { 2553 # 2554 # "data": { 2555 # 2556 # "createDataRegistry": { 2557 # 2558 # "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6", 2559 # 2560 # "organizationId": "35521" 2561 # 2562 # } 2563 # 2564 # } 2565 # } 2566 CreateDataRegistry!): DataRegistry ( : 2567 2568 # Update a structured data registry schema metadata. 2569 # Example: 2570 # Request: 2571 # mutation { 2572 # 2573 # updateDataRegistry(input: { 2574 # 2575 # id: "230f95e4-95c9-47c4-a845-61ca67ad6ba6" 2576 # 2577 # name: "example" 2578 # 2579 # description: "example" 2580 # 2581 # source: "new source"}) { 2582 # 2583 # id 2584 # 2585 # source 2586 # 2587 # } 2588 # } 2589 # Response: 2590 # { 2591 # 2592 # "data": { 2593 # 2594 # "updateDataRegistry": { 2595 # 2596 # "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6", 2597 # 2598 # "source": "new source" 2599 # 2600 # } 2601 # 2602 # } 2603 # } 2604 UpdateDataRegistry!): DataRegistry ( : 2605 2606 # Update a structured data registry schema. 2607 # Example: 2608 # Request: 2609 # mutation { 2610 # 2611 # upsertSchemaDraft(input: { 2612 # 2613 # dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6", 2614 # 2615 # schema: { 2616 # 2617 # example: "example" 2618 # 2619 # }}) { 2620 # 2621 # id 2622 # 2623 # } 2624 # } 2625 # Response: 2626 # { 2627 # 2628 # "data": { 2629 # 2630 # "upsertSchemaDraft": { 2631 # 2632 # "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91" 2633 # 2634 # } 2635 # 2636 # } 2637 # } 2638 UpsertSchemaDraft!): Schema ( : 2639 2640 # Update the state of a schema 2641 # Example: 2642 # Request: 2643 # mutation { 2644 # 2645 # updateSchemaState(input: { 2646 # 2647 # id: "0bd05e43-ddac-4b1a-9238-f3b177439b91", 2648 # 2649 # status: deleted}) { 2650 # 2651 # id 2652 # 2653 # } 2654 # } 2655 # Response: 2656 # { 2657 # 2658 # "data": { 2659 # 2660 # "updateSchemaState": { 2661 # 2662 # "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91" 2663 # 2664 # } 2665 # 2666 # } 2667 # } 2668 UpdateSchemaState!): Schema ( : 2669 2670 # Create (ingest) a structured data object 2671 # Example: 2672 # Request: 2673 # mutation { 2674 # 2675 # createStructuredData(input: { 2676 # 2677 # schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa", 2678 # 2679 # data: { 2680 # 2681 # example: "example" 2682 # 2683 # }}) { 2684 # 2685 # id 2686 # 2687 # } 2688 # } 2689 # Response: 2690 # { 2691 # 2692 # "data": { 2693 # 2694 # "createStructuredData": { 2695 # 2696 # "id": "e180f94f-866e-4454-92f9-7ee20d6448fa" 2697 # 2698 # } 2699 # 2700 # } 2701 # } 2702 CreateStructuredData!): StructuredData ( : 2703 2704 # Delete a structured data object 2705 # Example: 2706 # Request: 2707 # mutation { 2708 # 2709 # deleteStructuredData(input:{ 2710 # 2711 # id: "e180f94f-866e-4454-92f9-7ee20d6448fa", 2712 # 2713 # schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) { 2714 # 2715 # message 2716 # 2717 # } 2718 # } 2719 # Response: 2720 # { 2721 # 2722 # "data": { 2723 # 2724 # "deleteStructuredData": { 2725 # 2726 # "message": null 2727 # 2728 # } 2729 # 2730 # } 2731 # } 2732 DeleteStructuredData!): DeletePayload ( : 2733 2734 # Create (ingest) a structured data object 2735 # Example: 2736 # Request: 2737 # mutation { 2738 # 2739 # createCollection(input: { 2740 # 2741 # name: "example", 2742 # 2743 # folderDescription: "example", 2744 # 2745 # image:"", 2746 # 2747 # parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) { 2748 # 2749 # id 2750 # 2751 # } 2752 # } 2753 # Response: 2754 # { 2755 # 2756 # "data": { 2757 # 2758 # "createCollection": { 2759 # 2760 # "id": "242361" 2761 # 2762 # } 2763 # 2764 # } 2765 # } 2766 # 2767 # Arguments 2768 # input: Fields required to create new collection 2769 CreateCollection): Collection ( : 2770 2771 # Update a collection 2772 # Example: 2773 # Request: 2774 # mutation { 2775 # 2776 # updateCollection(input: { 2777 # 2778 # folderId: "242361" 2779 # 2780 # name: "new name" 2781 # 2782 # folderDescription: "new description"}) { 2783 # 2784 # id 2785 # 2786 # name 2787 # 2788 # } 2789 # } 2790 # Response: 2791 # { 2792 # 2793 # "data": { 2794 # 2795 # "updateCollection": { 2796 # 2797 # "id": "242361", 2798 # 2799 # "name": "new name" 2800 # 2801 # } 2802 # 2803 # } 2804 # } 2805 # 2806 # Arguments 2807 # input: Fields needed to update a collection 2808 UpdateCollection): Collection ( : 2809 2810 # Delete Collection 2811 # Example: 2812 # Request: 2813 # mutation { 2814 # 2815 # deleteCollection( 2816 # 2817 # id: "242361") { 2818 # 2819 # message 2820 # 2821 # } 2822 # } 2823 # Response: 2824 # { 2825 # 2826 # "data": { 2827 # 2828 # "deleteCollection": { 2829 # 2830 # "message": "Deleted Successfully" 2831 # 2832 # } 2833 # 2834 # } 2835 # } 2836 # 2837 # Arguments 2838 # id: Supply the ID of the folder or collection to delete 2839 ID, : ID): DeletePayload ( : 2840 2841 # Share a collection, allowing other organizations to view the data 2842 # it contains. 2843 # Example: 2844 # Request: 2845 # mutation { 2846 # 2847 # shareCollection(input: { 2848 # 2849 # folderId: "242599", 2850 # 2851 # shareMessage: "example", 2852 # 2853 # recipients: [] }) { 2854 # 2855 # id 2856 # 2857 # } 2858 # } 2859 # Response: 2860 # { 2861 # 2862 # "data": { 2863 # 2864 # "shareCollection": { 2865 # 2866 # "id": "FhQrlAwfRMaTy0blR_eHRw" 2867 # 2868 # } 2869 # 2870 # } 2871 # } 2872 # 2873 # Arguments 2874 # input: Fields needed to share a collection 2875 ShareCollection): Share ( : 2876 2877 # Arguments 2878 # shareId: ID of the shared collection to update 2879 # mentionIds: List of mentionIds to add or remove 2880 # type: Indicates whether or not the mentions are to be added or 2881 # deleted 2882 ( 2883 String!, : 2884 ID!], : [ 2885 SharedCollectionUpdateType! : 2886 ): Share 2887 2888 ( 2889 UpdateSharedCollectionHistory : 2890 ): SharedCollectionHistory 2891 2892 # Share a mention from a collection 2893 # 2894 # Arguments 2895 # input: Fields needed to share a mention 2896 ( 2897 ShareMentionFromCollection : 2898 ): Share 2899 2900 # Share mention 2901 ShareMention): Share ( : 2902 2903 # Share mentions in bulk 2904 ShareMentionInBulk): [Share] ( : 2905 2906 # Add a mention to a collection 2907 # 2908 # Arguments 2909 # input: Fields needed to add a mention to a collection 2910 CollectionMentionInput): CollectionMention ( : 2911 2912 # Arguments 2913 # input: Fields needed to add mentions to a collection 2914 ( 2915 CreateCollectionMentions : 2916 ): [CollectionMention!]! 2917 2918 # Update a mention in a collection 2919 # 2920 # Arguments 2921 # input: Fields needed to add mentions to a collection 2922 ( 2923 UpdateCollectionMention! : 2924 ): CollectionMention! 2925 2926 # Remove a mention from a collection 2927 # 2928 # Arguments 2929 # input: Fields needed to delete a mention from a collection 2930 CollectionMentionInput): CollectionMention ( : 2931 2932 # Create a new folder 2933 # Example: 2934 # Request: 2935 # mutation { 2936 # 2937 # createFolder(input: { 2938 # 2939 # name: "example", 2940 # 2941 # description: "example", 2942 # 2943 # parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982", 2944 # 2945 # rootFolderType:watchlist}) { 2946 # 2947 # id 2948 # 2949 # name 2950 # 2951 # } 2952 # } 2953 # Response: 2954 # { 2955 # 2956 # "data": { 2957 # 2958 # "createFolder": { 2959 # 2960 # "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2", 2961 # 2962 # "name": "example" 2963 # 2964 # } 2965 # 2966 # } 2967 # } 2968 # 2969 # Arguments 2970 # input: Fields needed to create a new folder. 2971 CreateFolder): Folder ( : 2972 2973 # Update an existing folder 2974 # Example: 2975 # Request: 2976 # mutation { 2977 # 2978 # updateFolder(input: { 2979 # 2980 # id: "d551fbd6-7354-4b0e-abfb-654ab8583be2", 2981 # 2982 # name: "new name"}) { 2983 # 2984 # name 2985 # 2986 # } 2987 # } 2988 # Response: 2989 # { 2990 # 2991 # "data": { 2992 # 2993 # "updateFolder": { 2994 # 2995 # "name": "new name" 2996 # 2997 # } 2998 # 2999 # } 3000 # } 3001 # 3002 # Arguments 3003 # input: Fields needed to update a folder. 3004 UpdateFolder): Folder ( : 3005 3006 # Move a folder from one parent folder to another. 3007 # Example: 3008 # Request: 3009 # mutation { 3010 # 3011 # moveFolder(input: { 3012 # 3013 # treeObjectId: "68a5833a-f573-41fe-840a-adb5f6888e2d", 3014 # 3015 # prevParentTreeObjectId: "3104f61f-4bd1-4175-9fe6-27436d591c54", 3016 # 3017 # newParentTreeObjectId: "ad7839a7-d088-4202-9db1-5ed4992f915d", 3018 # 3019 # prevOrderIndex: 1, 3020 # 3021 # newOrderIndex: 1}) { 3022 # 3023 # id 3024 # 3025 # name 3026 # 3027 # } 3028 # } 3029 # Response: 3030 # { 3031 # 3032 # "data": { 3033 # 3034 # "moveFolder": { 3035 # 3036 # "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2", 3037 # 3038 # "name": "new name" 3039 # 3040 # } 3041 # 3042 # } 3043 # } 3044 # 3045 # Arguments 3046 # input: Fields needed to move a folder 3047 MoveFolder): Folder ( : 3048 3049 # Delete a folder 3050 # Example: 3051 # Request: 3052 # mutation { 3053 # 3054 # deleteFolder(input: { 3055 # 3056 # id:"d551fbd6-7354-4b0e-abfb-654ab8583be2", 3057 # 3058 # orderIndex: 1}) { 3059 # 3060 # message 3061 # 3062 # } 3063 # } 3064 # Response: 3065 # { 3066 # 3067 # "data": { 3068 # 3069 # "deleteFolder": { 3070 # 3071 # "message": null 3072 # 3073 # } 3074 # 3075 # } 3076 # } 3077 # 3078 # Arguments 3079 # input: Fields needed to delete a folder 3080 DeleteFolder): DeletePayload ( : 3081 3082 # Create a mention comment 3083 # 3084 # Arguments 3085 # input: Fields needed to create a mention comment 3086 CreateMentionComment): MentionComment ( : 3087 3088 # Update a mention comment 3089 # 3090 # Arguments 3091 # input: Fields needed to update a mention comment 3092 UpdateMentionComment): MentionComment ( : 3093 3094 # Delete a mention comment 3095 # 3096 # Arguments 3097 # input: Fields needed to delete a mention comment 3098 DeleteMentionComment): DeletePayload ( : 3099 3100 # Create a mention rating 3101 # 3102 # Arguments 3103 # input: Fields needed to create a mention rating 3104 CreateMentionRating): MentionRating ( : 3105 3106 # Update a mention rating 3107 # 3108 # Arguments 3109 # input: Fields needed to update a mention rating 3110 UpdateMentionRating): MentionRating ( : 3111 3112 # Delete a mention rating 3113 # 3114 # Arguments 3115 # input: Fields needed to delete a mention rating. 3116 DeleteMentionRating): DeletePayload ( : 3117 3118 # Login as a user. This mutation does not require an existing authentication 3119 # context (via `Authorization` header with bearer token, cookie, etc.). 3120 # Instead, the client supplies credentials to this mutation, which then 3121 # authenticates the user and sets up the authentication context. 3122 # The returned tokens can be used to authenticate future requests. 3123 # Example: 3124 # Request: 3125 # mutation { 3126 # 3127 # userLogin(input: { 3128 # 3129 # userName: "example1", 3130 # 3131 # password: "example1"}) { 3132 # 3133 # apiToken 3134 # 3135 # lastLoggedIn 3136 # 3137 # } 3138 # } 3139 # Response: 3140 # { 3141 # 3142 # "data": { 3143 # 3144 # "userLogin": { 3145 # 3146 # "apiToken": null, 3147 # 3148 # "lastLoggedIn": "2021-06-15T02:04:52.000Z", 3149 # 3150 # "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a" 3151 # 3152 # } 3153 # 3154 # } 3155 # } 3156 # 3157 # Arguments 3158 # input: Fields needed to log in 3159 UserLogin): LoginInfo ( : 3160 3161 # Logout user and invalidate user token 3162 # Example: 3163 # Request: 3164 # mutation { 3165 # 3166 # userLogout( 3167 # 3168 # token: "a5610058-260d-46ac-aa3e-ee529c4feaab") 3169 # } 3170 # Response: 3171 # { 3172 # 3173 # "data": { 3174 # 3175 # "userLogout": null 3176 # 3177 # } 3178 # } 3179 # 3180 # Arguments 3181 # token: User token that should be invalidated 3182 String!): Boolean ( : 3183 3184 # Refresh a user token, returning a fresh token so that the client 3185 # can continue to authenticate to the API.\ 3186 # Example: 3187 # Request: 3188 # mutation { 3189 # 3190 # refreshToken( 3191 # 3192 # token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") { 3193 # 3194 # hasPassword 3195 # 3196 # user{id} 3197 # 3198 # } 3199 # } 3200 # Response: 3201 # { 3202 # 3203 # "data": { 3204 # 3205 # "refreshToken": { 3206 # 3207 # "hasPassword": true, 3208 # 3209 # "user": { 3210 # 3211 # "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066" 3212 # 3213 # } 3214 # 3215 # } 3216 # 3217 # } 3218 # } 3219 String!): LoginInfo ( : 3220 3221 # Validate a user token. This mutation is used by services to determine 3222 # if the token provided by a given client is valid. 3223 # Example: 3224 # Request: 3225 # mutation { 3226 # 3227 # validateToken( 3228 # 3229 # token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") { 3230 # 3231 # hasPassword 3232 # 3233 # user{id} 3234 # 3235 # } 3236 # } 3237 # Response: 3238 # { 3239 # 3240 # "data": { 3241 # 3242 # "validateToken": { 3243 # 3244 # "hasPassword": true, 3245 # 3246 # "user": { 3247 # 3248 # "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066" 3249 # 3250 # } 3251 # 3252 # } 3253 # 3254 # } 3255 # } 3256 String!): LoginInfo ( : 3257 3258 # Create a mention object 3259 CreateMention!): Mention ( : 3260 3261 # Update a mention object 3262 UpdateMention!): Mention ( : 3263 3264 # Update a set of mentions 3265 UpdateMentions!): [Mention] ( : 3266 3267 # Create root folder for an organization 3268 # Example: 3269 # Request: 3270 # mutation { 3271 # 3272 # createRootFolders { 3273 # 3274 # id 3275 # 3276 # treeObjectId 3277 # 3278 # rootFolderTypeId 3279 # 3280 # } 3281 # } 3282 # Response: 3283 # { 3284 # 3285 # "data": { 3286 # 3287 # "createRootFolders": [ 3288 # 3289 # { 3290 # 3291 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982", 3292 # 3293 # "treeObjectId": "3104f61f-4bd1-4175-9fe6-27436d591c54", 3294 # 3295 # "rootFolderTypeId": 1 3296 # 3297 # }, 3298 # 3299 # { 3300 # 3301 # "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e", 3302 # 3303 # "treeObjectId": "4c9f1c95-f6a3-4355-8831-c77719850eaa", 3304 # 3305 # "rootFolderTypeId": 1 3306 # 3307 # } 3308 # 3309 # ] 3310 # 3311 # } 3312 # } 3313 # 3314 # Arguments 3315 # rootFolderType: The type of root folder to create 3316 RootFolderType): [Folder] ( : 3317 3318 # Apply bulk updates to watchlists. 3319 # This mutation is currently available only to Veritone operations. 3320 # 3321 # Arguments 3322 # filter: A filter indicating which watchlists should be updated. 3323 # At least one filter condition must be provided. 3324 # Only watchlists for the user's organization will be updated. 3325 # input: Fields used to update a watchlist. 3326 ( 3327 BulkUpdateWatchlistFilter!, : 3328 BulkUpdateWatchlist : 3329 ): WatchlistList 3330 3331 # File a TemporalDataObject in a folder. A given TemporalDataObject can 3332 # be filed in any number of folders, or none. Filing causes the TemporalDataObject 3333 # and its assets to be visible within the folder. 3334 # Example: 3335 # Request: 3336 # mutation { 3337 # 3338 # fileTemporalDataObject(input:{ 3339 # 3340 # tdoId: "1580388995", 3341 # 3342 # folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) { 3343 # 3344 # id 3345 # 3346 # folders{ 3347 # 3348 # id 3349 # 3350 # } 3351 # 3352 # } 3353 # } 3354 # Response: 3355 # { 3356 # 3357 # "data": { 3358 # 3359 # "fileTemporalDataObject": { 3360 # 3361 # "id": "1580388995", 3362 # 3363 # "folders": [ 3364 # 3365 # { 3366 # 3367 # "id": "9d639f1b-a0d4-47b0-8149-3568f048f320" 3368 # 3369 # } 3370 # 3371 # ] 3372 # 3373 # } 3374 # 3375 # } 3376 # } 3377 # 3378 # Arguments 3379 # input: The fields needed to file a TemporalDataObject in a 3380 # folder 3381 FileTemporalDataObject!): TemporalDataObject ( : 3382 3383 # Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject 3384 # and its assets to disappear from the folder, but does not otherwise affect 3385 # either the TDO or the folder and does not change access controls. 3386 # Example: 3387 # Request: 3388 # mutation { 3389 # 3390 # unfileTemporalDataObject(input: { 3391 # 3392 # tdoId: "1580388995", 3393 # 3394 # folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) { 3395 # 3396 # id 3397 # 3398 # description 3399 # 3400 # } 3401 # } 3402 # Response: 3403 # { 3404 # 3405 # "data": { 3406 # 3407 # "unfileTemporalDataObject": { 3408 # 3409 # "id": "1580388995", 3410 # 3411 # "description": null 3412 # 3413 # } 3414 # 3415 # } 3416 # } 3417 # 3418 # Arguments 3419 # input: The fields needed to file a TemporalDataObject in a 3420 # folder 3421 ( 3422 UnfileTemporalDataObject! : 3423 ): TemporalDataObject 3424 3425 # Moves a TemporalDataObject from one parent folder to another. 3426 # Any other folders the TemporalDataObject is filed in are unaffected. 3427 # Example: 3428 # Request: 3429 # mutation { 3430 # 3431 # moveTemporalDataObject(input: { 3432 # 3433 # tdoId: "1580388995", 3434 # 3435 # oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320", 3436 # 3437 # newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) { 3438 # 3439 # id 3440 # 3441 # folders{ 3442 # 3443 # folderPath{id} 3444 # 3445 # } 3446 # 3447 # } 3448 # } 3449 # Response: 3450 # { 3451 # 3452 # "data": { 3453 # 3454 # "moveTemporalDataObject": { 3455 # 3456 # "id": "1580388995", 3457 # 3458 # "folders": [ 3459 # 3460 # { 3461 # 3462 # "folderPath": [ 3463 # 3464 # { 3465 # 3466 # "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982" 3467 # 3468 # } 3469 # 3470 # ] 3471 # 3472 # } 3473 # 3474 # ] 3475 # 3476 # } 3477 # 3478 # } 3479 # } 3480 # 3481 # Arguments 3482 # input: Fields need to move a TemporalDataObject 3483 MoveTemporalDataObject!): TemporalDataObject ( : 3484 3485 # Upload and store an engine result. The result will be stored as an 3486 # asset associated with the target TemporalDataObject and the 3487 # task will be updated accordingly. 3488 # Use a multipart form POST to all this mutation. 3489 # 3490 # Arguments 3491 # input: Fields needed to upload and store an engine result 3492 UploadEngineResult!): Asset ( : 3493 3494 # Create a watchlist 3495 # Example: 3496 # Request: 3497 # mutation { 3498 # 3499 # createWatchlist(input: { 3500 # 3501 # stopDateTime: 1623851655, 3502 # 3503 # name: "example", 3504 # 3505 # searchIndex: mine, 3506 # 3507 # parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320", 3508 # 3509 # cognitiveSearches: [], 3510 # 3511 # subscriptions: [], 3512 # 3513 # details: { 3514 # 3515 # example: "example"}}) { 3516 # 3517 # id 3518 # 3519 # } 3520 # } 3521 # Response: 3522 # { 3523 # 3524 # "data": { 3525 # 3526 # "createWatchlist": { 3527 # 3528 # "id": "325783" 3529 # 3530 # } 3531 # 3532 # } 3533 # } 3534 CreateWatchlist!): Watchlist ( : 3535 3536 BulkCreateWatchlist!): WatchlistList ( : 3537 3538 # Update a watchlist 3539 # Example: 3540 # Request: 3541 # mutation { 3542 # 3543 # updateWatchlist(input: { 3544 # 3545 # id: "325783" 3546 # 3547 # name: "new name" 3548 # 3549 # details: { 3550 # 3551 # example: "new details"}}) { 3552 # 3553 # id 3554 # 3555 # name 3556 # 3557 # } 3558 # } 3559 # Response: 3560 # 3561 # { 3562 # 3563 # "data": { 3564 # 3565 # "updateWatchlist": { 3566 # 3567 # "id": "325783", 3568 # 3569 # "name": "new name" 3570 # 3571 # } 3572 # 3573 # } 3574 # } 3575 UpdateWatchlist!): Watchlist ( : 3576 3577 # Delete a watchlist 3578 # Example: 3579 # Request: 3580 # mutation { 3581 # 3582 # deleteWatchlist( 3583 # 3584 # id:"325783") { 3585 # 3586 # message 3587 # 3588 # } 3589 # } 3590 # Response: 3591 # { 3592 # 3593 # "data": { 3594 # 3595 # "deleteWatchlist": { 3596 # 3597 # "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search 3598 # profiles, 0 mention comments, and 0 mention ratings." 3599 # 3600 # } 3601 # 3602 # } 3603 # } 3604 ID!): DeletePayload ( : 3605 3606 UpdateCognitiveSearch): CognitiveSearch ( : 3607 3608 CreateCognitiveSearch): CognitiveSearch ( : 3609 3610 ID!): DeletePayload ( : 3611 3612 FileWatchlist!): Watchlist ( : 3613 3614 # Unfile a watchlist from a folder 3615 # Example: 3616 # Request: 3617 # mutation { 3618 # 3619 # unfileWatchlist(input: { 3620 # 3621 # watchlistId:"325786", 3622 # 3623 # folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) { 3624 # 3625 # id 3626 # 3627 # folders{ 3628 # 3629 # folderPath{ 3630 # 3631 # id 3632 # 3633 # } 3634 # 3635 # } 3636 # 3637 # } 3638 # } 3639 # Response: 3640 # { 3641 # 3642 # "data": { 3643 # 3644 # "unfileWatchlist": { 3645 # 3646 # "id": "325786", 3647 # 3648 # "folders": [] 3649 # 3650 # } 3651 # 3652 # } 3653 # } 3654 UnfileWatchlist!): Watchlist ( : 3655 3656 # Share a folder with other organizations 3657 # Requires superadmin 3658 ShareFolderInput): Folder ( : 3659 3660 # Create a TDO and an asset with a single call 3661 # Example: 3662 # Request: 3663 # mutation { 3664 # 3665 # createTDOWithAsset(input: { 3666 # 3667 # startDateTime: 1623841655, 3668 # 3669 # stopDateTime: 1623851655, 3670 # 3671 # contentType: "video/mp4", 3672 # 3673 # assetType: "media", 3674 # 3675 # addToIndex: false, 3676 # 3677 # uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) { 3678 # 3679 # id 3680 # 3681 # status 3682 # 3683 # assets { 3684 # 3685 # records { 3686 # 3687 # id 3688 # 3689 # assetType 3690 # 3691 # contentType 3692 # 3693 # signedUri 3694 # 3695 # } 3696 # 3697 # } 3698 # 3699 # } 3700 # } 3701 # Response: 3702 # { 3703 # 3704 # "data": { 3705 # 3706 # "createTDOWithAsset": { 3707 # 3708 # "id": "1580507556", 3709 # 3710 # "status": "recorded", 3711 # 3712 # "assets": { 3713 # 3714 # "records": [ 3715 # 3716 # { 3717 # 3718 # "id": "1580507556_DQ2nU8cTDh", 3719 # 3720 # "assetType": "media", 3721 # 3722 # "contentType": "video/mp4", 3723 # 3724 # "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4" 3725 # 3726 # } 3727 # 3728 # ] 3729 # 3730 # } 3731 # 3732 # } 3733 # 3734 # } 3735 # } 3736 # 3737 # Arguments 3738 # input: Input fields necessary to create the TDO and asset 3739 CreateTDOWithAsset): TemporalDataObject ( : 3740 3741 # Create a subscription 3742 # Example: 3743 # Request: 3744 # mutation { 3745 # 3746 # createSubscription(input: { 3747 # 3748 # targetId: "325791", 3749 # 3750 # contact: { 3751 # 3752 # emailAddress: "example email"}, 3753 # 3754 # scheduledDay: Friday}) { 3755 # 3756 # id 3757 # 3758 # } 3759 # } 3760 # Response: 3761 # { 3762 # 3763 # "data": { 3764 # 3765 # "createSubscription": { 3766 # 3767 # "id": "274939" 3768 # 3769 # } 3770 # 3771 # } 3772 # } 3773 CreateSubscription!): Subscription ( : 3774 3775 # Update a subscription 3776 # Example: 3777 # Request: 3778 # mutation { 3779 # 3780 # updateSubscription(input: { 3781 # 3782 # id: "274939"}) { 3783 # 3784 # id 3785 # 3786 # } 3787 # } 3788 # Response: 3789 # mutation { 3790 # 3791 # updateSubscription(input: { 3792 # 3793 # id: "274939"}) { 3794 # 3795 # id 3796 # 3797 # } 3798 # } 3799 UpdateSubscription!): Subscription ( : 3800 3801 # Delete a subscription 3802 # Example: 3803 # Request: 3804 # mutation { 3805 # 3806 # deleteSubscription( 3807 # 3808 # id: "274939") { 3809 # 3810 # message 3811 # 3812 # } 3813 # } 3814 # Response: 3815 # mutation { 3816 # 3817 # deleteSubscription( 3818 # 3819 # id: "274939") { 3820 # 3821 # message 3822 # 3823 # } 3824 # } 3825 ID!): DeletePayload ( : 3826 3827 # Create trigger for events or types. 3828 # Example: 3829 # Request: 3830 # mutation { 3831 # 3832 # createTriggers(input: { 3833 # 3834 # events: "*", 3835 # 3836 # targets: { 3837 # 3838 # name: Email, 3839 # 3840 # params: { 3841 # 3842 # address: "example@veritone.com"}}}) { 3843 # 3844 # id 3845 # 3846 # } 3847 # } 3848 # Response: 3849 # { 3850 # 3851 # "data": { 3852 # 3853 # "createTriggers": [ 3854 # 3855 # { 3856 # 3857 # "id": "2936" 3858 # 3859 # } 3860 # 3861 # ] 3862 # 3863 # } 3864 # } 3865 CreateTriggers!): [Trigger] ( : 3866 3867 # Delete a registed trigger by ID. 3868 # Example: 3869 # Request: 3870 # mutation { 3871 # 3872 # deleteTrigger( 3873 # 3874 # id: "2936") { 3875 # 3876 # message 3877 # 3878 # } 3879 # } 3880 # Response: 3881 # { 3882 # 3883 # "data": { 3884 # 3885 # "deleteTrigger": { 3886 # 3887 # "message": "Trigger 2936 has been removed from organization 35521" 3888 # 3889 # } 3890 # 3891 # } 3892 # } 3893 ID!): DeletePayload ( : 3894 3895 # Validates if an engine output conforms to the engine output guidelines 3896 # Example: 3897 # Request: 3898 # mutation { 3899 # 3900 # validateEngineOutput(input: 3901 # 3902 # { 3903 # 3904 # schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json", 3905 # 3906 # validationContracts: [ 3907 # 3908 # "structured-data" 3909 # 3910 # ], 3911 # 3912 # series: [ 3913 # 3914 # { 3915 # 3916 # startTimeMs: 0, 3917 # 3918 # stopTimeMs: 10000, 3919 # 3920 # structuredData: { 3921 # 3922 # exampleschemaid: { 3923 # 3924 # key: "value", 3925 # 3926 # any: "data you'd like", 3927 # 3928 # as_long: "as it conforms to the schema" 3929 # 3930 # } 3931 # 3932 # } 3933 # 3934 # } 3935 # 3936 # ] 3937 # 3938 # } 3939 # 3940 # ) 3941 # } 3942 # Response: 3943 # { 3944 # 3945 # "data": { 3946 # 3947 # "validateEngineOutput": true 3948 # 3949 # } 3950 # } 3951 JSONData!): Boolean! ( : 3952 3953 # JWT tokens with a more limited scoped token to specific 3954 # resources to the recording, task, and job 3955 # and also has no organization association. 3956 # Example: 3957 # Request: 3958 # mutation { 3959 # 3960 # getEngineJWT(input: { 3961 # 3962 # engineId: "1", 3963 # 3964 # resource:{ 3965 # 3966 # tdoId: "1580701928" 3967 # 3968 # }}) { 3969 # 3970 # token 3971 # 3972 # } 3973 # } 3974 # 3975 # Response: 3976 # { 3977 # 3978 # "data": { 3979 # 3980 # "getEngineJWT": { 3981 # 3982 # "token": "eyJh...Tw_z3BKRA" 3983 # 3984 # } 3985 # 3986 # } 3987 # } 3988 getEngineJWT!): JWTTokenInfo! ( : 3989 3990 # Verify JWT token 3991 # Example: 3992 # Request: 3993 # mutation { 3994 # 3995 # verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW 3996 # 3997 # 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY 3998 # 3999 # wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ 4000 # 4001 # XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb 4002 # 4003 # eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw 4004 # 4005 # icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD 4006 # 4007 # A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia 4008 # 4009 # m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz 4010 # 4011 # NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI 4012 # 4013 # 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA") 4014 # { 4015 # 4016 # payload 4017 # 4018 # } 4019 # } 4020 # Response: 4021 # { 4022 # 4023 # "data": { 4024 # 4025 # "verifyJWT": { 4026 # 4027 # "payload": { 4028 # 4029 # "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09", 4030 # 4031 # "contentOrganizationId": 35521, 4032 # 4033 # "engineId": "1", 4034 # 4035 # "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008", 4036 # 4037 # "scope": [ 4038 # 4039 # { 4040 # 4041 # "actions": [ 4042 # 4043 # "asset:uri", 4044 # 4045 # "asset:all", 4046 # 4047 # "recording:read", 4048 # 4049 # "recording:update" 4050 # 4051 # ], 4052 # 4053 # "resources": { 4054 # 4055 # "recordingIds": [ 4056 # 4057 # "1580701928" 4058 # 4059 # ] 4060 # 4061 # } 4062 # 4063 # }, 4064 # 4065 # { 4066 # 4067 # "actions": [ 4068 # 4069 # "task:update" 4070 # 4071 # ], 4072 # 4073 # "resources": { 4074 # 4075 # "jobIds": [], 4076 # 4077 # "taskIds": [], 4078 # 4079 # "sourceIds": [] 4080 # 4081 # } 4082 # 4083 # } 4084 # 4085 # ], 4086 # 4087 # "iat": 1624036122, 4088 # 4089 # "exp": 1624640922, 4090 # 4091 # "sub": "engine-run", 4092 # 4093 # "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133" 4094 # 4095 # } 4096 # 4097 # } 4098 # 4099 # } 4100 # } 4101 String!): VerifyJWTPayload ( : 4102 4103 # Create a new Saved Search 4104 # Example: 4105 # Request: 4106 # mutation { 4107 # 4108 # createSavedSearch(input: { 4109 # 4110 # name: "example", 4111 # 4112 # csp: { 4113 # 4114 # example: "example"}}) { 4115 # 4116 # id 4117 # 4118 # } 4119 # } 4120 # Response: 4121 # { 4122 # 4123 # "data": { 4124 # 4125 # "createSavedSearch": { 4126 # 4127 # "id": "a29f2255-e509-4454-89ec-e425390ca4ca" 4128 # 4129 # } 4130 # 4131 # } 4132 # } 4133 CreateSavedSearch!): SavedSearch! ( : 4134 4135 # Delete a saved search 4136 # Example: 4137 # Request: 4138 # mutation { 4139 # 4140 # deleteSavedSearch( 4141 # 4142 # id:"a29f2255-e509-4454-89ec-e425390ca4ca") { 4143 # 4144 # message 4145 # 4146 # } 4147 # } 4148 # Response: 4149 # { 4150 # 4151 # "data": { 4152 # 4153 # "deleteSavedSearch": { 4154 # 4155 # "message": null 4156 # 4157 # } 4158 # 4159 # } 4160 # } 4161 ID!): DeletePayload! ( : 4162 4163 # Mark existing saved search profile as deleted 4164 # Create new saved search profile 4165 # Example: 4166 # Request: 4167 # mutation { 4168 # 4169 # replaceSavedSearch(input: { 4170 # 4171 # id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e", 4172 # 4173 # name: "example", 4174 # 4175 # csp: { 4176 # 4177 # example: "new csp"}}) { 4178 # 4179 # id 4180 # 4181 # } 4182 # } 4183 # Response: 4184 # mutation { 4185 # 4186 # replaceSavedSearch(input: { 4187 # 4188 # id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e", 4189 # 4190 # name: "example", 4191 # 4192 # csp: { 4193 # 4194 # example: "new csp"}}) { 4195 # 4196 # id 4197 # 4198 # } 4199 # } 4200 ReplaceSavedSearch!): SavedSearch! ( : 4201 4202 # Send a basic email. Mutation returns true for a success message. 4203 # The email from field will be automatically set the default platform email 4204 # address 4205 # Example: 4206 # Request: 4207 # mutation { 4208 # 4209 # sendEmail(input: { 4210 # 4211 # to: "example@veritone.com" 4212 # 4213 # subject: "example" 4214 # 4215 # message: "email body" 4216 # 4217 # replyTo: "example@veritone.com" 4218 # 4219 # }) 4220 # } 4221 # Response: 4222 # { 4223 # 4224 # "data": { 4225 # 4226 # "sendEmail": true 4227 # 4228 # } 4229 # } 4230 SendEmail!): Boolean! ( : 4231 4232 # Create new content template into a folder 4233 ( 4234 CreateFolderContentTempate! : 4235 ): FolderContentTemplate! 4236 4237 # Update existing content template by folderContentTemplateId 4238 ( 4239 UpdateFolderContentTempate! : 4240 ): FolderContentTemplate! 4241 4242 # Delete existing folder content template by folderContentTemplateId 4243 # 4244 # Arguments 4245 # id: Folder Content Template Id 4246 ID!): DeletePayload! ( : 4247 4248 # Create an export request. The requested TDO data, possibly including 4249 # TDO media and engine results, will be exported offline. 4250 # Example: 4251 # Request: 4252 # mutation { 4253 # 4254 # createExportRequest(input: { 4255 # 4256 # tdoData: { 4257 # 4258 # tdoId: "1580388995", 4259 # 4260 # }}) { 4261 # 4262 # id 4263 # 4264 # } 4265 # } 4266 # Response: 4267 # { 4268 # 4269 # "data": { 4270 # 4271 # "createExportRequest": { 4272 # 4273 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad" 4274 # 4275 # } 4276 # 4277 # } 4278 # } 4279 # 4280 # Arguments 4281 # input: Input data required to create the export request 4282 CreateExportRequest!): ExportRequest! ( : 4283 4284 # Update an export request 4285 # Example: 4286 # Request: 4287 # mutation { 4288 # 4289 # updateExportRequest(input: { 4290 # 4291 # id: "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4292 # 4293 # status: complete}) { 4294 # 4295 # id 4296 # 4297 # status 4298 # 4299 # } 4300 # } 4301 # Response: 4302 # { 4303 # 4304 # "data": { 4305 # 4306 # "updateExportRequest": { 4307 # 4308 # "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad", 4309 # 4310 # "status": "complete" 4311 # 4312 # } 4313 # 4314 # } 4315 # } 4316 # 4317 # Arguments 4318 # input: Input data required to update an export request 4319 UpdateExportRequest!): ExportRequest! ( : 4320 4321 # Create Mention in bulk. The input should be an array of createMentions 4322 CreateMentions!): MentionList ( : 4323 4324 # Create Media Share. Returning the url of the share 4325 CreateMediaShare!): CreatedMediaShare! ( : 4326 4327 # Create a new event 4328 # 4329 # Example: 4330 # 4331 # Request: 4332 # 4333 # mutation { 4334 # 4335 # createEvent(input: { 4336 # 4337 # eventName: "example", 4338 # 4339 # eventType: "example", 4340 # 4341 # application: "" 4342 # 4343 # description: "example"}) { 4344 # 4345 # id 4346 # 4347 # } 4348 # } 4349 # Response: 4350 # { 4351 # 4352 # "data": { 4353 # 4354 # "createEvent": { 4355 # 4356 # "id": "55fc7c51-1521-4043-902f-f0f3a357da6d" 4357 # 4358 # } 4359 # 4360 # } 4361 # } 4362 CreateEvent!): Event! ( : 4363 4364 # Update an event 4365 # Example: 4366 # Request: 4367 # mutation { 4368 # 4369 # updateEvent(input: { 4370 # 4371 # id: "55fc7c51-1521-4043-902f-f0f3a357da6d", 4372 # 4373 # description: "new example description"}) { 4374 # 4375 # id 4376 # 4377 # description 4378 # 4379 # } 4380 # } 4381 # Response: 4382 # { 4383 # 4384 # "data": { 4385 # 4386 # "updateEvent": { 4387 # 4388 # "id": "55fc7c51-1521-4043-902f-f0f3a357da6d", 4389 # 4390 # "description": "new example description" 4391 # 4392 # } 4393 # 4394 # } 4395 # } 4396 UpdateEvent!): Event! ( : 4397 4398 # Subscribe to an event 4399 # Example: 4400 # Request: 4401 # mutation { 4402 # 4403 # subscribeEvent(input: { 4404 # 4405 # eventName: "example", 4406 # 4407 # eventType: "example", 4408 # 4409 # application: "", 4410 # 4411 # delivery: { 4412 # 4413 # name: CreateJob, 4414 # 4415 # params: { 4416 # 4417 # targetId: "1580701928" 4418 # 4419 # engineId: "1" 4420 # 4421 # } 4422 # 4423 # } 4424 # 4425 # }) 4426 # } 4427 # Response: 4428 # { 4429 # 4430 # "data": { 4431 # 4432 # "subscribeEvent": "a0d04eeb-c32d-4852-9273-bb0acda970b9" 4433 # 4434 # } 4435 # } 4436 SubscribeEvent!): ID! ( : 4437 4438 # Unsubscribe to an event 4439 # Example: 4440 # Request: 4441 # mutation { 4442 # 4443 # unsubscribeEvent( 4444 # 4445 # id: "a0d04eeb-c32d-4852-9273-bb0acda970b9") { 4446 # 4447 # id 4448 # 4449 # message 4450 # 4451 # } 4452 # } 4453 # Response: 4454 # { 4455 # 4456 # "data": { 4457 # 4458 # "unsubscribeEvent": { 4459 # 4460 # "id": "a0d04eeb-c32d-4852-9273-bb0acda970b9", 4461 # 4462 # "message": "Unsubscribed from event" 4463 # 4464 # } 4465 # 4466 # } 4467 # } 4468 ID!): UnsubscribeEvent! ( : 4469 4470 # Emit an event 4471 # Example: 4472 # Request: 4473 # mutation { 4474 # 4475 # emitEvent(input: { 4476 # 4477 # eventName: "example", 4478 # 4479 # eventType: "example", 4480 # 4481 # application: "", 4482 # 4483 # payload: ""}) { 4484 # 4485 # id 4486 # 4487 # } 4488 # } 4489 # Response: 4490 # { 4491 # 4492 # "data": { 4493 # 4494 # "emitEvent": { 4495 # 4496 # "id": "0952fe68-5652-4804-857d-26e21ef3d7e8" 4497 # 4498 # } 4499 # 4500 # } 4501 # } 4502 EmitEvent!): EmitEventResponse! ( : 4503 4504 # Create a new event trigger template 4505 # Example: 4506 # Request: 4507 # mutation { 4508 # 4509 # createEventActionTemplate(input: { 4510 # 4511 # name: "example" 4512 # 4513 # inputType: event 4514 # 4515 # inputValidation: { 4516 # 4517 # example: "example" 4518 # 4519 # } 4520 # 4521 # inputAttributes: { 4522 # 4523 # example: "example" 4524 # 4525 # } 4526 # 4527 # actionType: job 4528 # 4529 # actionValidation: { 4530 # 4531 # example: "example" 4532 # 4533 # } 4534 # 4535 # actionDestination: "1" 4536 # 4537 # actionAttributes: { 4538 # 4539 # example: "example" 4540 # 4541 # }}) { 4542 # 4543 # id 4544 # 4545 # } 4546 # } 4547 # Response: 4548 # { 4549 # 4550 # "data": { 4551 # 4552 # "createEventActionTemplate": { 4553 # 4554 # "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92" 4555 # 4556 # } 4557 # 4558 # } 4559 # } 4560 ( 4561 CreateEventActionTemplate! : 4562 ): EventActionTemplate! 4563 4564 # Update an event trigger template 4565 # Example: 4566 # Request: 4567 # mutation { 4568 # 4569 # updateEventActionTemplate(input: { 4570 # 4571 # id: "d02522d7-ef5f-448f-981a-d2cfc7603d92", 4572 # 4573 # name: "example", 4574 # 4575 # actionValidation: { 4576 # 4577 # example: "new validation"}}) { 4578 # 4579 # id 4580 # 4581 # actionValidation 4582 # 4583 # } 4584 # } 4585 # Response: 4586 # { 4587 # 4588 # "data": { 4589 # 4590 # "updateEventActionTemplate": { 4591 # 4592 # "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92", 4593 # 4594 # "actionValidation": { 4595 # 4596 # "example": "new validation" 4597 # 4598 # } 4599 # 4600 # } 4601 # 4602 # } 4603 # } 4604 ( 4605 UpdateEventActionTemplate! : 4606 ): EventActionTemplate! 4607 4608 # Create a new event custom rule 4609 # Example: 4610 # Request: 4611 # mutation { 4612 # 4613 # createEventCustomRule(input: { 4614 # 4615 # name: "example" 4616 # 4617 # eventType: "example" 4618 # 4619 # eventName: "example" 4620 # 4621 # description: "example description" 4622 # 4623 # actions:[] 4624 # 4625 # params: { 4626 # 4627 # example: "example" 4628 # 4629 # }}) { 4630 # 4631 # id 4632 # 4633 # } 4634 # } 4635 # Response: 4636 # { 4637 # 4638 # "data": { 4639 # 4640 # "createEventCustomRule": { 4641 # 4642 # "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b" 4643 # 4644 # } 4645 # 4646 # } 4647 # } 4648 CreateEventCustomRule!): EventCustomRule! ( : 4649 4650 # Update an eve