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# Update specific roles for a user by adding and/or removing individual roles.
2548# Unlike updateUser which replaces all roles, this mutation allows granular
2549# changes.
2550# Only addRoleIds are validated against enabled applications, allowing removal
2551# of roles from disabled or legacy apps.
2552#
2553# Arguments
2554# input: Fields needed to update user roles
2555updateUserRoles(input: UpdateUserRolesInput!): User
2556
2557# Add an existing user to an organization.
2558# One of the user identifiers (userId or userName) has to be specified.
2559#
2560# Arguments
2561# userId: UUID of user
2562# userName: User name to uniquely identify a user
2563# organizationGuid: UUID of organization
2564# roleIds: Role Ids.
2565# priority: Priority of the organization. If not provided, max
2566# priority plus one will be used.
2567addUserToOrganization(
2568userId: ID,
2569userName: String,
2570organizationGuid: ID!,
2571roleIds: [ID],
2572priority: Int
2573): User
2574
2575# Remove an existing user for organization.
2576# One of the user identifiers (userId or userName) has to be specified.
2577# The operation fails if the organization is the last one to which user belongs.
2578#
2579# Arguments
2580# userId: UUID of user
2581# userName: User name to uniquely identify a user
2582# organizationGuid: UUID of organization
2583removeUserFromOrganization(
2584userId: ID,
2585userName: String,
2586organizationGuid: ID!
2587): User
2588
2589# #Switch user to organization
2590#
2591# Arguments
2592# token: User token that should be logout
2593# userName: The user login name -- typically, email address.
2594# organizationGuid: GUID of organization.
2595switchUserToOrganization(
2596token: String!,
2597userName: String!,
2598organizationGuid: ID!
2599): LoginInfo
2600
2601# Force a user to update password on next login.
2602# This mutation is used by administrators.
2603# Example:
2604# Request:
2605# mutation {
2606#
2607# createPasswordUpdateRequest(input: {
2608#
2609# id: "267de7e1-efb2-444a-a524-210328b78503",
2610#
2611# skipPasswordResetEmail: true}) {
2612#
2613# id
2614#
2615# name
2616#
2617# }
2618# }
2619# Response:
2620# {
2621#
2622# "data": {
2623#
2624# "createPasswordUpdateRequest": {
2625#
2626# "id": "267de7e1-efb2-444a-a524-210328b78503",
2627#
2628# "name": "example"
2629#
2630# }
2631#
2632# }
2633# }
2634#
2635# Arguments
2636# input: Fields needed to create a password update request
2637createPasswordUpdateRequest(
2638input: CreatePasswordUpdateRequest
2639): User
2640
2641# Create a password reset request. This mutation is used on behalf
2642# of a user who needs to reset their password. It operates only on
2643# the currently authenicated user (based on the authentication token provided).
2644# Example:
2645# Request:
2646# mutation {
2647#
2648# createPasswordResetRequest(input: {
2649#
2650# userName: "example",
2651#
2652# skipPasswordResetEmail:true}) {
2653#
2654# message
2655#
2656# }
2657# }
2658# Response:
2659# {
2660#
2661# "data": {
2662#
2663# "createPasswordResetRequest": {
2664#
2665# "message": "Reset request issued for example. Email will not be sent."
2666#
2667# }
2668#
2669# }
2670# }
2671createPasswordResetRequest(
2672input: CreatePasswordResetRequest
2673): CreatePasswordResetRequestPayload
2674
2675# Update the current authenticated user
2676# Example:
2677# Request:
2678# mutation {
2679#
2680# updateCurrentUser(input: {
2681#
2682# title: "undefined"}) {
2683#
2684# id
2685#
2686# }
2687# }
2688# Response:
2689# {
2690#
2691# "data": {
2692#
2693# "updateCurrentUser": {
2694#
2695# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008"
2696#
2697# }
2698#
2699# }
2700# }
2701updateCurrentUser(input: UpdateCurrentUser!): User!
2702
2703# Get password token info for current user
2704# Example:
2705# Request:
2706# mutation {
2707#
2708# getCurrentUserPasswordToken(input: {
2709#
2710# password: "Example password"}) {
2711#
2712# passwordToken
2713#
2714# }
2715# }
2716# Response:
2717# {
2718#
2719# "data": {
2720#
2721# "getCurrentUserPasswordToken": {
2722#
2723# "passwordToken": "e4cb86c7-34a4-4a52-b458-3ebbb2cca9c3"
2724#
2725# }
2726#
2727# }
2728# }
2729getCurrentUserPasswordToken(
2730input: GetCurrentUserPasswordToken!
2731): PasswordTokenInfo!
2732
2733# Change the current authenticated user's password
2734#
2735# Arguments
2736# input: Fields needed to change password
2737changePassword(input: ChangePassword!): User
2738
2739# Delete a user
2740# Example:
2741# Request:
2742# mutation {
2743#
2744# deleteUser(
2745#
2746# id: "267de7e1-efb2-444a-a524-210328b78503") {
2747#
2748# message
2749#
2750# }
2751# }
2752# Response:
2753# {
2754#
2755# "data": {
2756#
2757# "deleteUser": {
2758#
2759# "message": null
2760#
2761# }
2762#
2763# }
2764# }
2765#
2766# Arguments
2767# id: Supply the ID of the user to delete.
2768deleteUser(id: ID!): DeletePayload
2769
2770# Create a structured data registry schema metadata.
2771# Example:
2772# Request:
2773# mutation {
2774#
2775# createDataRegistry(input: {
2776#
2777# name: "example",
2778#
2779# description: "example"
2780#
2781# source: "example"}) {
2782#
2783# id
2784#
2785# organizationId
2786#
2787# }
2788# }
2789# Response:
2790# {
2791#
2792# "data": {
2793#
2794# "createDataRegistry": {
2795#
2796# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2797#
2798# "organizationId": "35521"
2799#
2800# }
2801#
2802# }
2803# }
2804createDataRegistry(input: CreateDataRegistry!): DataRegistry
2805
2806# Update a structured data registry schema metadata.
2807# Example:
2808# Request:
2809# mutation {
2810#
2811# updateDataRegistry(input: {
2812#
2813# id: "230f95e4-95c9-47c4-a845-61ca67ad6ba6"
2814#
2815# name: "example"
2816#
2817# description: "example"
2818#
2819# source: "new source"}) {
2820#
2821# id
2822#
2823# source
2824#
2825# }
2826# }
2827# Response:
2828# {
2829#
2830# "data": {
2831#
2832# "updateDataRegistry": {
2833#
2834# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2835#
2836# "source": "new source"
2837#
2838# }
2839#
2840# }
2841# }
2842updateDataRegistry(input: UpdateDataRegistry!): DataRegistry
2843
2844# Create a schema record.
2845# Example:
2846# Request:
2847# mutation {
2848#
2849# createSchema(input: {
2850#
2851# id: "450f95e4-95c9-47c4-a845-62ca67ad6ea6",
2852#
2853# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2854#
2855# status: published,
2856#
2857# definition: {
2858#
2859# example: "example"
2860#
2861# },
2862#
2863# majorVersion: 1,
2864#
2865# minorVersion: 2
2866#
2867# }) {
2868#
2869# id
2870#
2871# }
2872# }
2873# Response:
2874# {
2875#
2876# "data": {
2877#
2878# "createSchema": {
2879#
2880# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2881#
2882# }
2883#
2884# }
2885# }
2886createSchema(input: CreateSchema!): Schema
2887
2888# Update a structured data registry schema.
2889# Example:
2890# Request:
2891# mutation {
2892#
2893# upsertSchemaDraft(input: {
2894#
2895# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2896#
2897# schema: {
2898#
2899# example: "example"
2900#
2901# }}) {
2902#
2903# id
2904#
2905# }
2906# }
2907# Response:
2908# {
2909#
2910# "data": {
2911#
2912# "upsertSchemaDraft": {
2913#
2914# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2915#
2916# }
2917#
2918# }
2919# }
2920upsertSchemaDraft(input: UpsertSchemaDraft!): Schema
2921
2922# Update the state of a schema
2923# Example:
2924# Request:
2925# mutation {
2926#
2927# updateSchemaState(input: {
2928#
2929# id: "0bd05e43-ddac-4b1a-9238-f3b177439b91",
2930#
2931# status: deleted}) {
2932#
2933# id
2934#
2935# }
2936# }
2937# Response:
2938# {
2939#
2940# "data": {
2941#
2942# "updateSchemaState": {
2943#
2944# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2945#
2946# }
2947#
2948# }
2949# }
2950updateSchemaState(input: UpdateSchemaState!): Schema
2951
2952# Create (ingest) a structured data object
2953# Example:
2954# Request:
2955# mutation {
2956#
2957# createStructuredData(input: {
2958#
2959# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2960#
2961# data: {
2962#
2963# example: "example"
2964#
2965# }}) {
2966#
2967# id
2968#
2969# }
2970# }
2971# Response:
2972# {
2973#
2974# "data": {
2975#
2976# "createStructuredData": {
2977#
2978# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa"
2979#
2980# }
2981#
2982# }
2983# }
2984createStructuredData(input: CreateStructuredData!): StructuredData
2985
2986# Update an existing structured data object
2987# Example:
2988# Request:
2989# mutation {
2990#
2991# updateStructuredData(input: {
2992#
2993# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
2994#
2995# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2996#
2997# data: {
2998#
2999# name: "Updated Name",
3000#
3001# value: 42
3002#
3003# }
3004#
3005# }) {
3006#
3007# id
3008#
3009# schemaId
3010#
3011# data
3012#
3013# createdDateTime
3014#
3015# modifiedDateTime
3016#
3017# }
3018# }
3019# Response:
3020# {
3021#
3022# "data": {
3023#
3024# "updateStructuredData": {
3025#
3026# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa",
3027#
3028# "schemaId": "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
3029#
3030# "data": {
3031#
3032# "name": "Updated Name",
3033#
3034# "value": 42
3035#
3036# },
3037#
3038# "createdDateTime": "2024-01-15T10:30:00.000Z",
3039#
3040# "modifiedDateTime": "2024-01-15T14:25:00.000Z"
3041#
3042# }
3043#
3044# }
3045# }
3046updateStructuredData(input: UpdateStructuredData!): StructuredData
3047
3048# Delete a structured data object
3049# Example:
3050# Request:
3051# mutation {
3052#
3053# deleteStructuredData(input:{
3054#
3055# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
3056#
3057# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) {
3058#
3059# message
3060#
3061# }
3062# }
3063# Response:
3064# {
3065#
3066# "data": {
3067#
3068# "deleteStructuredData": {
3069#
3070# "message": null
3071#
3072# }
3073#
3074# }
3075# }
3076deleteStructuredData(input: DeleteStructuredData!): DeletePayload
3077
3078# Create (ingest) a structured data object
3079# Example:
3080# Request:
3081# mutation {
3082#
3083# createCollection(input: {
3084#
3085# name: "example",
3086#
3087# folderDescription: "example",
3088#
3089# image:"",
3090#
3091# parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) {
3092#
3093# id
3094#
3095# }
3096# }
3097# Response:
3098# {
3099#
3100# "data": {
3101#
3102# "createCollection": {
3103#
3104# "id": "242361"
3105#
3106# }
3107#
3108# }
3109# }
3110#
3111# Arguments
3112# input: Fields required to create new collection
3113createCollection(input: CreateCollection): Collection
3114
3115# Update a collection
3116# Example:
3117# Request:
3118# mutation {
3119#
3120# updateCollection(input: {
3121#
3122# folderId: "242361"
3123#
3124# name: "new name"
3125#
3126# folderDescription: "new description"}) {
3127#
3128# id
3129#
3130# name
3131#
3132# }
3133# }
3134# Response:
3135# {
3136#
3137# "data": {
3138#
3139# "updateCollection": {
3140#
3141# "id": "242361",
3142#
3143# "name": "new name"
3144#
3145# }
3146#
3147# }
3148# }
3149#
3150# Arguments
3151# input: Fields needed to update a collection
3152updateCollection(input: UpdateCollection): Collection
3153
3154# Delete Collection
3155# Example:
3156# Request:
3157# mutation {
3158#
3159# deleteCollection(
3160#
3161# id: "242361") {
3162#
3163# message
3164#
3165# }
3166# }
3167# Response:
3168# {
3169#
3170# "data": {
3171#
3172# "deleteCollection": {
3173#
3174# "message": "Deleted Successfully"
3175#
3176# }
3177#
3178# }
3179# }
3180#
3181# Arguments
3182# id: Supply the ID of the folder or collection to delete
3183deleteCollection(folderId: ID, id: ID): DeletePayload
3184
3185# Share a collection, allowing other organizations to view the data
3186# it contains.
3187# Example:
3188# Request:
3189# mutation {
3190#
3191# shareCollection(input: {
3192#
3193# folderId: "242599",
3194#
3195# shareMessage: "example",
3196#
3197# recipients: [] }) {
3198#
3199# id
3200#
3201# }
3202# }
3203# Response:
3204# {
3205#
3206# "data": {
3207#
3208# "shareCollection": {
3209#
3210# "id": "FhQrlAwfRMaTy0blR_eHRw"
3211#
3212# }
3213#
3214# }
3215# }
3216#
3217# Arguments
3218# input: Fields needed to share a collection
3219shareCollection(input: ShareCollection): Share
3220
3221# Arguments
3222# shareId: ID of the shared collection to update
3223# mentionIds: List of mentionIds to add or remove
3224# type: Indicates whether or not the mentions are to be added or
3225# deleted
3226updateSharedCollectionMentions(
3227shareId: String!,
3228mentionIds: [ID!],
3229type: SharedCollectionUpdateType!
3230): Share
3231
3232updateSharedCollectionHistory(
3233input: UpdateSharedCollectionHistory
3234): SharedCollectionHistory
3235
3236# Share a mention from a collection
3237#
3238# Arguments
3239# input: Fields needed to share a mention
3240shareMentionFromCollection(
3241input: ShareMentionFromCollection
3242): Share
3243
3244# Share mention
3245shareMention(input: ShareMention): Share
3246
3247# Share mentions in bulk
3248shareMentionInBulk(input: ShareMentionInBulk): [Share]
3249
3250# Add a mention to a collection
3251#
3252# Arguments
3253# input: Fields needed to add a mention to a collection
3254createCollectionMention(input: CollectionMentionInput): CollectionMention
3255
3256# Arguments
3257# input: Fields needed to add mentions to a collection
3258createCollectionMentions(
3259input: CreateCollectionMentions
3260): [CollectionMention!]!
3261
3262# Update a mention in a collection
3263#
3264# Arguments
3265# input: Fields needed to add mentions to a collection
3266updateCollectionMention(
3267input: UpdateCollectionMention!
3268): CollectionMention!
3269
3270# Remove a mention from a collection
3271#
3272# Arguments
3273# input: Fields needed to delete a mention from a collection
3274deleteCollectionMention(input: CollectionMentionInput): CollectionMention
3275
3276# Create a new folder
3277# Example:
3278# Request:
3279# mutation {
3280#
3281# createFolder(input: {
3282#
3283# name: "example",
3284#
3285# description: "example",
3286#
3287# parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3288#
3289# rootFolderType:watchlist}) {
3290#
3291# id
3292#
3293# name
3294#
3295# }
3296# }
3297# Response:
3298# {
3299#
3300# "data": {
3301#
3302# "createFolder": {
3303#
3304# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3305#
3306# "name": "example"
3307#
3308# }
3309#
3310# }
3311# }
3312#
3313# Arguments
3314# input: Fields needed to create a new folder.
3315createFolder(input: CreateFolder): Folder
3316
3317# Create a new PlatformVersion
3318# Example:
3319# Request:
3320# mutation {
3321#
3322# addPlatformVersion(input: {
3323#
3324# version: "1.2.0"
3325#
3326# manifestUrl: "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3327#
3328# changeLogUrl: "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3329#
3330# highlightsUrl: "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3331#
3332# }) {
3333#
3334# id
3335#
3336# version
3337#
3338# manifestUrl
3339#
3340# changeLogUrl
3341#
3342# highlightsUrl
3343#
3344# createdAt,
3345#
3346# createdBy
3347#
3348# }
3349# }
3350# Response:
3351# {
3352#
3353# "data": {
3354#
3355# "addPlatformVersion": {
3356#
3357# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3358#
3359# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3360#
3361# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3362#
3363# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3364#
3365# "createAt": "2023-05-10",
3366#
3367# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3368#
3369# }
3370#
3371# }
3372# }
3373#
3374# Arguments
3375# input: Fields needed to create a new aiWARE platform version.
3376addPlatformVersion(input: PlatformVersionInput): PlatformVersion
3377
3378# Set the current PlatformVersion
3379# Example:
3380# Request:
3381# mutation {
3382#
3383# setCurrentPlatformVersion(input: {
3384#
3385# version: "1.2.0"
3386#
3387# }) {
3388#
3389# id
3390#
3391# version
3392#
3393# manifestUrl
3394#
3395# changeLogUrl
3396#
3397# highlightsUrl
3398#
3399# createdAt,
3400#
3401# createdBy,
3402#
3403# installedAt,
3404#
3405# installedBy
3406#
3407# }
3408# }
3409# Response:
3410# {
3411#
3412# "data": {
3413#
3414# "setCurrentPlatformVersion": {
3415#
3416# "id": "6c6e0f59-5fb5-4179-9f5b-c5f5933d6f9a",
3417#
3418# "version": "1.2.0",
3419#
3420# "manifestUrl": "https://s3.example.com/aiware/versions/1.2.0/manifest.yaml"
3421#
3422# "changeLogUrl": "https://s3.example.com/aiware/versions/1.2.0/changelog.txt"
3423#
3424# "highlightsUrl": "https://s3.example.com/aiware/versions/1.2.0/highlights.txt"
3425#
3426# "createAt": "2023-05-10",
3427#
3428# "createdBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248",
3429#
3430# "installedAt": "2023-05-15",
3431#
3432# "installedBy": "1c2e7692-8206-4118-bd38-bb61aa3fb248"
3433#
3434# }
3435#
3436# }
3437# }
3438#
3439# Arguments
3440# version: The version field is required to set the current
3441# aiWARE platform version
3442setCurrentPlatformVersion(version: String!): PlatformVersion
3443
3444# Set the platform properties.
3445# Example:
3446# Request:
3447# mutation {
3448#
3449# setPlatformProperties(
3450#
3451# properties: {
3452#
3453# Environment: "US West",
3454#
3455# ClusterSize: "small" }
3456#
3457# )
3458# }
3459# Response:
3460# {
3461#
3462# "data": {
3463#
3464# "setPlatformProperties": {
3465#
3466# "properties": {
3467#
3468# "Environment": "US West",
3469#
3470# "ClusterSize": "small"
3471#
3472# }
3473#
3474# }
3475#
3476# }
3477# }
3478#
3479# Arguments
3480# properties: Properties is JSON object that contains the
3481# properties of the platform that need to be added/ updated.
3482# So all the other properties in the JSON will be kept
3483setPlatformProperties(properties: JSONData!): JSONData
3484
3485# Update an existing folder
3486# Example:
3487# Request:
3488# mutation {
3489#
3490# updateFolder(input: {
3491#
3492# id: "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3493#
3494# name: "new name"}) {
3495#
3496# name
3497#
3498# }
3499# }
3500# Response:
3501# {
3502#
3503# "data": {
3504#
3505# "updateFolder": {
3506#
3507# "name": "new name"
3508#
3509# }
3510#
3511# }
3512# }
3513#
3514# Arguments
3515# input: Fields needed to update a folder.
3516updateFolder(input: UpdateFolder): Folder
3517
3518# Move a folder from one parent folder to another.
3519# Example:
3520# Request:
3521# mutation {
3522#
3523# moveFolder(input: {
3524#
3525# folderId: "68a5833a-f573-41fe-840a-adb5f6888e2d",
3526#
3527# fromFolderId: "3104f61f-4bd1-4175-9fe6-27436d591c54",
3528#
3529# toFolderId: "ad7839a7-d088-4202-9db1-5ed4992f915d"
3530#
3531# }) {
3532#
3533# parentFolderId
3534#
3535# }
3536# }
3537# Response:
3538# {
3539#
3540# "data": {
3541#
3542# "moveFolder": {
3543#
3544# "parentFolderId": "ad7839a7-d088-4202-9db1-5ed4992f915d",
3545#
3546# }
3547#
3548# }
3549# }
3550#
3551# Arguments
3552# input: Fields needed to move a folder
3553moveFolder(input: MoveFolder): Folder
3554
3555# Move bulk folders to another.
3556# Example:
3557# Request:
3558# mutation {
3559#
3560# moveFolders(input: {
3561#
3562# folderIds: ["0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3563# "183f64e7-d519-4948-99d9-977657cce0c8"]
3564#
3565# newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8"
3566#
3567# rootFolderType: cms
3568#
3569# }) {
3570#
3571# id
3572#
3573# name
3574#
3575# }
3576# }
3577# Response:
3578# {
3579#
3580# "data": {
3581#
3582# "moveFolders": {
3583#
3584# "organizationId": "7682",
3585#
3586# "newParentFolderId: "22d2c53a-d33e-47d8-a77e-f64f5c3db7c8",
3587#
3588# "validFolderIds": [
3589#
3590# "0c4c2765-1817-40a7-bd6d-bf6362a384ba",
3591#
3592# "183f64e7-d519-4948-99d9-977657cce0c8"
3593#
3594# ]
3595#
3596# "invalidFolderIds": [],
3597#
3598# "message": "Successfully move all input folders to the parent folder."
3599#
3600# }
3601#
3602# }
3603# }
3604#
3605# Arguments
3606# input: Fields needed to move a folder
3607moveFolders(input: MoveFolders): MoveFoldersPayload
3608
3609# Delete a folder
3610# Example:
3611# Request:
3612# mutation {
3613#
3614# deleteFolder(input: {
3615#
3616# id:"d551fbd6-7354-4b0e-abfb-654ab8583be2",
3617#
3618# orderIndex: 1}) {
3619#
3620# message
3621#
3622# }
3623# }
3624# Response:
3625# {
3626#
3627# "data": {
3628#
3629# "deleteFolder": {
3630#
3631# "message": null
3632#
3633# }
3634#
3635# }
3636# }
3637#
3638# Arguments
3639# input: Fields needed to delete a folder
3640deleteFolder(input: DeleteFolder): DeletePayload
3641
3642# Create a mention comment
3643#
3644# Arguments
3645# input: Fields needed to create a mention comment
3646createMentionComment(input: CreateMentionComment): MentionComment
3647
3648# Update a mention comment
3649#
3650# Arguments
3651# input: Fields needed to update a mention comment
3652updateMentionComment(input: UpdateMentionComment): MentionComment
3653
3654# Delete a mention comment
3655#
3656# Arguments
3657# input: Fields needed to delete a mention comment
3658deleteMentionComment(input: DeleteMentionComment): DeletePayload
3659
3660# Create a mention rating
3661#
3662# Arguments
3663# input: Fields needed to create a mention rating
3664createMentionRating(input: CreateMentionRating): MentionRating
3665
3666# Update a mention rating
3667#
3668# Arguments
3669# input: Fields needed to update a mention rating
3670updateMentionRating(input: UpdateMentionRating): MentionRating
3671
3672# Delete a mention rating
3673#
3674# Arguments
3675# input: Fields needed to delete a mention rating.
3676deleteMentionRating(input: DeleteMentionRating): DeletePayload
3677
3678# Login as a user. This mutation does not require an existing authentication
3679# context (via `Authorization` header with bearer token, cookie, etc.).
3680# Instead, the client supplies credentials to this mutation, which then
3681# authenticates the user and sets up the authentication context.
3682# The returned tokens can be used to authenticate future requests.
3683# Example:
3684# Request:
3685# mutation {
3686#
3687# userLogin(input: {
3688#
3689# userName: "example1",
3690#
3691# password: "example1"}) {
3692#
3693# apiToken
3694#
3695# lastLoggedIn
3696#
3697# }
3698# }
3699# Response:
3700# {
3701#
3702# "data": {
3703#
3704# "userLogin": {
3705#
3706# "apiToken": null,
3707#
3708# "lastLoggedIn": "2021-06-15T02:04:52.000Z",
3709#
3710# "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a"
3711#
3712# }
3713#
3714# }
3715# }
3716#
3717# Arguments
3718# input: Fields needed to log in
3719userLogin(input: UserLogin): LoginInfo
3720
3721# Logout user and invalidate user token
3722# Example:
3723# Request:
3724# mutation {
3725#
3726# userLogout(
3727#
3728# token: "a5610058-260d-46ac-aa3e-ee529c4feaab")
3729# }
3730# Response:
3731# {
3732#
3733# "data": {
3734#
3735# "userLogout": null
3736#
3737# }
3738# }
3739#
3740# Arguments
3741# token: User token that should be invalidated
3742# sessionExpired: Internal system flag
3743userLogout(token: String!, sessionExpired: Boolean): Boolean
3744
3745# Refreshes the session user from database to reflect the latest changes. It does
3746# not extend session timeout.\
3747# Example:
3748# Request:
3749# mutation {
3750#
3751# refreshToken(
3752#
3753# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3754#
3755# hasPassword
3756#
3757# user{id}
3758#
3759# }
3760# }
3761# Response:
3762# {
3763#
3764# "data": {
3765#
3766# "refreshToken": {
3767#
3768# "hasPassword": true,
3769#
3770# "user": {
3771#
3772# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3773#
3774# }
3775#
3776# }
3777#
3778# }
3779# }
3780refreshToken(token: String!): LoginInfo
3781
3782# Refresh a user token, returning a fresh token so that the client
3783# can continue to authenticate to the API.\
3784# Example:
3785# Request:
3786# mutation {
3787#
3788# extendToken(
3789#
3790# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3791#
3792# hasPassword
3793#
3794# user{id}
3795#
3796# }
3797# }
3798# Response:
3799# {
3800#
3801# "data": {
3802#
3803# "extendToken": {
3804#
3805# "hasPassword": true,
3806#
3807# "user": {
3808#
3809# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3810#
3811# }
3812#
3813# }
3814#
3815# }
3816# }
3817extendToken(token: String!): LoginInfo
3818
3819# Validate a user token. This mutation is used by services to determine
3820# if the token provided by a given client is valid.
3821# Example:
3822# Request:
3823# mutation {
3824#
3825# validateToken(
3826#
3827# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3828#
3829# hasPassword
3830#
3831# user{id}
3832#
3833# }
3834# }
3835# Response:
3836# {
3837#
3838# "data": {
3839#
3840# "validateToken": {
3841#
3842# "hasPassword": true,
3843#
3844# "user": {
3845#
3846# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3847#
3848# }
3849#
3850# }
3851#
3852# }
3853# }
3854validateToken(token: String!): LoginInfo
3855
3856# Create a mention object
3857createMention(input: CreateMention!): Mention
3858
3859# Update a mention object
3860updateMention(input: UpdateMention!): Mention
3861
3862# Update a set of mentions
3863updateMentions(input: UpdateMentions!): [Mention]
3864
3865# Create root folder for an organization
3866# Example:
3867# Request:
3868# mutation {
3869#
3870# createRootFolders {
3871#
3872# id
3873#
3874# rootFolderTypeId
3875#
3876# }
3877# }
3878# Response:
3879# {
3880#
3881# "data": {
3882#
3883# "createRootFolders": [
3884#
3885# {
3886#
3887# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3888#
3889# "rootFolderTypeId": 1
3890#
3891# },
3892#
3893# {
3894#
3895# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3896#
3897# "rootFolderTypeId": 1
3898#
3899# }
3900#
3901# ]
3902#
3903# }
3904# }
3905#
3906# Arguments
3907# rootFolderType: The type of root folder to create
3908createRootFolders(rootFolderType: RootFolderType): [Folder]
3909
3910# Apply bulk updates to watchlists.
3911# This mutation is currently available only to Veritone operations.
3912#
3913# Arguments
3914# filter: A filter indicating which watchlists should be updated.
3915# At least one filter condition must be provided.
3916# Only watchlists for the user's organization will be updated.
3917# input: Fields used to update a watchlist.
3918bulkUpdateWatchlist(
3919filter: BulkUpdateWatchlistFilter!,
3920input: BulkUpdateWatchlist
3921): WatchlistList
3922
3923# File a TemporalDataObject in a folder. A given TemporalDataObject can
3924# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3925# and its assets to be visible within the folder.
3926# Example:
3927# Request:
3928# mutation {
3929#
3930# fileTemporalDataObject(input:{
3931#
3932# tdoId: "1580388995",
3933#
3934# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3935#
3936# id
3937#
3938# folders{
3939#
3940# id
3941#
3942# }
3943#
3944# }
3945# }
3946# Response:
3947# {
3948#
3949# "data": {
3950#
3951# "fileTemporalDataObject": {
3952#
3953# "id": "1580388995",
3954#
3955# "folders": [
3956#
3957# {
3958#
3959# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3960#
3961# }
3962#
3963# ]
3964#
3965# }
3966#
3967# }
3968# }
3969#
3970# Arguments
3971# input: The fields needed to file a TemporalDataObject in a
3972# folder
3973fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3974
3975# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3976# and its assets to disappear from the folder, but does not otherwise affect
3977# either the TDO or the folder and does not change access controls.
3978# Example:
3979# Request:
3980# mutation {
3981#
3982# unfileTemporalDataObject(input: {
3983#
3984# tdoId: "1580388995",
3985#
3986# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3987#
3988# id
3989#
3990# description
3991#
3992# }
3993# }
3994# Response:
3995# {
3996#
3997# "data": {
3998#
3999# "unfileTemporalDataObject": {
4000#
4001# "id": "1580388995",
4002#
4003# "description": null
4004#
4005# }
4006#
4007# }
4008# }
4009#
4010# Arguments
4011# input: The fields needed to file a TemporalDataObject in a
4012# folder
4013unfileTemporalDataObject(
4014input: UnfileTemporalDataObject!
4015): TemporalDataObject
4016
4017# Moves a TemporalDataObject from one parent folder to another.
4018# Any other folders the TemporalDataObject is filed in are unaffected.
4019# Example:
4020# Request:
4021# mutation {
4022#
4023# moveTemporalDataObject(input: {
4024#
4025# tdoId: "1580388995",
4026#
4027# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
4028#
4029# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
4030#
4031# id
4032#
4033# folders{
4034#
4035# folderPath{id}
4036#
4037# }
4038#
4039# }
4040# }
4041# Response:
4042# {
4043#
4044# "data": {
4045#
4046# "moveTemporalDataObject": {
4047#
4048# "id": "1580388995",
4049#
4050# "folders": [
4051#
4052# {
4053#
4054# "folderPath": [
4055#
4056# {
4057#
4058# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
4059#
4060# }
4061#
4062# ]
4063#
4064# }
4065#
4066# ]
4067#
4068# }
4069#
4070# }
4071# }
4072#
4073# Arguments
4074# input: Fields need to move a TemporalDataObject
4075moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
4076
4077# Upload and store an engine result. The result will be stored as an
4078# asset associated with the target TemporalDataObject and the
4079# task will be updated accordingly.
4080# Use a multipart form POST to all this mutation.
4081#
4082# Arguments
4083# input: Fields needed to upload and store an engine result
4084uploadEngineResult(input: UploadEngineResult!): Asset
4085
4086# Create a watchlist
4087# Example:
4088# Request:
4089# mutation {
4090#
4091# createWatchlist(input: {
4092#
4093# stopDateTime: 1623851655,
4094#
4095# name: "example",
4096#
4097# searchIndex: mine,
4098#
4099# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
4100#
4101# cognitiveSearches: [],
4102#
4103# subscriptions: [],
4104#
4105# details: {
4106#
4107# example: "example"}}) {
4108#
4109# id
4110#
4111# }
4112# }
4113# Response:
4114# {
4115#
4116# "data": {
4117#
4118# "createWatchlist": {
4119#
4120# "id": "325783"
4121#
4122# }
4123#
4124# }
4125# }
4126createWatchlist(input: CreateWatchlist!): Watchlist
4127
4128bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
4129
4130# Update a watchlist
4131# Example:
4132# Request:
4133# mutation {
4134#
4135# updateWatchlist(input: {
4136#
4137# id: "325783"
4138#
4139# name: "new name"
4140#
4141# details: {
4142#
4143# example: "new details"}}) {
4144#
4145# id
4146#
4147# name
4148#
4149# }
4150# }
4151# Response:
4152#
4153# {
4154#
4155# "data": {
4156#
4157# "updateWatchlist": {
4158#
4159# "id": "325783",
4160#
4161# "name": "new name"
4162#
4163# }
4164#
4165# }
4166# }
4167updateWatchlist(input: UpdateWatchlist!): Watchlist
4168
4169# Delete a watchlist
4170# Example:
4171# Request:
4172# mutation {
4173#
4174# deleteWatchlist(
4175#
4176# id:"325783") {
4177#
4178# message
4179#
4180# }
4181# }
4182# Response:
4183# {
4184#
4185# "data": {
4186#
4187# "deleteWatchlist": {
4188#
4189# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
4190# profiles, 0 mention comments, and 0 mention ratings."
4191#
4192# }
4193#
4194# }
4195# }
4196deleteWatchlist(id: ID!): DeletePayload
4197
4198updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
4199
4200createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
4201
4202deleteCognitiveSearch(id: ID!): DeletePayload
4203
4204fileWatchlist(input: FileWatchlist!): Watchlist
4205
4206# Unfile a watchlist from a folder
4207# Example:
4208# Request:
4209# mutation {
4210#
4211# unfileWatchlist(input: {
4212#
4213# watchlistId:"325786",
4214#
4215# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
4216#
4217# id
4218#
4219# folders{
4220#
4221# folderPath{
4222#
4223# id
4224#
4225# }
4226#
4227# }
4228#
4229# }
4230# }
4231# Response:
4232# {
4233#
4234# "data": {
4235#
4236# "unfileWatchlist": {
4237#
4238# "id": "325786",
4239#
4240# "folders": []
4241#
4242# }
4243#
4244# }
4245# }
4246unfileWatchlist(input: UnfileWatchlist!): Watchlist
4247
4248# Share a folder with other organizations
4249# Requires superadmin
4250shareFolder(input: ShareFolderInput): Folder
4251
4252# Create a TDO and an asset with a single call
4253# Example:
4254# Request:
4255# mutation {
4256#
4257# createTDOWithAsset(input: {
4258#
4259# startDateTime: 1623841655,
4260#
4261# stopDateTime: 1623851655,
4262#
4263# contentType: "video/mp4",
4264#
4265# assetType: "media",
4266#
4267# addToIndex: false,
4268#
4269# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
4270#
4271# id
4272#
4273# status
4274#
4275# assets {
4276#
4277# records {
4278#
4279# id
4280#
4281# assetType
4282#
4283# contentType
4284#
4285# signedUri
4286#
4287# }
4288#
4289# }
4290#
4291# }
4292# }
4293# Response:
4294# {
4295#
4296# "data": {
4297#
4298# "createTDOWithAsset": {
4299#
4300# "id": "1580507556",
4301#
4302# "status": "recorded",
4303#
4304# "assets": {
4305#
4306# "records": [
4307#
4308# {
4309#
4310# "id": "1580507556_DQ2nU8cTDh",
4311#
4312# "assetType": "media",
4313#
4314# "contentType": "video/mp4",
4315#
4316# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
4317#
4318# }
4319#
4320# ]
4321#
4322# }
4323#
4324# }
4325#
4326# }
4327# }
4328#
4329# Arguments
4330# input: Input fields necessary to create the TDO and asset
4331createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
4332
4333# Create a subscription
4334# Example:
4335# Request:
4336# mutation {
4337#
4338# createSubscription(input: {
4339#
4340# targetId: "325791",
4341#
4342# contact: {
4343#
4344# emailAddress: "example email"},
4345#
4346# scheduledDay: Friday}) {
4347#
4348# id
4349#
4350# }
4351# }
4352# Response:
4353# {
4354#
4355# "data": {
4356#
4357# "createSubscription": {
4358#
4359# "id": "274939"
4360#
4361# }
4362#
4363# }
4364# }
4365createSubscription(input: CreateSubscription!): Subscription
4366
4367# Update a subscription
4368# Example:
4369# Request:
4370# mutation {
4371#
4372# updateSubscription(input: {
4373#
4374# id: "274939"}) {
4375#
4376# id
4377#
4378# }
4379# }
4380# Response:
4381# mutation {
4382#
4383# updateSubscription(input: {
4384#
4385# id: "274939"}) {
4386#
4387# id
4388#
4389# }
4390# }
4391updateSubscription(input: UpdateSubscription!): Subscription
4392
4393# Delete a subscription
4394# Example:
4395# Request:
4396# mutation {
4397#
4398# deleteSubscription(
4399#
4400# id: "274939") {
4401#
4402# message
4403#
4404# }
4405# }
4406# Response:
4407# mutation {
4408#
4409# deleteSubscription(
4410#
4411# id: "274939") {
4412#
4413# message
4414#
4415# }
4416# }
4417deleteSubscription(id: ID!): DeletePayload
4418
4419# Create trigger for events or types.
4420# Example:
4421# Request:
4422# mutation {
4423#
4424# createTriggers(input: {
4425#
4426# events: "*",
4427#
4428# targets: {
4429#
4430# name: Email,
4431#
4432# params: {
4433#
4434# address: "example@veritone.com"}}}) {
4435#
4436# id
4437#
4438# }
4439# }
4440# Response:
4441# {
4442#
4443# "data": {
4444#
4445# "createTriggers": [
4446#
4447# {
4448#
4449# "id": "2936"
4450#
4451# }
4452#
4453# ]
4454#
4455# }
4456# }
4457createTriggers(input: CreateTriggers!): [Trigger]
4458
4459# Delete a registed trigger by ID.
4460# Example:
4461# Request:
4462# mutation {
4463#
4464# deleteTrigger(
4465#
4466# id: "2936") {
4467#
4468# message
4469#
4470# }
4471# }
4472# Response:
4473# {
4474#
4475# "data": {
4476#
4477# "deleteTrigger": {
4478#
4479# "message": "Trigger 2936 has been removed from organization 35521"
4480#
4481# }
4482#
4483# }
4484# }
4485deleteTrigger(id: ID!): DeletePayload
4486
4487# Validates if an engine output conforms to the engine output guidelines
4488# Example:
4489# Request:
4490# mutation {
4491#
4492# validateEngineOutput(input:
4493#
4494# {
4495#
4496# schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json",
4497#
4498# validationContracts: [
4499#
4500# "structured-data"
4501#
4502# ],
4503#
4504# series: [
4505#
4506# {
4507#
4508# startTimeMs: 0,
4509#
4510# stopTimeMs: 10000,
4511#
4512# structuredData: {
4513#
4514# exampleschemaid: {
4515#
4516# key: "value",
4517#
4518# any: "data you'd like",
4519#
4520# as_long: "as it conforms to the schema"
4521#
4522# }
4523#
4524# }
4525#
4526# }
4527#
4528# ]
4529#
4530# }
4531#
4532# )
4533# }
4534# Response:
4535# {
4536#
4537# "data": {
4538#
4539# "validateEngineOutput": true
4540#
4541# }
4542# }
4543validateEngineOutput(input: JSONData!): Boolean!
4544
4545# JWT tokens with a more limited scoped token to specific
4546# resources to the recording, task, and job
4547# and also has no organization association.
4548# Note: Restricted administrative permissions (e.g. superadmin) are explicitly
4549# filtered and cannot be requested.
4550# Example:
4551# Request:
4552# mutation {
4553#
4554# getEngineJWT(input: {
4555#
4556# engineId: "1",
4557#
4558# resource:{
4559#
4560# tdoId: "1580701928"
4561#
4562# }}) {
4563#
4564# token
4565#
4566# }
4567# }
4568#
4569# Response:
4570# {
4571#
4572# "data": {
4573#
4574# "getEngineJWT": {
4575#
4576# "token": "eyJh...Tw_z3BKRA"
4577#
4578# }
4579#
4580# }
4581# }
4582getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
4583
4584# Retrieve a JWT token scoped to a source. This token
4585# will provide enough rights to read/write ingest slugs
4586# that are owned by the source.
4587# Note: Restricted administrative permissions (e.g. superadmin) are explicitly
4588# filtered and cannot be included.
4589# Example:
4590# Request:
4591# mutation {
4592#
4593# getSourceJWT(sourceId: "123") {
4594#
4595# token
4596#
4597# }
4598# }
4599#
4600# Response:
4601# {
4602#
4603# "data": {
4604#
4605# "getSourceJWT": {
4606#
4607# "token": "eyJh...Tw_z3BKRA"
4608#
4609# }
4610#
4611# }
4612# }
4613getSourceJWT(sourceId: ID!, access: JWTAccess): SourceJWTTokenInfo!
4614
4615# Verify JWT token
4616# Example:
4617# Request:
4618# mutation {
4619#
4620# verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW
4621#
4622# 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY
4623#
4624# wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ
4625#
4626# XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb
4627#
4628# eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw
4629#
4630# icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD
4631#
4632# A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia
4633#
4634# m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz
4635#
4636# NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI
4637#
4638# 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA")
4639# {
4640#
4641# payload
4642#
4643# }
4644# }
4645# Response:
4646# {
4647#
4648# "data": {
4649#
4650# "verifyJWT": {
4651#
4652# "payload": {
4653#
4654# "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09",
4655#
4656# "contentOrganizationId": 35521,
4657#
4658# "engineId": "1",
4659#
4660# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4661#
4662# "scope": [
4663#
4664# {
4665#
4666# "actions": [
4667#
4668# "asset:uri",
4669#
4670# "asset:all",
4671#
4672# "recording:read",
4673#
4674# "recording:update"
4675#
4676# ],
4677#
4678# "resources": {
4679#
4680# "recordingIds": [
4681#
4682# "1580701928"
4683#
4684# ]
4685#
4686# }
4687#
4688# },
4689#
4690# {
4691#
4692# "actions": [
4693#
4694# "task:update"
4695#
4696# ],
4697#
4698# "resources": {
4699#
4700# "jobIds": [],
4701#
4702# "taskIds": [],
4703#
4704# "sourceIds": []
4705#
4706# }
4707#
4708# }
4709#
4710# ],
4711#
4712# "iat": 1624036122,
4713#
4714# "exp": 1624640922,
4715#
4716# "sub": "engine-run",
4717#
4718# "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133"
4719#
4720# }
4721#
4722# }
4723#
4724# }
4725# }
4726verifyJWT(jwtToken: String!): VerifyJWTPayload
4727
4728# Create a new Saved Search
4729# Example:
4730# Request:
4731# mutation {
4732#
4733# createSavedSearch(input: {
4734#
4735# name: "example",
4736#
4737# csp: {
4738#
4739# example: "example"}}) {
4740#
4741# id
4742#
4743# }
4744# }
4745# Response:
4746# {
4747#
4748# "data": {
4749#
4750# "createSavedSearch": {
4751#
4752# "id": "a29f2255-e509-4454-89ec-e425390ca4ca"
4753#
4754# }
4755#
4756# }
4757# }
4758createSavedSearch(input: CreateSavedSearch!): SavedSearch!
4759
4760# Delete a saved search
4761# Example:
4762# Request:
4763# mutation {
4764#
4765# deleteSavedSearch(
4766#
4767# id:"a29f2255-e509-4454-89ec-e425390ca4ca") {
4768#
4769# message
4770#
4771# }
4772# }
4773# Response:
4774# {
4775#
4776# "data": {
4777#
4778# "deleteSavedSearch": {
4779#
4780# "message": null
4781#
4782# }
4783#
4784# }
4785# }
4786deleteSavedSearch(id: ID!): DeletePayload!
4787
4788# Mark existing saved search profile as deleted
4789# Create new saved search profile
4790# Example:
4791# Request:
4792# mutation {
4793#
4794# replaceSavedSearch(input: {
4795#
4796# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4797#
4798# name: "example",
4799#
4800# csp: {
4801#
4802# example: "new csp"}}) {
4803#
4804# id
4805#
4806# }
4807# }
4808# Response:
4809# mutation {
4810#
4811# replaceSavedSearch(input: {
4812#
4813# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4814#
4815# name: "example",
4816#
4817# csp: {
4818#
4819# example: "new csp"}}) {
4820#
4821# id
4822#
4823# }
4824# }
4825replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
4826
4827# Send a basic email. Mutation returns true for a success message.
4828# The email from field will be automatically set the default platform email
4829# address
4830# Example:
4831# Request:
4832# mutation {
4833#
4834# sendEmail(input: {
4835#
4836# to: "example@veritone.com"
4837#
4838# subject: "example"
4839#
4840# message: "email body"
4841#
4842# replyTo: "example@veritone.com"
4843#
4844# })
4845# }
4846# Response:
4847# {
4848#
4849# "data": {
4850#
4851# "sendEmail": true
4852#
4853# }
4854# }
4855sendEmail(input: SendEmail!): Boolean!
4856
4857# Create new content template into a folder
4858createFolderContentTemplate(
4859input: CreateFolderContentTemplate!
4860): FolderContentTemplate!
4861
4862# Update existing content template by folderContentTemplateId
4863updateFolderContentTemplate(
4864input: UpdateFolderContentTemplate!
4865): FolderContentTemplate!
4866
4867# Delete existing folder content template by folderContentTemplateId
4868#
4869# Arguments
4870# id: Folder Content Template Id
4871deleteFolderContentTemplate(id: ID!): DeletePayload!
4872
4873createFolderContentTempate(
4874input: CreateFolderContentTempate!
4875): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4876
4877updateFolderContentTempate(
4878input: UpdateFolderContentTempate!
4879): FolderContentTemplate! @deprecated( reason: "Misspelling" )
4880
4881# Arguments
4882# id: Folder Content Template Id
4883deleteFolderContentTempate(
4884id: ID!
4885): DeletePayload! @deprecated( reason: "Misspelling" )
4886
4887# Create an export request. The requested TDO data, possibly including
4888# TDO media and engine results, will be exported offline.
4889# Example:
4890# Request:
4891# mutation {
4892#
4893# createExportRequest(input: {
4894#
4895# tdoData: {
4896#
4897# tdoId: "1580388995",
4898#
4899# }}) {
4900#
4901# id
4902#
4903# }
4904# }
4905# Response:
4906# {
4907#
4908# "data": {
4909#
4910# "createExportRequest": {
4911#
4912# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad"
4913#
4914# }
4915#
4916# }
4917# }
4918#
4919# Arguments
4920# input: Input data required to create the export request
4921createExportRequest(input: CreateExportRequest!): ExportRequest!
4922
4923# Update an export request
4924# Example:
4925# Request:
4926# mutation {
4927#
4928# updateExportRequest(input: {
4929#
4930# id: "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4931#
4932# status: complete}) {
4933#
4934# id
4935#
4936# status
4937#
4938# }
4939# }
4940# Response:
4941# {
4942#
4943# "data": {
4944#
4945# "updateExportRequest": {
4946#
4947# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4948#
4949# "status": "complete"
4950#
4951# }
4952#
4953# }
4954# }
4955#
4956# Arguments
4957# input: Input data required to update an export request
4958updateExportRequest(input: UpdateExportRequest!): ExportRequest!
4959
4960# Create Mention in bulk. The input should be an array of createMentions
4961createMentions(input: CreateMentions!): MentionList
4962
4963# Create Media Share. Returning the url of the share
4964createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
4965
4966# Create a new event
4967#
4968# Example:
4969#
4970# Request:
4971#
4972# mutation {
4973#
4974# createEvent(input: {
4975#
4976# eventName: "example",
4977#
4978# eventType: "example",
4979#
4980# application: ""
4981#
4982# description: "example"}) {
4983#
4984# id
4985#
4986# }
4987# }
4988# Response:
4989# {
4990#
4991# "data": {
4992#
4993# "createEvent": {
4994#
4995# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d"
4996#
4997# }
4998#
4999# }
5000# }
5001createEvent(input: CreateEvent!): Event!
5002
5003# Update an event
5004# Example:
5005# Request:
5006# mutation {
5007#
5008# updateEvent(input: {
5009#
5010# id: "55fc7c51-1521-4043-902f-f0f3a357da6d",
5011#
5012# description: "new example description"}) {
5013#
5014# id
5015#
5016# description
5017#
5018# }
5019# }
5020# Response:
5021# {
5022#
5023# "data": {
5024#
5025# "updateEvent": {
5026#
5027# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d",
5028#
5029# "description": "new example description"
5030#
5031# }
5032#
5033# }
5034# }
5035updateEvent(input: UpdateEvent!): Event!
5036
5037# Subscribe to an event
5038# Example:
5039# Request:
5040# mutation {
5041#
5042# subscribeEvent(input: {
5043#
5044# eventName: "example",
5045#
5046# eventType: "example",
5047#
5048# application: "",
5049#
5050# delivery: {
5051#
5052# name: CreateJob,
5053#
5054# params: {
5055#
5056# targetId: "1580701928"
5057#
5058# engineId: "1"
5059#
5060# }
5061#
5062# }
5063#
5064# })
5065# }
5066# Response:
5067# {
5068#
5069# "data": {
5070#
5071# "subscribeEvent": "a0d04eeb-c32d-4852-9273-bb0acda970b9"
5072#
5073# }
5074# }
5075subscribeEvent(input: SubscribeEvent!): ID!
5076
5077# Unsubscribe to an event
5078# Example:
5079# Request:
5080# mutation {
5081#
5082# unsubscribeEvent(
5083#
5084# id: "a0d04eeb-c32d-4852-9273-bb0acda970b9") {
5085#
5086# id
5087#
5088# message
5089#
5090# }
5091# }
5092# Response:
5093# {
5094#
5095# "data": {
5096#
5097# "unsubscribeEvent": {
5098#
5099# "id": "a0d04eeb-c32d-4852-9273-bb0acda970b9",
5100#
5101# "message": "Unsubscribed from event"
5102#
5103# }
5104#
5105# }
5106# }
5107unsubscribeEvent(id: ID!): UnsubscribeEvent!
5108
5109# Emit an event
5110# Example:
5111# Request:
5112# mutation {
5113#
5114# emitEvent(input: {
5115#
5116# eventName: "example",
5117#
5118# eventType: "example",
5119#
5120# application: "",
5121#
5122# payload: ""}) {
5123#
5124# id
5125#
5126# }
5127# }
5128# Response:
5129# {
5130#
5131# "data": {
5132#
5133# "emitEvent": {
5134#
5135# "id": "0952fe68-5652-4804-857d-26e21ef3d7e8"
5136#
5137# }
5138#
5139# }
5140# }
5141emitEvent(input: EmitEvent!): EmitEventResponse!
5142
5143# Create a new event trigger template
5144# Example:
5145# Request:
5146# mutation {
5147#
5148# createEventActionTemplate(input: {
5149#
5150# name: "example"
5151#
5152# inputType: event
5153#
5154# inputValidation: {
5155#
5156# example: "example"
5157#
5158# }
5159#
5160# inputAttributes: {
5161#
5162# example: "example"
5163#
5164# }
5165#
5166# actionType: job
5167#
5168# actionValidation: {
5169#
5170# example: "example"
5171#
5172# }
5173#
5174# actionDestination: "1"
5175#
5176# actionAttributes: {
5177#
5178# example: "example"
5179#
5180# }}) {
5181#
5182# id
5183#
5184# }
5185# }
5186# Response:
5187# {
5188#
5189# "data": {
5190#
5191# "createEventActionTemplate": {
5192#
5193# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92"
5194#
5195# }
5196#
5197# }
5198# }
5199createEventActionTemplate(
5200input: CreateEventActionTemplate!
5201): EventActionTemplate!
5202
5203# Update an event trigger template
5204# Example:
5205# Request:
5206# mutation {
5207#
5208# updateEventActionTemplate(input: {
5209#
5210# id: "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5211#
5212# name: "example",
5213#
5214# actionValidation: {
5215#
5216# example: "new validation"}}) {
5217#
5218# id
5219#
5220# actionValidation
5221#
5222# }
5223# }
5224# Response:
5225# {
5226#
5227# "data": {
5228#
5229# "updateEventActionTemplate": {
5230#
5231# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
5232#
5233# "actionValidation": {
5234#
5235# "example": "new validation"
5236#
5237# }
5238#
5239# }
5240#
5241# }
5242# }
5243updateEventActionTemplate(
5244input: UpdateEventActionTemplate!
5245): EventActionTemplate!
5246
5247# Create a new event custom rule
5248# Example:
5249# Request:
5250# mutation {
5251#
5252# createEventCustomRule(input: {
5253#
5254# name: "example"
5255#
5256# eventType: "example"
5257#
5258# eventName: "example"
5259#
5260# description: "example description"
5261#
5262# actions:[]
5263#
5264# params: {
5265#
5266# example: "example"
5267#
5268# }}) {
5269#
5270# id
5271#
5272# }
5273# }
5274# Response:
5275# {
5276#
5277# "data": {
5278#
5279# "createEventCustomRule": {
5280#
5281# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b"
5282#
5283# }
5284#
5285# }
5286# }
5287createEventCustomRule(input: CreateEventCustomRule!): EventCustomRule!
5288
5289# Update an event custom rule
5290# Example:
5291# Request:
5292#
5293# mutation {
5294#
5295# updateEventCustomRule(input: {
5296#
5297# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5298#
5299# name: "example",
5300#
5301# status: inactive,
5302#
5303# description: "new description"}) {
5304#
5305# id
5306#
5307# description
5308#
5309# }
5310# }
5311# Response:
5312# {
5313#
5314# "data": {
5315#
5316# "updateEventCustomRule": {
5317#
5318# "id": "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b",
5319#
5320# "description": "new description"
5321#
5322# }
5323#
5324# }
5325# }
5326updateEventCustomRule(input: UpdateEventCustomRule!): EventCustomRule!
5327
5328# Delete an event custom rule
5329# Example:
5330# Request:
5331# mutation {
5332#
5333# deleteEventCustomRule(
5334#
5335# id: "0a0d3ec8-b4fb-48fc-bd39-c47a22b2173b") {
5336#
5337# message
5338#
5339# }
5340# }
5341# Response:
5342# {
5343#
5344# "data": {
5345#
5346# "deleteEventCustomRule": {
5347#
5348# "message": "Deleted event custom rule"
5349#
5350# }
5351#
5352# }
5353# }
5354deleteEventCustomRule(id: ID!): DeletePayload!
5355
5356# Create a processTemplate in CMS
5357# Example:
5358# Request:
5359# mutation {
5360#
5361# createProcessTemplate(input: {
5362#
5363# name: "example",
5364#
5365# taskList: {
5366#
5367# example: "task"
5368#
5369# }}) {
5370#
5371# id
5372#
5373# }
5374# }
5375# Response:
5376# {
5377#
5378# "data": {
5379#
5380# "createProcessTemplate": {
5381#
5382# "id": "746"
5383#
5384# }
5385#
5386# }
5387# }
5388createProcessTemplate(input: CreateProcessTemplate!): ProcessTemplate!
5389
5390# Update a processTemplate by ID in CMS
5391# Example:
5392# Request:
5393# mutation {
5394#
5395# updateProcessTemplate(input: {
5396#
5397# id: "746",
5398#
5399# taskList: {
5400#
5401# example: "task",
5402#
5403# new: "new task"
5404#
5405# }}) {
5406#
5407# id
5408#
5409# }
5410# }
5411# Response:
5412# {
5413#
5414# "data": {
5415#
5416# "updateProcessTemplate": {
5417#
5418# "id": "746"
5419#
5420# }
5421#
5422# }
5423# }
5424updateProcessTemplate(input: UpdateProcessTemplate!): ProcessTemplate!
5425
5426# Delete a processTemplate by ID in CMS
5427# Example:
5428# Request:
5429# mutation {
5430#
5431# deleteProcessTemplate(
5432#
5433# id: "746") {
5434#
5435# message
5436#
5437# }
5438# }
5439# Response:
5440# {
5441#
5442# "data": {
5443#
5444# "deleteProcessTemplate": {
5445#
5446# "message": null
5447#
5448# }
5449#
5450# }
5451# }
5452deleteProcessTemplate(id: ID!): DeletePayload!
5453
5454# Create a mention export request. The requested mentionFilters including
5455# The mention export file csv will be exported offline.
5456# Example:
5457# Request:
5458# mutation {
5459#
5460# createMentionExportRequest(input: {
5461#
5462# mentionFilters: {
5463#
5464# watchlistIds: ["123"]}}) {
5465#
5466# id
5467#
5468# }
5469# }
5470# Response:
5471# {
5472#
5473# "data": {
5474#
5475# "createMentionExportRequest": {
5476#
5477# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5478#
5479# }
5480#
5481# }
5482# }
5483#
5484# Arguments
5485# input: Input data required to create the export request
5486createMentionExportRequest(
5487input: CreateMentionExportRequest!
5488): ExportRequest!
5489
5490# Update status or assetURI of a mentionExportRequest
5491# Often use when the file export was completed or downloaded
5492# Example:
5493# Request:
5494# mutation {
5495#
5496# updateMentionExportRequest(input: {
5497#
5498# id: "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5499#
5500# status: incomplete,
5501#
5502# assetUri: "www.veritone.com",
5503#
5504# sqlQueries:""}) {
5505#
5506# id
5507#
5508# }
5509# }
5510# Response:
5511# {
5512#
5513# "data": {
5514#
5515# "updateMentionExportRequest": {
5516#
5517# "id": "400c98c2-faa8-44e4-b5d8-daf2fb43445e"
5518#
5519# }
5520#
5521# }
5522# }
5523updateMentionExportRequest(
5524input: UpdateMentionExportRequest!
5525): ExportRequest!
5526
5527# Create a creative
5528# Example:
5529# Request:
5530# mutation {
5531#
5532# createCreative(input: {
5533#
5534# name: "example"
5535#
5536# keywords: "example keywords"
5537#
5538# brandId: null
5539#
5540# advertiserId: null}) {
5541#
5542# id
5543#
5544# }
5545# }
5546# Response:
5547# {
5548#
5549# "data": {
5550#
5551# "createCreative": {
5552#
5553# "id": "25208"
5554#
5555# }
5556#
5557# }
5558# }
5559createCreative(input: CreateCreative!): Creative!
5560
5561# Update a creative
5562# Example:
5563# Request:
5564# mutation {
5565#
5566# updateCreative(input: {
5567#
5568# id: "25208",
5569#
5570# name: "example",
5571#
5572# keywords: "new keywords",
5573#
5574# brandId: null,
5575#
5576# advertiserId: null}) {
5577#
5578# id
5579#
5580# }
5581# }
5582# Response:
5583# {
5584#
5585# "data": {
5586#
5587# "updateCreative": {
5588#
5589# "id": "25208"
5590#
5591# }
5592#
5593# }
5594# }
5595updateCreative(input: UpdateCreative!): Creative!
5596
5597# Delete a creative
5598# Example:
5599# Request:
5600# mutation {
5601#
5602# deleteCreative(
5603#
5604# id: "25208") {
5605#
5606# message
5607#
5608# }
5609# }
5610# Response:
5611# {
5612#
5613# "data": {
5614#
5615# "deleteCreative": {
5616#
5617# "message": null
5618#
5619# }
5620#
5621# }
5622# }
5623deleteCreative(id: ID!): DeletePayload!
5624
5625# Emit a system-level emit. This mutation is used only by
5626# Veritone platform components.
5627#
5628# Arguments
5629# input: Data required to create the event
5630emitSystemEvent(input: EmitSystemEvent!): SystemEventInfo!
5631
5632# Creates an immutable audit log event with the given payload
5633# Example:
5634# Request:
5635# mutation {
5636#
5637# emitAuditEvent(input: {
5638#
5639# application: ""
5640#
5641# payload: {
5642#
5643# example: "example"
5644#
5645# }}) {
5646#
5647# id
5648#
5649# }
5650# }
5651# Response:
5652# {
5653#
5654# "data": {
5655#
5656# "emitAuditEvent": {
5657#
5658# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f"
5659#
5660# }
5661#
5662# }
5663# }
5664emitAuditEvent(input: EmitAuditEvent!): AuditEvent!
5665
5666# Create a context menu extension
5667# Example:
5668# Request:
5669#
5670# mutation {
5671#
5672# createContextMenuExtension(input: {
5673#
5674# id: "80354999-d633-4595-9578-d82f59a5134f"
5675#
5676# label: "example"
5677#
5678# url: "www.veritone.com"
5679#
5680# type: tdo}) {
5681#
5682# id
5683#
5684# }
5685# }
5686# Response:
5687# {
5688#
5689# "data": {
5690#
5691# "createContextMenuExtension": {
5692#
5693# "id": "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"
5694#
5695# }
5696#
5697# }
5698# }
5699createContextMenuExtension(
5700input: CreateContextMenuExtension!
5701): ContextMenuExtension!
5702
5703# Update a context menu extension
5704# Example:
5705# Request:
5706#
5707# mutation {
5708#
5709# updateContextMenuExtension(input: {
5710#
5711# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746",
5712#
5713# label: "new label",
5714#
5715# url: "www.veritone.com"}) {
5716#
5717# label
5718#
5719# }
5720# }
5721# Response:
5722# {
5723#
5724# "data": {
5725#
5726# "updateContextMenuExtension": {
5727#
5728# "label": "new label"
5729#
5730# }
5731#
5732# }
5733# }
5734updateContextMenuExtension(
5735input: UpdateContextMenuExtension!
5736): ContextMenuExtension!
5737
5738# Delete a context menu extension
5739#
5740# Example:
5741#
5742# Request:
5743#
5744# mutation {
5745#
5746# deleteContextMenuExtension(input: {
5747#
5748# id: "cdf19d46-4d89-4b5b-a6bf-ae12c17f2746"}) {
5749#
5750# message
5751#
5752# }
5753# }
5754# Response:
5755# {
5756#
5757# "data": {
5758#
5759# "deleteContextMenuExtension": {
5760#
5761# "message": null
5762#
5763# }
5764#
5765# }
5766# }
5767deleteContextMenuExtension(
5768input: DeleteContextMenuExtension!
5769): DeletePayload!
5770
5771# Add or update an organization integration config by
5772# organization id and integration id. Requires superadmin.
5773setOrganizationIntegrationConfig(
5774input: SetOrganizationIntegrationConfig!
5775): IntegrationConfig!
5776
5777# Delete an integration config. Requires superadmin.
5778deleteOrganizationIntegrationConfig(
5779input: DeleteOrganizationIntegrationConfig!
5780): DeleteIntegrationConfigPayload!
5781
5782# Create customized Login Configuration for the Instance
5783createInstanceLoginConfiguration(
5784input: CreateInstanceLoginConfiguration!
5785): LoginConfiguration!
5786
5787# Update customized Login Configuration for the Instance by Slug.
5788#
5789# ___Requires superadmin.___
5790#
5791# Arguments
5792# querySlug: The slug corresponding to the login configuration to
5793# be updated.
5794updateInstanceLoginConfiguration(
5795querySlug: String!,
5796input: SetLoginConfiguration!
5797): LoginConfiguration!
5798
5799# Delete the login configuration for the organization.
5800#
5801# Arguments
5802# organizationId: Optional field for the Organization ID for
5803# which the login configuration is to be deleted.
5804# Deleting login configuration for an organization that is different from the
5805# caller's organization
5806# is only allowed for superadmin.
5807#
5808# Defaults to caller's Organization ID.
5809deleteLoginConfiguration(organizationId: ID): DeletePayload!
5810
5811# Delete an instance-level login configuration by slug.
5812#
5813# Arguments
5814# slug: The slug corresponding to the instance-level login
5815# configuration to be deleted.
5816deleteInstanceLoginConfiguration(
5817slug: String!
5818): DeletePayload!
5819
5820# Mutation to create a new registration configuration.
5821createRegistrationConfiguration(
5822input: CreateRegistrationConfigurationInput!
5823): RegistrationConfiguration!
5824
5825# Mutation to update an existing registration configuration for an organization.
5826updateRegistrationConfiguration(
5827id: ID!,
5828input: UpdateRegistrationConfiguration!
5829): RegistrationConfiguration!
5830
5831# Mutation to delete an existing registration configuration for an organization.
5832deleteRegistrationConfiguration(id: ID!): DeletePayload!
5833
5834# Update the status of a user
5835# Example:
5836# Request:
5837# mutation {
5838#
5839# updateUserStatus(input: {
5840#
5841# id: "9728eeef-4ccc-423c-8c98-ffa37313a98d",
5842#
5843# status: deleted}) {
5844#
5845# status
5846#
5847# }
5848# }
5849# Response:
5850# {
5851#
5852# "data": {
5853#
5854# "updateUserStatus": {
5855#
5856# "status": "deleted"
5857#
5858# }
5859#
5860# }
5861# }
5862#
5863# Arguments
5864# input: Data required to update the status of a user
5865updateUserStatus(input: UpdateUserStatus!): User!
5866
5867# Create a custom dashboard
5868# Example:
5869# Request:
5870# mutation {
5871#
5872# createCustomDashboard(input: {
5873#
5874# hostAppId: "80354999-d633-4595-9578-d82f59a5134f",
5875#
5876# name: "example",
5877#
5878# description: "example",
5879#
5880# data: {
5881#
5882# example: "example jsondata"}}) {
5883#
5884# id
5885#
5886# }
5887# }
5888# Response:
5889# {
5890#
5891# "data": {
5892#
5893# "createCustomDashboard": {
5894#
5895# "id": "60141fc5-8d31-487d-9847-c47f990e4537"
5896#
5897# }
5898#
5899# }
5900# }
5901createCustomDashboard(input: CreateCustomDashboard): CustomDashboard
5902
5903# Update a custom dashboard
5904# Example:
5905# Request:
5906# mutation {
5907#
5908# updateCustomDashboard(input: {
5909#
5910# id: "60141fc5-8d31-487d-9847-c47f990e4537",
5911#
5912# name: "new name"}) {
5913#
5914# name
5915#
5916# }
5917# }
5918# Response:
5919# {
5920#
5921# "data": {
5922#
5923# "updateCustomDashboard": {
5924#
5925# "name": "new name"
5926#
5927# }
5928#
5929# }
5930# }
5931updateCustomDashboard(input: UpdateCustomDashboard): CustomDashboard
5932
5933# Delete a custom dashboard
5934# Example:
5935# Request:
5936# mutation {
5937#
5938# deleteCustomDashboard(
5939#
5940# id: "60141fc5-8d31-487d-9847-c47f990e4537") {
5941#
5942# message
5943#
5944# }
5945# }
5946# Response:
5947# {
5948#
5949# "data": {
5950#
5951# "deleteCustomDashboard": {
5952#
5953# "message": "Custom dashboard deleted"
5954#
5955# }
5956#
5957# }
5958# }
5959deleteCustomDashboard(id: ID!): DeletePayload
5960
5961# Create a Dataset
5962# Example:
5963# Request:
5964# mutation {
5965#
5966# createDataset(input: {
5967#
5968# name: "example",
5969#
5970# description: "example",
5971#
5972# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9",
5973#
5974# tags: {
5975#
5976# name: "example",
5977#
5978# value: "example value"}}) {
5979#
5980# datasetId
5981#
5982# }
5983# }
5984# Response:
5985# {
5986#
5987# "data": {
5988#
5989# "createDataset": {
5990#
5991# "datasetId": "47c831ea-f4f6-4eeb-9e39-8c1cd0a1eb95"
5992#
5993# }
5994#
5995# }
5996# }
5997createDataset(input: DatasetInput!): Dataset
5998
5999# Create a Dataset Schema
6000# Example:
6001# Request:
6002# mutation {
6003#
6004# createDatasetSchema(input: {
6005#
6006# name: "example"
6007#
6008# description: "example"
6009#
6010# schema: {
6011#
6012# example: "example value"
6013#
6014# }
6015#
6016# tags: {
6017#
6018# name: "example",
6019#
6020# value: "example value"}}) {
6021#
6022# schema{
6023#
6024# id
6025#
6026# }
6027#
6028# }
6029# }
6030# Response:
6031# {
6032#
6033# "data": {
6034#
6035# "createDatasetSchema": null
6036#
6037# }
6038# }
6039createDatasetSchema(input: CreateDatasetSchema!): Dataset
6040
6041# Update a Dataset
6042updateDataset(id: ID!, input: DatasetInput): Dataset
6043
6044# Delete a Dataset
6045deleteDataset(id: ID!): DeleteDatasetPayload!
6046
6047# Perform Dataset Operations
6048#
6049# Arguments
6050# id: Specify the Dataset ID for the operation to be performed
6051datasetDataOperation(
6052id: ID!,
6053actions: [DatasetActionInput!],
6054async: Boolean,
6055updateMetrics: Boolean
6056): DatasetStateInfo
6057
6058# Replace a source engine to replacement engine
6059# Example:
6060# Request:
6061# mutation {
6062#
6063# addTaskReplacementEngine(input: {
6064#
6065# sourceEngineId: "1"
6066#
6067# replacementEngineId: "2"
6068#
6069# organizationId: "35521"
6070#
6071# payloadFunc: null}) {
6072#
6073# replacementEngineId
6074#
6075# }
6076# }
6077# Response:
6078# {
6079#
6080# "data": {
6081#
6082# "addTaskReplacementEngine": {
6083#
6084# "replacementEngineId": "2"
6085#
6086# }
6087#
6088# }
6089# }
6090addTaskReplacementEngine(
6091input: AddTaskReplacementEngine
6092): TaskEngineReplacement
6093
6094# Remove an engine replacement
6095# Example:
6096# Request:
6097# mutation {
6098#
6099# removeTaskReplacementEngine(input: {
6100#
6101# sourceEngineId: "1",
6102#
6103# replacementEngineId: "2",
6104#
6105# organizationId: "35521"}) {
6106#
6107# message
6108#
6109# }
6110# }
6111# Response:
6112# {
6113#
6114# "data": {
6115#
6116# "removeTaskReplacementEngine": {
6117#
6118# "message": "Engine replacement has been removed"
6119#
6120# }
6121#
6122# }
6123# }
6124removeTaskReplacementEngine(
6125input: RemoveTaskReplacementEngine
6126): DeletePayload
6127
6128# Create a custom notification mailbox
6129# Example:
6130# Request:
6131# mutation {
6132#
6133# notificationMailboxCreate(input: {
6134#
6135# name: "example",
6136#
6137# eventFilter: {
6138#
6139# eventNames: "example",
6140#
6141# eventType: "example",,
6142#
6143# delivery: {
6144#
6145# params: {
6146#
6147# example: "example params"
6148#
6149# }
6150#
6151# }
6152#
6153# },
6154#
6155# notificationTemplate: "",
6156#
6157# limit: 10}) {
6158#
6159# id
6160#
6161# }
6162# }
6163# Response:
6164# {
6165#
6166# "data": {
6167#
6168# "notificationMailboxCreate": [
6169#
6170# {
6171#
6172# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6173#
6174# }
6175# } }
6176notificationMailboxCreate(
6177input: NotificationMailboxInput
6178): NotificationMailbox
6179
6180# Pause a notification mailbox
6181# Example:
6182# Request:
6183# mutation {
6184#
6185# notificationMailboxPause(
6186#
6187# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6188#
6189# id
6190#
6191# paused
6192#
6193# }
6194# }
6195# Response:
6196# {
6197#
6198# "data": {
6199#
6200# "notificationMailboxPause": {
6201#
6202# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6203#
6204# "paused": true
6205#
6206# }
6207#
6208# }
6209# }
6210notificationMailboxPause(id: ID!): NotificationMailbox
6211
6212# Delete a notification mailbox
6213# Example:
6214# Request:
6215# mutation {
6216#
6217# notificationMailboxDelete(id:"0415f525-813d-4fd4-9dea-9428382b05b9") {
6218#
6219# message
6220#
6221# }
6222# }
6223# Response:
6224# {
6225#
6226# "data": {
6227#
6228# "notificationMailboxDelete": {
6229#
6230# "message": "Notification mailbox has been removed"
6231#
6232# }
6233#
6234# }
6235# }
6236notificationMailboxDelete(id: ID!): DeletePayload!
6237
6238# Post a notification to some mailboxes
6239# Example:
6240# Request:
6241# mutation {
6242#
6243# notificationPost(input: {
6244#
6245# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"],
6246#
6247# title: "example title",
6248#
6249# body: "example body",
6250#
6251# contentType: "type",
6252#
6253# flags: unread}) {
6254#
6255# id
6256#
6257# }
6258# }
6259# Response:
6260# {
6261#
6262# "data": {
6263#
6264# "notificationPost": {
6265#
6266# "id": "iDDfG3oB3LnZSYqhRv7-"
6267#
6268# }
6269#
6270# }
6271# }
6272notificationPost(input: NotificaionPostInput): Notification
6273
6274# Add a new notification template by eventName, eventType, application
6275# Example:
6276# Request:
6277# mutation {
6278#
6279# addNotificationTemplate(input: {
6280#
6281# eventName: "example"
6282#
6283# eventType: "example"
6284#
6285# title: "example"
6286#
6287# body: "example"
6288#
6289# application: "80354999-d633-4595-9578-d82f59a5134f"
6290#
6291# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6292#
6293# id
6294#
6295# }
6296# }
6297# Response:
6298# {
6299#
6300# "data": {
6301#
6302# "addNotificationTemplate": {
6303#
6304# "id": "1dbf3d28-bc7a-434f-ba65-455da0169323"
6305#
6306# }
6307#
6308# }
6309# }
6310addNotificationTemplate(input: AddNotificationTemplate): NotificationTemplate
6311
6312# Remove a notification template by id
6313# Example:
6314# Request:
6315# mutation {
6316#
6317# removeNotificationTemplate(id: "1dbf3d28-bc7a-434f-ba65-455da0169323") {
6318#
6319# message
6320#
6321# }
6322# }
6323# Response:
6324# {
6325#
6326# "data": {
6327#
6328# "removeNotificationTemplate": {
6329#
6330# "message": "Notification Template has been removed"
6331#
6332# }
6333#
6334# }
6335# }
6336removeNotificationTemplate(id: ID!): DeletePayload!
6337
6338# Add a new notification action by eventName, eventType, application
6339# Example:
6340# Request:
6341# mutation {
6342#
6343# addNotificationAction(input: {
6344#
6345# eventName: "example",
6346#
6347# eventType: "example"
6348#
6349# actionName: "example"
6350#
6351# icon:
6352# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
6353#
6354# urlTemplate: "www.veritone.com"
6355#
6356# application: "80354999-d633-4595-9578-d82f59a5134f"
6357#
6358# mailboxId: "0415f525-813d-4fd4-9dea-9428382b05b9"}) {
6359#
6360# id
6361#
6362# }
6363# }
6364# Response:
6365# {
6366#
6367# "data": {
6368#
6369# "addNotificationAction": {
6370#
6371# "id": "27dab45b-d825-4f20-b758-4b089d610903"
6372#
6373# }
6374#
6375# }
6376# }
6377addNotificationAction(input: AddNotificationAction): NotificationAction
6378
6379# Remove a notification action by id
6380# Example
6381# Request:
6382# mutation {
6383#
6384# removeNotificationAction(
6385#
6386# id:"27dab45b-d825-4f20-b758-4b089d610903") {
6387#
6388# message
6389#
6390# }
6391# }
6392# Response:
6393# {
6394#
6395# "data": {
6396#
6397# "removeNotificationAction": {
6398#
6399# "message": "Notification Action has been removed"
6400#
6401# }
6402#
6403# }
6404# }
6405removeNotificationAction(id: ID!): DeletePayload!
6406
6407# Set and unset the notification flags
6408# Example:
6409# Request:
6410# mutation {
6411#
6412# setNotificationFlag(input: {
6413#
6414# notificationId: "iDDfG3oB3LnZSYqhRv7-",
6415#
6416# setFlags: read}) {
6417#
6418# id
6419#
6420# flags
6421#
6422# }
6423# }
6424# Response:
6425# {
6426#
6427# "data": {
6428#
6429# "setNotificationFlag": {
6430#
6431# "id": "iDDfG3oB3LnZSYqhRv7-",
6432#
6433# "flags": [
6434#
6435# "unread",
6436#
6437# "read"
6438#
6439# ]
6440#
6441# }
6442#
6443# }
6444# }
6445setNotificationFlag(input: SetNotificationFlag): Notification
6446
6447# Unpause/resume a notification mailbox
6448# Example:
6449# Request:
6450# mutation {
6451#
6452# notificationMailboxUnpause(
6453#
6454# id: "0415f525-813d-4fd4-9dea-9428382b05b9") {
6455#
6456# id
6457#
6458# }
6459# }
6460# Response:
6461# {
6462#
6463# "data": {
6464#
6465# "notificationMailboxUnpause": {
6466#
6467# "id": "0415f525-813d-4fd4-9dea-9428382b05b9"
6468#
6469# }
6470#
6471# }
6472# }
6473notificationMailboxUnpause(id: ID!): NotificationMailbox
6474
6475# Mark all notification as read for mailboxIds
6476# Example:
6477# Request:
6478# mutation {
6479#
6480# markAllNotificationsRead(
6481#
6482# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6483#
6484# id
6485#
6486# }
6487# }
6488# Response:
6489# "data": {
6490#
6491# "markAllNotificationsRead": {
6492#
6493# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6494#
6495# "notifications": {
6496#
6497# "records": {
6498#
6499# "flags": [
6500#
6501# "unseen",
6502#
6503# "read"
6504#
6505# ]
6506#
6507# }
6508#
6509# }
6510#
6511# }
6512# }
6513markAllNotificationsRead(mailboxIds: [ID]!): [NotificationMailbox]
6514
6515# Mark all notification as read for mailboxIds
6516# Example:
6517# Request:
6518# mutation {
6519#
6520# markAllNotificationsSeen(
6521#
6522# mailboxIds: ["0415f525-813d-4fd4-9dea-9428382b05b9"]) {
6523#
6524# id
6525#
6526# notifications{
6527#
6528# records{
6529#
6530# flags
6531#
6532# }
6533#
6534# }
6535#
6536# }
6537# }
6538# Response:
6539# {
6540#
6541# "data": {
6542#
6543# "markAllNotificationsSeen":
6544#
6545# {
6546#
6547# "id": "0415f525-813d-4fd4-9dea-9428382b05b9",
6548#
6549# "notifications": {
6550#
6551# "records":
6552#
6553# {
6554#
6555# "flags": [
6556#
6557# "read",
6558#
6559# "seen"
6560#
6561# ]
6562#
6563# }
6564#
6565# }
6566#
6567# }
6568#
6569# }
6570#
6571# }
6572markAllNotificationsSeen(mailboxIds: [ID]!): [NotificationMailbox]
6573
6574# Create the default user setting definition for application by current
6575# organization
6576# Example:
6577# Request:
6578# mutation {
6579#
6580# createUserSettingDefinition(
6581#
6582# application: "80354999-d633-4595-9578-d82f59a5134f",
6583#
6584# key: "example",
6585#
6586# type: "example",
6587#
6588# defaultValue: "example") {
6589#
6590# applicationId
6591#
6592# organizationGuid
6593#
6594# }
6595# }
6596# Response:
6597# {
6598#
6599# "data": {
6600#
6601# "createUserSettingDefinition": {
6602#
6603# "applicationId": "80354999-d633-4595-9578-d82f59a5134f",
6604#
6605# "organizationGuid": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09"
6606#
6607# }
6608#
6609# }
6610# }
6611#
6612# Arguments
6613# organizationGuid: Should be required by orgless token,
6614# or can be set by superadmin
6615createUserSettingDefinition(
6616application: ID!,
6617key: String!,
6618type: String!,
6619description: String,
6620defaultValue: String!,
6621organizationGuid: ID
6622): ApplicationSetting
6623
6624# Delete the default user setting definition for application and org
6625# Example:
6626# Request:
6627# mutation {
6628#
6629# deleteUserSettingDefinition(
6630#
6631# application: "80354999-d633-4595-9578-d82f59a5134f",
6632#
6633# key:"example") {
6634#
6635# message
6636#
6637# }
6638# }
6639# Response:
6640# {
6641#
6642# "data": {
6643#
6644# "deleteUserSettingDefinition": {
6645#
6646# "message": "Application setting (application:
6647# 80354999-d633-4595-9578-d82f59a5134f, organizationGuid:
6648# 49a4cbbc-5e83-4c42-b9a3-be6ec0732f09, key: example) has been deleted"
6649#
6650# }
6651#
6652# }
6653# }
6654#
6655# Arguments
6656# organizationGuid: Should be required by orgless token,
6657# or can be set by superadmin
6658deleteUserSettingDefinition(
6659application: ID!,
6660organizationGuid: ID,
6661key: String!
6662): DeletePayload!
6663
6664# Update setting for user (add/update/remove settings)
6665# Example:
6666# Request:
6667# mutation {
6668#
6669# updateUserSetting(input: {
6670#
6671# application: "80354999-d633-4595-9578-d82f59a5134f",
6672#
6673# key: "example12",
6674#
6675# value: "example value"}) {
6676#
6677# userId
6678#
6679# }
6680# }
6681# Response:
6682# {
6683#
6684# "data": {
6685#
6686# "updateUserSetting": {
6687#
6688# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008"
6689#
6690# }
6691#
6692# }
6693# }
6694updateUserSetting(input: UpdateUserSetting): UserSetting
6695
6696# Create an OpenID Provider
6697createOpenIdProvider(input: CreateOpenIdProvider): OpenIdProvider
6698
6699# Update an OpenId Provider by ID
6700updateOpenIdProvider(input: UpdateOpenIdProvider): OpenIdProvider
6701
6702# Enable Global OpenID Provider for Organization
6703enableOpenIdProviderForOrg(
6704input: EnableOpenIdProviderForOrg
6705): UpdatePayload
6706
6707# Disable Global OpenID Provider for Organization
6708disableOpenIdProviderForOrg(
6709input: DisableOpenIdProviderForOrg
6710): UpdatePayload
6711
6712# Delete OpenID Provider
6713deleteOpenIdProvider(id: ID!): DeletePayload
6714
6715# Get Organization scoped application JWT token
6716getApplicationJWT(input: GetApplicationJWT): ApplicationJWTTokenInfo
6717
6718# Remove an application event endpoint
6719removeApplicationEventEndpoint(id: ID!): DeletePayload
6720
6721# Update event endpoint for an application
6722updateApplicationEventEndpoint(
6723input: UpdateApplicationEventEndpoint
6724): Application
6725
6726# Multi Organization Invitation.
6727createOrganizationInvite(
6728input: CreateOrganizationInviteInput!
6729): OrganizationInvite!
6730
6731updateOrganizationInvite(
6732input: UpdateOrganizationInviteInput!
6733): OrganizationInvite!
6734
6735setUserDefaultOrganization(
6736defaultOrganizationId: ID!
6737): OrganizationInfo
6738
6739# delete organization invitation
6740# This deletion is hard-delete process. It will remove invitation completely from
6741# the database.
6742deleteOrganizationInvite(organizationInviteId: ID!): DeletePayload
6743
6744# Create a package
6745packageCreate(input: PackageCreateInput): Package
6746
6747# This updates the specified package.
6748#
6749# This will result in upgrading the package by duplicating the original package
6750# and
6751# bumping its version number up to the next major version. The new package will
6752# reflect
6753# the changes made to the original package. __Note: The original package will not
6754# be altered in any way.__
6755#
6756# The data returned will be the newly upgraded version of the package.
6757packageUpdate(input: PackageUpdateInput): Package
6758
6759# Delete a package
6760packageDelete(id: ID!): PackageDeleteResult
6761
6762# This updates the resources of the specified package.
6763#
6764# This will result in upgrading the package by duplicating the original package
6765# and
6766# bumping its version number up to the next major version. The new package will
6767# reflect
6768# the changes made to the original package's resources. __Note: The original
6769# package will not
6770# be altered in any way.__
6771#
6772# The data returned will be the newly upgraded version of the package.
6773packageUpdateResources(input: BulkPackageResourceInput): Package
6774
6775# Add or remove Grants to a package and organization
6776packageUpdateGrants(input: BulkPackageGrantInput!): Package
6777
6778apiTokenCreate(name: String!, rights: [AuthPermissionType]!): ApiToken
6779
6780apiTokenUpdate(hash: String!, input: ApiTokenUpdateInput!): ApiTokenInfo
6781
6782# Update an ApplicationViewer
6783# Example:
6784# Request:
6785# mutation {
6786# updateApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a", input:
6787# { name: "Test"}) {
6788# records{
6789# id
6790# name
6791# }
6792# }
6793# }
6794# Response:
6795# {
6796# "data": {
6797# "viewers": {
6798# "records": [
6799# {
6800# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6801# "name": "Test"
6802# }
6803# ]
6804# }
6805# }
6806# }
6807#
6808# Arguments
6809# viewerId: Provide an id of the viewer to update.
6810# input: Input for the update viewer
6811updateApplicationViewer(
6812viewerId: ID!,
6813input: UpdateApplicationViewerInput!
6814): ApplicationViewer
6815
6816# Delete an ApplicationViewer
6817# Example:
6818# Request:
6819# mutation {
6820# deleteApplicationViewer(viewerId: "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
6821# records{
6822# id
6823# name
6824# }
6825# }
6826# }
6827# Response:
6828# {
6829# "data": {
6830# "viewers": {
6831# "records": [
6832# {
6833# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6834# }
6835# ]
6836# }
6837# }
6838# }
6839#
6840# Arguments
6841# viewerId: Provide an id of the viewer to delete.
6842deleteApplicationViewer(viewerId: ID!): ApplicationViewer
6843
6844# Delete an ApplicationViewerBuild
6845# Example:
6846# Request:
6847# mutation {
6848# deleteApplicationViewerBuild(viewerBuildId:
6849# "2a1a1b58-6983-4002-b9ed-7b7f325f621a") {
6850# records{
6851# id
6852# name
6853# }
6854# }
6855# }
6856# Response:
6857# {
6858# "data": {
6859# "viewers": {
6860# "records": [
6861# {
6862# "viewerId": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6863# }
6864# ]
6865# }
6866# }
6867# }
6868#
6869# Arguments
6870# viewerBuildId: Provide an id of the viewer build to delete.
6871deleteApplicationViewerBuild(viewerBuildId: ID!): ApplicationViewerBuild
6872
6873# This mutation creates the multipart upload session to an S3 bucket. If provided,
6874# it will create the session for a
6875# specified bucket. Otherwise, it will create a session for the API bucket that is
6876# configured for aiware by default.
6877# What this mutation does is establish a connection to the bucket, initiate the
6878# multipart upload session,
6879# and generate pre-signed URLs for each part that needs to be uploaded. The number
6880# of generated pre-signed URLs is
6881# determined by the `numberOfParts` input field.
6882# Example:
6883# Request:
6884# mutation {
6885#
6886# initiateMultipartUpload(input: {
6887#
6888# fileName: "exampleImage.jpg",
6889#
6890# contentType: "image/jpeg",
6891#
6892# fileSize: 22594,
6893#
6894# }) {
6895#
6896# preSignedUrls {
6897#
6898# partNumber
6899#
6900# signedUrl
6901#
6902# }
6903#
6904# chunkSize
6905#
6906# key
6907#
6908# uploadId
6909#
6910# }
6911# }
6912initiateMultipartUpload(
6913input: InitiateMultipartUploadInput!
6914): MultipartUploadSessionInfo
6915
6916# This mutation is called after all parts have been uploaded. This will finalize
6917# and close out the
6918# multipart upload session and return the final URL where the file was uploaded
6919# to.
6920# Example:
6921# Request:
6922# mutation {
6923#
6924# completeMultipartUpload(input: {
6925#
6926# key: "exampleImage.jpg",
6927#
6928# uploadId: "exampleUploadId",
6929#
6930# parts: [
6931#
6932# {
6933#
6934# partNumber: "1",
6935#
6936# etag: "exampleEtag"
6937#
6938# }
6939#
6940# ]
6941#
6942# }) {
6943#
6944# url
6945#
6946# }
6947# }
6948completeMultipartUpload(
6949input: CompleteMultipartUploadInput!
6950): CompleteMultipartUploadResult
6951
6952# This mutation can be called at any point during an open multipart upload
6953# session.
6954# This will cancel the session and free up any space taken up by any parts already
6955# uploaded.
6956# However, it is possible for there to be dangling parts that may have still been
6957# in-progress and
6958# uploaded after the cancel request was made. This mutation will make the cancel
6959# request up to 3 times
6960# to ensure that everything has been cleaned up properly. If it’s not fully clean
6961# after 3 calls,
6962# an error will be returned, directing to run this mutation again.
6963# Example:
6964# Request:
6965# mutation {
6966#
6967# cancelMultipartUpload(input: {
6968#
6969# key: "exampleImage.jpg",
6970#
6971# uploadId: "exampleUploadId"
6972#
6973# }) {
6974#
6975# id
6976#
6977# message
6978#
6979# }
6980# }
6981cancelMultipartUpload(input: CancelMultipartUploadInput!): DeletePayload
6982
6983addPlatformEmailProvider(
6984input: EmailProviderConfigInput!
6985): EmailProviderConfig!
6986
6987# Create an email template.
6988emailTemplateCreate(input: EmailTemplateInput!): EmailTemplate!
6989
6990# This updates the specified email template.
6991emailTemplateUpdate(input: EmailTemplateInput!): EmailTemplate!
6992
6993# Delete an email template.
6994emailTemplateDelete(id: String!, organizationGuid: String!): EmailTemplate!
6995
6996# Create one or more ingest slugs in bulk.
6997#
6998# This mutation creates ingest slug records for files, enabling tracking through
6999# the ingestion pipeline. It supports batch processing (up to 1000 files per
7000# batch),
7001# returns both successful creations and failures, and validates sourceId and
7002# optional
7003# engineId and appId parameters. The organizationId is retrieved from the user's
7004# authorization context.
7005#
7006# Requires scope: superadmin OR aiware.slug.create
7007#
7008# Example: Create multiple ingest slugs for a video source:
7009# mutation {
7010#
7011# ingestSlugsCreate(
7012#
7013# input: {
7014#
7015# sourceId: "100"
7016#
7017# files: [
7018#
7019# {
7020#
7021# fileUri: "s3://bucket/videos/file1.mp4"
7022#
7023# bundleKey: "bundle-001"
7024#
7025# mimeType: "video/mp4"
7026#
7027# fileSizeBytes: 2147483648
7028#
7029# fileCreatedAt: "2024-01-15T10:00:00Z"
7030#
7031# fileModifiedAt: "2024-01-15T10:30:00Z"
7032#
7033# status: "pending"
7034#
7035# },
7036#
7037# {
7038#
7039# fileUri: "s3://bucket/videos/file2.mov"
7040#
7041# bundleKey: "bundle-001"
7042#
7043# mimeType: "video/quicktime"
7044#
7045# fileSizeBytes: 1073741824
7046#
7047# fileCreatedAt: "2024-01-15T11:00:00Z"
7048#
7049# fileModifiedAt: "2024-01-15T11:30:00Z"
7050#
7051# status: "pending"
7052#
7053# }
7054#
7055# ]
7056#
7057# engineId: "c0e55cde-340b-44d7-bb42-2e0d65e98255"
7058#
7059# appId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a"
7060#
7061# }
7062#
7063# ) {
7064#
7065# sourceId
7066#
7067# created {
7068#
7069# sourceId
7070#
7071# fileUri
7072#
7073# status
7074#
7075# bundleKey
7076#
7077# createdAt
7078#
7079# }
7080#
7081# failed {
7082#
7083# fileUri
7084#
7085# errorCode
7086#
7087# errorMessage
7088#
7089# }
7090#
7091# }
7092# }
7093#
7094# Response:
7095# {
7096#
7097# "data": {
7098#
7099# "ingestSlugsCreate": {
7100#
7101# "sourceId": "100",
7102#
7103# "created": [
7104#
7105# {
7106#
7107# "sourceId": "100",
7108#
7109# "fileUri": "s3://bucket/videos/file1.mp4",
7110#
7111# "status": "pending",
7112#
7113# "bundleKey": "bundle-001",
7114#
7115# "createdAt": "2024-01-15T09:00:00Z"
7116#
7117# },
7118#
7119# {
7120#
7121# "sourceId": "100",
7122#
7123# "fileUri": "s3://bucket/videos/file2.mov",
7124#
7125# "status": "pending",
7126#
7127# "bundleKey": "bundle-001",
7128#
7129# "createdAt": "2024-01-15T09:05:00Z"
7130#
7131# }
7132#
7133# ],
7134#
7135# "failed": []
7136#
7137# }
7138#
7139# }
7140# }
7141#
7142# Notes:
7143# - Status defaults to "pending" if not provided
7144# - Duplicate file URIs for the same source are ignored and returned as failures
7145# - engineId and appId are optional but must exist if provided
7146# - If tdoId is provided, the slug will be associated with that temporal data
7147# object
7148# - organizationId is automatically determined from the user's authorization
7149# context
7150ingestSlugsCreate(input: IngestSlugsCreateInput!): IngestSlugsCreateResult
7151
7152# Update an individual ingest slug's metadata with optional conditional filtering.
7153#
7154# Allows updating file metadata, processing status, and TDO/asset associations
7155# for a specific ingest slug identified by sourceId and fileUri. Only provided
7156# fields
7157# are updated (partial updates are supported). The updatedAt timestamp is
7158# automatically
7159# updated. The sourceId is scoped to the user's organization from their
7160# authorization context.
7161#
7162# Optional filtering can be applied to restrict updates to slugs in a specific
7163# status,
7164# useful for preventing concurrent updates or ensuring updates only occur on files
7165# in a particular state.
7166#
7167# Requires scope: superadmin OR aiware.slug.update
7168#
7169# Example 1: Update slug status and associate with a TDO:
7170# mutation {
7171#
7172# ingestSlugUpdate(
7173#
7174# sourceId: "100"
7175#
7176# fileUri: "s3://bucket/videos/sample.mp4"
7177#
7178# input: {
7179#
7180# status: "ingested"
7181#
7182# statusMessage: "Successfully ingested and transcoded"
7183#
7184# tdoId: "1570654874"
7185#
7186# assetId: "1570654874_4hJtNKSUXD"
7187#
7188# mimeType: "video/mp4"
7189#
7190# fileSizeBytes: 2147483648
7191#
7192# }
7193#
7194# ) {
7195#
7196# sourceId
7197#
7198# fileUri
7199#
7200# status
7201#
7202# statusMessage
7203#
7204# tdoId
7205#
7206# assetId
7207#
7208# mimeType
7209#
7210# fileSizeBytes
7211#
7212# updatedAt
7213#
7214# }
7215# }
7216#
7217# Example 2: Update file metadata timestamps:
7218# mutation {
7219#
7220# ingestSlugUpdate(
7221#
7222# sourceId: "100"
7223#
7224# fileUri: "s3://bucket/videos/sample.mp4"
7225#
7226# input: {
7227#
7228# fileModifiedAt: "2024-01-15T14:00:00Z"
7229#
7230# bundleKey: "bundle-updated"
7231#
7232# }
7233#
7234# ) {
7235#
7236# fileModifiedAt
7237#
7238# bundleKey
7239#
7240# updatedAt
7241#
7242# }
7243# }
7244#
7245# Example 3: Conditional update - only update if status is currently 'pending':
7246# mutation {
7247#
7248# ingestSlugUpdate(
7249#
7250# sourceId: "100"
7251#
7252# fileUri: "s3://bucket/videos/sample.mp4"
7253#
7254# input: {
7255#
7256# status: "ingested"
7257#
7258# filter: {
7259#
7260# status: "pending"
7261#
7262# }
7263#
7264# }
7265#
7266# ) {
7267#
7268# sourceId
7269#
7270# fileUri
7271#
7272# status
7273#
7274# updatedAt
7275#
7276# }
7277# }
7278#
7279# Response:
7280# {
7281#
7282# "data": {
7283#
7284# "ingestSlugUpdate": {
7285#
7286# "sourceId": "100",
7287#
7288# "fileUri": "s3://bucket/videos/sample.mp4",
7289#
7290# "status": "ingested",
7291#
7292# "statusMessage": "Successfully ingested and transcoded",
7293#
7294# "tdoId": "1570654874",
7295#
7296# "assetId": "1570654874_4hJtNKSUXD",
7297#
7298# "mimeType": "video/mp4",
7299#
7300# "fileSizeBytes": 2147483648,
7301#
7302# "updatedAt": "2024-01-15T14:00:00Z"
7303#
7304# }
7305#
7306# }
7307# }
7308#
7309# Notes:
7310# - Both sourceId and fileUri are required and used as composite key
7311# - Any combination of updatable fields can be provided
7312# - TDO/asset associations are upserted
7313# - The returned object contains all current slug fields after the update
7314# - sourceId is validated to belong to the user's organization from authorization
7315# context
7316# - filter.status can be used to make updates conditional on current status
7317# - If filter.status is provided and current status doesn't match, returns null
7318# (not found)
7319ingestSlugUpdate(
7320sourceId: ID!,
7321fileUri: String!,
7322input: IngestSlugUpdateInput!
7323): IngestSlug
7324
7325# Bulk update the status of multiple ingest slugs with optimized batch processing.
7326#
7327# The sourceId is scoped to the user's organization from their authorization
7328# context.
7329#
7330# Requires scope: superadmin OR aiware.slug.update
7331#
7332# Example 1: Mark multiple files as ingested:
7333# mutation {
7334#
7335# ingestSlugUpdateStatus(
7336#
7337# sourceId: "100"
7338#
7339# fileUris: [
7340#
7341# "s3://bucket/videos/file1.mp4"
7342#
7343# "s3://bucket/videos/file2.mp4"
7344#
7345# "s3://bucket/videos/file3.mp4"
7346#
7347# ]
7348#
7349# input: {
7350#
7351# status: "ingested"
7352#
7353# statusMessage: "Batch processing completed successfully"
7354#
7355# }
7356#
7357# ) {
7358#
7359# sourceId
7360#
7361# updated {
7362#
7363# sourceId
7364#
7365# fileUri
7366#
7367# status
7368#
7369# statusMessage
7370#
7371# updatedAt
7372#
7373# }
7374#
7375# failed {
7376#
7377# fileUri
7378#
7379# errorCode
7380#
7381# errorMessage
7382#
7383# }
7384#
7385# }
7386# }
7387#
7388# Example 2: Reset failed uploads back to pending:
7389# mutation {
7390#
7391# ingestSlugUpdateStatus(
7392#
7393# sourceId: "100"
7394#
7395# fileUris: [
7396#
7397# "s3://bucket/videos/failed1.mp4"
7398#
7399# "s3://bucket/videos/failed2.mp4"
7400#
7401# ]
7402#
7403# input: {
7404#
7405# status: "pending"
7406#
7407# statusMessage: "Retry after connection restored"
7408#
7409# }
7410#
7411# ) {
7412#
7413# sourceId
7414#
7415# updated {
7416#
7417# fileUri
7418#
7419# status
7420#
7421# updatedAt
7422#
7423# }
7424#
7425# failed {
7426#
7427# fileUri
7428#
7429# errorCode
7430#
7431# errorMessage
7432#
7433# }
7434#
7435# }
7436# }
7437#
7438# Response:
7439# {
7440#
7441# "data": {
7442#
7443# "ingestSlugUpdateStatus": {
7444#
7445# "sourceId": "100",
7446#
7447# "updated": [
7448#
7449# {
7450#
7451# "sourceId": "100",
7452#
7453# "fileUri": "s3://bucket/videos/file1.mp4",
7454#
7455# "status": "ingested",
7456#
7457# "statusMessage": "Batch processing completed successfully",
7458#
7459# "updatedAt": "2024-01-15T14:00:00Z"
7460#
7461# },
7462#
7463# {
7464#
7465# "sourceId": "100",
7466#
7467# "fileUri": "s3://bucket/videos/file2.mp4",
7468#
7469# "status": "ingested",
7470#
7471# "statusMessage": "Batch processing completed successfully",
7472#
7473# "updatedAt": "2024-01-15T14:00:00Z"
7474#
7475# },
7476#
7477# {
7478#
7479# "sourceId": "100",
7480#
7481# "fileUri": "s3://bucket/videos/file3.mp4",
7482#
7483# "status": "ingested",
7484#
7485# "statusMessage": "Batch processing completed successfully",
7486#
7487# "updatedAt": "2024-01-15T14:00:00Z"
7488#
7489# }
7490#
7491# ],
7492#
7493# "failed": []
7494#
7495# }
7496#
7497# }
7498# }
7499#
7500# Notes:
7501# - sourceId and at least one fileUri are required
7502# - Status is a required input, statusMessage is optional
7503# - All files are updated in a single efficient batch operation (single database
7504# round-trip)
7505# - Partial success is possible: some files may succeed while others fail
7506# - Possible error codes:
7507#
7508# * 'constraint_violation': File would violate unique constraint on
7509# (media_source_id, bundle_key) where status='ingesting'
7510#
7511# * 'batch_conflict': Multiple files in the batch would conflict with each other
7512# (same bundle_key)
7513#
7514# * 'not_found': The ingest slug does not exist for the given sourceId and fileUri
7515#
7516# * 'not_updated': Database error occurred during update
7517# - Returns full IngestSlug objects for successfully updated records
7518# - All updates are processed with organization security binding
7519# - Maximum batch limit is 1000 fileUris per request
7520ingestSlugUpdateStatus(
7521sourceId: ID!,
7522fileUris: [String!]!,
7523input: IngestSlugsStatusUpdateInput!
7524): IngestSlugUpdateStatusResult
7525
7526# Delete specific ingest slug records.
7527#
7528# Removes ingest slug records from the system for the specified sourceId and
7529# fileUris.
7530# Returns IngestSlugKey objects (sourceId and fileUri pairs) for successfully
7531# deleted records.
7532# The sourceId is scoped to the user's organization from their authorization
7533# context.
7534#
7535# Requires scope: superadmin OR aiware.slug.delete
7536#
7537# Example: Delete specific ingest slugs:
7538# mutation {
7539#
7540# ingestSlugsDelete(
7541#
7542# sourceId: "100"
7543#
7544# fileUris: [
7545#
7546# "s3://bucket/videos/old_file1.mp4"
7547#
7548# "s3://bucket/videos/old_file2.mp4"
7549#
7550# ]
7551#
7552# ) {
7553#
7554# sourceId
7555#
7556# deleted {
7557#
7558# sourceId
7559#
7560# fileUri
7561#
7562# }
7563#
7564# failed {
7565#
7566# fileUri
7567#
7568# errorCode
7569#
7570# errorMessage
7571#
7572# }
7573#
7574# }
7575# }
7576#
7577# Response:
7578# {
7579#
7580# "data": {
7581#
7582# "ingestSlugsDelete": {
7583#
7584# "sourceId": "100",
7585#
7586# "deleted": [
7587#
7588# {
7589#
7590# "sourceId": "100",
7591#
7592# "fileUri": "s3://bucket/videos/old_file1.mp4"
7593#
7594# },
7595#
7596# {
7597#
7598# "sourceId": "100",
7599#
7600# "fileUri": "s3://bucket/videos/old_file2.mp4"
7601#
7602# }
7603#
7604# ],
7605#
7606# "failed": []
7607#
7608# }
7609#
7610# }
7611# }
7612#
7613# Notes:
7614# - sourceId and at least one fileUri are required
7615# - Returns IngestSlugKey objects (composite key with sourceId and fileUri) for
7616# each successfully deleted slug
7617# - Failures occur if slug not found or on database error
7618# - sourceId is validated to belong to the user's organization from authorization
7619# context
7620ingestSlugsDelete(sourceId: ID!, fileUris: [String!]!): IngestSlugsDeleteResult
7621
7622# Delete all ingest slug records for a source.
7623#
7624# Removes all ingest slug records associated with a specific source. This
7625# operation
7626# is performed asynchronously and may take time for sources with many records.
7627# A IngestSlugsDeleteBySource event is emitted and the operation is queued for
7628# processing.
7629# The sourceId is scoped to the user's organization from their authorization
7630# context.
7631#
7632# Requires scope: superadmin OR aiware.slug.delete
7633#
7634# Example:
7635# mutation {
7636#
7637# ingestSlugsDeleteForSource(
7638#
7639# sourceId: "100"
7640#
7641# ) {
7642#
7643# message
7644#
7645# submitted
7646#
7647# }
7648# }
7649#
7650# Response:
7651# {
7652#
7653# "data": {
7654#
7655# "ingestSlugsDeleteForSource": {
7656#
7657# "message": "Deletion request submitted for source 100. Processing
7658# asynchronously.",
7659#
7660# "submitted": true
7661#
7662# }
7663#
7664# }
7665# }
7666#
7667# Notes:
7668# - This operation removes ALL ingest slugs for the source (use with caution)
7669# - The deletion is processed asynchronously in the background
7670# - sourceId is validated to belong to the user's organization from authorization
7671# context
7672ingestSlugsDeleteForSource(sourceId: ID!): IngestSlugsDeleteForSourceResult!
7673
7674# Create a new processing project.
7675processingProjectCreate(input: ProcessingProjectInput!): ProcessingProject!
7676
7677# Delete a processing project by ID.
7678processingProjectDelete(id: ID!): DeletePayload!
7679
7680# Create a new processing deliverable.
7681processingDeliverableCreate(
7682input: ProcessingDeliverableInput!
7683): ProcessingDeliverable!
7684
7685# Cancel a processing deliverable by ID.
7686processingDeliverableCancel(
7687id: ID!,
7688projectId: ID!,
7689message: String
7690): ProcessingDeliverable!
7691
7692}

link Required by

This element is not required by anyone