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

link Required by

This element is not required by anyone