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

link Required by

This element is not required by anyone