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

link Required by

This element is not required by anyone