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

1type 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
48createTDO(input: 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
91updateTDO(input: 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
131deleteTDO(id: 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.
172cleanupTDO(id: ID!, options: [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.
179createTaskLog(input: 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.
231createAsset(input: 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.
266deleteAsset(id: 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.
315updateAsset(input: 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.
363addMediaSegment(input: 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)
428addMediaSegments(
429containerId: ID!,
430segments: [AddMediaSegments]!,
431segmentGroupId: 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.
469requestClone(input: RequestClone): CloneRequest
470
471# Create a new automate flow. An automate flow is an engine
472# with extra metadata to work in the automate environment.
473# This endpoint will return an engineId that can be used to open
474# the flow in automate.
475# Example:
476# Request:
477# mutation {
478#
479# createAutomateFlow(input: {
480#
481# name: "My New Flow",
482#
483# linkedApplicationId: "123",
484#
485# templateId: "36"
486#
487# }
488# }
489# Response:
490# {
491#
492# "data": {
493#
494# "createAutomateFlow": {
495#
496# "engineId": "567",
497#
498# "build": {
499#
500# "engineId": 567
501#
502# }
503#
504# }
505#
506# }
507# }
508#
509# Arguments
510# input: Fields needed to create a new automate flow
511createAutomateFlow(input: AutomateFlowInput!): AutomateRunConfig
512
513# Create a new engine. The engine will need to go
514# through a sequence of workflow steps before
515# use in production. See VDA documentation for details.
516# Example:
517# Request:
518# mutation {
519#
520# createEngine(input: {
521#
522# id: "123",
523#
524# name: "example",
525#
526# categoryId: "581dbb32-ea5b-4458-bd15-8094942345e3",
527#
528# deploymentModel: FullyNetworkIsolated
529#
530# useCases: [],
531#
532# industries: []
533#
534# }) {
535#
536# id
537#
538# ownerOrganizationId
539#
540# }
541# }
542# Response:
543# {
544#
545# "data": {
546#
547# "createEngine": {
548#
549# "id": "123",
550#
551# "ownerOrganizationId": "35521"
552#
553# }
554#
555# }
556# }
557#
558# Arguments
559# input: Fields needed to create a new engine
560createEngine(input: CreateEngine): Engine
561
562# Update an engine. Engines are subject to specific
563# workflow steps. An engine's state determines what
564# updates can be made to it. See VDA documentation for
565# details.
566# Example:
567# Request:
568# mutation {
569#
570# updateEngine(input: {
571#
572# id:"123",
573#
574# isPublic: false,
575#
576# name: "example",
577#
578# deploymentModel: FullyNetworkIsolated,
579#
580# price: 1}) {
581#
582# id
583#
584# ownerOrganizationId
585#
586# name
587#
588# price
589#
590# }
591# }
592# Response:
593# {
594#
595# "data": {
596#
597# "updateEngine": {
598#
599# "id": "123",
600#
601# "ownerOrganizationId": "35521",
602#
603# "name": "example",
604#
605# "price": 1
606#
607# }
608#
609# }
610# }
611#
612# Arguments
613# input: Fields needed to update an engine
614updateEngine(input: UpdateEngine): Engine
615
616# Delete an engine
617# Example:
618# Request:
619# mutation {
620#
621# deleteEngine(
622#
623# id: "123") {
624#
625# id
626#
627# message
628#
629# }
630# }
631# Response:
632# {
633#
634# "data": {
635#
636# "deleteEngine": {
637#
638# "id": "123",
639#
640# "message": "engine 123 deleted"
641#
642# }
643#
644# }
645# }
646#
647# Arguments
648# id: Provide the ID of the engine to delete
649deleteEngine(id: ID!): DeletePayload
650
651# Create an engine build.
652# Example:
653# Request:
654#
655# mutation {
656#
657# createEngineBuild(input: {
658#
659# engineId: "1",
660#
661# taskRuntime: [],
662#
663# dockerImage: "build",
664#
665# manifest: [] }) {
666#
667# id
668#
669# name
670#
671# engineId
672#
673# }
674#
675# realeaseNotes: "Includes feature x..."
676#
677# }
678#
679# }
680# Response:
681# {
682#
683# "data": {
684#
685# "createEngineBuild": {
686#
687# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
688#
689# "name": "example Version 1",
690#
691# "engineId": "1",
692#
693# "releaseNotes": "Includes feature x..."
694#
695# }
696#
697# }
698# }
699#
700# Arguments
701# input: Fields needed to create an engine build.
702createEngineBuild(input: CreateBuild!): Build
703
704# Update an engine build. Engine builds are subject to
705# specific workflow steps. A build's state determines what
706# updates can be made to it. See VDA documentation for details.
707# Example:
708# Request:
709# mutation {
710#
711# updateEngineBuild(input: {
712#
713# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
714#
715# engineId: "1",
716#
717# action: update,
718#
719# taskRuntime: []}) {
720#
721# id
722#
723# name
724#
725# }
726#
727# releaseNotes: "Includes feature x..."
728#
729# }
730# }
731# Response:
732# {
733#
734# "data": {
735#
736# "updateEngineBuild": {
737#
738# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
739#
740# "name": "example Version 3"
741#
742# "releaseNotes": "Includes feature x..."
743#
744# }
745#
746# }
747# }
748#
749# Arguments
750# input: Fields needed to update an engine build.
751updateEngineBuild(input: UpdateBuild!): Build
752
753# Delete an engine build
754# Example:
755# Request:
756# mutation {
757#
758# deleteEngineBuild(input: {
759#
760# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
761#
762# engineId: "1"}) {
763#
764# id
765#
766# message
767#
768# }
769# }
770# Response:
771# {
772#
773# "data": {
774#
775# "deleteEngineBuild": {
776#
777# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
778#
779# "message": "Engine build 6f766576-03a9-42c4-8a96-f4cd932e7c6c deleted"
780#
781# }
782#
783# }
784# }
785#
786# Arguments
787# input: Fields needed to delete an engine build.
788deleteEngineBuild(input: DeleteBuild!): DeletePayload
789
790# Update a task
791#
792# Arguments
793# input: Fields required to update a task.
794updateTask(input: UpdateTask): Task
795
796# Arguments
797# reason: Short string describing the warning
798# message: Optional: the actual problem
799# referenceId: Optional: Reference ID for the warning, such as
800# assetId, or sourceId
801appendWarningToTask(
802taskId: ID,
803reason: String!,
804message: String,
805referenceId: ID
806): ID
807
808# Create a new application viewer, which are visual ways to consume engine output.
809# These can be pre-built by aiWARE or developed by third parties for custom views.
810# Example:
811# Request:
812# mutation {
813#
814# createApplicationViewer(input: {
815#
816# name: "example123",
817#
818# description: "Viewer used to display transcriptions.",
819#
820# icon: "https://s3.amazonaws.com/dev-api.veritone.com/7682/other/icon.png",
821#
822# mimetype: "application/json",
823#
824# viewerType: "external"
825#
826# }) {
827#
828# id
829#
830# name
831#
832# }
833# }
834# Response:
835# {
836#
837# "data": {
838#
839# "createApplicationViewer": {
840#
841# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
842#
843# "name": "example123"
844#
845# }
846#
847# }
848# }
849#
850# Arguments
851# input: Fields needed to create a new custom application.
852createApplicationViewer(
853input: CreateApplicationViewer!
854): ApplicationViewer
855
856# Create an Application Viewer build.
857# Example:
858# Request:
859#
860# mutation {
861#
862# createApplicationViewerBuild(input: {
863#
864# viewerId: "7e863365-94de-4ac9-8826-df1a398c9a21",
865#
866# sourceUrl: "https://viewers.aws-dev.veritone.com/json",
867#
868# accessUrl: "https://viewers.aws-dev.veritone.com/json"
869#
870# }) {
871#
872# viewerId
873#
874# viewerBuildId
875#
876# sourceUrl
877#
878# accessUrl
879#
880# version
881#
882# status
883#
884# }
885#
886# }
887# Response:
888# {
889#
890# "data": {
891#
892# "createApplicationViewerBuild": {
893#
894# "viewerId": "7e863365-94de-4ac9-8826-df1a398c9a21",
895#
896# "viewerBuildId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
897#
898# "sourceUrl": "https://viewers.aws-dev.veritone.com/json",
899#
900# "accessUrl": "https://viewers.aws-dev.veritone.com/json",
901#
902# "version": "1",
903#
904# "status": "draft"
905#
906# }
907#
908# }
909# }
910#
911# Arguments
912# input: Fields needed to create an engine build.
913createApplicationViewerBuild(
914input: CreateApplicationViewerBuild!
915): ApplicationViewerBuild
916
917addTasksToJobs(input: AddTasksToJobs): AddTasksToJobsResponse
918
919# Create a job
920#
921# Arguments
922# input: Fields required to create a job.
923createJob(input: CreateJob): Job
924
925# Cancel a job. This action effectively deletes the job,
926# although a records of job and task execution remains in
927# Veritone's database.
928#
929# Arguments
930# id: Supply the ID of the job to delete.
931cancelJob(id: ID!): DeletePayload
932
933# Retry a job. This action applies only to jobs
934# that are in a failure state. The task sequence
935# for the job will be restarted in its original
936# configuration.
937#
938# Arguments
939# id: Supply the ID of the job to retry.
940# clusterId: Use this field to change the cluster id, by default
941# the job
942# will be retried on the same cluster as the original
943retryJob(id: ID!, clusterId: ID): Job
944
945# Create and launch a job executing a single engine,
946# using the default engine DAG definition modified with the
947# supplied field values
948launchSingleEngineJob(input: SingleEngineJobInput!): Job
949
950# Create and launch a job executing multiple engines,
951# using a DAG template definition modified with the
952# supplied field values.
953launchDAGTemplate(input: LaunchDAGTemplateInput!): Job
954
955updateJobs(input: UpdateJobs!): JobList
956
957# This creates a config definition for an application
958applicationConfigDefinitionCreate(
959input: [ApplicationConfigDefinitionCreate]
960): ApplicationConfigDefinitionList
961
962# This updates an existing config definition for an application
963applicationConfigDefinitionUpdate(
964input: [ApplicationConfigDefinitionUpdateInput]
965): ApplicationConfigDefinitionList
966
967# This removes an existing config definition from an application
968applicationConfigDefinitionDelete(
969input: ApplicationConfigDefinitionDelete
970): OperationResult
971
972# This sets configs for an app/org/user
973applicationConfigSet(
974input: ApplicationConfigSetConfigInput
975): ApplicationConfigList
976
977# This removes configs for an app/org/user
978applicationConfigDelete(input: ApplicationConfigDelete): OperationResult
979
980# This adds an application to an organization.
981#
982# Arguments
983# orgId: OrgID
984# appId: AppID
985# configs: Pass in configs
986applicationAddToOrg(
987orgId: ID!,
988appId: ID!,
989configs: [ApplicationConfigInput!]
990): Application!
991
992# This removes an application from an organization
993applicationRemoveFromOrg(
994orgId: ID!,
995appId: ID!,
996userId: ID,
997clearConfigs: Boolean
998): OperationResult
999
1000# This creates headerbar information for an application/organization
1001createApplicationHeaderbar(
1002appId: ID!,
1003orgId: ID,
1004input: ApplicationHeaderbarInput
1005): ApplicationHeaderbar
1006
1007# This updates headerbar information for an application/organization
1008updateApplicationHeaderbar(
1009appId: ID!,
1010orgId: ID,
1011input: ApplicationHeaderbarUpdate
1012): ApplicationHeaderbar
1013
1014# Create a new application. An application must
1015# go through a sequence of workflow steps before
1016# it is available in production. See the VDA documentation
1017# for details.
1018# Example:
1019# Request:
1020# mutation {
1021#
1022# createApplication(input: {
1023#
1024# name: "example123",
1025#
1026# key: "example123",
1027#
1028# category: "example",
1029#
1030# url: "www.veritone.com",
1031#
1032# checkPermissions: true}) {
1033#
1034# id
1035#
1036# name
1037#
1038# }
1039# }
1040# Response:
1041# {
1042#
1043# "data": {
1044#
1045# "createApplication": {
1046#
1047# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
1048#
1049# "name": "example123"
1050#
1051# }
1052#
1053# }
1054# }
1055#
1056# Arguments
1057# input: Fields needed to create a new custom application.
1058createApplication(input: CreateApplication): Application
1059
1060# Delete an application
1061# Example:
1062# Request:
1063# mutation {
1064#
1065# deleteApplication(
1066#
1067# id: "7e863365-94de-4ac9-8826-df1a398c9a21") {
1068#
1069# id
1070#
1071# message
1072#
1073# }
1074# }
1075# Response:
1076# {
1077#
1078# "data": {
1079#
1080# "deleteApplication": {
1081#
1082# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
1083#
1084# "message": null
1085#
1086# }
1087#
1088# }
1089# }
1090#
1091# Arguments
1092# id: Supply the ID of the application to delete.
1093deleteApplication(id: ID!): DeletePayload
1094
1095# Update a custom application. Applications are subject to
1096# specific workflows. The current application state determines
1097# what updates can be made to it. See VDA documentation for details.
1098# Example:
1099# Request:
1100# mutation {
1101#
1102# updateApplication(input: {
1103#
1104# name: "example123",
1105#
1106# id: "7e863365-94de-4ac9-8826-df1a398c9a21"
1107#
1108# category: "example",
1109#
1110# url: "www.veritone.com",
1111#
1112# checkPermissions: true,
1113#
1114# oauth2RedirectUrls: [],
1115#
1116# permissionsRequired: []}) {
1117#
1118# id
1119#
1120# name
1121#
1122# url
1123#
1124# }
1125# }
1126# Response:
1127# {
1128#
1129# "data": {
1130#
1131# "updateApplication": {
1132#
1133# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
1134#
1135# "name": "example123",
1136#
1137# "url": "www.veritone.com"
1138#
1139# }
1140#
1141# }
1142# }
1143#
1144# Arguments
1145# input: Fields required to update a custom application.
1146updateApplication(input: UpdateApplication): Application
1147
1148# Deprecated: Application Components are no longer supported.
1149# Instead, use packageUpdate or packageUpdateResources to associate
1150# resources with the application's package.
1151updateApplicationComponent(
1152input: UpdateApplicationComponent!
1153): ApplicationComponent!
1154
1155# Update an application's billing plan id for an organization.
1156# Example:
1157# Request:
1158# mutation {
1159#
1160# updateApplicationBillingPlanId(
1161#
1162# applicationId:"32babe30-fb42-11e4-89bc-27b69865858a",
1163#
1164# organizationId: "35521",
1165#
1166# billingPlanId: "123") {
1167#
1168# applicationId
1169#
1170# billingDirty
1171#
1172# }
1173# }
1174# Response:
1175# {
1176#
1177# "data": {
1178#
1179# "updateApplicationBillingPlanId": {
1180#
1181# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1182#
1183# "billingDirty": true
1184#
1185# }
1186#
1187# }
1188# }
1189updateApplicationBillingPlanId(
1190applicationId: ID!,
1191organizationId: ID!,
1192billingPlanId: String!
1193): ApplicationBillingPlanId!
1194
1195# Update an application's billing dirty for an organization.
1196# Example:
1197# Request:
1198# mutation {
1199#
1200# updateApplicationBillingDirty(
1201#
1202# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a",
1203#
1204# organizationId: "35521",
1205#
1206# billingDirty: false) {
1207#
1208# applicationId
1209#
1210# billingDirty
1211#
1212# }
1213# }
1214# Response:
1215# {
1216#
1217# "data": {
1218#
1219# "updateApplicationBillingDirty": {
1220#
1221# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1222#
1223# "billingDirty": false
1224#
1225# }
1226#
1227# }
1228# }
1229updateApplicationBillingDirty(
1230applicationId: ID!,
1231organizationId: ID!,
1232billingDirty: Boolean!
1233): ApplicationBillingDirty!
1234
1235# Bulk delete context menu extensions.
1236# Example:
1237# Request:
1238# mutation {
1239#
1240# bulkDeleteContextMenuExtensions(input: {
1241#
1242# ids: []}) {
1243#
1244# mentions{
1245#
1246# id
1247#
1248# }
1249#
1250# }
1251# }
1252# Response:
1253# {
1254#
1255# "data": {
1256#
1257# "bulkDeleteContextMenuExtensions": {
1258#
1259# "mentions": []
1260#
1261# }
1262#
1263# }
1264# }
1265fileApplication(input: FileApplication!): Application
1266
1267unfileApplication(input: UnfileApplication!): Application
1268
1269bulkDeleteContextMenuExtensions(
1270input: BulkDeleteContextMenuExtensions
1271): ContextMenuExtensionList
1272
1273# Update an organization
1274# Example:
1275# Request:
1276# mutation {
1277#
1278# updateOrganization(input: {
1279#
1280# id: "35521",
1281#
1282# indexTDOsByDefault: true}) {
1283#
1284# id
1285#
1286# status
1287#
1288# }
1289# }
1290# Response:
1291# {
1292#
1293# "data": {
1294#
1295# "updateOrganization": {
1296#
1297# "id": "35521",
1298#
1299# "status": "active"
1300#
1301# }
1302#
1303# }
1304# }
1305#
1306# Arguments
1307# input: Fields required to update an organization.
1308updateOrganization(input: UpdateOrganization!): Organization
1309
1310# Update organization billing policy. Requires superadmin
1311#
1312# Arguments
1313# planId: External billing plan id.
1314# targetOrganizationId: Optional organization id, to use when the
1315# caller is a superadmin from a different org
1316updateOrganizationBilling(
1317planId: String!,
1318targetOrganizationId: ID
1319): OrganizationBilling
1320
1321addToEngineWhitelist(toAdd: SetEngineWhitelist!): EngineWhitelist
1322
1323addToEngineBlacklist(toAdd: SetEngineBlacklist!): EngineBlacklist
1324
1325deleteFromEngineBlacklist(
1326toDelete: SetEngineBlacklist!
1327): EngineBlacklist
1328
1329deleteFromEngineWhitelist(
1330toDelete: SetEngineBlacklist!
1331): EngineWhitelist
1332
1333# Create an entity identifier type, such as "face" or "image".
1334# Entity identifier types are typically created or modified
1335# only by Veritone engineering. Most libraries and
1336# entities will use existing entity identifier types.
1337# Example:
1338# Request:
1339# mutation {
1340#
1341# createEntityIdentifierType(input: {
1342#
1343# label: "example"
1344#
1345# labelPlural: "example"
1346#
1347# iconClass: null
1348#
1349# description: "example"
1350#
1351# dataType: text
1352#
1353# id: "123"}) {
1354#
1355# id
1356#
1357# description
1358#
1359# }
1360# }
1361# Response:
1362# {
1363#
1364# "data": {
1365#
1366# "createEntityIdentifierType": {
1367#
1368# "id": "123",
1369#
1370# "description": null
1371#
1372# }
1373#
1374# }
1375# }
1376#
1377# Arguments
1378# input: Fields required to create an entity identifier type.
1379createEntityIdentifierType(
1380input: CreateEntityIdentifierType!
1381): EntityIdentifierType
1382
1383# Update an entity identifier type.
1384# Example:
1385# Request:
1386# mutation {
1387#
1388# updateEntityIdentifierType(input: {
1389#
1390# id: "123",
1391#
1392# label: "example",
1393#
1394# labelPlural: "example"
1395#
1396# description: "new description",
1397#
1398# dataType: image}) {
1399#
1400# id
1401#
1402# description
1403#
1404# }
1405# }
1406# Response:
1407# {
1408#
1409# "data": {
1410#
1411# "updateEntityIdentifierType": null
1412#
1413# }
1414# }
1415#
1416# Arguments
1417# input: Fields required to update an entity identifier type.
1418updateEntityIdentifierType(
1419input: UpdateEntityIdentifierType!
1420): EntityIdentifierType
1421
1422# Create a library type, such as "ad" or "people".
1423# Entity identifier types are typically created or modified
1424# only by Veritone engineering. Most libraries
1425# will use existing entity identifier types.
1426# Example:
1427# Request:
1428# mutation {
1429#
1430# createLibraryType(input: {
1431#
1432# id: "123",
1433#
1434# label: "example",
1435#
1436# entityIdentifierTypeIds: ["123"],
1437#
1438# entityType: {
1439#
1440# name: "example",
1441#
1442# namePlural: "example",
1443#
1444# schema: {
1445#
1446# example: "example" }}}) {
1447#
1448# id
1449#
1450# label
1451#
1452# }
1453# }
1454# Response:
1455# {
1456#
1457# "data": {
1458#
1459# "createLibraryType": {
1460#
1461# "id": "123",
1462#
1463# "label": "example"
1464#
1465# }
1466#
1467# }
1468# }
1469#
1470# Arguments
1471# input: Fields needed to create a new library type.
1472createLibraryType(input: CreateLibraryType!): LibraryType
1473
1474# Update a library type.
1475# Example:
1476# Request:
1477# mutation {
1478#
1479# updateLibraryType(input: {
1480#
1481# id: "123",
1482#
1483# label: "example",
1484#
1485# entityIdentifierTypeIds: ["123"],
1486#
1487# entityType: {
1488#
1489# name: "example",
1490#
1491# namePlural: "example",
1492#
1493# schema: {
1494#
1495# example: "new example" }}}) {
1496#
1497# id
1498#
1499# label
1500#
1501# }
1502# }
1503# Response:
1504# {
1505#
1506# "data": {
1507#
1508# "updateLibraryType": null
1509#
1510# }
1511# }
1512#
1513# Arguments
1514# input: Fields needed to update a library type.
1515updateLibraryType(input: UpdateLibraryType!): LibraryType
1516
1517# Create a new library.
1518# Once the library is created, the client can add
1519# entities and entity identifiers. Note that the
1520# library type determines what types of entity identifiers
1521# can be used within the library.
1522# Example:
1523# Request:
1524# mutation {
1525#
1526# createLibrary(input: {
1527#
1528# name: "example"
1529#
1530# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a"
1531#
1532# organizationId: "35521"
1533#
1534# libraryTypeId: "123"
1535#
1536# coverImageUrl:
1537# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1538#
1539# description: "example"}) {
1540#
1541# id
1542#
1543# name
1544#
1545# }
1546# }
1547# Response:
1548# {
1549#
1550# "data": {
1551#
1552# "createLibrary": {
1553#
1554# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1555#
1556# "name": "example"
1557#
1558# }
1559#
1560# }
1561# }
1562#
1563# Arguments
1564# input: Fields needed to create a new library.
1565createLibrary(input: CreateLibrary!): Library
1566
1567# Update an existing library.
1568# Example:
1569# Request:
1570# mutation {
1571#
1572# updateLibrary(input: {
1573#
1574# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1575#
1576# name: "example"
1577#
1578# coverImageUrl:
1579# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1580#
1581# description: "new description"
1582#
1583# libraryTypeId: "123"
1584#
1585# version: 2}) {
1586#
1587# id
1588#
1589# name
1590#
1591# description
1592#
1593# }
1594# }
1595# Response:
1596# {
1597#
1598# "data": {
1599#
1600# "updateLibrary": {
1601#
1602# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1603#
1604# "name": "example",
1605#
1606# "description": "new description"
1607#
1608# }
1609#
1610# }
1611# }
1612#
1613# Arguments
1614# input: Fields needed to update a library
1615updateLibrary(input: UpdateLibrary!): Library
1616
1617# Delete a library. This mutation will also delete all entities,
1618# entity identifiers, library engine models, and associated objects.
1619# Example:
1620# Request:
1621# mutation {
1622#
1623# deleteLibrary(id:"d232c90f-ae47-4125-b884-0d35fbed7e5f") {
1624#
1625# message
1626#
1627# }
1628# }
1629# Response:
1630# {
1631#
1632# "data": {
1633#
1634# "deleteLibrary": {
1635#
1636# "message": "d232c90f-ae47-4125-b884-0d35fbed7e5f deleted"
1637#
1638# }
1639#
1640# }
1641# }
1642#
1643# Arguments
1644# id: Provide the ID of the library to delete.
1645deleteLibrary(id: ID!): DeletePayload
1646
1647# Publish a new version of a library.
1648# Increments library version by one and trains compatible engines.
1649# Example:
1650# Request:
1651# mutation {
1652#
1653# publishLibrary(
1654#
1655# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1656#
1657# name
1658#
1659# description
1660#
1661# version
1662#
1663# }
1664# }
1665# Response:
1666# {
1667#
1668# "data": {
1669#
1670# "publishLibrary": {
1671#
1672# "name": "example",
1673#
1674# "description": "new description",
1675#
1676# "version": 2
1677#
1678# }
1679#
1680# }
1681# }
1682#
1683# Arguments
1684# id: ID of the library to publish
1685publishLibrary(id: ID!): Library
1686
1687# Create a new entity.
1688# Example:
1689# Request:
1690# mutation {
1691#
1692# createEntity(input: {
1693#
1694# name: "example",
1695#
1696# description: "example",
1697#
1698# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1699#
1700# jsondata: {
1701#
1702# example: "new example" }}) {
1703#
1704# id
1705#
1706# name
1707#
1708# }
1709# }
1710# Response:
1711# {
1712#
1713# "data": {
1714#
1715# "createEntity": {
1716#
1717# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1718#
1719# "name": "example"
1720#
1721# }
1722#
1723# }
1724# }
1725#
1726# Arguments
1727# input: Fields required to create a new entity.
1728createEntity(input: CreateEntity!): Entity
1729
1730# Update an entity.
1731# Example:
1732# Request:
1733# mutation {
1734#
1735# updateEntity(input: {
1736#
1737# id: "85b700fa-f327-4fea-b94b-ed83054170db",
1738#
1739# name: "example",
1740#
1741# description: "example",
1742#
1743# jsondata: {
1744#
1745# example: "updated example" }}) {
1746#
1747# id
1748#
1749# name
1750#
1751# jsondata
1752#
1753# }
1754# }
1755# Response:
1756# {
1757#
1758# "data": {
1759#
1760# "updateEntity": {
1761#
1762# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1763#
1764# "name": "example",
1765#
1766# "jsondata": {
1767#
1768# "example": "updated example"
1769#
1770# }
1771#
1772# }
1773#
1774# }
1775# }
1776#
1777# Arguments
1778# input: Fields required to update an entity.
1779updateEntity(input: UpdateEntity!): Entity
1780
1781# Delete an entity. This mutation will also delete all associated
1782# entity identifiers and associated objects.
1783# Example:
1784# Request:
1785# mutation {
1786#
1787# deleteEntity(id: "522bc6cf-5b7c-47bd-bd30-10cd77016a49") {
1788#
1789# message
1790#
1791# }
1792# }
1793# Response:
1794# {
1795#
1796# "data": {
1797#
1798# "deleteEntity": {
1799#
1800# "message": "Entity 522bc6cf-5b7c-47bd-bd30-10cd77016a49 deleted."
1801#
1802# }
1803#
1804# }
1805# }
1806#
1807# Arguments
1808# id: Supply the ID of the entity to delete.
1809deleteEntity(id: ID!): DeletePayload
1810
1811# Create an entity identifier.
1812# This mutation accepts file uploads. To use this mutation and upload a file,
1813# send a multipart form POST containing two parameters: `query`, with the
1814# GraphQL query, and `file` containing the file itself.
1815# For more information see the documentation at
1816# https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL.
1817# Example:
1818# Request:
1819# mutation {
1820#
1821# createEntityIdentifier(input: {
1822#
1823# entityId: "85b700fa-f327-4fea-b94b-ed83054170db",
1824#
1825# identifierTypeId: "123",
1826#
1827# title: "example",
1828#
1829# isPriority: false,
1830#
1831# contentType: "example",
1832#
1833# url:
1834# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1835# {
1836#
1837# id
1838#
1839# isPriority
1840#
1841# }
1842# }
1843# Result:
1844# {
1845#
1846# "data": {
1847#
1848# "createEntityIdentifier": {
1849#
1850# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1851#
1852# "isPriority": false,
1853#
1854# }
1855#
1856# }
1857# }
1858#
1859# Arguments
1860# input: Fields needed to create an entity identifier.
1861createEntityIdentifier(input: CreateEntityIdentifier!): EntityIdentifier
1862
1863# Updates an entity identifier.
1864# Example:
1865# Request:
1866# mutation {
1867#
1868# updateEntityIdentifier(input: {
1869#
1870# id: "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1871#
1872# title: "example",
1873#
1874# isPriority: true,
1875#
1876# url:
1877# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1878# {
1879#
1880# id
1881#
1882# isPriority
1883#
1884# }
1885# }
1886# Response:
1887# {
1888#
1889# "data": {
1890#
1891# "updateEntityIdentifier": {
1892#
1893# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1894#
1895# "isPriority": true
1896#
1897# }
1898#
1899# }
1900# }
1901#
1902# Arguments
1903# input: Fields required to update an entity identifier.
1904updateEntityIdentifier(input: UpdateEntityIdentifier!): EntityIdentifier
1905
1906# Delete an entity identifier
1907# Example:
1908# Request:
1909# mutation {
1910#
1911# deleteEntityIdentifier(id: "0bda9fa6-9fad-4025-8f03-07cc73321050") {
1912#
1913# message
1914#
1915# }
1916# }
1917# Response:
1918# {
1919#
1920# "data": {
1921#
1922# "deleteEntityIdentifier": {
1923#
1924# "message": "Entity identifier0bda9fa6-9fad-4025-8f03-07cc73321050 deleted."
1925#
1926# }
1927#
1928# }
1929# }
1930#
1931# Arguments
1932# id: Supply the ID of the entity identifier to delete.
1933deleteEntityIdentifier(id: ID!): DeletePayload
1934
1935# Create a library engine model.
1936# Example:
1937# Request:
1938# mutation {
1939#
1940# createLibraryEngineModel(input: {
1941#
1942# engineId: "1",
1943#
1944# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1945#
1946# trainJobId: "123",
1947#
1948# dataUrl:
1949# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1950# {
1951#
1952# id
1953#
1954# engineId
1955#
1956# }
1957# }
1958# Response:
1959# {
1960#
1961# "data": {
1962#
1963# "createLibraryEngineModel": {
1964#
1965# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1966#
1967# "engineId": "1"
1968#
1969# }
1970#
1971# }
1972# }
1973#
1974# Arguments
1975# input: Fields required to create a library engine model.
1976createLibraryEngineModel(
1977input: CreateLibraryEngineModel!
1978): LibraryEngineModel
1979
1980# Update a library engine model
1981# Example:
1982# Request:
1983# mutation {
1984#
1985# updateLibraryEngineModel(input: {
1986#
1987# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1988#
1989# trainJobId: "1234"}) {
1990#
1991# trainJobId
1992#
1993# }
1994# }
1995# Response:
1996# {
1997#
1998# "data": {
1999#
2000# "updateLibraryEngineModel": {
2001#
2002# "trainJobId": "1234"
2003#
2004# }
2005#
2006# }
2007# }
2008#
2009# Arguments
2010# input: Fields required to update a library engine model
2011updateLibraryEngineModel(
2012input: UpdateLibraryEngineModel!
2013): LibraryEngineModel
2014
2015# Delete a library engine model
2016# Example:
2017# Request:
2018# mutation {
2019#
2020# deleteLibraryEngineModel(
2021#
2022# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b") {
2023#
2024# id
2025#
2026# message
2027#
2028# }
2029# }
2030# Response:
2031# {
2032#
2033# "data": {
2034#
2035# "deleteLibraryEngineModel": {
2036#
2037# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
2038#
2039# "message": "library engine model 0e9c25f7-d994-4363-af41-c00b37de9a1b deleted."
2040#
2041# }
2042#
2043# }
2044# }
2045#
2046# Arguments
2047# id: Supply the ID of the library engine model to delete.
2048deleteLibraryEngineModel(id: ID!): DeletePayload
2049
2050# Create a library collaborator.
2051# Example:
2052# Request:
2053# mutation {
2054#
2055# createLibraryCollaborator(input: {
2056#
2057# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2058#
2059# organizationId: 35521,
2060#
2061# permissions: ["job.create"]}) {
2062#
2063# organizationId
2064#
2065# status
2066#
2067# }
2068# }
2069# Response:
2070# {
2071#
2072# "data": {
2073#
2074# "createLibraryCollaborator": {
2075#
2076# "organizationId": "35521",
2077#
2078# "status": "active"
2079#
2080# }
2081#
2082# }
2083# }
2084#
2085# Arguments
2086# input: Fields required to create a library collaborator.
2087createLibraryCollaborator(
2088input: CreateLibraryCollaborator!
2089): LibraryCollaborator
2090
2091# Update a library collaborator
2092# Example:
2093# Request:
2094# mutation {
2095#
2096# updateLibraryCollaborator(input: {
2097#
2098# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2099#
2100# organizationId: 35521,
2101#
2102# permissions: ["job.create", "job.read"]}) {
2103#
2104# status
2105#
2106# permissions
2107#
2108# }
2109# }
2110# Response:
2111# {
2112#
2113# "data": {
2114#
2115# "updateLibraryCollaborator": {
2116#
2117# "status": "active",
2118#
2119# "permissions": [
2120#
2121# "job.create"
2122#
2123# ]
2124#
2125# }
2126#
2127# }
2128# }
2129#
2130# Arguments
2131# input: Fields required to update a library collaborator
2132updateLibraryCollaborator(
2133input: UpdateLibraryCollaborator!
2134): LibraryCollaborator
2135
2136# Delete a library collaborator
2137# Example:
2138# Request:
2139# mutation {
2140#
2141# deleteLibraryCollaborator(
2142#
2143# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2144#
2145# organizationId: "35521") {
2146#
2147# id
2148#
2149# message
2150#
2151# }
2152# }
2153# Response:
2154# {
2155#
2156# "data": {
2157#
2158# "deleteLibraryCollaborator": {
2159#
2160# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599 - 35521",
2161#
2162# "message": "library collaborator model libraryId:
2163# e0a6e5ad-dec8-49a1-ad33-3f1194c2e599, organizationId: 35521 deleted."
2164#
2165# }
2166#
2167# }
2168# }
2169#
2170# Arguments
2171# libraryId: Supply the ID of the library collaborator to delete.
2172# organizationId: Supply the ID of the library collaborator to
2173# delete.
2174deleteLibraryCollaborator(
2175libraryId: ID!,
2176organizationId: ID!
2177): DeletePayload
2178
2179# Create Dataset Library Configuration
2180# Example
2181# Request:
2182# mutation {
2183#
2184# createLibraryConfiguration(input: {
2185#
2186# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2187#
2188# engineCategoryId: "c1e5f177-ca10-433a-a155-bb5e4872cf9a",
2189#
2190# targetEngineIds: ["1"],
2191#
2192# confidence: {}}) {
2193#
2194# id
2195#
2196# }
2197# }
2198# Response:
2199# {
2200#
2201# "data": {
2202#
2203# "createLibraryConfiguration": {
2204#
2205# "id": "7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7"
2206#
2207# }
2208#
2209# }
2210# }
2211#
2212# Arguments
2213# input: Fields required to create library configuration
2214createLibraryConfiguration(
2215input: CreateLibraryConfiguration!
2216): LibraryConfiguration
2217
2218# Update Dataset Library Configuration
2219#
2220# Arguments
2221# input: Fields required to create library configuration
2222updateLibraryConfiguration(
2223input: UpdateLibraryConfiguration!
2224): LibraryConfiguration
2225
2226# Delete Dataset Library Configuration
2227#
2228# Arguments
2229# id: Supply configuration ID to delete.
2230deleteLibraryConfiguration(id: ID!): DeletePayload
2231
2232# Add recordings to a dataset library
2233# Example:
2234# Request:
2235# mutation {
2236#
2237# addLibraryDataset(input: {
2238#
2239# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2240#
2241# tdoIds: ["1570899328"]}) {
2242#
2243# tdoIds
2244#
2245# }
2246# }
2247# Response:
2248# {
2249#
2250# "data": {
2251#
2252# "addLibraryDataset": {
2253#
2254# "tdoIds": [
2255#
2256# "1570899328"
2257#
2258# ]
2259#
2260# }
2261#
2262# }
2263# }
2264addLibraryDataset(input: AddLibraryDataset!): LibraryDataset
2265
2266# Remove recordings from a dataset library
2267# Example:
2268# Request:
2269# mutation {
2270#
2271# deleteLibraryDataset(input: {
2272#
2273# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2274#
2275# tdoIds: ["1570899328"]}) {
2276#
2277# tdoIds
2278#
2279# message
2280#
2281# }
2282# }
2283# Response:
2284# {
2285#
2286# "data": {
2287#
2288# "deleteLibraryDataset": {
2289#
2290# "tdoIds": [
2291#
2292# "1570899328"
2293#
2294# ],
2295#
2296# "message": "[1570899328] are removed from e0a6e5ad-dec8-49a1-ad33-3f1194c2e599"
2297#
2298# }
2299#
2300# }
2301# }
2302deleteLibraryDataset(input: DeleteLibraryDataset!): DeleteLibraryDatasetPayload
2303
2304# Apply an application workflow step, such as "submit" or "approve"
2305# Example:
2306# Request:
2307# mutation {
2308#
2309# applicationWorkflow(input: {
2310#
2311# id: "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2312#
2313# action: submit}) {
2314#
2315# id
2316#
2317# name
2318#
2319# }
2320# }
2321# Response:
2322# {
2323#
2324# "data": {
2325#
2326# "applicationWorkflow": {
2327#
2328# "id": "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2329#
2330# "name": "appexamplebill2"
2331#
2332# }
2333#
2334# }
2335# }
2336#
2337# Arguments
2338# input: Fields required to apply a application workflow step
2339applicationWorkflow(input: ApplicationWorkflow): Application
2340
2341# Apply an engine workflow step, such as "submit" or "approve"
2342#
2343# Arguments
2344# input: Fields required to apply a engine workflow step
2345engineWorkflow(input: EngineWorkflow): Engine
2346
2347# Creates a widget associated with a collection
2348# Example:
2349# Request:
2350# mutation {
2351#
2352# createWidget(input:{
2353#
2354# collectionId: "242361",
2355#
2356# name: "example",
2357#
2358# nextButtonColor: "000000"}) {
2359#
2360# id
2361#
2362# name
2363#
2364# }
2365# }
2366# Response:
2367# {
2368#
2369# "data": {
2370#
2371# "createWidget": {
2372#
2373# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2374#
2375# "name": ""
2376#
2377# }
2378#
2379# }
2380# }
2381#
2382# Arguments
2383# input: Fields needed to create a new widget
2384createWidget(input: CreateWidget): Widget
2385
2386# Updates a widget
2387# Example:
2388# Request:
2389# mutation {
2390#
2391# updateWidget(input: {
2392#
2393# id: "fwSwWdRWTm2fdFMoPQDKkg",
2394#
2395# name: "new example name"}) {
2396#
2397# id
2398#
2399# name
2400#
2401# }
2402# }
2403# Response:
2404# {
2405#
2406# "data": {
2407#
2408# "updateWidget": {
2409#
2410# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2411#
2412# "name": "new example name"
2413#
2414# }
2415#
2416# }
2417# }
2418#
2419# Arguments
2420# input: Fields needed to update a widget
2421updateWidget(input: UpdateWidget): Widget
2422
2423# Create a new user within an organization.
2424# Example:
2425# Request:
2426# mutation {
2427#
2428# createUser(input: {
2429#
2430# name: "example",
2431#
2432# password: "example",
2433#
2434# organizationId: "35521"}) {
2435#
2436# id
2437#
2438# }
2439# }
2440# Response:
2441# {
2442#
2443# "data": {
2444#
2445# "createUser": {
2446#
2447# "id": "267de7e1-efb2-444a-a524-210328b78503"
2448#
2449# }
2450#
2451# }
2452# }
2453#
2454# Arguments
2455# input: Fields needed to create a user.
2456createUser(input: CreateUser): User
2457
2458# Create a new organization.
2459#
2460# Arguments
2461# input: Fields needed to create an organization. Requires
2462# superadmin
2463createOrganization(input: CreateOrganization!): Organization
2464
2465# Update an existing user'
2466# Example:
2467# Request:
2468# mutation {
2469#
2470# updateUser(input: {
2471#
2472# id: "267de7e1-efb2-444a-a524-210328b78503",
2473#
2474# firstName: "example",
2475#
2476# lastName: "example"}) {
2477#
2478# firstName
2479#
2480# lastName
2481#
2482# }
2483# }
2484# Response:
2485# {
2486#
2487# "data": {
2488#
2489# "updateUser": {
2490#
2491# "firstName": "example",
2492#
2493# "lastName": "example"
2494#
2495# }
2496#
2497# }
2498# }
2499#
2500# Arguments
2501# input: Fields needed to update a user
2502updateUser(input: UpdateUser): User
2503
2504# Add an existing user to an organization.
2505# One of the user identifiers (userId or userName) has to be specified.
2506#
2507# Arguments
2508# userId: UUID of user
2509# userName: User name to uniquely identify a user
2510# organizationGuid: UUID of organization
2511# roleIds: Role Ids.
2512# priority: Priority of the organization. If not provided, max
2513# priority plus one will be used.
2514addUserToOrganization(
2515userId: ID,
2516userName: String,
2517organizationGuid: ID!,
2518roleIds: [ID],
2519priority: Int
2520): User
2521
2522# Remove an existing user for organization.
2523# One of the user identifiers (userId or userName) has to be specified.
2524# The operation fails if the organization is the last one to which user belongs.
2525#
2526# Arguments
2527# userId: UUID of user
2528# userName: User name to uniquely identify a user
2529# organizationGuid: UUID of organization
2530removeUserFromOrganization(
2531userId: ID,
2532userName: String,
2533organizationGuid: ID!
2534): User
2535
2536# #Switch user to organization
2537#
2538# Arguments
2539# token: User token that should be logout
2540# userName: The user login name -- typically, email address.
2541# organizationGuid: GUID of organization.
2542switchUserToOrganization(
2543token: String!,
2544userName: String!,
2545organizationGuid: ID!
2546): LoginInfo
2547
2548# Force a user to update password on next login.
2549# This mutation is used by administrators.
2550# Example:
2551# Request:
2552# mutation {
2553#
2554# createPasswordUpdateRequest(input: {
2555#
2556# id: "267de7e1-efb2-444a-a524-210328b78503",
2557#
2558# skipPasswordResetEmail: true}) {
2559#
2560# id
2561#
2562# name
2563#
2564# }
2565# }
2566# Response:
2567# {
2568#
2569# "data": {
2570#
2571# "createPasswordUpdateRequest": {
2572#
2573# "id": "267de7e1-efb2-444a-a524-210328b78503",
2574#
2575# "name": "example"
2576#
2577# }
2578#
2579# }
2580# }
2581#
2582# Arguments
2583# input: Fields needed to create a password update request
2584createPasswordUpdateRequest(
2585input: CreatePasswordUpdateRequest
2586): User
2587
2588# Create a password reset request. This mutation is used on behalf
2589# of a user who needs to reset their password. It operates only on
2590# the currently authenicated user (based on the authentication token provided).
2591# Example:
2592# Request:
2593# mutation {
2594#
2595# createPasswordResetRequest(input: {
2596#
2597# userName: "example",
2598#
2599# skipPasswordResetEmail:true}) {
2600#
2601# message
2602#
2603# }
2604# }
2605# Response:
2606# {
2607#
2608# "data": {
2609#
2610# "createPasswordResetRequest": {
2611#
2612# "message": "Reset request issued for example. Email will not be sent."
2613#
2614# }
2615#
2616# }
2617# }
2618createPasswordResetRequest(
2619input: CreatePasswordResetRequest
2620): CreatePasswordResetRequestPayload
2621
2622# Update the current authenticated user
2623# Example:
2624# Request:
2625# mutation {
2626#
2627# updateCurrentUser(input: {
2628#
2629# title: "undefined"}) {
2630#
2631# id
2632#
2633# }
2634# }
2635# Response:
2636# {
2637#
2638# "data": {
2639#
2640# "updateCurrentUser": {
2641#
2642# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008"
2643#
2644# }
2645#
2646# }
2647# }
2648updateCurrentUser(input: UpdateCurrentUser!): User!
2649
2650# Get password token info for current user
2651# Example:
2652# Request:
2653# mutation {
2654#
2655# getCurrentUserPasswordToken(input: {
2656#
2657# password: "Example password"}) {
2658#
2659# passwordToken
2660#
2661# }
2662# }
2663# Response:
2664# {
2665#
2666# "data": {
2667#
2668# "getCurrentUserPasswordToken": {
2669#
2670# "passwordToken": "e4cb86c7-34a4-4a52-b458-3ebbb2cca9c3"
2671#
2672# }
2673#
2674# }
2675# }
2676getCurrentUserPasswordToken(
2677input: GetCurrentUserPasswordToken!
2678): PasswordTokenInfo!
2679
2680# Change the current authenticated user's password
2681#
2682# Arguments
2683# input: Fields needed to change password
2684changePassword(input: ChangePassword!): User
2685
2686# Delete a user
2687# Example:
2688# Request:
2689# mutation {
2690#
2691# deleteUser(
2692#
2693# id: "267de7e1-efb2-444a-a524-210328b78503") {
2694#
2695# message
2696#
2697# }
2698# }
2699# Response:
2700# {
2701#
2702# "data": {
2703#
2704# "deleteUser": {
2705#
2706# "message": null
2707#
2708# }
2709#
2710# }
2711# }
2712#
2713# Arguments
2714# id: Supply the ID of the user to delete.
2715deleteUser(id: ID!): DeletePayload
2716
2717# Create a structured data registry schema metadata.
2718# Example:
2719# Request:
2720# mutation {
2721#
2722# createDataRegistry(input: {
2723#
2724# name: "example",
2725#
2726# description: "example"
2727#
2728# source: "example"}) {
2729#
2730# id
2731#
2732# organizationId
2733#
2734# }
2735# }
2736# Response:
2737# {
2738#
2739# "data": {
2740#
2741# "createDataRegistry": {
2742#
2743# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2744#
2745# "organizationId": "35521"
2746#
2747# }
2748#
2749# }
2750# }
2751createDataRegistry(input: CreateDataRegistry!): DataRegistry
2752
2753# Update a structured data registry schema metadata.
2754# Example:
2755# Request:
2756# mutation {
2757#
2758# updateDataRegistry(input: {
2759#
2760# id: "230f95e4-95c9-47c4-a845-61ca67ad6ba6"
2761#
2762# name: "example"
2763#
2764# description: "example"
2765#
2766# source: "new source"}) {
2767#
2768# id
2769#
2770# source
2771#
2772# }
2773# }
2774# Response:
2775# {
2776#
2777# "data": {
2778#
2779# "updateDataRegistry": {
2780#
2781# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2782#
2783# "source": "new source"
2784#
2785# }
2786#
2787# }
2788# }
2789updateDataRegistry(input: UpdateDataRegistry!): DataRegistry
2790
2791# Create a schema record.
2792# Example:
2793# Request:
2794# mutation {
2795#
2796# createSchema(input: {
2797#
2798# id: "450f95e4-95c9-47c4-a845-62ca67ad6ea6",
2799#
2800# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2801#
2802# status: published,
2803#
2804# definition: {
2805#
2806# example: "example"
2807#
2808# },
2809#
2810# majorVersion: 1,
2811#
2812# minorVersion: 2
2813#
2814# }) {
2815#
2816# id
2817#
2818# }
2819# }
2820# Response:
2821# {
2822#
2823# "data": {
2824#
2825# "createSchema": {
2826#
2827# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2828#
2829# }
2830#
2831# }
2832# }
2833createSchema(input: CreateSchema!): Schema
2834
2835# Update a structured data registry schema.
2836# Example:
2837# Request:
2838# mutation {
2839#
2840# upsertSchemaDraft(input: {
2841#
2842# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2843#
2844# schema: {
2845#
2846# example: "example"
2847#
2848# }}) {
2849#
2850# id
2851#
2852# }
2853# }
2854# Response:
2855# {
2856#
2857# "data": {
2858#
2859# "upsertSchemaDraft": {
2860#
2861# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2862#
2863# }
2864#
2865# }
2866# }
2867upsertSchemaDraft(input: UpsertSchemaDraft!): Schema
2868
2869# Update the state of a schema
2870# Example:
2871# Request:
2872# mutation {
2873#
2874# updateSchemaState(input: {
2875#
2876# id: "0bd05e43-ddac-4b1a-9238-f3b177439b91",
2877#
2878# status: deleted}) {
2879#
2880# id
2881#
2882# }
2883# }
2884# Response:
2885# {
2886#
2887# "data": {
2888#
2889# "updateSchemaState": {
2890#
2891# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2892#
2893# }
2894#
2895# }
2896# }
2897updateSchemaState(input: UpdateSchemaState!): Schema
2898
2899# Create (ingest) a structured data object
2900# Example:
2901# Request:
2902# mutation {
2903#
2904# createStructuredData(input: {
2905#
2906# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2907#
2908# data: {
2909#
2910# example: "example"
2911#
2912# }}) {
2913#
2914# id
2915#
2916# }
2917# }
2918# Response:
2919# {
2920#
2921# "data": {
2922#
2923# "createStructuredData": {
2924#
2925# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa"
2926#
2927# }
2928#
2929# }
2930# }
2931createStructuredData(input: CreateStructuredData!): StructuredData
2932
2933# Update an existing structured data object
2934# Example:
2935# Request:
2936# mutation {
2937#
2938# updateStructuredData(input: {
2939#
2940# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
2941#
2942# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2943#
2944# data: {
2945#
2946# name: "Updated Name",
2947#
2948# value: 42
2949#
2950# }
2951#
2952# }) {
2953#
2954# id
2955#
2956# schemaId
2957#
2958# data
2959#
2960# createdDateTime
2961#
2962# modifiedDateTime
2963#
2964# }
2965# }
2966# Response:
2967# {
2968#
2969# "data": {
2970#
2971# "updateStructuredData": {
2972#
2973# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa",
2974#
2975# "schemaId": "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2976#
2977# "data": {
2978#
2979# "name": "Updated Name",
2980#
2981# "value": 42
2982#
2983# },
2984#
2985# "createdDateTime": "2024-01-15T10:30:00.000Z",
2986#
2987# "modifiedDateTime": "2024-01-15T14:25:00.000Z"
2988#
2989# }
2990#
2991# }
2992# }
2993updateStructuredData(input: UpdateStructuredData!): StructuredData
2994
2995# Delete a structured data object
2996# Example:
2997# Request:
2998# mutation {
2999#
3000# deleteStructuredData(input:{
3001#
3002# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
3003#
3004# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) {
3005#
3006# message
3007#
3008# }
3009# }
3010# Response:
3011# {
3012#
3013# "data": {
3014#
3015# "deleteStructuredData": {
3016#
3017# "message": null
3018#
3019# }
3020#
3021# }
3022# }
3023deleteStructuredData(input: DeleteStructuredData!): DeletePayload
3024
3025# Create (ingest) a structured data object
3026# Example:
3027# Request:
3028# mutation {
3029#
3030# createCollection(input: {
3031#
3032# name: "example",
3033#
3034# folderDescription: "example",
3035#
3036# image:"",
3037#
3038# parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) {
3039#
3040# id
3041#
3042# }
3043# }
3044# Response:
3045# {
3046#
3047# "data": {
3048#
3049# "createCollection": {
3050#
3051# "id": "242361"
3052#
3053# }
3054#
3055# }
3056# }
3057#
3058# Arguments
3059# input: Fields required to create new collection
3060createCollection(input: CreateCollection): Collection
3061
3062# Update a collection
3063# Example:
3064# Request:
3065# mutation {
3066#
3067# updateCollection(input: {
3068#
3069# folderId: "242361"
3070#
3071# name: "new name"
3072#
3073# folderDescription: "new description"}) {
3074#
3075# id
3076#
3077# name
3078#
3079# }
3080# }
3081# Response:
3082# {
3083#
3084# "data": {
3085#
3086# "updateCollection": {
3087#
3088# "id": "242361",
3089#
3090# "name": "new name"
3091#
3092# }
3093#
3094# }
3095# }
3096#
3097# Arguments
3098# input: Fields needed to update a collection
3099updateCollection(input: UpdateCollection): Collection
3100
3101# Delete Collection
3102# Example:
3103# Request:
3104# mutation {
3105#
3106# deleteCollection(
3107#
3108# id: "242361") {
3109#
3110# message
3111#
3112# }
3113# }
3114# Response:
3115# {
3116#
3117# "data": {
3118#
3119# "deleteCollection": {
3120#
3121# "message": "Deleted Successfully"
3122#
3123# }
3124#
3125# }
3126# }
3127#
3128# Arguments
3129# id: Supply the ID of the folder or collection to delete
3130deleteCollection(folderId: ID, id: ID): DeletePayload
3131
3132# Share a collection, allowing other organizations to view the data
3133# it contains.
3134# Example:
3135# Request:
3136# mutation {
3137#
3138# shareCollection(input: {
3139#
3140# folderId: "242599",
3141#
3142# shareMessage: "example",
3143#
3144# recipients: [] }) {
3145#
3146# id
3147#
3148# }
3149# }
3150# Response:
3151# {
3152#
3153# "data": {
3154#
3155# "shareCollection": {
3156#
3157# "id": "FhQrlAwfRMaTy0blR_eHRw"
3158#
3159# }
3160#
3161# }
3162# }
3163#
3164# Arguments
3165# input: Fields needed to share a collection
3166shareCollection(input: ShareCollection): Share
3167
3168# Arguments
3169# shareId: ID of the shared collection to update
3170# mentionIds: List of mentionIds to add or remove
3171# type: Indicates whether or not the mentions are to be added or
3172# deleted
3173updateSharedCollectionMentions(
3174shareId: String!,
3175mentionIds: [ID!],
3176type: SharedCollectionUpdateType!
3177): Share
3178
3179updateSharedCollectionHistory(
3180input: UpdateSharedCollectionHistory
3181): SharedCollectionHistory
3182
3183# Share a mention from a collection
3184#
3185# Arguments
3186# input: Fields needed to share a mention
3187shareMentionFromCollection(
3188input: ShareMentionFromCollection
3189): Share
3190
3191# Share mention
3192shareMention(input: ShareMention): Share
3193
3194# Share mentions in bulk
3195shareMentionInBulk(input: ShareMentionInBulk): [Share]
3196
3197# Add a mention to a collection
3198#
3199# Arguments
3200# input: Fields needed to add a mention to a collection
3201createCollectionMention(input: CollectionMentionInput): CollectionMention
3202
3203# Arguments
3204# input: Fields needed to add mentions to a collection
3205createCollectionMentions(
3206input: CreateCollectionMentions
3207): [CollectionMention!]!
3208
3209# Update a mention in a collection
3210#
3211# Arguments
3212# input: Fields needed to add mentions to a collection
3213updateCollectionMention(
3214input: UpdateCollectionMention!
3215): CollectionMention!
3216
3217# Remove a mention from a collection
3218#
3219# Arguments
3220# input: Fields needed to delete a mention from a collection
3221deleteCollectionMention(input: CollectionMentionInput): CollectionMention
3222
3223# Create a new folder
3224# Example:
3225# Request:
3226# mutation {
3227#
3228# createFolder(input: {
3229#
3230# name: "example",
3231#
3232# description: "example",
3233#
3234# parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3235#
3236# rootFolderType:watchlist}) {
3237#
3238# id
3239#
3240# name
3241#
3242# }
3243# }
3244# Response:
3245# {
3246#
3247# "data": {
3248#
3249# "createFolder": {
3250#
3251# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3252#
3253# "name": "example"
3254#
3255# }
3256#
3257# }
3258# }
3259#
3260# Arguments
3261# input: Fields needed to create a new folder.
3262createFolder(input: CreateFolder): Folder
3263
3264# Create a new PlatformVersion
3265# Example:
3266# Request:
3267# mutation {
3268#
3269# addPlatformVersion(input: {
3270#
3271# version: "1.2.0"
3272#
3273# manifestUrl: "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3274#
3275# changeLogUrl: "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3276#
3277# highlightsUrl: "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3278#
3279# }) {
3280#
3281# id
3282#
3283# version
3284#
3285# manifestUrl
3286#
3287# changeLogUrl
3288#
3289# highlightsUrl
3290#
3291# createdAt,
3292#
3293# createdBy
3294#
3295# }
3296# }
3297# Response:
3298# {
3299#
3300# "data": {
3301#
3302# "addPlatformVersion": {
3303#
3304# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3305#
3306# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3307#
3308# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3309#
3310# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3311#
3312# "createAt": "2023-05-10",
3313#
3314# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3315#
3316# }
3317#
3318# }
3319# }
3320#
3321# Arguments
3322# input: Fields needed to create a new aiWARE platform version.
3323addPlatformVersion(input: PlatformVersionInput): PlatformVersion
3324
3325# Set the current PlatformVersion
3326# Example:
3327# Request:
3328# mutation {
3329#
3330# setCurrentPlatformVersion(input: {
3331#
3332# version: "1.2.0"
3333#
3334# }) {
3335#
3336# id
3337#
3338# version
3339#
3340# manifestUrl
3341#
3342# changeLogUrl
3343#
3344# highlightsUrl
3345#
3346# createdAt,
3347#
3348# createdBy,
3349#
3350# installedAt,
3351#
3352# installedBy
3353#
3354# }
3355# }
3356# Response:
3357# {
3358#
3359# "data": {
3360#
3361# "setCurrentPlatformVersion": {
3362#
3363# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3364#
3365# "version": "1.2.0",
3366#
3367# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3368#
3369# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3370#
3371# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3372#
3373# "createAt": "2023-05-10",
3374#
3375# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248",
3376#
3377# "installedAt": "2023-05-15",
3378#
3379# "installedBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3380#
3381# }
3382#
3383# }
3384# }
3385#
3386# Arguments
3387# version: The version field is required to set the current
3388# aiWARE platform version
3389setCurrentPlatformVersion(version: String!): PlatformVersion
3390
3391# Set the platform properties.
3392# Example:
3393# Request:
3394# mutation {
3395#
3396# setPlatformProperties(
3397#
3398# properties: {
3399#
3400# Environment: "US West",
3401#
3402# ClusterSize: "small" }
3403#
3404# )
3405# }
3406# Response:
3407# {
3408#
3409# "data": {
3410#
3411# "setPlatformProperties": {
3412#
3413# "properties": {
3414#
3415# "Environment": "US West",
3416#
3417# "ClusterSize": "small"
3418#
3419# }
3420#
3421# }
3422#
3423# }
3424# }
3425#
3426# Arguments
3427# properties: Properties is JSON object that contains the
3428# properties of the platform that need to be added/ updated.
3429# So all the other properties in the JSON will be kept
3430setPlatformProperties(properties: JSONData!): JSONData
3431
3432# Update an existing folder
3433# Example:
3434# Request:
3435# mutation {
3436#
3437# updateFolder(input: {
3438#
3439# id: "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3440#
3441# name: "new name"}) {
3442#
3443# name
3444#
3445# }
3446# }
3447# Response:
3448# {
3449#
3450# "data": {
3451#
3452# "updateFolder": {
3453#
3454# "name": "new name"
3455#
3456# }
3457#
3458# }
3459# }
3460#
3461# Arguments
3462# input: Fields needed to update a folder.
3463updateFolder(input: UpdateFolder): Folder
3464
3465# Move a folder from one parent folder to another.
3466# Example:
3467# Request:
3468# mutation {
3469#
3470# moveFolder(input: {
3471#
3472# folderId: "68a5833a-f573-41fe-840a-adb5f6888e2d",
3473#
3474# fromFolderId: "3104f61f-4bd1-4175-9fe6-27436d591c54",
3475#
3476# toFolderId: "ad7839a7-d088-4202-9db1-5ed4992f915d"
3477#
3478# }) {
3479#
3480# parentFolderId
3481#
3482# }
3483# }
3484# Response:
3485# {
3486#
3487# "data": {
3488#
3489# "moveFolder": {
3490#
3491# "parentFolderId": "ad7839a7-d088-4202-9db1-5ed4992f915d",
3492#
3493# }
3494#
3495# }
3496# }
3497#
3498# Arguments
3499# input: Fields needed to move a folder
3500moveFolder(input: MoveFolder): Folder
3501
3502# Move bulk folders to another.
3503# Example:
3504# Request:
3505# mutation {
3506#
3507# moveFolders(input: {
3508#
3509# folderIds: ["0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3510# "183f64e7-d519-4948-99d9-977657cce0c8"]
3511#
3512# newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8"
3513#
3514# rootFolderType: cms
3515#
3516# }) {
3517#
3518# id
3519#
3520# name
3521#
3522# }
3523# }
3524# Response:
3525# {
3526#
3527# "data": {
3528#
3529# "moveFolders": {
3530#
3531# "organizationId": "7682",
3532#
3533# "newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8",
3534#
3535# "validFolderIds": [
3536#
3537# "0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3538#
3539# "183f64e7-d519-4948-99d9-977657cce0c8"
3540#
3541# ]
3542#
3543# "invalidFolderIds": [],
3544#
3545# "message": "Successfully move all input folders to the parent folder."
3546#
3547# }
3548#
3549# }
3550# }
3551#
3552# Arguments
3553# input: Fields needed to move a folder
3554moveFolders(input: MoveFolders): MoveFoldersPayload
3555
3556# Delete a folder
3557# Example:
3558# Request:
3559# mutation {
3560#
3561# deleteFolder(input: {
3562#
3563# id:"d551fbd6-7354-4b0e-abfb-654ab8583be2",
3564#
3565# orderIndex: 1}) {
3566#
3567# message
3568#
3569# }
3570# }
3571# Response:
3572# {
3573#
3574# "data": {
3575#
3576# "deleteFolder": {
3577#
3578# "message": null
3579#
3580# }
3581#
3582# }
3583# }
3584#
3585# Arguments
3586# input: Fields needed to delete a folder
3587deleteFolder(input: DeleteFolder): DeletePayload
3588
3589# Create a mention comment
3590#
3591# Arguments
3592# input: Fields needed to create a mention comment
3593createMentionComment(input: CreateMentionComment): MentionComment
3594
3595# Update a mention comment
3596#
3597# Arguments
3598# input: Fields needed to update a mention comment
3599updateMentionComment(input: UpdateMentionComment): MentionComment
3600
3601# Delete a mention comment
3602#
3603# Arguments
3604# input: Fields needed to delete a mention comment
3605deleteMentionComment(input: DeleteMentionComment): DeletePayload
3606
3607# Create a mention rating
3608#
3609# Arguments
3610# input: Fields needed to create a mention rating
3611createMentionRating(input: CreateMentionRating): MentionRating
3612
3613# Update a mention rating
3614#
3615# Arguments
3616# input: Fields needed to update a mention rating
3617updateMentionRating(input: UpdateMentionRating): MentionRating
3618
3619# Delete a mention rating
3620#
3621# Arguments
3622# input: Fields needed to delete a mention rating.
3623deleteMentionRating(input: DeleteMentionRating): DeletePayload
3624
3625# Login as a user. This mutation does not require an existing authentication
3626# context (via `Authorization` header with bearer token, cookie, etc.).
3627# Instead, the client supplies credentials to this mutation, which then
3628# authenticates the user and sets up the authentication context.
3629# The returned tokens can be used to authenticate future requests.
3630# Example:
3631# Request:
3632# mutation {
3633#
3634# userLogin(input: {
3635#
3636# userName: "example1",
3637#
3638# password: "example1"}) {
3639#
3640# apiToken
3641#
3642# lastLoggedIn
3643#
3644# }
3645# }
3646# Response:
3647# {
3648#
3649# "data": {
3650#
3651# "userLogin": {
3652#
3653# "apiToken": null,
3654#
3655# "lastLoggedIn": "2021-06-15T02:04:52.000Z",
3656#
3657# "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a"
3658#
3659# }
3660#
3661# }
3662# }
3663#
3664# Arguments
3665# input: Fields needed to log in
3666userLogin(input: UserLogin): LoginInfo
3667
3668# Logout user and invalidate user token
3669# Example:
3670# Request:
3671# mutation {
3672#
3673# userLogout(
3674#
3675# token: "a5610058-260d-46ac-aa3e-ee529c4feaab")
3676# }
3677# Response:
3678# {
3679#
3680# "data": {
3681#
3682# "userLogout": null
3683#
3684# }
3685# }
3686#
3687# Arguments
3688# token: User token that should be invalidated
3689# sessionExpired: Internal system flag
3690userLogout(token: String!, sessionExpired: Boolean): Boolean
3691
3692# Refreshes the session user from database to reflect the latest changes. It does
3693# not extend session timeout.\
3694# Example:
3695# Request:
3696# mutation {
3697#
3698# refreshToken(
3699#
3700# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3701#
3702# hasPassword
3703#
3704# user{id}
3705#
3706# }
3707# }
3708# Response:
3709# {
3710#
3711# "data": {
3712#
3713# "refreshToken": {
3714#
3715# "hasPassword": true,
3716#
3717# "user": {
3718#
3719# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3720#
3721# }
3722#
3723# }
3724#
3725# }
3726# }
3727refreshToken(token: String!): LoginInfo
3728
3729# Refresh a user token, returning a fresh token so that the client
3730# can continue to authenticate to the API.\
3731# Example:
3732# Request:
3733# mutation {
3734#
3735# extendToken(
3736#
3737# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3738#
3739# hasPassword
3740#
3741# user{id}
3742#
3743# }
3744# }
3745# Response:
3746# {
3747#
3748# "data": {
3749#
3750# "extendToken": {
3751#
3752# "hasPassword": true,
3753#
3754# "user": {
3755#
3756# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3757#
3758# }
3759#
3760# }
3761#
3762# }
3763# }
3764extendToken(token: String!): LoginInfo
3765
3766# Validate a user token. This mutation is used by services to determine
3767# if the token provided by a given client is valid.
3768# Example:
3769# Request:
3770# mutation {
3771#
3772# validateToken(
3773#
3774# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3775#
3776# hasPassword
3777#
3778# user{id}
3779#
3780# }
3781# }
3782# Response:
3783# {
3784#
3785# "data": {
3786#
3787# "validateToken": {
3788#
3789# "hasPassword": true,
3790#
3791# "user": {
3792#
3793# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3794#
3795# }
3796#
3797# }
3798#
3799# }
3800# }
3801validateToken(token: String!): LoginInfo
3802
3803# Create a mention object
3804createMention(input: CreateMention!): Mention
3805
3806# Update a mention object
3807updateMention(input: UpdateMention!): Mention
3808
3809# Update a set of mentions
3810updateMentions(input: UpdateMentions!): [Mention]
3811
3812# Create root folder for an organization
3813# Example:
3814# Request:
3815# mutation {
3816#
3817# createRootFolders {
3818#
3819# id
3820#
3821# rootFolderTypeId
3822#
3823# }
3824# }
3825# Response:
3826# {
3827#
3828# "data": {
3829#
3830# "createRootFolders": [
3831#
3832# {
3833#
3834# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3835#
3836# "rootFolderTypeId": 1
3837#
3838# },
3839#
3840# {
3841#
3842# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3843#
3844# "rootFolderTypeId": 1
3845#
3846# }
3847#
3848# ]
3849#
3850# }
3851# }
3852#
3853# Arguments
3854# rootFolderType: The type of root folder to create
3855createRootFolders(rootFolderType: RootFolderType): [Folder]
3856
3857# Apply bulk updates to watchlists.
3858# This mutation is currently available only to Veritone operations.
3859#
3860# Arguments
3861# filter: A filter indicating which watchlists should be updated.
3862# At least one filter condition must be provided.
3863# Only watchlists for the user's organization will be updated.
3864# input: Fields used to update a watchlist.
3865bulkUpdateWatchlist(
3866filter: BulkUpdateWatchlistFilter!,
3867input: BulkUpdateWatchlist
3868): WatchlistList
3869
3870# File a TemporalDataObject in a folder. A given TemporalDataObject can
3871# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3872# and its assets to be visible within the folder.
3873# Example:
3874# Request:
3875# mutation {
3876#
3877# fileTemporalDataObject(input:{
3878#
3879# tdoId: "1580388995",
3880#
3881# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3882#
3883# id
3884#
3885# folders{
3886#
3887# id
3888#
3889# }
3890#
3891# }
3892# }
3893# Response:
3894# {
3895#
3896# "data": {
3897#
3898# "fileTemporalDataObject": {
3899#
3900# "id": "1580388995",
3901#
3902# "folders": [
3903#
3904# {
3905#
3906# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3907#
3908# }
3909#
3910# ]
3911#
3912# }
3913#
3914# }
3915# }
3916#
3917# Arguments
3918# input: The fields needed to file a TemporalDataObject in a
3919# folder
3920fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3921
3922# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3923# and its assets to disappear from the folder, but does not otherwise affect
3924# either the TDO or the folder and does not change access controls.
3925# Example:
3926# Request:
3927# mutation {
3928#
3929# unfileTemporalDataObject(input: {
3930#
3931# tdoId: "1580388995",
3932#
3933# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3934#
3935# id
3936#
3937# description
3938#
3939# }
3940# }
3941# Response:
3942# {
3943#
3944# "data": {
3945#
3946# "unfileTemporalDataObject": {
3947#
3948# "id": "1580388995",
3949#
3950# "description": null
3951#
3952# }
3953#
3954# }
3955# }
3956#
3957# Arguments
3958# input: The fields needed to file a TemporalDataObject in a
3959# folder
3960unfileTemporalDataObject(
3961input: UnfileTemporalDataObject!
3962): TemporalDataObject
3963
3964# Moves a TemporalDataObject from one parent folder to another.
3965# Any other folders the TemporalDataObject is filed in are unaffected.
3966# Example:
3967# Request:
3968# mutation {
3969#
3970# moveTemporalDataObject(input: {
3971#
3972# tdoId: "1580388995",
3973#
3974# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3975#
3976# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
3977#
3978# id
3979#
3980# folders{
3981#
3982# folderPath{id}
3983#
3984# }
3985#
3986# }
3987# }
3988# Response:
3989# {
3990#
3991# "data": {
3992#
3993# "moveTemporalDataObject": {
3994#
3995# "id": "1580388995",
3996#
3997# "folders": [
3998#
3999# {
4000#
4001# "folderPath": [
4002#
4003# {
4004#
4005# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
4006#
4007# }
4008#
4009# ]
4010#
4011# }
4012#
4013# ]
4014#
4015# }
4016#
4017# }
4018# }
4019#
4020# Arguments
4021# input: Fields need to move a TemporalDataObject
4022moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
4023
4024# Upload and store an engine result. The result will be stored as an
4025# asset associated with the target TemporalDataObject and the
4026# task will be updated accordingly.
4027# Use a multipart form POST to all this mutation.
4028#
4029# Arguments
4030# input: Fields needed to upload and store an engine result
4031uploadEngineResult(input: UploadEngineResult!): Asset
4032
4033# Create a watchlist
4034# Example:
4035# Request:
4036# mutation {
4037#
4038# createWatchlist(input: {
4039#
4040# stopDateTime: 1623851655,
4041#
4042# name: "example",
4043#
4044# searchIndex: mine,
4045#
4046# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
4047#
4048# cognitiveSearches: [],
4049#
4050# subscriptions: [],
4051#
4052# details: {
4053#
4054# example: "example"}}) {
4055#
4056# id
4057#
4058# }
4059# }
4060# Response:
4061# {
4062#
4063# "data": {
4064#
4065# "createWatchlist": {
4066#
4067# "id": "325783"
4068#
4069# }
4070#
4071# }
4072# }
4073createWatchlist(input: CreateWatchlist!): Watchlist
4074
4075bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
4076
4077# Update a watchlist
4078# Example:
4079# Request:
4080# mutation {
4081#
4082# updateWatchlist(input: {
4083#
4084# id: "325783"
4085#
4086# name: "new name"
4087#
4088# details: {
4089#
4090# example: "new details"}}) {
4091#
4092# id
4093#
4094# name
4095#
4096# }
4097# }
4098# Response:
4099#
4100# {
4101#
4102# "data": {
4103#
4104# "updateWatchlist": {
4105#
4106# "id": "325783",
4107#
4108# "name": "new name"
4109#
4110# }
4111#
4112# }
4113# }
4114updateWatchlist(input: UpdateWatchlist!): Watchlist
4115
4116# Delete a watchlist
4117# Example:
4118# Request:
4119# mutation {
4120#
4121# deleteWatchlist(
4122#
4123# id:"325783") {
4124#
4125# message
4126#
4127# }
4128# }
4129# Response:
4130# {
4131#
4132# "data": {
4133#
4134# "deleteWatchlist": {
4135#
4136# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
4137# profiles, 0 mention comments, and 0 mention ratings."
4138#
4139# }
4140#
4141# }
4142# }
4143deleteWatchlist(id: ID!): DeletePayload
4144
4145updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
4146
4147createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
4148
4149deleteCognitiveSearch(id: ID!): DeletePayload
4150
4151fileWatchlist(input: FileWatchlist!): Watchlist
4152
4153# Unfile a watchlist from a folder
4154# Example:
4155# Request:
4156# mutation {
4157#
4158# unfileWatchlist(input: {
4159#
4160# watchlistId:"325786",
4161#
4162# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
4163#
4164# id
4165#
4166# folders{
4167#
4168# folderPath{
4169#
4170# id
4171#
4172# }
4173#
4174# }
4175#
4176# }
4177# }
4178# Response:
4179# {
4180#
4181# "data": {
4182#
4183# "unfileWatchlist": {
4184#
4185# "id": "325786",
4186#
4187# "folders": []
4188#
4189# }
4190#
4191# }
4192# }
4193unfileWatchlist(input: UnfileWatchlist!): Watchlist
4194
4195# Share a folder with other organizations
4196# Requires superadmin
4197shareFolder(input: ShareFolderInput): Folder
4198
4199# Create a TDO and an asset with a single call
4200# Example:
4201# Request:
4202# mutation {
4203#
4204# createTDOWithAsset(input: {
4205#
4206# startDateTime: 1623841655,
4207#
4208# stopDateTime: 1623851655,
4209#
4210# contentType: "video/mp4",
4211#
4212# assetType: "media",
4213#
4214# addToIndex: false,
4215#
4216# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
4217#
4218# id
4219#
4220# status
4221#
4222# assets {
4223#
4224# records {
4225#
4226# id
4227#
4228# assetType
4229#
4230# contentType
4231#
4232# signedUri
4233#
4234# }
4235#
4236# }
4237#
4238# }
4239# }
4240# Response:
4241# {
4242#
4243# "data": {
4244#
4245# "createTDOWithAsset": {
4246#
4247# "id": "1580507556",
4248#
4249# "status": "recorded",
4250#
4251# "assets": {
4252#
4253# "records": [
4254#
4255# {
4256#
4257# "id": "1580507556_DQ2nU8cTDh",
4258#
4259# "assetType": "media",
4260#
4261# "contentType": "video/mp4",
4262#
4263# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
4264#
4265# }
4266#
4267# ]
4268#
4269# }
4270#
4271# }
4272#
4273# }
4274# }
4275#
4276# Arguments
4277# input: Input fields necessary to create the TDO and asset
4278createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
4279
4280# Create a subscription
4281# Example:
4282# Request:
4283# mutation {
4284#
4285# createSubscription(input: {
4286#
4287# targetId: "325791",
4288#
4289# contact: {
4290#
4291# emailAddress: "example email"},
4292#
4293# scheduledDay: Friday}) {
4294#
4295# id
4296#
4297# }
4298# }
4299# Response:
4300# {
4301#
4302# "data": {
4303#
4304# "createSubscription": {
4305#
4306# "id": "274939"
4307#
4308# }
4309#
4310# }
4311# }
4312createSubscription(input: CreateSubscription!): Subscription
4313
4314# Update a subscription
4315# Example:
4316# Request:
4317# mutation {
4318#
4319# updateSubscription(input: {
4320#
4321# id: "274939"}) {
4322#
4323# id
4324#
4325# }
4326# }
4327# Response:
4328# mutation {
4329#
4330# updateSubscription(input: {
4331#
4332# id: "274939"}) {
4333#
4334# id
4335#
4336# }
4337# }
4338updateSubscription(input: UpdateSubscription!): Subscription
4339
4340# Delete a subscription
4341# Example:
4342# Request:
4343# mutation {
4344#
4345# deleteSubscription(
4346#
4347# id: "274939") {
4348#
4349# message
4350#
4351# }
4352# }
4353# Response:
4354# mutation {
4355#
4356# deleteSubscription(
4357#
4358# id: "274939") {
4359#
4360# message
4361#
4362# }
4363# }
4364deleteSubscription(id: ID!): DeletePayload
4365
4366# Create trigger for events or types.
4367# Example:
4368# Request:
4369# mutation {
4370#
4371# createTriggers(input: {
4372#
4373# events: "*",
4374#
4375# targets: {
4376#
4377# name: Email,
4378#
4379# params: {
4380#
4381# address: "example@veritone.com"}}}) {
4382#
4383# id
4384#
4385# }
4386# }
4387# Response:
4388# {
4389#
4390# "data": {
4391#
4392# "createTriggers": [
4393#
4394# {
4395#
4396# "id": "2936"
4397#
4398# }
4399#
4400# ]
4401#
4402# }
4403# }
4404createTriggers(input: CreateTriggers!): [Trigger]
4405
4406# Delete a registed trigger by ID.
4407# Example:
4408# Request:
4409# mutation {
4410#
4411# deleteTrigger(
4412#
4413# id: "2936") {
4414#
4415# message
4416#
4417# }
4418# }
4419# Response:
4420# {
4421#
4422# "data": {
4423#
4424# "deleteTrigger": {
4425#
4426# "message": "Trigger 2936 has been removed from organization 35521"
4427#
4428# }
4429#
4430# }
4431# }
4432deleteTrigger(id: ID!): DeletePayload
4433
4434# Validates if an engine output conforms to the engine output guidelines
4435# Example:
4436# Request:
4437# mutation {
4438#
4439# validateEngineOutput(input:
4440#
4441# {
4442#
4443# schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json",
4444#
4445# validationContracts: [
4446#
4447# "structured-data"
4448#
4449# ],
4450#
4451# series: [
4452#
4453# {
4454#
4455# startTimeMs: 0,
4456#
4457# stopTimeMs: 10000,
4458#
4459# structuredData: {
4460#
4461# exampleschemaid: {
4462#
4463# key: "value",
4464#
4465# any: "data you'd like",
4466#
4467# as_long: "as it conforms to the schema"
4468#
4469# }
4470#
4471# }
4472#
4473# }
4474#
4475# ]
4476#
4477# }
4478#
4479# )
4480# }
4481# Response:
4482# {
4483#
4484# "data": {
4485#
4486# "validateEngineOutput": true
4487#
4488# }
4489# }
4490validateEngineOutput(input: JSONData!): Boolean!
4491
4492# JWT tokens with a more limited scoped token to specific
4493# resources to the recording, task, and job
4494# and also has no organization association.
4495# Example:
4496# Request:
4497# mutation {
4498#
4499# getEngineJWT(input: {
4500#
4501# engineId: "1",
4502#
4503# resource:{
4504#
4505# tdoId: "1580701928"
4506#
4507# }}) {
4508#
4509# token
4510#
4511# }
4512# }
4513#
4514# Response:
4515# {
4516#
4517# "data": {
4518#
4519# "getEngineJWT": {
4520#
4521# "token": "eyJh...Tw_z3BKRA"
4522#
4523# }
4524#
4525# }
4526# }
4527getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
4528
4529# Verify JWT token
4530# Example:
4531# Request:
4532# mutation {
4533#
4534# verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW
4535#
4536# 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY
4537#
4538# wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ
4539#
4540# XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb
4541#
4542# eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw
4543#
4544# icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD
4545#
4546# A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia
4547#
4548# m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz
4549#
4550# NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI
4551#
4552# 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA")
4553# {
4554#
4555# payload
4556#
4557# }
4558# }
4559# Response:
4560# {
4561#
4562# "data": {
4563#
4564# "verifyJWT": {
4565#
4566# "payload": {
4567#
4568# "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09",
4569#
4570# "contentOrganizationId": 35521,
4571#
4572# "engineId": "1",
4573#
4574# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4575#
4576# "scope": [
4577#
4578# {
4579#
4580# "actions": [
4581#
4582# "asset:uri",
4583#
4584# "asset:all",
4585#
4586# "recording:read",
4587#
4588# "recording:update"
4589#
4590# ],
4591#
4592# "resources": {
4593#
4594# "recordingIds": [
4595#
4596# "1580701928"
4597#
4598# ]
4599#
4600# }
4601#
4602# },
4603#
4604# {
4605#
4606# "actions": [
4607#
4608# "task:update"
4609#
4610# ],
4611#
4612# "resources": {
4613#
4614# "jobIds": [],
4615#
4616# "taskIds": [],
4617#
4618# "sourceIds": []
4619#
4620# }
4621#
4622# }
4623#
4624# ],
4625#
4626# "iat": 1624036122,
4627#
4628# "exp": 1624640922,
4629#
4630# "sub": "engine-run",
4631#
4632# "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133"
4633#
4634# }
4635#
4636# }
4637#
4638# }
4639# }
4640verifyJWT(jwtToken: String!): VerifyJWTPayload
4641
4642# Create a new Saved Search
4643# Example:
4644# Request:
4645# mutation {
4646#
4647# createSavedSearch(input: {
4648#
4649# name: "example",
4650#
4651# csp: {
4652#
4653# example: "example"}}) {
4654#
4655# id
4656#
4657# }
4658# }
4659# Response:
4660# {
4661#
4662# "data": {
4663#
4664# "createSavedSearch": {
4665#
4666# "id": "a29f2255-e509-4454-89ec-e425390ca4ca"
4667#
4668# }
4669#
4670# }
4671# }
4672createSavedSearch(input: CreateSavedSearch!): SavedSearch!
4673
4674# Delete a saved search
4675# Example:
4676# Request:
4677# mutation {
4678#
4679# deleteSavedSearch(
4680#
4681# id:"a29f2255-e509-4454-89ec-e425390ca4ca") {
4682#
4683# message
4684#
4685# }
4686# }
4687# Response:
4688# {
4689#
4690# "data": {
4691#
4692# "deleteSavedSearch": {
4693#
4694# "message": null
4695#
4696# }
4697#
4698# }
4699# }
4700deleteSavedSearch(id: ID!): DeletePayload!
4701
4702# Mark existing saved search profile as deleted
4703# Create new saved search profile
4704# Example:
4705# Request:
4706# mutation {
4707#
4708# replaceSavedSearch(input: {
4709#
4710# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4711#
4712# name: "example",
4713#
4714# csp: {
4715#
4716# example: "new csp"}}) {
4717#
4718# id
4719#
4720# }
4721# }
4722# Response:
4723# mutation {
4724#
4725# replaceSavedSearch(input: {
4726#
4727# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4728#
4729# name: "example",
4730#
4731# csp: {
4732#
4733# example: "new csp"}}) {
4734#
4735# id
4736#
4737# }
4738# }
4739replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
4740
4741# Send a basic email. Mutation returns true for a success message.
4742# The email from field will be automatically set the default platform email
4743# address
4744# Example:
4745# Request:
4746# mutation {
4747#
4748# sendEmail(input: {
4749#
4750# to: "example@veritone.com"
4751#
4752# subject: "example"
4753#
4754# message: "email body"
4755#
4756# replyTo: "example@veritone.com"
4757#
4758# })
4759# }
4760# Response:
4761# {
4762#
4763# "data": {
4764#
4765# "sendEmail": true
4766#
4767# }
4768# }
4769sendEmail(input: SendEmail!): Boolean!
4770
4771# Create new content template into a folder
4772createFolderContentTemplate(
4773input: CreateFolderContentTemplate!
4774): FolderContentTemplate!
4775
4776# Update existing content template by folderContentTemplateId
4777updateFolderContentTemplate(
4778input: UpdateFolderContentTemplate!
4779): FolderContentTemplate!
4780
4781# Delete existing folder content template by folderContentTemplateId
4782#
4783# Arguments
4784# id: Folder Content Template Id
4785deleteFolderContentTemplate(id: ID!): DeletePayload!
4786
4787createFolderContentTempate(
4788input: CreateFolderContentTempate!
4789): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4790
4791updateFolderContentTempate(
4792input: UpdateFolderContentTempate!
4793): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4794
4795# Arguments
4796# id: Folder Content Template Id
4797deleteFolderContentTempate(
4798id: ID!
4799): DeletePayload! @deprecated( reason: "Misspelling" )
4800
4801# Create an export request. The requested TDO data, possibly including
4802# TDO media and engine results, will be exported offline.
4803# Example:
4804# Request:
4805# mutation {
4806#
4807# createExportRequest(input: {
4808#
4809# tdoData: {
4810#
4811# tdoId: "1580388995",
4812#
4813# }}) {
4814#
4815# id
4816#
4817# }
4818# }
4819# Response:
4820# {
4821#
4822# "data": {
4823#
4824# "createExportRequest": {
4825#
4826# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad"
4827#
4828# }
4829#
4830# }
4831# }
4832#
4833# Arguments
4834# input: Input data required to create the export request
4835createExportRequest(input: CreateExportRequest!): ExportRequest!
4836
4837# Update an export request
4838# Example:
4839# Request:
4840# mutation {
4841#
4842# updateExportRequest(input: {
4843#
4844# id: "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4845#
4846# status: complete}) {
4847#
4848# id
4849#
4850# status
4851#
4852# }
4853# }
4854# Response:
4855# {
4856#
4857# "data": {
4858#
4859# "updateExportRequest": {
4860#
4861# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4862#
4863# "status": "complete"
4864#
4865# }
4866#
4867# }
4868# }
4869#
4870# Arguments
4871# input: Input data required to update an export request
4872updateExportRequest(input: UpdateExportRequest!): ExportRequest!
4873
4874# Create Mention in bulk. The input should be an array of createMentions
4875createMentions(input: CreateMentions!): MentionList
4876
4877# Create Media Share. Returning the url of the share
4878createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
4879
4880# Create a new event
4881#
4882# Example:
4883#
4884# Request:
4885#
4886# mutation {
4887#
4888# createEvent(input: {
4889#
4890# eventName: "example",
4891#
4892# eventType: "example",
4893#
4894# application: ""
4895#
4896# description: "example"}) {
4897#
4898# id
4899#
4900# }
4901# }
4902# Response:
4903# {
4904#
4905# "data": {
4906#
4907# "createEvent": {
4908#
4909# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d"
4910#
4911# }
4912#
4913# }
4914# }
4915createEvent(input: CreateEvent!): Event!
4916
4917# Update an event
4918# Example:
4919# Request:
4920# mutation {
4921#
4922# updateEvent(input: {
4923#
4924# id: "55fc7c51-1521-4043-902f-f0f3a357da6d",
4925#
4926# description: "new example description"}) {
4927#
4928# id
4929#
4930# description
4931#
4932# }
4933# }
4934# Response:
4935# {
4936#
4937# "data": {
4938#
4939# "updateEvent": {
4940#
4941# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d",
4942#
4943# "description": "new example description"
4944#
4945# }
4946#
4947# }
4948# }
4949updateEvent(input: UpdateEvent!): Event!
4950
4951# Subscribe to an event
4952# Example:
4953# Request:
4954# mutation {
4955#
4956# subscribeEvent(input: {
4957#
4958# eventName: "example",
4959#
4960# eventType: "example",
4961#
4962# application: "",
4963#
4964# delivery: {
4965#
4966# name: CreateJob,
4967#
4968# params: {
4969#
4970# targetId: "1580701928"
4971#
4972# engineId: "1"
4973#
4974# }
4975#
4976# }
4977#
4978# })
4979# }
4980# Response:
4981# {
4982#
4983# "data": {
4984#
4985# "subscribeEvent": "a0d04eeb-c32d-4852-9273-bb0acda970b9"
4986#
4987# }
4988# }
4989subscribeEvent(input: SubscribeEvent!): ID!
4990
4991# Unsubscribe to an event
4992# Example:
4993# Request:
4994# mutation {
4995#
4996# unsubscribeEvent(
4997#
4998# id: "a0d04eeb-c32d-4852-9273-bb0acda970b9") {
4999#
5000# id
5001#
5002# message
5003#
5004# }
5005# }
5006# Response:
5007# {
5008#
5009# "data": {
5010#
5011# "unsubscribeEvent": {
5012#
5013# "id": "a0d04eeb-c32d-4852-9273-bb0acda970b9",
5014#
5015# "message": "Unsubscribed from event"
5016#
5017# }
5018#
5019# }
5020# }
5021unsubscribeEvent(id: ID!): UnsubscribeEvent!
5022
5023# Emit an event
5024# Example:
5025# Request:
5026# mutation {
5027#
5028# emitEvent(input: {
5029#
5030# eventName: "example",
5031#
5032# eventType: "example",
5033#
5034# application: "",
5035#
5036# payload: ""}) {
5037#
5038# id
5039#
5040# }
5041# }
5042# Response:
5043# {
5044#
5045# "data": {
5046#
5047# "emitEvent": {
5048#
5049# "id": "0952fe68-5652-4804-857d-26e21ef3d7e8"
5050#
5051# }
5052#
5053# }
5054# }
5055emitEvent(input: EmitEvent!): EmitEventResponse!
5056
5057# Create a new event trigger template
5058# Example:
5059# Request:
5060# mutation {
5061#
5062# createEventActionTemplate(input: {
5063#
5064# name: "example"
5065#
5066# inputType: event
5067#
5068# inputValidation: {
5069#
5070# example: "example"
5071#
5072# }
5073#
5074# inputAttributes: {
5075#
5076# example: "example"
5077#
5078# }
5079#
5080# actionType: job
5081#
5082# actionValidation: {
5083#
5084# example: "example"
5085#
5086# }
5087#
5088# actionDestination: "1"
5089#
5090# actionAttributes: {
5091#
5092# example: "example"
5093#
5094# }}) {
5095#
5096# id
5097#
5098# }
5099# }
5100# Response:
5101# {
5102#
5103# "data": {
5104#
5105# "createEventActionTemplate": {
5106#
5107# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92"
5108#
5109# }
5110#
5111# }
5112# }
5113createEventActionTemplate(
5114input: CreateEventActionTemplate!
5115): EventActionTemplate!
5116
5117# Update an event trigger template
5118# Example:
5119# Request:
5120# mutation {
5121#
5122# updateEventActionTemplate(input: {
5123#
5124# id: "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5125#
5126# name: "example",
5127#
5128# actionValidation: {
5129#
5130# example: "new validation"}}) {
5131#
5132# id
5133#
5134# actionValidation
5135#
5136# }
5137# }
5138# Response:
5139# {
5140#
5141# "data": {
5142#
5143# "updateEventActionTemplate": {
5144#
5145# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5146#
5147# "actionValidation": {
5148#
5149# "example": "new validation"
5150#
5151# }
5152#
5153# }
5154#
5155# }
5156# }
5157updateEventActionTemplate(
5158input: UpdateEventActionTemplate!
5159): EventActionTemplate!
5160
5161# Create a new event custom rule
5162# Example:
5163# Request:
5164# mutation {
5165#
5166# createEventCustomRule(input: {
5167#
5168# name: "example"
5169#
5170# eventType: "example"
5171#
5172# eventName: "example"
5173#
5174# description: "example description"
5175#
5176# actions:[]
5177#
5178# params: {
5179#
5180# example: "example"
5181#
5182# }}) {
5183#
5184# id
5185#
5186# }
5187# }
5188# Response:
5189# {
5190#
5191# "data": {
5192#
5193# "createEventCustomRule": {
5194#
5195# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b"
5196#
5197# }
5198#
5199# }
5200# }
5201createEventCustomRule(input: CreateEventCustomRule!): EventCustomRule!
5202
5203# Update an event custom rule
5204# Example:
5205# Request:
5206#
5207# mutation {
5208#
5209# updateEventCustomRule(input: {
5210#
5211# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5212#
5213# name: "example",
5214#
5215# status: inactive,
5216#
5217# description: "new description"}) {
5218#
5219# id
5220#
5221# description
5222#
5223# }
5224# }
5225# Response:
5226# {
5227#
5228# "data": {
5229#
5230# "updateEventCustomRule": {
5231#
5232# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5233#
5234# "description": "new description"
5235#
5236# }
5237#
5238# }
5239# }
5240updateEventCustomRule(input: UpdateEventCustomRule!): EventCustomRule!
5241
5242# Delete an event custom rule
5243# Example:
5244# Request:
5245# mutation {
5246#
5247# deleteEventCustomRule(
5248#
5249# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b") {
5250#
5251# message
5252#
5253# }
5254# }
5255# Response:
5256# {
5257#
5258# "data": {
5259#
5260# "deleteEventCustomRule": {
5261#
5262# "message": "Deleted event custom rule"
5263#
5264# }
5265#
5266# }
5267# }
5268deleteEventCustomRule(id: ID!): DeletePayload!
5269
5270# Create a processTemplate in CMS
5271# Example:
5272# Request:
5273# mutation {
5274#
5275# createProcessTemplate(input: {
5276#
5277# name: "example",
5278#
5279# taskList: {
5280#
5281# example: "task"
5282#
5283# }}) {
5284#
5285# id
5286#
5287# }
5288# }
5289# Response:
5290# {
5291#
5292# "data": {
5293#
5294# "createProcessTemplate": {
5295#
5296# "id": "746"
5297#
5298# }
5299#
5300# }
5301# }
5302createProcessTemplate(input: CreateProcessTemplate!): ProcessTemplate!
5303
5304# Update a processTemplate by ID in CMS
5305# Example:
5306# Request:
5307# mutation {
5308#
5309# updateProcessTemplate(input: {
5310#
5311# id: "746",
5312#
5313# taskList: {
5314#
5315# example: "task",
5316#
5317# new: "new task"
5318#
5319# }}) {
5320#
5321# id
5322#
5323# }
5324# }
5325# Response:
5326# {
5327#
5328# "data": {
5329#
5330# "updateProcessTemplate": {
5331#
5332# "id": "746"
5333#
5334# }
5335#
5336# }
5337# }
5338updateProcessTemplate(input: UpdateProcessTemplate!): ProcessTemplate!
5339
5340# Delete a processTemplate by ID in CMS
5341# Example:
5342# Request:
5343# mutation {
5344#
5345# deleteProcessTemplate(
5346#
5347# id: "746") {
5348#
5349# message
5350#
5351# }
5352# }
5353# Response:
5354# {
5355#
5356# "data": {
5357#
5358# "deleteProcessTemplate": {
5359#
5360# "message": null
5361#
5362# }
5363#
5364# }
5365# }
5366deleteProcessTemplate(id: ID!): DeletePayload!
5367
5368# Create a mention export request. The requested mentionFilters including
5369# The mention export file csv will be exported offline.
5370# Example:
5371# Request:
5372# mutation {
5373#
5374# createMentionExportRequest(input: {
5375#
5376# mentionFilters: {
5377#
5378# watchlistIds: ["123"]}}) {
5379#
5380# id
5381#
5382# }
5383# }
5384# Response:
5385# {
5386#
5387# "data": {
5388#
5389# "createMentionExportRequest": {
5390#
5391# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5392#
5393# }
5394#
5395# }
5396# }
5397#
5398# Arguments
5399# input: Input data required to create the export request
5400createMentionExportRequest(
5401input: CreateMentionExportRequest!
5402): ExportRequest!
5403
5404# Update status or assetURI of a mentionExportRequest
5405# Often use when the file export was completed or downloaded
5406# Example:
5407# Request:
5408# mutation {
5409#
5410# updateMentionExportRequest(input: {
5411#
5412# id: "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5413#
5414# status: incomplete,
5415#
5416# assetUri: "www.veritone.com",
5417#
5418# sqlQueries:""}) {
5419#
5420# id
5421#
5422# }
5423# }
5424# Response:
5425# {
5426#
5427# "data": {
5428#
5429# "updateMentionExportRequest": {
5430#
5431# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5432#
5433# }
5434#
5435# }
5436# }
5437updateMentionExportRequest(
5438input: UpdateMentionExportRequest!
5439): ExportRequest!
5440
5441# Create a creative
5442# Example:
5443# Request:
5444# mutation {
5445#
5446# createCreative(input: {
5447#
5448# name: "example"
5449#
5450# keywords: "example keywords"
5451#
5452# brandId: null
5453#
5454# advertiserId: null}) {
5455#
5456# id
5457#
5458# }
5459# }
5460# Response:
5461# {
5462#
5463# "data": {
5464#
5465# "createCreative": {
5466#
5467# "id": "25208"
5468#
5469# }
5470#
5471# }
5472# }
5473createCreative(input: CreateCreative!): Creative!
5474
5475# Update a creative
5476# Example:
5477# Request:
5478# mutation {
5479#
5480# updateCreative(input: {
5481#
5482# id: "25208",
5483#
5484# name: "example",
5485#
5486# keywords: "new keywords",
5487#
5488# brandId: null,
5489#
5490# advertiserId: null}) {
5491#
5492# id
5493#
5494# }
5495# }
5496# Response:
5497# {
5498#
5499# "data": {
5500#
5501# "updateCreative": {
5502#
5503# "id": "25208"
5504#
5505# }
5506#
5507# }
5508# }
5509updateCreative(input: UpdateCreative!): Creative!
5510
5511# Delete a creative
5512# Example:
5513# Request:
5514# mutation {
5515#
5516# deleteCreative(
5517#
5518# id: "25208") {
5519#
5520# message
5521#
5522# }
5523# }
5524# Response:
5525# {
5526#
5527# "data": {
5528#
5529# "deleteCreative": {
5530#
5531# "message": null
5532#
5533# }
5534#
5535# }
5536# }
5537deleteCreative(id: ID!): DeletePayload!
5538
5539# Emit a system-level emit. This mutation is used only by
5540# Veritone platform components.
5541#
5542# Arguments
5543# input: Data required to create the event
5544emitSystemEvent(input: EmitSystemEvent!): SystemEventInfo!
5545
5546# Creates an immutable audit log event with the given payload
5547# Example:
5548# Request:
5549# mutation {
5550#
5551# emitAuditEvent(input: {
5552#
5553# application: ""
5554#
5555# payload: {
5556#
5557# example: "example"
5558#
5559# }}) {
5560#
5561# id
5562#
5563# }
5564# }
5565# Response:
5566# {
5567#
5568# "data": {
5569#
5570# "emitAuditEvent": {
5571#
5572# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f"
5573#
5574# }
5575#
5576# }
5577# }
5578emitAuditEvent(input: EmitAuditEvent!): AuditEvent!
5579
5580# Create a context menu extension
5581# Example:
5582# Request:
5583#
5584# mutation {
5585#
5586# createContextMenuExtension(input: {
5587#
5588# id: "80354999-d633-4595-9578-d82f59a5134f"
5589#
5590# label: "example"
5591#
5592# url: "www.veritone.com"
5593#
5594# type: tdo}) {
5595#
5596# id
5597#
5598# }
5599# }
5600# Response:
5601# {
5602#
5603# "data": {
5604#
5605# "createContextMenuExtension": {
5606#
5607# "id": "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"
5608#
5609# }
5610#
5611# }
5612# }
5613createContextMenuExtension(
5614input: CreateContextMenuExtension!
5615): ContextMenuExtension!
5616
5617# Update a context menu extension
5618# Example:
5619# Request:
5620#
5621# mutation {
5622#
5623# updateContextMenuExtension(input: {
5624#
5625# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746",
5626#
5627# label: "new label",
5628#
5629# url: "www.veritone.com"}) {
5630#
5631# label
5632#
5633# }
5634# }
5635# Response:
5636# {
5637#
5638# "data": {
5639#
5640# "updateContextMenuExtension": {
5641#
5642# "label": "new label"
5643#
5644# }
5645#
5646# }
5647# }
5648updateContextMenuExtension(
5649input: UpdateContextMenuExtension!
5650): ContextMenuExtension!
5651
5652# Delete a context menu extension
5653#
5654# Example:
5655#
5656# Request:
5657#
5658# mutation {
5659#
5660# deleteContextMenuExtension(input: {
5661#
5662# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"}) {
5663#
5664# message
5665#
5666# }
5667# }
5668# Response:
5669# {
5670#
5671# "data": {
5672#
5673# "deleteContextMenuExtension": {
5674#
5675# "message": null
5676#
5677# }
5678#
5679# }
5680# }
5681deleteContextMenuExtension(
5682input: DeleteContextMenuExtension!
5683): DeletePayload!
5684
5685# Add or update an organization integration config by
5686# organization id and integration id. Requires superadmin.
5687setOrganizationIntegrationConfig(
5688input: SetOrganizationIntegrationConfig!
5689): IntegrationConfig!
5690
5691# Delete an integration config. Requires superadmin.
5692deleteOrganizationIntegrationConfig(
5693input: DeleteOrganizationIntegrationConfig!
5694): DeleteIntegrationConfigPayload!
5695
5696# Create customized Login Configuration for the Instance
5697createInstanceLoginConfiguration(
5698input: CreateInstanceLoginConfiguration!
5699): LoginConfiguration!
5700
5701# Update customized Login Configuration for the Instance by Slug.
5702#
5703# ___Requires superadmin.___
5704#
5705# Arguments
5706# querySlug: The slug corresponding to the login configuration to
5707# be updated.
5708updateInstanceLoginConfiguration(
5709querySlug: String!,
5710input: SetLoginConfiguration!
5711): LoginConfiguration!
5712
5713# Delete the login configuration for the organization.
5714#
5715# Arguments
5716# organizationId: Optional field for the Organization ID for
5717# which the login configuration is to be deleted.
5718# Deleting login configuration for an organization that is different from the
5719# caller's organization
5720# is only allowed for superadmin.
5721#
5722# Defaults to caller's Organization ID.
5723deleteLoginConfiguration(organizationId: ID): DeletePayload!
5724
5725# Delete an instance-level login configuration by slug.
5726#
5727# Arguments
5728# slug: The slug corresponding to the instance-level login
5729# configuration to be deleted.
5730deleteInstanceLoginConfiguration(
5731slug: String!
5732): DeletePayload!
5733
5734# Mutation to create a new registration configuration.
5735createRegistrationConfiguration(
5736input: CreateRegistrationConfigurationInput!
5737): RegistrationConfiguration!
5738
5739# Mutation to update an existing registration configuration for an organization.
5740updateRegistrationConfiguration(
5741id: ID!,
5742input: UpdateRegistrationConfiguration!
5743): RegistrationConfiguration!
5744
5745# Mutation to delete an existing registration configuration for an organization.
5746deleteRegistrationConfiguration(id: ID!): DeletePayload!
5747
5748# Update the status of a user
5749# Example:
5750# Request:
5751# mutation {
5752#
5753# updateUserStatus(input: {
5754#
5755# id: "9728eeef-4ccc-423c-8c98-ffa37313a98d",
5756#
5757# status: deleted}) {
5758#
5759# status
5760#
5761# }
5762# }
5763# Response:
5764# {
5765#
5766# "data": {
5767#
5768# "updateUserStatus": {
5769#
5770# "status": "deleted"
5771#
5772# }
5773#
5774# }
5775# }
5776#
5777# Arguments
5778# input: Data required to update the status of a user
5779updateUserStatus(input: UpdateUserStatus!): User!
5780
5781# Create a custom dashboard
5782# Example:
5783# Request:
5784# mutation {
5785#
5786# createCustomDashboard(input: {
5787#
5788# hostAppId: "80354999-d633-4595-9578-d82f59a5134f",
5789#
5790# name: "example",
5791#
5792# description: "example",
5793#
5794# data: {
5795#
5796# example: "example jsondata"}}) {
5797#
5798# id
5799#
5800# }
5801# }
5802# Response:
5803# {
5804#
5805# "data": {
5806#
5807# "createCustomDashboard": {
5808#
5809# "id": "60141fc5-8d31-487d-9847-c47f990e4537"
5810#
5811# }
5812#
5813# }
5814# }
5815createCustomDashboard(input: CreateCustomDashboard): CustomDashboard
5816
5817# Update a custom dashboard
5818# Example:
5819# Request:
5820# mutation {
5821#
5822# updateCustomDashboard(input: {
5823#
5824# id: "60141fc5-8d31-487d-9847-c47f990e4537",
5825#
5826# name: "new name"}) {
5827#
5828# name
5829#
5830# }
5831# }
5832# Response:
5833# {
5834#
5835# "data": {
5836#
5837# "updateCustomDashboard": {
5838#
5839# "name": "new name"
5840#
5841# }
5842#
5843# }
5844# }
5845updateCustomDashboard(input: UpdateCustomDashboard): CustomDashboard
5846
5847# Delete a custom dashboard
5848# Example:
5849# Request:
5850# mutation {
5851#
5852# deleteCustomDashboard(
5853#
5854# id: "60141fc5-8d31-487d-9847-c47f990e4537") {
5855#
5856# message
5857#
5858# }
5859# }
5860# Response:
5861# {
5862#
5863# "data": {
5864#
5865# "deleteCustomDashboard": {
5866#
5867# "message": "Custom dashboard deleted"
5868#
5869# }
5870#
5871# }
5872# }
5873deleteCustomDashboard(id: ID!): DeletePayload
5874
5875# Create a Dataset
5876# Example:
5877# Request:
5878# mutation {
5879#
5880# createDataset(input: {
5881#
5882# name: "example",
5883#
5884# description: "example",
5885#
5886# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9",
5887#
5888# tags: {
5889#
5890# name: "example",
5891#
5892# value: "example value"}}) {
5893#
5894# datasetId
5895#
5896# }
5897# }
5898# Response:
5899# {
5900#
5901# "data": {
5902#
5903# "createDataset": {
5904#
5905# "datasetId": "47c831ea-f4f6-4eeb-9e39-8c1cd0a1eb95"
5906#
5907# }
5908#
5909# }
5910# }
5911createDataset(input: DatasetInput!): Dataset
5912
5913# Create a Dataset Schema
5914# Example:
5915# Request:
5916# mutation {
5917#
5918# createDatasetSchema(input: {
5919#
5920# name: "example"
5921#
5922# description: "example"
5923#
5924# schema: {
5925#
5926# example: "example value"
5927#
5928# }
5929#
5930# tags: {
5931#
5932# name: "example",
5933#
5934# value: "example value"}}) {
5935#
5936# schema{
5937#
5938# id
5939#
5940# }
5941#
5942# }
5943# }
5944# Response:
5945# {
5946#
5947# "data": {
5948#
5949# "createDatasetSchema": null
5950#
5951# }
5952# }
5953createDatasetSchema(input: CreateDatasetSchema!): Dataset
5954
5955# Update a Dataset
5956updateDataset(id: ID!, input: DatasetInput): Dataset
5957
5958# Delete a Dataset
5959deleteDataset(id: ID!): DeleteDatasetPayload!
5960
5961# Perform Dataset Operations
5962#
5963# Arguments
5964# id: Specify the Dataset ID for the operation to be performed
5965datasetDataOperation(
5966id: ID!,
5967actions: [DatasetActionInput!],
5968async: Boolean,
5969updateMetrics: Boolean
5970): DatasetStateInfo
5971
5972# Replace a source engine to replacement engine
5973# Example:
5974# Request:
5975# mutation {
5976#
5977# addTaskReplacementEngine(input: {
5978#
5979# sourceEngineId: "1"
5980#
5981# replacementEngineId: "2"
5982#
5983# organizationId: "35521"
5984#
5985# payloadFunc: null}) {
5986#
5987# replacementEngineId
5988#
5989# }
5990# }
5991# Response:
5992# {
5993#
5994# "data": {
5995#
5996# "addTaskReplacementEngine": {
5997#
5998# "replacementEngineId": "2"
5999#
6000# }
6001#
6002# }
6003# }
6004addTaskReplacementEngine(
6005input: AddTaskReplacementEngine
6006): TaskEngineReplacement
6007
6008# Remove an engine replacement
6009# Example:
6010# Request:
6011# mutation {
6012#
6013# removeTaskReplacementEngine(input: {
6014#
6015# sourceEngineId: "1",
6016#
6017# replacementEngineId: "2",
6018#
6019# organizationId: "35521"}) {
6020#
6021# message
6022#
6023# }
6024# }
6025# Response:
6026# {
6027#
6028# "data": {
6029#
6030# "removeTaskReplacementEngine": {
6031#
6032# "message": "Engine replacement has been removed"
6033#
6034# }
6035#
6036# }
6037# }
6038removeTaskReplacementEngine(
6039input: RemoveTaskReplacementEngine
6040): DeletePayload
6041
6042# Create a custom notification mailbox
6043# Example:
6044# Request:
6045# mutation {
6046#
6047# notificationMailboxCreate(input: {
6048#
6049# name: "example",
6050#
6051# eventFilter: {
6052#
6053# eventNames: "example",
6054#
6055# eventType: "example",,
6056#
6057# delivery: {
6058#
6059# params: {
6060#
6061# example: "example params"
6062#
6063# }
6064#
6065# }
6066#
6067# },
6068#
6069# notificationTemplate: "",
6070#
6071# limit: 10}) {
6072#
6073# id
6074#
6075# }
6076# }
6077# Response:
6078# {
6079#
6080# "data": {
6081#
6082# "notificationMailboxCreate": [
6083#
6084# {
6085#
6086# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6087#
6088# }
6089# } }
6090notificationMailboxCreate(
6091input: NotificationMailboxInput
6092): NotificationMailbox
6093
6094# Pause a notification mailbox
6095# Example:
6096# Request:
6097# mutation {
6098#
6099# notificationMailboxPause(
6100#
6101# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6102#
6103# id
6104#
6105# paused
6106#
6107# }
6108# }
6109# Response:
6110# {
6111#
6112# "data": {
6113#
6114# "notificationMailboxPause": {
6115#
6116# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6117#
6118# "paused": true
6119#
6120# }
6121#
6122# }
6123# }
6124notificationMailboxPause(id: ID!): NotificationMailbox
6125
6126# Delete a notification mailbox
6127# Example:
6128# Request:
6129# mutation {
6130#
6131# notificationMailboxDelete(id:"0415f525-813d-4fd4-9dea-9428382b05b9") {
6132#
6133# message
6134#
6135# }
6136# }
6137# Response:
6138# {
6139#
6140# "data": {
6141#
6142# "notificationMailboxDelete": {
6143#
6144# "message": "Notification mailbox has been removed"
6145#
6146# }
6147#
6148# }
6149# }
6150notificationMailboxDelete(id: ID!): DeletePayload!
6151
6152# Post a notification to some mailboxes
6153# Example:
6154# Request:
6155# mutation {
6156#
6157# notificationPost(input: {
6158#
6159# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"],
6160#
6161# title: "example title",
6162#
6163# body: "example body",
6164#
6165# contentType: "type",
6166#
6167# flags: unread}) {
6168#
6169# id
6170#
6171# }
6172# }
6173# Response:
6174# {
6175#
6176# "data": {
6177#
6178# "notificationPost": {
6179#
6180# "id": "iDDfG3oB3LnZSYqhRv7-"
6181#
6182# }
6183#
6184# }
6185# }
6186notificationPost(input: NotificaionPostInput): Notification
6187
6188# Add a new notification template by eventName, eventType, application
6189# Example:
6190# Request:
6191# mutation {
6192#
6193# addNotificationTemplate(input: {
6194#
6195# eventName: "example"
6196#
6197# eventType: "example"
6198#
6199# title: "example"
6200#
6201# body: "example"
6202#
6203# application: "80354999-d633-4595-9578-d82f59a5134f"
6204#
6205# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6206#
6207# id
6208#
6209# }
6210# }
6211# Response:
6212# {
6213#
6214# "data": {
6215#
6216# "addNotificationTemplate": {
6217#
6218# "id": "1dbf3d28-bc7a-434f-ba65-455da0169323"
6219#
6220# }
6221#
6222# }
6223# }
6224addNotificationTemplate(input: AddNotificationTemplate): NotificationTemplate
6225
6226# Remove a notification template by id
6227# Example:
6228# Request:
6229# mutation {
6230#
6231# removeNotificationTemplate(id: "1dbf3d28-bc7a-434f-ba65-455da0169323") {
6232#
6233# message
6234#
6235# }
6236# }
6237# Response:
6238# {
6239#
6240# "data": {
6241#
6242# "removeNotificationTemplate": {
6243#
6244# "message": "Notification Template has been removed"
6245#
6246# }
6247#
6248# }
6249# }
6250removeNotificationTemplate(id: ID!): DeletePayload!
6251
6252# Add a new notification action by eventName, eventType, application
6253# Example:
6254# Request:
6255# mutation {
6256#
6257# addNotificationAction(input: {
6258#
6259# eventName: "example",
6260#
6261# eventType: "example"
6262#
6263# actionName: "example"
6264#
6265# icon:
6266# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
6267#
6268# urlTemplate: "www.veritone.com"
6269#
6270# application: "80354999-d633-4595-9578-d82f59a5134f"
6271#
6272# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6273#
6274# id
6275#
6276# }
6277# }
6278# Response:
6279# {
6280#
6281# "data": {
6282#
6283# "addNotificationAction": {
6284#
6285# "id": "27dab45b-d825-4f20-b758-4b089d610903"
6286#
6287# }
6288#
6289# }
6290# }
6291addNotificationAction(input: AddNotificationAction): NotificationAction
6292
6293# Remove a notification action by id
6294# Example
6295# Request:
6296# mutation {
6297#
6298# removeNotificationAction(
6299#
6300# id:"27dab45b-d825-4f20-b758-4b089d610903") {
6301#
6302# message
6303#
6304# }
6305# }
6306# Response:
6307# {
6308#
6309# "data": {
6310#
6311# "removeNotificationAction": {
6312#
6313# "message": "Notification Action has been removed"
6314#
6315# }
6316#
6317# }
6318# }
6319removeNotificationAction(id: ID!): DeletePayload!
6320
6321# Set and unset the notification flags
6322# Example:
6323# Request:
6324# mutation {
6325#
6326# setNotificationFlag(input: {
6327#
6328# notificationId: "iDDfG3oB3LnZSYqhRv7-",
6329#
6330# setFlags: read}) {
6331#
6332# id
6333#
6334# flags
6335#
6336# }
6337# }
6338# Response:
6339# {
6340#
6341# "data": {
6342#
6343# "setNotificationFlag": {
6344#
6345# "id": "iDDfG3oB3LnZSYqhRv7-",
6346#
6347# "flags": [
6348#
6349# "unread",
6350#
6351# "read"
6352#
6353# ]
6354#
6355# }
6356#
6357# }
6358# }
6359setNotificationFlag(input: SetNotificationFlag): Notification
6360
6361# Unpause/resume a notification mailbox
6362# Example:
6363# Request:
6364# mutation {
6365#
6366# notificationMailboxUnpause(
6367#
6368# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6369#
6370# id
6371#
6372# }
6373# }
6374# Response:
6375# {
6376#
6377# "data": {
6378#
6379# "notificationMailboxUnpause": {
6380#
6381# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6382#
6383# }
6384#
6385# }
6386# }
6387notificationMailboxUnpause(id: ID!): NotificationMailbox
6388
6389# Mark all notification as read for mailboxIds
6390# Example:
6391# Request:
6392# mutation {
6393#
6394# markAllNotificationsRead(
6395#
6396# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6397#
6398# id
6399#
6400# }
6401# }
6402# Response:
6403# "data": {
6404#
6405# "markAllNotificationsRead": {
6406#
6407# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6408#
6409# "notifications": {
6410#
6411# "records": {
6412#
6413# "flags": [
6414#
6415# "unseen",
6416#
6417# "read"
6418#
6419# ]
6420#
6421# }
6422#
6423# }
6424#
6425# }
6426# }
6427markAllNotificationsRead(mailboxIds: [ID]!): [NotificationMailbox]
6428
6429# Mark all notification as read for mailboxIds
6430# Example:
6431# Request:
6432# mutation {
6433#
6434# markAllNotificationsSeen(
6435#
6436# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6437#
6438# id
6439#
6440# notifications{
6441#
6442# records{
6443#
6444# flags
6445#
6446# }
6447#
6448# }
6449#
6450# }
6451# }
6452# Response:
6453# {
6454#
6455# "data": {
6456#
6457# "markAllNotificationsSeen":
6458#
6459# {
6460#
6461# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6462#
6463# "notifications": {
6464#
6465# "records":
6466#
6467# {
6468#
6469# "flags": [
6470#
6471# "read",
6472#
6473# "seen"
6474#
6475# ]
6476#
6477# }
6478#
6479# }
6480#
6481# }
6482#
6483# }
6484#
6485# }
6486# }
6487markAllNotificationsSeen(mailboxIds: [ID]!): [NotificationMailbox]
6488
6489# Create the default user setting definition for application by current
6490# organization
6491# Example:
6492# Request:
6493# mutation {
6494#
6495# createUserSettingDefinition(
6496#
6497# application: "80354999-d633-4595-9578-d82f59a5134f",
6498#
6499# key: "example",
6500#
6501# type: "example",
6502#
6503# defaultValue: "example") {
6504#
6505# applicationId
6506#
6507# organizationGuid
6508#
6509# }
6510# }
6511# Response:
6512# {
6513#
6514# "data": {
6515#
6516# "createUserSettingDefinition": {
6517#
6518# "applicationId": "80354999-d633-4595-9578-d82f59a5134f",
6519#
6520# "organizationGuid": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09"
6521#
6522# }
6523#
6524# }
6525# }
6526#
6527# Arguments
6528# organizationGuid: Should be required by orgless token,
6529# or can be set by superadmin
6530createUserSettingDefinition(
6531application: ID!,
6532key: String!,
6533type: String!,
6534description: String,
6535defaultValue: String!,
6536organizationGuid: ID
6537): ApplicationSetting
6538
6539# Delete the default user setting definition for application and org
6540# Example:
6541# Request:
6542# mutation {
6543#
6544# deleteUserSettingDefinition(
6545#
6546# application: "80354999-d633-4595-9578-d82f59a5134f",
6547#
6548# key:"example") {
6549#
6550# message
6551#
6552# }
6553# }
6554# Response:
6555# {
6556#
6557# "data": {
6558#
6559# "deleteUserSettingDefinition": {
6560#
6561# "message": "Application setting (application:
6562# 80354999-d633-4595-9578-d82f59a5134f, organizationGuid:
6563# 49a4cbbc-5e83-4c42-b9a3-be6ec0732f09, key: example) has been deleted"
6564#
6565# }
6566#
6567# }
6568# }
6569#
6570# Arguments
6571# organizationGuid: Should be required by orgless token,
6572# or can be set by superadmin
6573deleteUserSettingDefinition(
6574application: ID!,
6575organizationGuid: ID,
6576key: String!
6577): DeletePayload!
6578
6579# Update setting for user (add/update/remove settings)
6580# Example:
6581# Request:
6582# mutation {
6583#
6584# updateUserSetting(input: {
6585#
6586# application: "80354999-d633-4595-9578-d82f59a5134f",
6587#
6588# key: "example12",
6589#
6590# value: "example value"}) {
6591#
6592# userId
6593#
6594# }
6595# }
6596# Response:
6597# {
6598#
6599# "data": {
6600#
6601# "updateUserSetting": {
6602#
6603# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008"
6604#
6605# }
6606#
6607# }
6608# }
6609updateUserSetting(input: UpdateUserSetting): UserSetting
6610
6611# Create an OpenID Provider
6612createOpenIdProvider(input: CreateOpenIdProvider): OpenIdProvider
6613
6614# Update an OpenId Provider by ID
6615updateOpenIdProvider(input: UpdateOpenIdProvider): OpenIdProvider
6616
6617# Enable Global OpenID Provider for Organization
6618enableOpenIdProviderForOrg(
6619input: EnableOpenIdProviderForOrg
6620): UpdatePayload
6621
6622# Disable Global OpenID Provider for Organization
6623disableOpenIdProviderForOrg(
6624input: DisableOpenIdProviderForOrg
6625): UpdatePayload
6626
6627# Delete OpenID Provider
6628deleteOpenIdProvider(id: ID!): DeletePayload
6629
6630# Get Organization scoped application JWT token
6631getApplicationJWT(input: GetApplicationJWT): ApplicationJWTTokenInfo
6632
6633# Remove an application event endpoint
6634removeApplicationEventEndpoint(id: ID!): DeletePayload
6635
6636# Update event endpoint for an application
6637updateApplicationEventEndpoint(
6638input: UpdateApplicationEventEndpoint
6639): Application
6640
6641# Multi Organization Invitation
6642createOrganizationInvite(
6643input: CreateOrganizationInviteInput!
6644): OrganizationInvite!
6645
6646updateOrganizationInvite(
6647input: UpdateOrganizationInviteInput!
6648): OrganizationInvite!
6649
6650setUserDefaultOrganization(
6651defaultOrganizationId: ID!
6652): OrganizationInfo
6653
6654# delete organization invitation
6655# This deletion is hard-delete process. It will remove invitation completely from
6656# the database.
6657deleteOrganizationInvite(organizationInviteId: ID!): DeletePayload
6658
6659# Create a package
6660packageCreate(input: PackageCreateInput): Package
6661
6662# This updates the specified package.
6663#
6664# This will result in upgrading the package by duplicating the original package
6665# and
6666# bumping its version number up to the next major version. The new package will
6667# reflect
6668# the changes made to the original package. __Note: The original package will not
6669# be altered in any way.__
6670#
6671# The data returned will be the newly upgraded version of the package.
6672packageUpdate(input: PackageUpdateInput): Package
6673
6674# Delete a package
6675packageDelete(id: ID!): PackageDeleteResult
6676
6677# This updates the resources of the specified package.
6678#
6679# This will result in upgrading the package by duplicating the original package
6680# and
6681# bumping its version number up to the next major version. The new package will
6682# reflect
6683# the changes made to the original package's resources. __Note: The original
6684# package will not
6685# be altered in any way.__
6686#
6687# The data returned will be the newly upgraded version of the package.
6688packageUpdateResources(input: BulkPackageResourceInput): Package
6689
6690# Add or remove Grants to a package and organization
6691packageUpdateGrants(input: BulkPackageGrantInput!): Package
6692
6693apiTokenCreate(name: String!, rights: [AuthPermissionType]!): ApiToken
6694
6695apiTokenUpdate(hash: String!, input: ApiTokenUpdateInput!): ApiTokenInfo
6696
6697# Update an ApplicationViewer
6698# Example:
6699# Request:
6700# mutation {
6701# updateApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a", input:
6702# { name: "Test"}) {
6703# records{
6704# id
6705# name
6706# }
6707# }
6708# }
6709# Response:
6710# {
6711# "data": {
6712# "viewers": {
6713# "records": [
6714# {
6715# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6716# "name": "Test"
6717# }
6718# ]
6719# }
6720# }
6721# }
6722#
6723# Arguments
6724# viewerId: Provide an id of the viewer to update.
6725# input: Input for the update viewer
6726updateApplicationViewer(
6727viewerId: ID!,
6728input: UpdateApplicationViewerInput!
6729): ApplicationViewer
6730
6731# Delete an ApplicationViewer
6732# Example:
6733# Request:
6734# mutation {
6735# deleteApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
6736# records{
6737# id
6738# name
6739# }
6740# }
6741# }
6742# Response:
6743# {
6744# "data": {
6745# "viewers": {
6746# "records": [
6747# {
6748# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6749# }
6750# ]
6751# }
6752# }
6753# }
6754#
6755# Arguments
6756# viewerId: Provide an id of the viewer to delete.
6757deleteApplicationViewer(viewerId: ID!): ApplicationViewer
6758
6759# Delete an ApplicationViewerBuild
6760# Example:
6761# Request:
6762# mutation {
6763# deleteApplicationViewerBuild(viewerBuildId:
6764# "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
6765# records{
6766# id
6767# name
6768# }
6769# }
6770# }
6771# Response:
6772# {
6773# "data": {
6774# "viewers": {
6775# "records": [
6776# {
6777# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6778# }
6779# ]
6780# }
6781# }
6782# }
6783#
6784# Arguments
6785# viewerBuildId: Provide an id of the viewer build to delete.
6786deleteApplicationViewerBuild(viewerBuildId: ID!): ApplicationViewerBuild
6787
6788# This mutation creates the multipart upload session to an S3 bucket. If provided,
6789# it will create the session for a
6790# specified bucket. Otherwise, it will create a session for the API bucket that is
6791# configured for aiware by default.
6792# What this mutation does is establish a connection to the bucket, initiate the
6793# multipart upload session,
6794# and generate pre-signed URLs for each part that needs to be uploaded. The number
6795# of generated pre-signed URLs is
6796# determined by the `numberOfParts` input field.
6797# Example:
6798# Request:
6799# mutation {
6800#
6801# initiateMultipartUpload(input: {
6802#
6803# fileName: "exampleImage.jpg",
6804#
6805# contentType: "image/jpeg",
6806#
6807# fileSize: 22594,
6808#
6809# }) {
6810#
6811# preSignedUrls {
6812#
6813# partNumber
6814#
6815# signedUrl
6816#
6817# }
6818#
6819# chunkSize
6820#
6821# key
6822#
6823# uploadId
6824#
6825# }
6826# }
6827initiateMultipartUpload(
6828input: InitiateMultipartUploadInput!
6829): MultipartUploadSessionInfo
6830
6831# This mutation is called after all parts have been uploaded. This will finalize
6832# and close out the
6833# multipart upload session and return the final URL where the file was uploaded
6834# to.
6835# Example:
6836# Request:
6837# mutation {
6838#
6839# completeMultipartUpload(input: {
6840#
6841# key: "exampleImage.jpg",
6842#
6843# uploadId: "exampleUploadId",
6844#
6845# parts: [
6846#
6847# {
6848#
6849# partNumber: "1",
6850#
6851# etag: "exampleEtag"
6852#
6853# }
6854#
6855# ]
6856#
6857# }) {
6858#
6859# url
6860#
6861# }
6862# }
6863completeMultipartUpload(
6864input: CompleteMultipartUploadInput!
6865): CompleteMultipartUploadResult
6866
6867# This mutation can be called at any point during an open multipart upload
6868# session.
6869# This will cancel the session and free up any space taken up by any parts already
6870# uploaded.
6871# However, it is possible for there to be dangling parts that may have still been
6872# in-progress and
6873# uploaded after the cancel request was made. This mutation will make the cancel
6874# request up to 3 times
6875# to ensure that everything has been cleaned up properly. If it’s not fully clean
6876# after 3 calls,
6877# an error will be returned, directing to run this mutation again.
6878# Example:
6879# Request:
6880# mutation {
6881#
6882# cancelMultipartUpload(input: {
6883#
6884# key: "exampleImage.jpg",
6885#
6886# uploadId: "exampleUploadId"
6887#
6888# }) {
6889#
6890# id
6891#
6892# message
6893#
6894# }
6895# }
6896cancelMultipartUpload(input: CancelMultipartUploadInput!): DeletePayload
6897
6898addPlatformEmailProvider(
6899input: EmailProviderConfigInput!
6900): EmailProviderConfig!
6901
6902# Create an email template.
6903emailTemplateCreate(input: EmailTemplateInput!): EmailTemplate!
6904
6905# This updates the specified email template.
6906emailTemplateUpdate(input: EmailTemplateInput!): EmailTemplate!
6907
6908# Delete an email template.
6909emailTemplateDelete(id: String!, organizationGuid: String!): EmailTemplate!
6910
6911}

link Required by

This element is not required by anyone