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
3627# sessionExpired: Internal system flag
3628userLogout(token: String!, sessionExpired: Boolean): Boolean
3629
3630# Refreshes the session user from database to reflect the latest changes. It does
3631# not extend session timeout.\
3632# Example:
3633# Request:
3634# mutation {
3635#
3636# refreshToken(
3637#
3638# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3639#
3640# hasPassword
3641#
3642# user{id}
3643#
3644# }
3645# }
3646# Response:
3647# {
3648#
3649# "data": {
3650#
3651# "refreshToken": {
3652#
3653# "hasPassword": true,
3654#
3655# "user": {
3656#
3657# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3658#
3659# }
3660#
3661# }
3662#
3663# }
3664# }
3665refreshToken(token: String!): LoginInfo
3666
3667# Refresh a user token, returning a fresh token so that the client
3668# can continue to authenticate to the API.\
3669# Example:
3670# Request:
3671# mutation {
3672#
3673# extendToken(
3674#
3675# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3676#
3677# hasPassword
3678#
3679# user{id}
3680#
3681# }
3682# }
3683# Response:
3684# {
3685#
3686# "data": {
3687#
3688# "extendToken": {
3689#
3690# "hasPassword": true,
3691#
3692# "user": {
3693#
3694# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3695#
3696# }
3697#
3698# }
3699#
3700# }
3701# }
3702extendToken(token: String!): LoginInfo
3703
3704# Validate a user token. This mutation is used by services to determine
3705# if the token provided by a given client is valid.
3706# Example:
3707# Request:
3708# mutation {
3709#
3710# validateToken(
3711#
3712# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3713#
3714# hasPassword
3715#
3716# user{id}
3717#
3718# }
3719# }
3720# Response:
3721# {
3722#
3723# "data": {
3724#
3725# "validateToken": {
3726#
3727# "hasPassword": true,
3728#
3729# "user": {
3730#
3731# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3732#
3733# }
3734#
3735# }
3736#
3737# }
3738# }
3739validateToken(token: String!): LoginInfo
3740
3741# Create a mention object
3742createMention(input: CreateMention!): Mention
3743
3744# Update a mention object
3745updateMention(input: UpdateMention!): Mention
3746
3747# Update a set of mentions
3748updateMentions(input: UpdateMentions!): [Mention]
3749
3750# Create root folder for an organization
3751# Example:
3752# Request:
3753# mutation {
3754#
3755# createRootFolders {
3756#
3757# id
3758#
3759# rootFolderTypeId
3760#
3761# }
3762# }
3763# Response:
3764# {
3765#
3766# "data": {
3767#
3768# "createRootFolders": [
3769#
3770# {
3771#
3772# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3773#
3774# "rootFolderTypeId": 1
3775#
3776# },
3777#
3778# {
3779#
3780# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3781#
3782# "rootFolderTypeId": 1
3783#
3784# }
3785#
3786# ]
3787#
3788# }
3789# }
3790#
3791# Arguments
3792# rootFolderType: The type of root folder to create
3793createRootFolders(rootFolderType: RootFolderType): [Folder]
3794
3795# Apply bulk updates to watchlists.
3796# This mutation is currently available only to Veritone operations.
3797#
3798# Arguments
3799# filter: A filter indicating which watchlists should be updated.
3800# At least one filter condition must be provided.
3801# Only watchlists for the user's organization will be updated.
3802# input: Fields used to update a watchlist.
3803bulkUpdateWatchlist(
3804filter: BulkUpdateWatchlistFilter!,
3805input: BulkUpdateWatchlist
3806): WatchlistList
3807
3808# File a TemporalDataObject in a folder. A given TemporalDataObject can
3809# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3810# and its assets to be visible within the folder.
3811# Example:
3812# Request:
3813# mutation {
3814#
3815# fileTemporalDataObject(input:{
3816#
3817# tdoId: "1580388995",
3818#
3819# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3820#
3821# id
3822#
3823# folders{
3824#
3825# id
3826#
3827# }
3828#
3829# }
3830# }
3831# Response:
3832# {
3833#
3834# "data": {
3835#
3836# "fileTemporalDataObject": {
3837#
3838# "id": "1580388995",
3839#
3840# "folders": [
3841#
3842# {
3843#
3844# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3845#
3846# }
3847#
3848# ]
3849#
3850# }
3851#
3852# }
3853# }
3854#
3855# Arguments
3856# input: The fields needed to file a TemporalDataObject in a
3857# folder
3858fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3859
3860# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3861# and its assets to disappear from the folder, but does not otherwise affect
3862# either the TDO or the folder and does not change access controls.
3863# Example:
3864# Request:
3865# mutation {
3866#
3867# unfileTemporalDataObject(input: {
3868#
3869# tdoId: "1580388995",
3870#
3871# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3872#
3873# id
3874#
3875# description
3876#
3877# }
3878# }
3879# Response:
3880# {
3881#
3882# "data": {
3883#
3884# "unfileTemporalDataObject": {
3885#
3886# "id": "1580388995",
3887#
3888# "description": null
3889#
3890# }
3891#
3892# }
3893# }
3894#
3895# Arguments
3896# input: The fields needed to file a TemporalDataObject in a
3897# folder
3898unfileTemporalDataObject(
3899input: UnfileTemporalDataObject!
3900): TemporalDataObject
3901
3902# Moves a TemporalDataObject from one parent folder to another.
3903# Any other folders the TemporalDataObject is filed in are unaffected.
3904# Example:
3905# Request:
3906# mutation {
3907#
3908# moveTemporalDataObject(input: {
3909#
3910# tdoId: "1580388995",
3911#
3912# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3913#
3914# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
3915#
3916# id
3917#
3918# folders{
3919#
3920# folderPath{id}
3921#
3922# }
3923#
3924# }
3925# }
3926# Response:
3927# {
3928#
3929# "data": {
3930#
3931# "moveTemporalDataObject": {
3932#
3933# "id": "1580388995",
3934#
3935# "folders": [
3936#
3937# {
3938#
3939# "folderPath": [
3940#
3941# {
3942#
3943# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
3944#
3945# }
3946#
3947# ]
3948#
3949# }
3950#
3951# ]
3952#
3953# }
3954#
3955# }
3956# }
3957#
3958# Arguments
3959# input: Fields need to move a TemporalDataObject
3960moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
3961
3962# Upload and store an engine result. The result will be stored as an
3963# asset associated with the target TemporalDataObject and the
3964# task will be updated accordingly.
3965# Use a multipart form POST to all this mutation.
3966#
3967# Arguments
3968# input: Fields needed to upload and store an engine result
3969uploadEngineResult(input: UploadEngineResult!): Asset
3970
3971# Create a watchlist
3972# Example:
3973# Request:
3974# mutation {
3975#
3976# createWatchlist(input: {
3977#
3978# stopDateTime: 1623851655,
3979#
3980# name: "example",
3981#
3982# searchIndex: mine,
3983#
3984# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3985#
3986# cognitiveSearches: [],
3987#
3988# subscriptions: [],
3989#
3990# details: {
3991#
3992# example: "example"}}) {
3993#
3994# id
3995#
3996# }
3997# }
3998# Response:
3999# {
4000#
4001# "data": {
4002#
4003# "createWatchlist": {
4004#
4005# "id": "325783"
4006#
4007# }
4008#
4009# }
4010# }
4011createWatchlist(input: CreateWatchlist!): Watchlist
4012
4013bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
4014
4015# Update a watchlist
4016# Example:
4017# Request:
4018# mutation {
4019#
4020# updateWatchlist(input: {
4021#
4022# id: "325783"
4023#
4024# name: "new name"
4025#
4026# details: {
4027#
4028# example: "new details"}}) {
4029#
4030# id
4031#
4032# name
4033#
4034# }
4035# }
4036# Response:
4037#
4038# {
4039#
4040# "data": {
4041#
4042# "updateWatchlist": {
4043#
4044# "id": "325783",
4045#
4046# "name": "new name"
4047#
4048# }
4049#
4050# }
4051# }
4052updateWatchlist(input: UpdateWatchlist!): Watchlist
4053
4054# Delete a watchlist
4055# Example:
4056# Request:
4057# mutation {
4058#
4059# deleteWatchlist(
4060#
4061# id:"325783") {
4062#
4063# message
4064#
4065# }
4066# }
4067# Response:
4068# {
4069#
4070# "data": {
4071#
4072# "deleteWatchlist": {
4073#
4074# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
4075# profiles, 0 mention comments, and 0 mention ratings."
4076#
4077# }
4078#
4079# }
4080# }
4081deleteWatchlist(id: ID!): DeletePayload
4082
4083updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
4084
4085createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
4086
4087deleteCognitiveSearch(id: ID!): DeletePayload
4088
4089fileWatchlist(input: FileWatchlist!): Watchlist
4090
4091# Unfile a watchlist from a folder
4092# Example:
4093# Request:
4094# mutation {
4095#
4096# unfileWatchlist(input: {
4097#
4098# watchlistId:"325786",
4099#
4100# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
4101#
4102# id
4103#
4104# folders{
4105#
4106# folderPath{
4107#
4108# id
4109#
4110# }
4111#
4112# }
4113#
4114# }
4115# }
4116# Response:
4117# {
4118#
4119# "data": {
4120#
4121# "unfileWatchlist": {
4122#
4123# "id": "325786",
4124#
4125# "folders": []
4126#
4127# }
4128#
4129# }
4130# }
4131unfileWatchlist(input: UnfileWatchlist!): Watchlist
4132
4133# Share a folder with other organizations
4134# Requires superadmin
4135shareFolder(input: ShareFolderInput): Folder
4136
4137# Create a TDO and an asset with a single call
4138# Example:
4139# Request:
4140# mutation {
4141#
4142# createTDOWithAsset(input: {
4143#
4144# startDateTime: 1623841655,
4145#
4146# stopDateTime: 1623851655,
4147#
4148# contentType: "video/mp4",
4149#
4150# assetType: "media",
4151#
4152# addToIndex: false,
4153#
4154# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
4155#
4156# id
4157#
4158# status
4159#
4160# assets {
4161#
4162# records {
4163#
4164# id
4165#
4166# assetType
4167#
4168# contentType
4169#
4170# signedUri
4171#
4172# }
4173#
4174# }
4175#
4176# }
4177# }
4178# Response:
4179# {
4180#
4181# "data": {
4182#
4183# "createTDOWithAsset": {
4184#
4185# "id": "1580507556",
4186#
4187# "status": "recorded",
4188#
4189# "assets": {
4190#
4191# "records": [
4192#
4193# {
4194#
4195# "id": "1580507556_DQ2nU8cTDh",
4196#
4197# "assetType": "media",
4198#
4199# "contentType": "video/mp4",
4200#
4201# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
4202#
4203# }
4204#
4205# ]
4206#
4207# }
4208#
4209# }
4210#
4211# }
4212# }
4213#
4214# Arguments
4215# input: Input fields necessary to create the TDO and asset
4216createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
4217
4218# Create a subscription
4219# Example:
4220# Request:
4221# mutation {
4222#
4223# createSubscription(input: {
4224#
4225# targetId: "325791",
4226#
4227# contact: {
4228#
4229# emailAddress: "example email"},
4230#
4231# scheduledDay: Friday}) {
4232#
4233# id
4234#
4235# }
4236# }
4237# Response:
4238# {
4239#
4240# "data": {
4241#
4242# "createSubscription": {
4243#
4244# "id": "274939"
4245#
4246# }
4247#
4248# }
4249# }
4250createSubscription(input: CreateSubscription!): Subscription
4251
4252# Update a subscription
4253# Example:
4254# Request:
4255# mutation {
4256#
4257# updateSubscription(input: {
4258#
4259# id: "274939"}) {
4260#
4261# id
4262#
4263# }
4264# }
4265# Response:
4266# mutation {
4267#
4268# updateSubscription(input: {
4269#
4270# id: "274939"}) {
4271#
4272# id
4273#
4274# }
4275# }
4276updateSubscription(input: UpdateSubscription!): Subscription
4277
4278# Delete a subscription
4279# Example:
4280# Request:
4281# mutation {
4282#
4283# deleteSubscription(
4284#
4285# id: "274939") {
4286#
4287# message
4288#
4289# }
4290# }
4291# Response:
4292# mutation {
4293#
4294# deleteSubscription(
4295#
4296# id: "274939") {
4297#
4298# message
4299#
4300# }
4301# }
4302deleteSubscription(id: ID!): DeletePayload
4303
4304# Create trigger for events or types.
4305# Example:
4306# Request:
4307# mutation {
4308#
4309# createTriggers(input: {
4310#
4311# events: "*",
4312#
4313# targets: {
4314#
4315# name: Email,
4316#
4317# params: {
4318#
4319# address: "example@veritone.com"}}}) {
4320#
4321# id
4322#
4323# }
4324# }
4325# Response:
4326# {
4327#
4328# "data": {
4329#
4330# "createTriggers": [
4331#
4332# {
4333#
4334# "id": "2936"
4335#
4336# }
4337#
4338# ]
4339#
4340# }
4341# }
4342createTriggers(input: CreateTriggers!): [Trigger]
4343
4344# Delete a registed trigger by ID.
4345# Example:
4346# Request:
4347# mutation {
4348#
4349# deleteTrigger(
4350#
4351# id: "2936") {
4352#
4353# message
4354#
4355# }
4356# }
4357# Response:
4358# {
4359#
4360# "data": {
4361#
4362# "deleteTrigger": {
4363#
4364# "message": "Trigger 2936 has been removed from organization 35521"
4365#
4366# }
4367#
4368# }
4369# }
4370deleteTrigger(id: ID!): DeletePayload
4371
4372# Validates if an engine output conforms to the engine output guidelines
4373# Example:
4374# Request:
4375# mutation {
4376#
4377# validateEngineOutput(input:
4378#
4379# {
4380#
4381# schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json",
4382#
4383# validationContracts: [
4384#
4385# "structured-data"
4386#
4387# ],
4388#
4389# series: [
4390#
4391# {
4392#
4393# startTimeMs: 0,
4394#
4395# stopTimeMs: 10000,
4396#
4397# structuredData: {
4398#
4399# exampleschemaid: {
4400#
4401# key: "value",
4402#
4403# any: "data you'd like",
4404#
4405# as_long: "as it conforms to the schema"
4406#
4407# }
4408#
4409# }
4410#
4411# }
4412#
4413# ]
4414#
4415# }
4416#
4417# )
4418# }
4419# Response:
4420# {
4421#
4422# "data": {
4423#
4424# "validateEngineOutput": true
4425#
4426# }
4427# }
4428validateEngineOutput(input: JSONData!): Boolean!
4429
4430# JWT tokens with a more limited scoped token to specific
4431# resources to the recording, task, and job
4432# and also has no organization association.
4433# Example:
4434# Request:
4435# mutation {
4436#
4437# getEngineJWT(input: {
4438#
4439# engineId: "1",
4440#
4441# resource:{
4442#
4443# tdoId: "1580701928"
4444#
4445# }}) {
4446#
4447# token
4448#
4449# }
4450# }
4451#
4452# Response:
4453# {
4454#
4455# "data": {
4456#
4457# "getEngineJWT": {
4458#
4459# "token": "eyJh...Tw_z3BKRA"
4460#
4461# }
4462#
4463# }
4464# }
4465getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
4466
4467# Verify JWT token
4468# Example:
4469# Request:
4470# mutation {
4471#
4472# verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW
4473#
4474# 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY
4475#
4476# wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ
4477#
4478# XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb
4479#
4480# eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw
4481#
4482# icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD
4483#
4484# A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia
4485#
4486# m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz
4487#
4488# NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI
4489#
4490# 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA")
4491# {
4492#
4493# payload
4494#
4495# }
4496# }
4497# Response:
4498# {
4499#
4500# "data": {
4501#
4502# "verifyJWT": {
4503#
4504# "payload": {
4505#
4506# "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09",
4507#
4508# "contentOrganizationId": 35521,
4509#
4510# "engineId": "1",
4511#
4512# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4513#
4514# "scope": [
4515#
4516# {
4517#
4518# "actions": [
4519#
4520# "asset:uri",
4521#
4522# "asset:all",
4523#
4524# "recording:read",
4525#
4526# "recording:update"
4527#
4528# ],
4529#
4530# "resources": {
4531#
4532# "recordingIds": [
4533#
4534# "1580701928"
4535#
4536# ]
4537#
4538# }
4539#
4540# },
4541#
4542# {
4543#
4544# "actions": [
4545#
4546# "task:update"
4547#
4548# ],
4549#
4550# "resources": {
4551#
4552# "jobIds": [],
4553#
4554# "taskIds": [],
4555#
4556# "sourceIds": []
4557#
4558# }
4559#
4560# }
4561#
4562# ],
4563#
4564# "iat": 1624036122,
4565#
4566# "exp": 1624640922,
4567#
4568# "sub": "engine-run",
4569#
4570# "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133"
4571#
4572# }
4573#
4574# }
4575#
4576# }
4577# }
4578verifyJWT(jwtToken: String!): VerifyJWTPayload
4579
4580# Create a new Saved Search
4581# Example:
4582# Request:
4583# mutation {
4584#
4585# createSavedSearch(input: {
4586#
4587# name: "example",
4588#
4589# csp: {
4590#
4591# example: "example"}}) {
4592#
4593# id
4594#
4595# }
4596# }
4597# Response:
4598# {
4599#
4600# "data": {
4601#
4602# "createSavedSearch": {
4603#
4604# "id": "a29f2255-e509-4454-89ec-e425390ca4ca"
4605#
4606# }
4607#
4608# }
4609# }
4610createSavedSearch(input: CreateSavedSearch!): SavedSearch!
4611
4612# Delete a saved search
4613# Example:
4614# Request:
4615# mutation {
4616#
4617# deleteSavedSearch(
4618#
4619# id:"a29f2255-e509-4454-89ec-e425390ca4ca") {
4620#
4621# message
4622#
4623# }
4624# }
4625# Response:
4626# {
4627#
4628# "data": {
4629#
4630# "deleteSavedSearch": {
4631#
4632# "message": null
4633#
4634# }
4635#
4636# }
4637# }
4638deleteSavedSearch(id: ID!): DeletePayload!
4639
4640# Mark existing saved search profile as deleted
4641# Create new saved search profile
4642# Example:
4643# Request:
4644# mutation {
4645#
4646# replaceSavedSearch(input: {
4647#
4648# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4649#
4650# name: "example",
4651#
4652# csp: {
4653#
4654# example: "new csp"}}) {
4655#
4656# id
4657#
4658# }
4659# }
4660# Response:
4661# mutation {
4662#
4663# replaceSavedSearch(input: {
4664#
4665# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4666#
4667# name: "example",
4668#
4669# csp: {
4670#
4671# example: "new csp"}}) {
4672#
4673# id
4674#
4675# }
4676# }
4677replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
4678
4679# Send a basic email. Mutation returns true for a success message.
4680# The email from field will be automatically set the default platform email
4681# address
4682# Example:
4683# Request:
4684# mutation {
4685#
4686# sendEmail(input: {
4687#
4688# to: "example@veritone.com"
4689#
4690# subject: "example"
4691#
4692# message: "email body"
4693#
4694# replyTo: "example@veritone.com"
4695#
4696# })
4697# }
4698# Response:
4699# {
4700#
4701# "data": {
4702#
4703# "sendEmail": true
4704#
4705# }
4706# }
4707sendEmail(input: SendEmail!): Boolean!
4708
4709# Create new content template into a folder
4710createFolderContentTemplate(
4711input: CreateFolderContentTemplate!
4712): FolderContentTemplate!
4713
4714# Update existing content template by folderContentTemplateId
4715updateFolderContentTemplate(
4716input: UpdateFolderContentTemplate!
4717): FolderContentTemplate!
4718
4719# Delete existing folder content template by folderContentTemplateId
4720#
4721# Arguments
4722# id: Folder Content Template Id
4723deleteFolderContentTemplate(id: ID!): DeletePayload!
4724
4725createFolderContentTempate(
4726input: CreateFolderContentTempate!
4727): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4728
4729updateFolderContentTempate(
4730input: UpdateFolderContentTempate!
4731): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4732
4733# Arguments
4734# id: Folder Content Template Id
4735deleteFolderContentTempate(
4736id: ID!
4737): DeletePayload! @deprecated( reason: "Misspelling" )
4738
4739# Create an export request. The requested TDO data, possibly including
4740# TDO media and engine results, will be exported offline.
4741# Example:
4742# Request:
4743# mutation {
4744#
4745# createExportRequest(input: {
4746#
4747# tdoData: {
4748#
4749# tdoId: "1580388995",
4750#
4751# }}) {
4752#
4753# id
4754#
4755# }
4756# }
4757# Response:
4758# {
4759#
4760# "data": {
4761#
4762# "createExportRequest": {
4763#
4764# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad"
4765#
4766# }
4767#
4768# }
4769# }
4770#
4771# Arguments
4772# input: Input data required to create the export request
4773createExportRequest(input: CreateExportRequest!): ExportRequest!
4774
4775# Update an export request
4776# Example:
4777# Request:
4778# mutation {
4779#
4780# updateExportRequest(input: {
4781#
4782# id: "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4783#
4784# status: complete}) {
4785#
4786# id
4787#
4788# status
4789#
4790# }
4791# }
4792# Response:
4793# {
4794#
4795# "data": {
4796#
4797# "updateExportRequest": {
4798#
4799# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4800#
4801# "status": "complete"
4802#
4803# }
4804#
4805# }
4806# }
4807#
4808# Arguments
4809# input: Input data required to update an export request
4810updateExportRequest(input: UpdateExportRequest!): ExportRequest!
4811
4812# Create Mention in bulk. The input should be an array of createMentions
4813createMentions(input: CreateMentions!): MentionList
4814
4815# Create Media Share. Returning the url of the share
4816createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
4817
4818# Create a new event
4819#
4820# Example:
4821#
4822# Request:
4823#
4824# mutation {
4825#
4826# createEvent(input: {
4827#
4828# eventName: "example",
4829#
4830# eventType: "example",
4831#
4832# application: ""
4833#
4834# description: "example"}) {
4835#
4836# id
4837#
4838# }
4839# }
4840# Response:
4841# {
4842#
4843# "data": {
4844#
4845# "createEvent": {
4846#
4847# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d"
4848#
4849# }
4850#
4851# }
4852# }
4853createEvent(input: CreateEvent!): Event!
4854
4855# Update an event
4856# Example:
4857# Request:
4858# mutation {
4859#
4860# updateEvent(input: {
4861#
4862# id: "55fc7c51-1521-4043-902f-f0f3a357da6d",
4863#
4864# description: "new example description"}) {
4865#
4866# id
4867#
4868# description
4869#
4870# }
4871# }
4872# Response:
4873# {
4874#
4875# "data": {
4876#
4877# "updateEvent": {
4878#
4879# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d",
4880#
4881# "description": "new example description"
4882#
4883# }
4884#
4885# }
4886# }
4887updateEvent(input: UpdateEvent!): Event!
4888
4889# Subscribe to an event
4890# Example:
4891# Request:
4892# mutation {
4893#
4894# subscribeEvent(input: {
4895#
4896# eventName: "example",
4897#
4898# eventType: "example",
4899#
4900# application: "",
4901#
4902# delivery: {
4903#
4904# name: CreateJob,
4905#
4906# params: {
4907#
4908# targetId: "1580701928"
4909#
4910# engineId: "1"
4911#
4912# }
4913#
4914# }
4915#
4916# })
4917# }
4918# Response:
4919# {
4920#
4921# "data": {
4922#
4923# "subscribeEvent": "a0d04eeb-c32d-4852-9273-bb0acda970b9"
4924#
4925# }
4926# }
4927subscribeEvent(input: SubscribeEvent!): ID!
4928
4929# Unsubscribe to an event
4930# Example:
4931# Request:
4932# mutation {
4933#
4934# unsubscribeEvent(
4935#
4936# id: "a0d04eeb-c32d-4852-9273-bb0acda970b9") {
4937#
4938# id
4939#
4940# message
4941#
4942# }
4943# }
4944# Response:
4945# {
4946#
4947# "data": {
4948#
4949# "unsubscribeEvent": {
4950#
4951# "id": "a0d04eeb-c32d-4852-9273-bb0acda970b9",
4952#
4953# "message": "Unsubscribed from event"
4954#
4955# }
4956#
4957# }
4958# }
4959unsubscribeEvent(id: ID!): UnsubscribeEvent!
4960
4961# Emit an event
4962# Example:
4963# Request:
4964# mutation {
4965#
4966# emitEvent(input: {
4967#
4968# eventName: "example",
4969#
4970# eventType: "example",
4971#
4972# application: "",
4973#
4974# payload: ""}) {
4975#
4976# id
4977#
4978# }
4979# }
4980# Response:
4981# {
4982#
4983# "data": {
4984#
4985# "emitEvent": {
4986#
4987# "id": "0952fe68-5652-4804-857d-26e21ef3d7e8"
4988#
4989# }
4990#
4991# }
4992# }
4993emitEvent(input: EmitEvent!): EmitEventResponse!
4994
4995# Create a new event trigger template
4996# Example:
4997# Request:
4998# mutation {
4999#
5000# createEventActionTemplate(input: {
5001#
5002# name: "example"
5003#
5004# inputType: event
5005#
5006# inputValidation: {
5007#
5008# example: "example"
5009#
5010# }
5011#
5012# inputAttributes: {
5013#
5014# example: "example"
5015#
5016# }
5017#
5018# actionType: job
5019#
5020# actionValidation: {
5021#
5022# example: "example"
5023#
5024# }
5025#
5026# actionDestination: "1"
5027#
5028# actionAttributes: {
5029#
5030# example: "example"
5031#
5032# }}) {
5033#
5034# id
5035#
5036# }
5037# }
5038# Response:
5039# {
5040#
5041# "data": {
5042#
5043# "createEventActionTemplate": {
5044#
5045# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92"
5046#
5047# }
5048#
5049# }
5050# }
5051createEventActionTemplate(
5052input: CreateEventActionTemplate!
5053): EventActionTemplate!
5054
5055# Update an event trigger template
5056# Example:
5057# Request:
5058# mutation {
5059#
5060# updateEventActionTemplate(input: {
5061#
5062# id: "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5063#
5064# name: "example",
5065#
5066# actionValidation: {
5067#
5068# example: "new validation"}}) {
5069#
5070# id
5071#
5072# actionValidation
5073#
5074# }
5075# }
5076# Response:
5077# {
5078#
5079# "data": {
5080#
5081# "updateEventActionTemplate": {
5082#
5083# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5084#
5085# "actionValidation": {
5086#
5087# "example": "new validation"
5088#
5089# }
5090#
5091# }
5092#
5093# }
5094# }
5095updateEventActionTemplate(
5096input: UpdateEventActionTemplate!
5097): EventActionTemplate!
5098
5099# Create a new event custom rule
5100# Example:
5101# Request:
5102# mutation {
5103#
5104# createEventCustomRule(input: {
5105#
5106# name: "example"
5107#
5108# eventType: "example"
5109#
5110# eventName: "example"
5111#
5112# description: "example description"
5113#
5114# actions:[]
5115#
5116# params: {
5117#
5118# example: "example"
5119#
5120# }}) {
5121#
5122# id
5123#
5124# }
5125# }
5126# Response:
5127# {
5128#
5129# "data": {
5130#
5131# "createEventCustomRule": {
5132#
5133# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b"
5134#
5135# }
5136#
5137# }
5138# }
5139createEventCustomRule(input: CreateEventCustomRule!): EventCustomRule!
5140
5141# Update an event custom rule
5142# Example:
5143# Request:
5144#
5145# mutation {
5146#
5147# updateEventCustomRule(input: {
5148#
5149# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5150#
5151# name: "example",
5152#
5153# status: inactive,
5154#
5155# description: "new description"}) {
5156#
5157# id
5158#
5159# description
5160#
5161# }
5162# }
5163# Response:
5164# {
5165#
5166# "data": {
5167#
5168# "updateEventCustomRule": {
5169#
5170# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5171#
5172# "description": "new description"
5173#
5174# }
5175#
5176# }
5177# }
5178updateEventCustomRule(input: UpdateEventCustomRule!): EventCustomRule!
5179
5180# Delete an event custom rule
5181# Example:
5182# Request:
5183# mutation {
5184#
5185# deleteEventCustomRule(
5186#
5187# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b") {
5188#
5189# message
5190#
5191# }
5192# }
5193# Response:
5194# {
5195#
5196# "data": {
5197#
5198# "deleteEventCustomRule": {
5199#
5200# "message": "Deleted event custom rule"
5201#
5202# }
5203#
5204# }
5205# }
5206deleteEventCustomRule(id: ID!): DeletePayload!
5207
5208# Create a processTemplate in CMS
5209# Example:
5210# Request:
5211# mutation {
5212#
5213# createProcessTemplate(input: {
5214#
5215# name: "example",
5216#
5217# taskList: {
5218#
5219# example: "task"
5220#
5221# }}) {
5222#
5223# id
5224#
5225# }
5226# }
5227# Response:
5228# {
5229#
5230# "data": {
5231#
5232# "createProcessTemplate": {
5233#
5234# "id": "746"
5235#
5236# }
5237#
5238# }
5239# }
5240createProcessTemplate(input: CreateProcessTemplate!): ProcessTemplate!
5241
5242# Update a processTemplate by ID in CMS
5243# Example:
5244# Request:
5245# mutation {
5246#
5247# updateProcessTemplate(input: {
5248#
5249# id: "746",
5250#
5251# taskList: {
5252#
5253# example: "task",
5254#
5255# new: "new task"
5256#
5257# }}) {
5258#
5259# id
5260#
5261# }
5262# }
5263# Response:
5264# {
5265#
5266# "data": {
5267#
5268# "updateProcessTemplate": {
5269#
5270# "id": "746"
5271#
5272# }
5273#
5274# }
5275# }
5276updateProcessTemplate(input: UpdateProcessTemplate!): ProcessTemplate!
5277
5278# Delete a processTemplate by ID in CMS
5279# Example:
5280# Request:
5281# mutation {
5282#
5283# deleteProcessTemplate(
5284#
5285# id: "746") {
5286#
5287# message
5288#
5289# }
5290# }
5291# Response:
5292# {
5293#
5294# "data": {
5295#
5296# "deleteProcessTemplate": {
5297#
5298# "message": null
5299#
5300# }
5301#
5302# }
5303# }
5304deleteProcessTemplate(id: ID!): DeletePayload!
5305
5306# Create a mention export request. The requested mentionFilters including
5307# The mention export file csv will be exported offline.
5308# Example:
5309# Request:
5310# mutation {
5311#
5312# createMentionExportRequest(input: {
5313#
5314# mentionFilters: {
5315#
5316# watchlistIds: ["123"]}}) {
5317#
5318# id
5319#
5320# }
5321# }
5322# Response:
5323# {
5324#
5325# "data": {
5326#
5327# "createMentionExportRequest": {
5328#
5329# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5330#
5331# }
5332#
5333# }
5334# }
5335#
5336# Arguments
5337# input: Input data required to create the export request
5338createMentionExportRequest(
5339input: CreateMentionExportRequest!
5340): ExportRequest!
5341
5342# Update status or assetURI of a mentionExportRequest
5343# Often use when the file export was completed or downloaded
5344# Example:
5345# Request:
5346# mutation {
5347#
5348# updateMentionExportRequest(input: {
5349#
5350# id: "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5351#
5352# status: incomplete,
5353#
5354# assetUri: "www.veritone.com",
5355#
5356# sqlQueries:""}) {
5357#
5358# id
5359#
5360# }
5361# }
5362# Response:
5363# {
5364#
5365# "data": {
5366#
5367# "updateMentionExportRequest": {
5368#
5369# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5370#
5371# }
5372#
5373# }
5374# }
5375updateMentionExportRequest(
5376input: UpdateMentionExportRequest!
5377): ExportRequest!
5378
5379# Create a creative
5380# Example:
5381# Request:
5382# mutation {
5383#
5384# createCreative(input: {
5385#
5386# name: "example"
5387#
5388# keywords: "example keywords"
5389#
5390# brandId: null
5391#
5392# advertiserId: null}) {
5393#
5394# id
5395#
5396# }
5397# }
5398# Response:
5399# {
5400#
5401# "data": {
5402#
5403# "createCreative": {
5404#
5405# "id": "25208"
5406#
5407# }
5408#
5409# }
5410# }
5411createCreative(input: CreateCreative!): Creative!
5412
5413# Update a creative
5414# Example:
5415# Request:
5416# mutation {
5417#
5418# updateCreative(input: {
5419#
5420# id: "25208",
5421#
5422# name: "example",
5423#
5424# keywords: "new keywords",
5425#
5426# brandId: null,
5427#
5428# advertiserId: null}) {
5429#
5430# id
5431#
5432# }
5433# }
5434# Response:
5435# {
5436#
5437# "data": {
5438#
5439# "updateCreative": {
5440#
5441# "id": "25208"
5442#
5443# }
5444#
5445# }
5446# }
5447updateCreative(input: UpdateCreative!): Creative!
5448
5449# Delete a creative
5450# Example:
5451# Request:
5452# mutation {
5453#
5454# deleteCreative(
5455#
5456# id: "25208") {
5457#
5458# message
5459#
5460# }
5461# }
5462# Response:
5463# {
5464#
5465# "data": {
5466#
5467# "deleteCreative": {
5468#
5469# "message": null
5470#
5471# }
5472#
5473# }
5474# }
5475deleteCreative(id: ID!): DeletePayload!
5476
5477# Emit a system-level emit. This mutation is used only by
5478# Veritone platform components.
5479#
5480# Arguments
5481# input: Data required to create the event
5482emitSystemEvent(input: EmitSystemEvent!): SystemEventInfo!
5483
5484# Creates an immutable audit log event with the given payload
5485# Example:
5486# Request:
5487# mutation {
5488#
5489# emitAuditEvent(input: {
5490#
5491# application: ""
5492#
5493# payload: {
5494#
5495# example: "example"
5496#
5497# }}) {
5498#
5499# id
5500#
5501# }
5502# }
5503# Response:
5504# {
5505#
5506# "data": {
5507#
5508# "emitAuditEvent": {
5509#
5510# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f"
5511#
5512# }
5513#
5514# }
5515# }
5516emitAuditEvent(input: EmitAuditEvent!): AuditEvent!
5517
5518# Create a context menu extension
5519# Example:
5520# Request:
5521#
5522# mutation {
5523#
5524# createContextMenuExtension(input: {
5525#
5526# id: "80354999-d633-4595-9578-d82f59a5134f"
5527#
5528# label: "example"
5529#
5530# url: "www.veritone.com"
5531#
5532# type: tdo}) {
5533#
5534# id
5535#
5536# }
5537# }
5538# Response:
5539# {
5540#
5541# "data": {
5542#
5543# "createContextMenuExtension": {
5544#
5545# "id": "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"
5546#
5547# }
5548#
5549# }
5550# }
5551createContextMenuExtension(
5552input: CreateContextMenuExtension!
5553): ContextMenuExtension!
5554
5555# Update a context menu extension
5556# Example:
5557# Request:
5558#
5559# mutation {
5560#
5561# updateContextMenuExtension(input: {
5562#
5563# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746",
5564#
5565# label: "new label",
5566#
5567# url: "www.veritone.com"}) {
5568#
5569# label
5570#
5571# }
5572# }
5573# Response:
5574# {
5575#
5576# "data": {
5577#
5578# "updateContextMenuExtension": {
5579#
5580# "label": "new label"
5581#
5582# }
5583#
5584# }
5585# }
5586updateContextMenuExtension(
5587input: UpdateContextMenuExtension!
5588): ContextMenuExtension!
5589
5590# Delete a context menu extension
5591#
5592# Example:
5593#
5594# Request:
5595#
5596# mutation {
5597#
5598# deleteContextMenuExtension(input: {
5599#
5600# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"}) {
5601#
5602# message
5603#
5604# }
5605# }
5606# Response:
5607# {
5608#
5609# "data": {
5610#
5611# "deleteContextMenuExtension": {
5612#
5613# "message": null
5614#
5615# }
5616#
5617# }
5618# }
5619deleteContextMenuExtension(
5620input: DeleteContextMenuExtension!
5621): DeletePayload!
5622
5623# Add or update an organization integration config by
5624# organization id and integration id. Requires superadmin.
5625setOrganizationIntegrationConfig(
5626input: SetOrganizationIntegrationConfig!
5627): IntegrationConfig!
5628
5629# Delete an integration config. Requires superadmin.
5630deleteOrganizationIntegrationConfig(
5631input: DeleteOrganizationIntegrationConfig!
5632): DeleteIntegrationConfigPayload!
5633
5634# Create customized Login Configuration for the Instance
5635createInstanceLoginConfiguration(
5636input: CreateInstanceLoginConfiguration!
5637): LoginConfiguration!
5638
5639# Update customized Login Configuration for the Instance by Slug.
5640#
5641# ___Requires superadmin.___
5642#
5643# Arguments
5644# querySlug: The slug corresponding to the login configuration to
5645# be updated.
5646updateInstanceLoginConfiguration(
5647querySlug: String!,
5648input: SetLoginConfiguration!
5649): LoginConfiguration!
5650
5651# Delete the login configuration for the organization.
5652#
5653# Arguments
5654# organizationId: Optional field for the Organization ID for
5655# which the login configuration is to be deleted.
5656# Deleting login configuration for an organization that is different from the
5657# caller's organization
5658# is only allowed for superadmin.
5659#
5660# Defaults to caller's Organization ID.
5661deleteLoginConfiguration(organizationId: ID): DeletePayload!
5662
5663# Delete an instance-level login configuration by slug.
5664#
5665# Arguments
5666# slug: The slug corresponding to the instance-level login
5667# configuration to be deleted.
5668deleteInstanceLoginConfiguration(
5669slug: String!
5670): DeletePayload!
5671
5672# Mutation to create a new registration configuration.
5673createRegistrationConfiguration(
5674input: CreateRegistrationConfigurationInput!
5675): RegistrationConfiguration!
5676
5677# Mutation to update an existing registration configuration for an organization.
5678updateRegistrationConfiguration(
5679id: ID!,
5680input: UpdateRegistrationConfiguration!
5681): RegistrationConfiguration!
5682
5683# Mutation to delete an existing registration configuration for an organization.
5684deleteRegistrationConfiguration(id: ID!): DeletePayload!
5685
5686# Update the status of a user
5687# Example:
5688# Request:
5689# mutation {
5690#
5691# updateUserStatus(input: {
5692#
5693# id: "9728eeef-4ccc-423c-8c98-ffa37313a98d",
5694#
5695# status: deleted}) {
5696#
5697# status
5698#
5699# }
5700# }
5701# Response:
5702# {
5703#
5704# "data": {
5705#
5706# "updateUserStatus": {
5707#
5708# "status": "deleted"
5709#
5710# }
5711#
5712# }
5713# }
5714#
5715# Arguments
5716# input: Data required to update the status of a user
5717updateUserStatus(input: UpdateUserStatus!): User!
5718
5719# Create a custom dashboard
5720# Example:
5721# Request:
5722# mutation {
5723#
5724# createCustomDashboard(input: {
5725#
5726# hostAppId: "80354999-d633-4595-9578-d82f59a5134f",
5727#
5728# name: "example",
5729#
5730# description: "example",
5731#
5732# data: {
5733#
5734# example: "example jsondata"}}) {
5735#
5736# id
5737#
5738# }
5739# }
5740# Response:
5741# {
5742#
5743# "data": {
5744#
5745# "createCustomDashboard": {
5746#
5747# "id": "60141fc5-8d31-487d-9847-c47f990e4537"
5748#
5749# }
5750#
5751# }
5752# }
5753createCustomDashboard(input: CreateCustomDashboard): CustomDashboard
5754
5755# Update a custom dashboard
5756# Example:
5757# Request:
5758# mutation {
5759#
5760# updateCustomDashboard(input: {
5761#
5762# id: "60141fc5-8d31-487d-9847-c47f990e4537",
5763#
5764# name: "new name"}) {
5765#
5766# name
5767#
5768# }
5769# }
5770# Response:
5771# {
5772#
5773# "data": {
5774#
5775# "updateCustomDashboard": {
5776#
5777# "name": "new name"
5778#
5779# }
5780#
5781# }
5782# }
5783updateCustomDashboard(input: UpdateCustomDashboard): CustomDashboard
5784
5785# Delete a custom dashboard
5786# Example:
5787# Request:
5788# mutation {
5789#
5790# deleteCustomDashboard(
5791#
5792# id: "60141fc5-8d31-487d-9847-c47f990e4537") {
5793#
5794# message
5795#
5796# }
5797# }
5798# Response:
5799# {
5800#
5801# "data": {
5802#
5803# "deleteCustomDashboard": {
5804#
5805# "message": "Custom dashboard deleted"
5806#
5807# }
5808#
5809# }
5810# }
5811deleteCustomDashboard(id: ID!): DeletePayload
5812
5813# Create a Dataset
5814# Example:
5815# Request:
5816# mutation {
5817#
5818# createDataset(input: {
5819#
5820# name: "example",
5821#
5822# description: "example",
5823#
5824# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9",
5825#
5826# tags: {
5827#
5828# name: "example",
5829#
5830# value: "example value"}}) {
5831#
5832# datasetId
5833#
5834# }
5835# }
5836# Response:
5837# {
5838#
5839# "data": {
5840#
5841# "createDataset": {
5842#
5843# "datasetId": "47c831ea-f4f6-4eeb-9e39-8c1cd0a1eb95"
5844#
5845# }
5846#
5847# }
5848# }
5849createDataset(input: DatasetInput!): Dataset
5850
5851# Create a Dataset Schema
5852# Example:
5853# Request:
5854# mutation {
5855#
5856# createDatasetSchema(input: {
5857#
5858# name: "example"
5859#
5860# description: "example"
5861#
5862# schema: {
5863#
5864# example: "example value"
5865#
5866# }
5867#
5868# tags: {
5869#
5870# name: "example",
5871#
5872# value: "example value"}}) {
5873#
5874# schema{
5875#
5876# id
5877#
5878# }
5879#
5880# }
5881# }
5882# Response:
5883# {
5884#
5885# "data": {
5886#
5887# "createDatasetSchema": null
5888#
5889# }
5890# }
5891createDatasetSchema(input: CreateDatasetSchema!): Dataset
5892
5893# Update a Dataset
5894updateDataset(id: ID!, input: DatasetInput): Dataset
5895
5896# Delete a Dataset
5897deleteDataset(id: ID!): DeleteDatasetPayload!
5898
5899# Perform Dataset Operations
5900#
5901# Arguments
5902# id: Specify the Dataset ID for the operation to be performed
5903datasetDataOperation(
5904id: ID!,
5905actions: [DatasetActionInput!],
5906async: Boolean,
5907updateMetrics: Boolean
5908): DatasetStateInfo
5909
5910# Replace a source engine to replacement engine
5911# Example:
5912# Request:
5913# mutation {
5914#
5915# addTaskReplacementEngine(input: {
5916#
5917# sourceEngineId: "1"
5918#
5919# replacementEngineId: "2"
5920#
5921# organizationId: "35521"
5922#
5923# payloadFunc: null}) {
5924#
5925# replacementEngineId
5926#
5927# }
5928# }
5929# Response:
5930# {
5931#
5932# "data": {
5933#
5934# "addTaskReplacementEngine": {
5935#
5936# "replacementEngineId": "2"
5937#
5938# }
5939#
5940# }
5941# }
5942addTaskReplacementEngine(
5943input: AddTaskReplacementEngine
5944): TaskEngineReplacement
5945
5946# Remove an engine replacement
5947# Example:
5948# Request:
5949# mutation {
5950#
5951# removeTaskReplacementEngine(input: {
5952#
5953# sourceEngineId: "1",
5954#
5955# replacementEngineId: "2",
5956#
5957# organizationId: "35521"}) {
5958#
5959# message
5960#
5961# }
5962# }
5963# Response:
5964# {
5965#
5966# "data": {
5967#
5968# "removeTaskReplacementEngine": {
5969#
5970# "message": "Engine replacement has been removed"
5971#
5972# }
5973#
5974# }
5975# }
5976removeTaskReplacementEngine(
5977input: RemoveTaskReplacementEngine
5978): DeletePayload
5979
5980# Create a custom notification mailbox
5981# Example:
5982# Request:
5983# mutation {
5984#
5985# notificationMailboxCreate(input: {
5986#
5987# name: "example",
5988#
5989# eventFilter: {
5990#
5991# eventNames: "example",
5992#
5993# eventType: "example",,
5994#
5995# delivery: {
5996#
5997# params: {
5998#
5999# example: "example params"
6000#
6001# }
6002#
6003# }
6004#
6005# },
6006#
6007# notificationTemplate: "",
6008#
6009# limit: 10}) {
6010#
6011# id
6012#
6013# }
6014# }
6015# Response:
6016# {
6017#
6018# "data": {
6019#
6020# "notificationMailboxCreate": [
6021#
6022# {
6023#
6024# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6025#
6026# }
6027# } }
6028notificationMailboxCreate(
6029input: NotificationMailboxInput
6030): NotificationMailbox
6031
6032# Pause a notification mailbox
6033# Example:
6034# Request:
6035# mutation {
6036#
6037# notificationMailboxPause(
6038#
6039# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6040#
6041# id
6042#
6043# paused
6044#
6045# }
6046# }
6047# Response:
6048# {
6049#
6050# "data": {
6051#
6052# "notificationMailboxPause": {
6053#
6054# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6055#
6056# "paused": true
6057#
6058# }
6059#
6060# }
6061# }
6062notificationMailboxPause(id: ID!): NotificationMailbox
6063
6064# Delete a notification mailbox
6065# Example:
6066# Request:
6067# mutation {
6068#
6069# notificationMailboxDelete(id:"0415f525-813d-4fd4-9dea-9428382b05b9") {
6070#
6071# message
6072#
6073# }
6074# }
6075# Response:
6076# {
6077#
6078# "data": {
6079#
6080# "notificationMailboxDelete": {
6081#
6082# "message": "Notification mailbox has been removed"
6083#
6084# }
6085#
6086# }
6087# }
6088notificationMailboxDelete(id: ID!): DeletePayload!
6089
6090# Post a notification to some mailboxes
6091# Example:
6092# Request:
6093# mutation {
6094#
6095# notificationPost(input: {
6096#
6097# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"],
6098#
6099# title: "example title",
6100#
6101# body: "example body",
6102#
6103# contentType: "type",
6104#
6105# flags: unread}) {
6106#
6107# id
6108#
6109# }
6110# }
6111# Response:
6112# {
6113#
6114# "data": {
6115#
6116# "notificationPost": {
6117#
6118# "id": "iDDfG3oB3LnZSYqhRv7-"
6119#
6120# }
6121#
6122# }
6123# }
6124notificationPost(input: NotificaionPostInput): Notification
6125
6126# Add a new notification template by eventName, eventType, application
6127# Example:
6128# Request:
6129# mutation {
6130#
6131# addNotificationTemplate(input: {
6132#
6133# eventName: "example"
6134#
6135# eventType: "example"
6136#
6137# title: "example"
6138#
6139# body: "example"
6140#
6141# application: "80354999-d633-4595-9578-d82f59a5134f"
6142#
6143# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6144#
6145# id
6146#
6147# }
6148# }
6149# Response:
6150# {
6151#
6152# "data": {
6153#
6154# "addNotificationTemplate": {
6155#
6156# "id": "1dbf3d28-bc7a-434f-ba65-455da0169323"
6157#
6158# }
6159#
6160# }
6161# }
6162addNotificationTemplate(input: AddNotificationTemplate): NotificationTemplate
6163
6164# Remove a notification template by id
6165# Example:
6166# Request:
6167# mutation {
6168#
6169# removeNotificationTemplate(id: "1dbf3d28-bc7a-434f-ba65-455da0169323") {
6170#
6171# message
6172#
6173# }
6174# }
6175# Response:
6176# {
6177#
6178# "data": {
6179#
6180# "removeNotificationTemplate": {
6181#
6182# "message": "Notification Template has been removed"
6183#
6184# }
6185#
6186# }
6187# }
6188removeNotificationTemplate(id: ID!): DeletePayload!
6189
6190# Add a new notification action by eventName, eventType, application
6191# Example:
6192# Request:
6193# mutation {
6194#
6195# addNotificationAction(input: {
6196#
6197# eventName: "example",
6198#
6199# eventType: "example"
6200#
6201# actionName: "example"
6202#
6203# icon:
6204# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
6205#
6206# urlTemplate: "www.veritone.com"
6207#
6208# application: "80354999-d633-4595-9578-d82f59a5134f"
6209#
6210# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6211#
6212# id
6213#
6214# }
6215# }
6216# Response:
6217# {
6218#
6219# "data": {
6220#
6221# "addNotificationAction": {
6222#
6223# "id": "27dab45b-d825-4f20-b758-4b089d610903"
6224#
6225# }
6226#
6227# }
6228# }
6229addNotificationAction(input: AddNotificationAction): NotificationAction
6230
6231# Remove a notification action by id
6232# Example
6233# Request:
6234# mutation {
6235#
6236# removeNotificationAction(
6237#
6238# id:"27dab45b-d825-4f20-b758-4b089d610903") {
6239#
6240# message
6241#
6242# }
6243# }
6244# Response:
6245# {
6246#
6247# "data": {
6248#
6249# "removeNotificationAction": {
6250#
6251# "message": "Notification Action has been removed"
6252#
6253# }
6254#
6255# }
6256# }
6257removeNotificationAction(id: ID!): DeletePayload!
6258
6259# Set and unset the notification flags
6260# Example:
6261# Request:
6262# mutation {
6263#
6264# setNotificationFlag(input: {
6265#
6266# notificationId: "iDDfG3oB3LnZSYqhRv7-",
6267#
6268# setFlags: read}) {
6269#
6270# id
6271#
6272# flags
6273#
6274# }
6275# }
6276# Response:
6277# {
6278#
6279# "data": {
6280#
6281# "setNotificationFlag": {
6282#
6283# "id": "iDDfG3oB3LnZSYqhRv7-",
6284#
6285# "flags": [
6286#
6287# "unread",
6288#
6289# "read"
6290#
6291# ]
6292#
6293# }
6294#
6295# }
6296# }
6297setNotificationFlag(input: SetNotificationFlag): Notification
6298
6299# Unpause/resume a notification mailbox
6300# Example:
6301# Request:
6302# mutation {
6303#
6304# notificationMailboxUnpause(
6305#
6306# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6307#
6308# id
6309#
6310# }
6311# }
6312# Response:
6313# {
6314#
6315# "data": {
6316#
6317# "notificationMailboxUnpause": {
6318#
6319# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6320#
6321# }
6322#
6323# }
6324# }
6325notificationMailboxUnpause(id: ID!): NotificationMailbox
6326
6327# Mark all notification as read for mailboxIds
6328# Example:
6329# Request:
6330# mutation {
6331#
6332# markAllNotificationsRead(
6333#
6334# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6335#
6336# id
6337#
6338# }
6339# }
6340# Response:
6341# "data": {
6342#
6343# "markAllNotificationsRead": {
6344#
6345# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6346#
6347# "notifications": {
6348#
6349# "records": {
6350#
6351# "flags": [
6352#
6353# "unseen",
6354#
6355# "read"
6356#
6357# ]
6358#
6359# }
6360#
6361# }
6362#
6363# }
6364# }
6365markAllNotificationsRead(mailboxIds: [ID]!): [NotificationMailbox]
6366
6367# Mark all notification as read for mailboxIds
6368# Example:
6369# Request:
6370# mutation {
6371#
6372# markAllNotificationsSeen(
6373#
6374# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6375#
6376# id
6377#
6378# notifications{
6379#
6380# records{
6381#
6382# flags
6383#
6384# }
6385#
6386# }
6387#
6388# }
6389# }
6390# Response:
6391# {
6392#
6393# "data": {
6394#
6395# "markAllNotificationsSeen":
6396#
6397# {
6398#
6399# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6400#
6401# "notifications": {
6402#
6403# "records":
6404#
6405# {
6406#
6407# "flags": [
6408#
6409# "read",
6410#
6411# "seen"
6412#
6413# ]
6414#
6415# }
6416#
6417# }
6418#
6419# }
6420#
6421# }
6422#
6423# }
6424# }
6425markAllNotificationsSeen(mailboxIds: [ID]!): [NotificationMailbox]
6426
6427# Create the default user setting definition for application by current
6428# organization
6429# Example:
6430# Request:
6431# mutation {
6432#
6433# createUserSettingDefinition(
6434#
6435# application: "80354999-d633-4595-9578-d82f59a5134f",
6436#
6437# key: "example",
6438#
6439# type: "example",
6440#
6441# defaultValue: "example") {
6442#
6443# applicationId
6444#
6445# organizationGuid
6446#
6447# }
6448# }
6449# Response:
6450# {
6451#
6452# "data": {
6453#
6454# "createUserSettingDefinition": {
6455#
6456# "applicationId": "80354999-d633-4595-9578-d82f59a5134f",
6457#
6458# "organizationGuid": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09"
6459#
6460# }
6461#
6462# }
6463# }
6464#
6465# Arguments
6466# organizationGuid: Should be required by orgless token,
6467# or can be set by superadmin
6468createUserSettingDefinition(
6469application: ID!,
6470key: String!,
6471type: String!,
6472description: String,
6473defaultValue: String!,
6474organizationGuid: ID
6475): ApplicationSetting
6476
6477# Delete the default user setting definition for application and org
6478# Example:
6479# Request:
6480# mutation {
6481#
6482# deleteUserSettingDefinition(
6483#
6484# application: "80354999-d633-4595-9578-d82f59a5134f",
6485#
6486# key:"example") {
6487#
6488# message
6489#
6490# }
6491# }
6492# Response:
6493# {
6494#
6495# "data": {
6496#
6497# "deleteUserSettingDefinition": {
6498#
6499# "message": "Application setting (application:
6500# 80354999-d633-4595-9578-d82f59a5134f, organizationGuid:
6501# 49a4cbbc-5e83-4c42-b9a3-be6ec0732f09, key: example) has been deleted"
6502#
6503# }
6504#
6505# }
6506# }
6507#
6508# Arguments
6509# organizationGuid: Should be required by orgless token,
6510# or can be set by superadmin
6511deleteUserSettingDefinition(
6512application: ID!,
6513organizationGuid: ID,
6514key: String!
6515): DeletePayload!
6516
6517# Update setting for user (add/update/remove settings)
6518# Example:
6519# Request:
6520# mutation {
6521#
6522# updateUserSetting(input: {
6523#
6524# application: "80354999-d633-4595-9578-d82f59a5134f",
6525#
6526# key: "example12",
6527#
6528# value: "example value"}) {
6529#
6530# userId
6531#
6532# }
6533# }
6534# Response:
6535# {
6536#
6537# "data": {
6538#
6539# "updateUserSetting": {
6540#
6541# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008"
6542#
6543# }
6544#
6545# }
6546# }
6547updateUserSetting(input: UpdateUserSetting): UserSetting
6548
6549# Create an OpenID Provider
6550createOpenIdProvider(input: CreateOpenIdProvider): OpenIdProvider
6551
6552# Update an OpenId Provider by ID
6553updateOpenIdProvider(input: UpdateOpenIdProvider): OpenIdProvider
6554
6555# Enable Global OpenID Provider for Organization
6556enableOpenIdProviderForOrg(
6557input: EnableOpenIdProviderForOrg
6558): UpdatePayload
6559
6560# Disable Global OpenID Provider for Organization
6561disableOpenIdProviderForOrg(
6562input: DisableOpenIdProviderForOrg
6563): UpdatePayload
6564
6565# Delete OpenID Provider
6566deleteOpenIdProvider(id: ID!): DeletePayload
6567
6568# Get Organization scoped application JWT token
6569getApplicationJWT(input: GetApplicationJWT): ApplicationJWTTokenInfo
6570
6571# Remove an application event endpoint
6572removeApplicationEventEndpoint(id: ID!): DeletePayload
6573
6574# Update event endpoint for an application
6575updateApplicationEventEndpoint(
6576input: UpdateApplicationEventEndpoint
6577): Application
6578
6579# Multi Organization Invitation
6580createOrganizationInvite(
6581input: CreateOrganizationInviteInput!
6582): OrganizationInvite!
6583
6584updateOrganizationInvite(
6585input: UpdateOrganizationInviteInput!
6586): OrganizationInvite!
6587
6588setUserDefaultOrganization(
6589defaultOrganizationId: ID!
6590): OrganizationInfo
6591
6592# delete organization invitation
6593# This deletion is hard-delete process. It will remove invitation completely from
6594# the database.
6595deleteOrganizationInvite(organizationInviteId: ID!): DeletePayload
6596
6597# Create a package
6598packageCreate(input: PackageCreateInput): Package
6599
6600# This updates the specified package.
6601#
6602# This will result in upgrading the package by duplicating the original package
6603# and
6604# bumping its version number up to the next major version. The new package will
6605# reflect
6606# the changes made to the original package. __Note: The original package will not
6607# be altered in any way.__
6608#
6609# The data returned will be the newly upgraded version of the package.
6610packageUpdate(input: PackageUpdateInput): Package
6611
6612# Delete a package
6613packageDelete(id: ID!): PackageDeleteResult
6614
6615# This updates the resources of the specified package.
6616#
6617# This will result in upgrading the package by duplicating the original package
6618# and
6619# bumping its version number up to the next major version. The new package will
6620# reflect
6621# the changes made to the original package's resources. __Note: The original
6622# package will not
6623# be altered in any way.__
6624#
6625# The data returned will be the newly upgraded version of the package.
6626packageUpdateResources(input: BulkPackageResourceInput): Package
6627
6628# Add or remove Grants to a package and organization
6629packageUpdateGrants(input: BulkPackageGrantInput!): Package
6630
6631apiTokenCreate(name: String!, rights: [AuthPermissionType]!): ApiToken
6632
6633apiTokenUpdate(hash: String!, input: ApiTokenUpdateInput!): ApiTokenInfo
6634
6635# Update an ApplicationViewer
6636# Example:
6637# Request:
6638# mutation {
6639# updateApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a", input:
6640# { name: "Test"}) {
6641# records{
6642# id
6643# name
6644# }
6645# }
6646# }
6647# Response:
6648# {
6649# "data": {
6650# "viewers": {
6651# "records": [
6652# {
6653# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6654# "name": "Test"
6655# }
6656# ]
6657# }
6658# }
6659# }
6660#
6661# Arguments
6662# viewerId: Provide an id of the viewer to update.
6663# input: Input for the update viewer
6664updateApplicationViewer(
6665viewerId: ID!,
6666input: UpdateApplicationViewerInput!
6667): ApplicationViewer
6668
6669# Delete an ApplicationViewer
6670# Example:
6671# Request:
6672# mutation {
6673# deleteApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
6674# records{
6675# id
6676# name
6677# }
6678# }
6679# }
6680# Response:
6681# {
6682# "data": {
6683# "viewers": {
6684# "records": [
6685# {
6686# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6687# }
6688# ]
6689# }
6690# }
6691# }
6692#
6693# Arguments
6694# viewerId: Provide an id of the viewer to delete.
6695deleteApplicationViewer(viewerId: ID!): ApplicationViewer
6696
6697# Delete an ApplicationViewerBuild
6698# Example:
6699# Request:
6700# mutation {
6701# deleteApplicationViewerBuild(viewerBuildId:
6702# "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
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# }
6717# ]
6718# }
6719# }
6720# }
6721#
6722# Arguments
6723# viewerBuildId: Provide an id of the viewer build to delete.
6724deleteApplicationViewerBuild(viewerBuildId: ID!): ApplicationViewerBuild
6725
6726# This mutation creates the multipart upload session to an S3 bucket. If provided,
6727# it will create the session for a
6728# specified bucket. Otherwise, it will create a session for the API bucket that is
6729# configured for aiware by default.
6730# What this mutation does is establish a connection to the bucket, initiate the
6731# multipart upload session,
6732# and generate pre-signed URLs for each part that needs to be uploaded. The number
6733# of generated pre-signed URLs is
6734# determined by the `numberOfParts` input field.
6735# Example:
6736# Request:
6737# mutation {
6738#
6739# initiateMultipartUpload(input: {
6740#
6741# fileName: "exampleImage.jpg",
6742#
6743# contentType: "image/jpeg",
6744#
6745# fileSize: 22594,
6746#
6747# }) {
6748#
6749# preSignedUrls {
6750#
6751# partNumber
6752#
6753# signedUrl
6754#
6755# }
6756#
6757# chunkSize
6758#
6759# key
6760#
6761# uploadId
6762#
6763# }
6764# }
6765initiateMultipartUpload(
6766input: InitiateMultipartUploadInput!
6767): MultipartUploadSessionInfo
6768
6769# This mutation is called after all parts have been uploaded. This will finalize
6770# and close out the
6771# multipart upload session and return the final URL where the file was uploaded
6772# to.
6773# Example:
6774# Request:
6775# mutation {
6776#
6777# completeMultipartUpload(input: {
6778#
6779# key: "exampleImage.jpg",
6780#
6781# uploadId: "exampleUploadId",
6782#
6783# parts: [
6784#
6785# {
6786#
6787# partNumber: "1",
6788#
6789# etag: "exampleEtag"
6790#
6791# }
6792#
6793# ]
6794#
6795# }) {
6796#
6797# url
6798#
6799# }
6800# }
6801completeMultipartUpload(
6802input: CompleteMultipartUploadInput!
6803): CompleteMultipartUploadResult
6804
6805# This mutation can be called at any point during an open multipart upload
6806# session.
6807# This will cancel the session and free up any space taken up by any parts already
6808# uploaded.
6809# However, it is possible for there to be dangling parts that may have still been
6810# in-progress and
6811# uploaded after the cancel request was made. This mutation will make the cancel
6812# request up to 3 times
6813# to ensure that everything has been cleaned up properly. If it’s not fully clean
6814# after 3 calls,
6815# an error will be returned, directing to run this mutation again.
6816# Example:
6817# Request:
6818# mutation {
6819#
6820# cancelMultipartUpload(input: {
6821#
6822# key: "exampleImage.jpg",
6823#
6824# uploadId: "exampleUploadId"
6825#
6826# }) {
6827#
6828# id
6829#
6830# message
6831#
6832# }
6833# }
6834cancelMultipartUpload(input: CancelMultipartUploadInput!): DeletePayload
6835
6836addPlatformEmailProvider(
6837input: EmailProviderConfigInput!
6838): EmailProviderConfig!
6839
6840# Create an email template.
6841emailTemplateCreate(input: EmailTemplateInput!): EmailTemplate!
6842
6843# This updates the specified email template.
6844emailTemplateUpdate(input: EmailTemplateInput!): EmailTemplate!
6845
6846# Delete an email template.
6847emailTemplateDelete(id: String!, organizationGuid: String!): EmailTemplate!
6848
6849}

link Required by

This element is not required by anyone