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# Delete a structured data object
2934# Example:
2935# Request:
2936# mutation {
2937#
2938# deleteStructuredData(input:{
2939#
2940# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
2941#
2942# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) {
2943#
2944# message
2945#
2946# }
2947# }
2948# Response:
2949# {
2950#
2951# "data": {
2952#
2953# "deleteStructuredData": {
2954#
2955# "message": null
2956#
2957# }
2958#
2959# }
2960# }
2961deleteStructuredData(input: DeleteStructuredData!): DeletePayload
2962
2963# Create (ingest) a structured data object
2964# Example:
2965# Request:
2966# mutation {
2967#
2968# createCollection(input: {
2969#
2970# name: "example",
2971#
2972# folderDescription: "example",
2973#
2974# image:"",
2975#
2976# parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) {
2977#
2978# id
2979#
2980# }
2981# }
2982# Response:
2983# {
2984#
2985# "data": {
2986#
2987# "createCollection": {
2988#
2989# "id": "242361"
2990#
2991# }
2992#
2993# }
2994# }
2995#
2996# Arguments
2997# input: Fields required to create new collection
2998createCollection(input: CreateCollection): Collection
2999
3000# Update a collection
3001# Example:
3002# Request:
3003# mutation {
3004#
3005# updateCollection(input: {
3006#
3007# folderId: "242361"
3008#
3009# name: "new name"
3010#
3011# folderDescription: "new description"}) {
3012#
3013# id
3014#
3015# name
3016#
3017# }
3018# }
3019# Response:
3020# {
3021#
3022# "data": {
3023#
3024# "updateCollection": {
3025#
3026# "id": "242361",
3027#
3028# "name": "new name"
3029#
3030# }
3031#
3032# }
3033# }
3034#
3035# Arguments
3036# input: Fields needed to update a collection
3037updateCollection(input: UpdateCollection): Collection
3038
3039# Delete Collection
3040# Example:
3041# Request:
3042# mutation {
3043#
3044# deleteCollection(
3045#
3046# id: "242361") {
3047#
3048# message
3049#
3050# }
3051# }
3052# Response:
3053# {
3054#
3055# "data": {
3056#
3057# "deleteCollection": {
3058#
3059# "message": "Deleted Successfully"
3060#
3061# }
3062#
3063# }
3064# }
3065#
3066# Arguments
3067# id: Supply the ID of the folder or collection to delete
3068deleteCollection(folderId: ID, id: ID): DeletePayload
3069
3070# Share a collection, allowing other organizations to view the data
3071# it contains.
3072# Example:
3073# Request:
3074# mutation {
3075#
3076# shareCollection(input: {
3077#
3078# folderId: "242599",
3079#
3080# shareMessage: "example",
3081#
3082# recipients: [] }) {
3083#
3084# id
3085#
3086# }
3087# }
3088# Response:
3089# {
3090#
3091# "data": {
3092#
3093# "shareCollection": {
3094#
3095# "id": "FhQrlAwfRMaTy0blR_eHRw"
3096#
3097# }
3098#
3099# }
3100# }
3101#
3102# Arguments
3103# input: Fields needed to share a collection
3104shareCollection(input: ShareCollection): Share
3105
3106# Arguments
3107# shareId: ID of the shared collection to update
3108# mentionIds: List of mentionIds to add or remove
3109# type: Indicates whether or not the mentions are to be added or
3110# deleted
3111updateSharedCollectionMentions(
3112shareId: String!,
3113mentionIds: [ID!],
3114type: SharedCollectionUpdateType!
3115): Share
3116
3117updateSharedCollectionHistory(
3118input: UpdateSharedCollectionHistory
3119): SharedCollectionHistory
3120
3121# Share a mention from a collection
3122#
3123# Arguments
3124# input: Fields needed to share a mention
3125shareMentionFromCollection(
3126input: ShareMentionFromCollection
3127): Share
3128
3129# Share mention
3130shareMention(input: ShareMention): Share
3131
3132# Share mentions in bulk
3133shareMentionInBulk(input: ShareMentionInBulk): [Share]
3134
3135# Add a mention to a collection
3136#
3137# Arguments
3138# input: Fields needed to add a mention to a collection
3139createCollectionMention(input: CollectionMentionInput): CollectionMention
3140
3141# Arguments
3142# input: Fields needed to add mentions to a collection
3143createCollectionMentions(
3144input: CreateCollectionMentions
3145): [CollectionMention!]!
3146
3147# Update a mention in a collection
3148#
3149# Arguments
3150# input: Fields needed to add mentions to a collection
3151updateCollectionMention(
3152input: UpdateCollectionMention!
3153): CollectionMention!
3154
3155# Remove a mention from a collection
3156#
3157# Arguments
3158# input: Fields needed to delete a mention from a collection
3159deleteCollectionMention(input: CollectionMentionInput): CollectionMention
3160
3161# Create a new folder
3162# Example:
3163# Request:
3164# mutation {
3165#
3166# createFolder(input: {
3167#
3168# name: "example",
3169#
3170# description: "example",
3171#
3172# parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3173#
3174# rootFolderType:watchlist}) {
3175#
3176# id
3177#
3178# name
3179#
3180# }
3181# }
3182# Response:
3183# {
3184#
3185# "data": {
3186#
3187# "createFolder": {
3188#
3189# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3190#
3191# "name": "example"
3192#
3193# }
3194#
3195# }
3196# }
3197#
3198# Arguments
3199# input: Fields needed to create a new folder.
3200createFolder(input: CreateFolder): Folder
3201
3202# Create a new PlatformVersion
3203# Example:
3204# Request:
3205# mutation {
3206#
3207# addPlatformVersion(input: {
3208#
3209# version: "1.2.0"
3210#
3211# manifestUrl: "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3212#
3213# changeLogUrl: "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3214#
3215# highlightsUrl: "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3216#
3217# }) {
3218#
3219# id
3220#
3221# version
3222#
3223# manifestUrl
3224#
3225# changeLogUrl
3226#
3227# highlightsUrl
3228#
3229# createdAt,
3230#
3231# createdBy
3232#
3233# }
3234# }
3235# Response:
3236# {
3237#
3238# "data": {
3239#
3240# "addPlatformVersion": {
3241#
3242# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3243#
3244# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3245#
3246# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3247#
3248# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3249#
3250# "createAt": "2023-05-10",
3251#
3252# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3253#
3254# }
3255#
3256# }
3257# }
3258#
3259# Arguments
3260# input: Fields needed to create a new aiWARE platform version.
3261addPlatformVersion(input: PlatformVersionInput): PlatformVersion
3262
3263# Set the current PlatformVersion
3264# Example:
3265# Request:
3266# mutation {
3267#
3268# setCurrentPlatformVersion(input: {
3269#
3270# version: "1.2.0"
3271#
3272# }) {
3273#
3274# id
3275#
3276# version
3277#
3278# manifestUrl
3279#
3280# changeLogUrl
3281#
3282# highlightsUrl
3283#
3284# createdAt,
3285#
3286# createdBy,
3287#
3288# installedAt,
3289#
3290# installedBy
3291#
3292# }
3293# }
3294# Response:
3295# {
3296#
3297# "data": {
3298#
3299# "setCurrentPlatformVersion": {
3300#
3301# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3302#
3303# "version": "1.2.0",
3304#
3305# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3306#
3307# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3308#
3309# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3310#
3311# "createAt": "2023-05-10",
3312#
3313# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248",
3314#
3315# "installedAt": "2023-05-15",
3316#
3317# "installedBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3318#
3319# }
3320#
3321# }
3322# }
3323#
3324# Arguments
3325# version: The version field is required to set the current
3326# aiWARE platform version
3327setCurrentPlatformVersion(version: String!): PlatformVersion
3328
3329# Set the platform properties.
3330# Example:
3331# Request:
3332# mutation {
3333#
3334# setPlatformProperties(
3335#
3336# properties: {
3337#
3338# Environment: "US West",
3339#
3340# ClusterSize: "small" }
3341#
3342# )
3343# }
3344# Response:
3345# {
3346#
3347# "data": {
3348#
3349# "setPlatformProperties": {
3350#
3351# "properties": {
3352#
3353# "Environment": "US West",
3354#
3355# "ClusterSize": "small"
3356#
3357# }
3358#
3359# }
3360#
3361# }
3362# }
3363#
3364# Arguments
3365# properties: Properties is JSON object that contains the
3366# properties of the platform that need to be added/ updated.
3367# So all the other properties in the JSON will be kept
3368setPlatformProperties(properties: JSONData!): JSONData
3369
3370# Update an existing folder
3371# Example:
3372# Request:
3373# mutation {
3374#
3375# updateFolder(input: {
3376#
3377# id: "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3378#
3379# name: "new name"}) {
3380#
3381# name
3382#
3383# }
3384# }
3385# Response:
3386# {
3387#
3388# "data": {
3389#
3390# "updateFolder": {
3391#
3392# "name": "new name"
3393#
3394# }
3395#
3396# }
3397# }
3398#
3399# Arguments
3400# input: Fields needed to update a folder.
3401updateFolder(input: UpdateFolder): Folder
3402
3403# Move a folder from one parent folder to another.
3404# Example:
3405# Request:
3406# mutation {
3407#
3408# moveFolder(input: {
3409#
3410# folderId: "68a5833a-f573-41fe-840a-adb5f6888e2d",
3411#
3412# fromFolderId: "3104f61f-4bd1-4175-9fe6-27436d591c54",
3413#
3414# toFolderId: "ad7839a7-d088-4202-9db1-5ed4992f915d"
3415#
3416# }) {
3417#
3418# parentFolderId
3419#
3420# }
3421# }
3422# Response:
3423# {
3424#
3425# "data": {
3426#
3427# "moveFolder": {
3428#
3429# "parentFolderId": "ad7839a7-d088-4202-9db1-5ed4992f915d",
3430#
3431# }
3432#
3433# }
3434# }
3435#
3436# Arguments
3437# input: Fields needed to move a folder
3438moveFolder(input: MoveFolder): Folder
3439
3440# Move bulk folders to another.
3441# Example:
3442# Request:
3443# mutation {
3444#
3445# moveFolders(input: {
3446#
3447# folderIds: ["0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3448# "183f64e7-d519-4948-99d9-977657cce0c8"]
3449#
3450# newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8"
3451#
3452# rootFolderType: cms
3453#
3454# }) {
3455#
3456# id
3457#
3458# name
3459#
3460# }
3461# }
3462# Response:
3463# {
3464#
3465# "data": {
3466#
3467# "moveFolders": {
3468#
3469# "organizationId": "7682",
3470#
3471# "newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8",
3472#
3473# "validFolderIds": [
3474#
3475# "0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3476#
3477# "183f64e7-d519-4948-99d9-977657cce0c8"
3478#
3479# ]
3480#
3481# "invalidFolderIds": [],
3482#
3483# "message": "Successfully move all input folders to the parent folder."
3484#
3485# }
3486#
3487# }
3488# }
3489#
3490# Arguments
3491# input: Fields needed to move a folder
3492moveFolders(input: MoveFolders): MoveFoldersPayload
3493
3494# Delete a folder
3495# Example:
3496# Request:
3497# mutation {
3498#
3499# deleteFolder(input: {
3500#
3501# id:"d551fbd6-7354-4b0e-abfb-654ab8583be2",
3502#
3503# orderIndex: 1}) {
3504#
3505# message
3506#
3507# }
3508# }
3509# Response:
3510# {
3511#
3512# "data": {
3513#
3514# "deleteFolder": {
3515#
3516# "message": null
3517#
3518# }
3519#
3520# }
3521# }
3522#
3523# Arguments
3524# input: Fields needed to delete a folder
3525deleteFolder(input: DeleteFolder): DeletePayload
3526
3527# Create a mention comment
3528#
3529# Arguments
3530# input: Fields needed to create a mention comment
3531createMentionComment(input: CreateMentionComment): MentionComment
3532
3533# Update a mention comment
3534#
3535# Arguments
3536# input: Fields needed to update a mention comment
3537updateMentionComment(input: UpdateMentionComment): MentionComment
3538
3539# Delete a mention comment
3540#
3541# Arguments
3542# input: Fields needed to delete a mention comment
3543deleteMentionComment(input: DeleteMentionComment): DeletePayload
3544
3545# Create a mention rating
3546#
3547# Arguments
3548# input: Fields needed to create a mention rating
3549createMentionRating(input: CreateMentionRating): MentionRating
3550
3551# Update a mention rating
3552#
3553# Arguments
3554# input: Fields needed to update a mention rating
3555updateMentionRating(input: UpdateMentionRating): MentionRating
3556
3557# Delete a mention rating
3558#
3559# Arguments
3560# input: Fields needed to delete a mention rating.
3561deleteMentionRating(input: DeleteMentionRating): DeletePayload
3562
3563# Login as a user. This mutation does not require an existing authentication
3564# context (via `Authorization` header with bearer token, cookie, etc.).
3565# Instead, the client supplies credentials to this mutation, which then
3566# authenticates the user and sets up the authentication context.
3567# The returned tokens can be used to authenticate future requests.
3568# Example:
3569# Request:
3570# mutation {
3571#
3572# userLogin(input: {
3573#
3574# userName: "example1",
3575#
3576# password: "example1"}) {
3577#
3578# apiToken
3579#
3580# lastLoggedIn
3581#
3582# }
3583# }
3584# Response:
3585# {
3586#
3587# "data": {
3588#
3589# "userLogin": {
3590#
3591# "apiToken": null,
3592#
3593# "lastLoggedIn": "2021-06-15T02:04:52.000Z",
3594#
3595# "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a"
3596#
3597# }
3598#
3599# }
3600# }
3601#
3602# Arguments
3603# input: Fields needed to log in
3604userLogin(input: UserLogin): LoginInfo
3605
3606# Logout user and invalidate user token
3607# Example:
3608# Request:
3609# mutation {
3610#
3611# userLogout(
3612#
3613# token: "a5610058-260d-46ac-aa3e-ee529c4feaab")
3614# }
3615# Response:
3616# {
3617#
3618# "data": {
3619#
3620# "userLogout": null
3621#
3622# }
3623# }
3624#
3625# Arguments
3626# token: User token that should be invalidated
3627userLogout(token: String!): Boolean
3628
3629# Refreshes the session user from database to reflect the latest changes. It does
3630# not extend session timeout.\
3631# Example:
3632# Request:
3633# mutation {
3634#
3635# refreshToken(
3636#
3637# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3638#
3639# hasPassword
3640#
3641# user{id}
3642#
3643# }
3644# }
3645# Response:
3646# {
3647#
3648# "data": {
3649#
3650# "refreshToken": {
3651#
3652# "hasPassword": true,
3653#
3654# "user": {
3655#
3656# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3657#
3658# }
3659#
3660# }
3661#
3662# }
3663# }
3664refreshToken(token: String!): LoginInfo
3665
3666# Refresh a user token, returning a fresh token so that the client
3667# can continue to authenticate to the API.\
3668# Example:
3669# Request:
3670# mutation {
3671#
3672# extendToken(
3673#
3674# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3675#
3676# hasPassword
3677#
3678# user{id}
3679#
3680# }
3681# }
3682# Response:
3683# {
3684#
3685# "data": {
3686#
3687# "extendToken": {
3688#
3689# "hasPassword": true,
3690#
3691# "user": {
3692#
3693# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3694#
3695# }
3696#
3697# }
3698#
3699# }
3700# }
3701extendToken(token: String!): LoginInfo
3702
3703# Validate a user token. This mutation is used by services to determine
3704# if the token provided by a given client is valid.
3705# Example:
3706# Request:
3707# mutation {
3708#
3709# validateToken(
3710#
3711# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3712#
3713# hasPassword
3714#
3715# user{id}
3716#
3717# }
3718# }
3719# Response:
3720# {
3721#
3722# "data": {
3723#
3724# "validateToken": {
3725#
3726# "hasPassword": true,
3727#
3728# "user": {
3729#
3730# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3731#
3732# }
3733#
3734# }
3735#
3736# }
3737# }
3738validateToken(token: String!): LoginInfo
3739
3740# Create a mention object
3741createMention(input: CreateMention!): Mention
3742
3743# Update a mention object
3744updateMention(input: UpdateMention!): Mention
3745
3746# Update a set of mentions
3747updateMentions(input: UpdateMentions!): [Mention]
3748
3749# Create root folder for an organization
3750# Example:
3751# Request:
3752# mutation {
3753#
3754# createRootFolders {
3755#
3756# id
3757#
3758# rootFolderTypeId
3759#
3760# }
3761# }
3762# Response:
3763# {
3764#
3765# "data": {
3766#
3767# "createRootFolders": [
3768#
3769# {
3770#
3771# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3772#
3773# "rootFolderTypeId": 1
3774#
3775# },
3776#
3777# {
3778#
3779# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3780#
3781# "rootFolderTypeId": 1
3782#
3783# }
3784#
3785# ]
3786#
3787# }
3788# }
3789#
3790# Arguments
3791# rootFolderType: The type of root folder to create
3792createRootFolders(rootFolderType: RootFolderType): [Folder]
3793
3794# Apply bulk updates to watchlists.
3795# This mutation is currently available only to Veritone operations.
3796#
3797# Arguments
3798# filter: A filter indicating which watchlists should be updated.
3799# At least one filter condition must be provided.
3800# Only watchlists for the user's organization will be updated.
3801# input: Fields used to update a watchlist.
3802bulkUpdateWatchlist(
3803filter: BulkUpdateWatchlistFilter!,
3804input: BulkUpdateWatchlist
3805): WatchlistList
3806
3807# File a TemporalDataObject in a folder. A given TemporalDataObject can
3808# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3809# and its assets to be visible within the folder.
3810# Example:
3811# Request:
3812# mutation {
3813#
3814# fileTemporalDataObject(input:{
3815#
3816# tdoId: "1580388995",
3817#
3818# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3819#
3820# id
3821#
3822# folders{
3823#
3824# id
3825#
3826# }
3827#
3828# }
3829# }
3830# Response:
3831# {
3832#
3833# "data": {
3834#
3835# "fileTemporalDataObject": {
3836#
3837# "id": "1580388995",
3838#
3839# "folders": [
3840#
3841# {
3842#
3843# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3844#
3845# }
3846#
3847# ]
3848#
3849# }
3850#
3851# }
3852# }
3853#
3854# Arguments
3855# input: The fields needed to file a TemporalDataObject in a
3856# folder
3857fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3858
3859# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3860# and its assets to disappear from the folder, but does not otherwise affect
3861# either the TDO or the folder and does not change access controls.
3862# Example:
3863# Request:
3864# mutation {
3865#
3866# unfileTemporalDataObject(input: {
3867#
3868# tdoId: "1580388995",
3869#
3870# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3871#
3872# id
3873#
3874# description
3875#
3876# }
3877# }
3878# Response:
3879# {
3880#
3881# "data": {
3882#
3883# "unfileTemporalDataObject": {
3884#
3885# "id": "1580388995",
3886#
3887# "description": null
3888#
3889# }
3890#
3891# }
3892# }
3893#
3894# Arguments
3895# input: The fields needed to file a TemporalDataObject in a
3896# folder
3897unfileTemporalDataObject(
3898input: UnfileTemporalDataObject!
3899): TemporalDataObject
3900
3901# Moves a TemporalDataObject from one parent folder to another.
3902# Any other folders the TemporalDataObject is filed in are unaffected.
3903# Example:
3904# Request:
3905# mutation {
3906#
3907# moveTemporalDataObject(input: {
3908#
3909# tdoId: "1580388995",
3910#
3911# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3912#
3913# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
3914#
3915# id
3916#
3917# folders{
3918#
3919# folderPath{id}
3920#
3921# }
3922#
3923# }
3924# }
3925# Response:
3926# {
3927#
3928# "data": {
3929#
3930# "moveTemporalDataObject": {
3931#
3932# "id": "1580388995",
3933#
3934# "folders": [
3935#
3936# {
3937#
3938# "folderPath": [
3939#
3940# {
3941#
3942# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
3943#
3944# }
3945#
3946# ]
3947#
3948# }
3949#
3950# ]
3951#
3952# }
3953#
3954# }
3955# }
3956#
3957# Arguments
3958# input: Fields need to move a TemporalDataObject
3959moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
3960
3961# Upload and store an engine result. The result will be stored as an
3962# asset associated with the target TemporalDataObject and the
3963# task will be updated accordingly.
3964# Use a multipart form POST to all this mutation.
3965#
3966# Arguments
3967# input: Fields needed to upload and store an engine result
3968uploadEngineResult(input: UploadEngineResult!): Asset
3969
3970# Create a watchlist
3971# Example:
3972# Request:
3973# mutation {
3974#
3975# createWatchlist(input: {
3976#
3977# stopDateTime: 1623851655,
3978#
3979# name: "example",
3980#
3981# searchIndex: mine,
3982#
3983# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3984#
3985# cognitiveSearches: [],
3986#
3987# subscriptions: [],
3988#
3989# details: {
3990#
3991# example: "example"}}) {
3992#
3993# id
3994#
3995# }
3996# }
3997# Response:
3998# {
3999#
4000# "data": {
4001#
4002# "createWatchlist": {
4003#
4004# "id": "325783"
4005#
4006# }
4007#
4008# }
4009# }
4010createWatchlist(input: CreateWatchlist!): Watchlist
4011
4012bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
4013
4014# Update a watchlist
4015# Example:
4016# Request:
4017# mutation {
4018#
4019# updateWatchlist(input: {
4020#
4021# id: "325783"
4022#
4023# name: "new name"
4024#
4025# details: {
4026#
4027# example: "new details"}}) {
4028#
4029# id
4030#
4031# name
4032#
4033# }
4034# }
4035# Response:
4036#
4037# {
4038#
4039# "data": {
4040#
4041# "updateWatchlist": {
4042#
4043# "id": "325783",
4044#
4045# "name": "new name"
4046#
4047# }
4048#
4049# }
4050# }
4051updateWatchlist(input: UpdateWatchlist!): Watchlist
4052
4053# Delete a watchlist
4054# Example:
4055# Request:
4056# mutation {
4057#
4058# deleteWatchlist(
4059#
4060# id:"325783") {
4061#
4062# message
4063#
4064# }
4065# }
4066# Response:
4067# {
4068#
4069# "data": {
4070#
4071# "deleteWatchlist": {
4072#
4073# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
4074# profiles, 0 mention comments, and 0 mention ratings."
4075#
4076# }
4077#
4078# }
4079# }
4080deleteWatchlist(id: ID!): DeletePayload
4081
4082updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
4083
4084createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
4085
4086deleteCognitiveSearch(id: ID!): DeletePayload
4087
4088fileWatchlist(input: FileWatchlist!): Watchlist
4089
4090# Unfile a watchlist from a folder
4091# Example:
4092# Request:
4093# mutation {
4094#
4095# unfileWatchlist(input: {
4096#
4097# watchlistId:"325786",
4098#
4099# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
4100#
4101# id
4102#
4103# folders{
4104#
4105# folderPath{
4106#
4107# id
4108#
4109# }
4110#
4111# }
4112#
4113# }
4114# }
4115# Response:
4116# {
4117#
4118# "data": {
4119#
4120# "unfileWatchlist": {
4121#
4122# "id": "325786",
4123#
4124# "folders": []
4125#
4126# }
4127#
4128# }
4129# }
4130unfileWatchlist(input: UnfileWatchlist!): Watchlist
4131
4132# Share a folder with other organizations
4133# Requires superadmin
4134shareFolder(input: ShareFolderInput): Folder
4135
4136# Create a TDO and an asset with a single call
4137# Example:
4138# Request:
4139# mutation {
4140#
4141# createTDOWithAsset(input: {
4142#
4143# startDateTime: 1623841655,
4144#
4145# stopDateTime: 1623851655,
4146#
4147# contentType: "video/mp4",
4148#
4149# assetType: "media",
4150#
4151# addToIndex: false,
4152#
4153# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
4154#
4155# id
4156#
4157# status
4158#
4159# assets {
4160#
4161# records {
4162#
4163# id
4164#
4165# assetType
4166#
4167# contentType
4168#
4169# signedUri
4170#
4171# }
4172#
4173# }
4174#
4175# }
4176# }
4177# Response:
4178# {
4179#
4180# "data": {
4181#
4182# "createTDOWithAsset": {
4183#
4184# "id": "1580507556",
4185#
4186# "status": "recorded",
4187#
4188# "assets": {
4189#
4190# "records": [
4191#
4192# {
4193#
4194# "id": "1580507556_DQ2nU8cTDh",
4195#
4196# "assetType": "media",
4197#
4198# "contentType": "video/mp4",
4199#
4200# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
4201#
4202# }
4203#
4204# ]
4205#
4206# }
4207#
4208# }
4209#
4210# }
4211# }
4212#
4213# Arguments
4214# input: Input fields necessary to create the TDO and asset
4215createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
4216
4217# Create a subscription
4218# Example:
4219# Request:
4220# mutation {
4221#
4222# createSubscription(input: {
4223#
4224# targetId: "325791",
4225#
4226# contact: {
4227#
4228# emailAddress: "example email"},
4229#
4230# scheduledDay: Friday}) {
4231#
4232# id
4233#
4234# }
4235# }
4236# Response:
4237# {
4238#
4239# "data": {
4240#
4241# "createSubscription": {
4242#
4243# "id": "274939"
4244#
4245# }
4246#
4247# }
4248# }
4249createSubscription(input: CreateSubscription!): Subscription
4250
4251# Update a subscription
4252# Example:
4253# Request:
4254# mutation {
4255#
4256# updateSubscription(input: {
4257#
4258# id: "274939"}) {
4259#
4260# id
4261#
4262# }
4263# }
4264# Response:
4265# mutation {
4266#
4267# updateSubscription(input: {
4268#
4269# id: "274939"}) {
4270#
4271# id
4272#
4273# }
4274# }
4275updateSubscription(input: UpdateSubscription!): Subscription
4276
4277# Delete a subscription
4278# Example:
4279# Request:
4280# mutation {
4281#
4282# deleteSubscription(
4283#
4284# id: "274939") {
4285#
4286# message
4287#
4288# }
4289# }
4290# Response:
4291# mutation {
4292#
4293# deleteSubscription(
4294#
4295# id: "274939") {
4296#
4297# message
4298#
4299# }
4300# }
4301deleteSubscription(id: ID!): DeletePayload
4302
4303# Create trigger for events or types.
4304# Example:
4305# Request:
4306# mutation {
4307#
4308# createTriggers(input: {
4309#
4310# events: "*",
4311#
4312# targets: {
4313#
4314# name: Email,
4315#
4316# params: {
4317#
4318# address: "example@veritone.com"}}}) {
4319#
4320# id
4321#
4322# }
4323# }
4324# Response:
4325# {
4326#
4327# "data": {
4328#
4329# "createTriggers": [
4330#
4331# {
4332#
4333# "id": "2936"
4334#
4335# }
4336#
4337# ]
4338#
4339# }
4340# }
4341createTriggers(input: CreateTriggers!): [Trigger]
4342
4343# Delete a registed trigger by ID.
4344# Examp