OBJECT

Mutation

Mutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.

link GraphQL Schema definition

1type Mutation {
2
3# Create a new temporal data object
4# Example:
5# Request:
6# mutation {
7#
8# createTDO(input: {
9#
10# startDateTime: 1623253937,
11#
12# stopDateTime: 1623259000,
13#
14# source: "123",
15#
16# name: "example",
17#
18# description: "example",
19#
20# isPublic: false,
21#
22# applicationId: "123"}) {
23#
24# id
25#
26# name
27#
28# }
29# }
30# Response:
31# {
32#
33# "data": {
34#
35# "createTDO": {
36#
37# "id": "1570654874",
38#
39# "name": "example"
40#
41# }
42#
43# }
44# }
45#
46# Arguments
47# input: Fields required to create a TDO
48createTDO(input: CreateTDO): TemporalDataObject
49
50# Update a temporal data object
51# Example:
52# Request:
53# mutation {
54#
55# updateTDO(input:{
56#
57# id: "1570654874",
58#
59# status: "example",
60#
61# name: "example"}) {
62#
63# id
64#
65# name
66#
67# description
68#
69# }
70# }
71# Result:
72# {
73#
74# "data": {
75#
76# "updateTDO": {
77#
78# "id": "1570654874",
79#
80# "name": "example",
81#
82# "description": null
83#
84# }
85#
86# }
87# }
88#
89# Arguments
90# input: Fields required to update a TDO
91updateTDO(input: UpdateTDO): TemporalDataObject
92
93# Delete a temporal data object. The TDO metadata, its assets and
94# all storage objects, and search index data are deleted.
95# Engine results stored in related task objects are not.
96# cleanupTDO can be used to selectively delete certain data on the TDO.
97# Example:
98# Request:
99# mutation {
100#
101# deleteTDO(
102#
103# id: "1570654874") {
104#
105# id
106#
107# message
108#
109# }
110# }
111# Response:
112#
113# {
114#
115# "data": {
116#
117# "deleteTDO": {
118#
119# "id": "1570654874",
120#
121# "message": "TemporalDataObject 1570654874 and all associated asset content was
122# deleted."
123#
124# }
125#
126# }
127# }
128#
129# Arguments
130# id: Supply the ID of the TDO to delete
131deleteTDO(id: ID!): DeletePayload
132
133# Delete partial information from a temporal data object.
134# Use the delete options to control exactly which data is deleted.
135# The default is to delete objects from storage and the search index,
136# while leaving TDO-level metadata and task engine results intact.
137# To permanently delete the TDO, use delete TDO.
138# Example:
139# Request:
140# mutation {
141#
142# cleanupTDO(
143#
144# id: "1570705980") {
145#
146# id
147#
148# message
149#
150# }
151# }
152# Response:
153# {
154#
155# "data": {
156#
157# "cleanupTDO": {
158#
159# "id": "1570705980",
160#
161# "message": null
162#
163# }
164#
165# }
166# }
167#
168# Arguments
169# id: Supply the ID of the TDO to clean up.
170# options: Supply a list of cleanup options. See TDOCleanupOption
171# for details. If not provided, the server will use default settings.
172cleanupTDO(id: ID!, options: [TDOCleanupOption!]): DeletePayload
173
174# Create a task log by using
175# multipart form POST.
176#
177# Arguments
178# input: Fields needed to create a task log.
179createTaskLog(input: CreateTaskLog!): TaskLog
180
181# Create a media asset. Optionally, upload content using
182# multipart form POST.
183# example:
184# Request:
185# mutation {
186#
187# createAsset(input: {
188#
189# containerId: "1570654874",
190#
191# contentType: "application/json",
192#
193# description: "example",
194#
195# file: null,
196#
197# assetType: "text",
198#
199# uri: "example"
200#
201# name: "example"}) {
202#
203# id
204#
205# name
206#
207# description
208#
209# }
210# }
211# Response:
212# {
213#
214# "data": {
215#
216# "createAsset": {
217#
218# "id": "1570654874_4hJtNKSUXD",
219#
220# "name": "example",
221#
222# "description": "example"
223#
224# }
225#
226# }
227# }
228#
229# Arguments
230# input: Fields needed to create an asset.
231createAsset(input: CreateAsset!): Asset
232
233# Delete an asset
234# Example:
235# Request:
236# mutation {
237#
238# deleteAsset(
239#
240# id: "1570705980_w4ZLCPU7Dk") {
241#
242# id
243#
244# message
245#
246# }
247# }
248# Response:
249# {
250#
251# "data": {
252#
253# "deleteAsset": {
254#
255# "id": "1570705980_w4ZLCPU7Dk",
256#
257# "message": "No storage objects deleted for example"
258#
259# }
260#
261# }
262# }
263#
264# Arguments
265# id: Provide the ID of the asset to delete.
266deleteAsset(id: ID!): DeletePayload
267
268# Update an asset
269# Example:
270# Request:
271# mutation {
272#
273# updateAsset(input: {
274#
275# id: "1570705980_w4ZLCPU7Dk",
276#
277# description: "example",
278#
279# name: "example",
280#
281# fileData: null,
282#
283# sourceData: null,
284#
285# details: null}) {
286#
287# id
288#
289# name
290#
291# contentType
292#
293# }
294# }
295# Result:
296# {
297#
298# "data": {
299#
300# "updateAsset": {
301#
302# "id": "1570705980_w4ZLCPU7Dk",
303#
304# "name": "example",
305#
306# "contentType": "application/json"
307#
308# }
309#
310# }
311# }
312#
313# Arguments
314# input: Fields needed to update an asset.
315updateAsset(input: UpdateAsset!): Asset
316
317# Add a single media segment to a TemporalDataObject.
318# This mutation will update the manifest asset (`media-mdp`)
319# for the TemporalDataObject.
320# Example:
321# Request:
322# mutation {
323#
324# addMediaSegment(input: {
325#
326# containerId: "1570705980",
327#
328# details: [],
329#
330# url:
331# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg",
332#
333# segmentGroupId: "123"}) {
334#
335# id
336#
337# name
338#
339# createdBy
340#
341# }
342# }
343# Response:
344# {
345#
346# "data": {
347#
348# "addMediaSegment": {
349#
350# "id": "1570705980",
351#
352# "name": "example",
353#
354# "createdBy": null
355#
356# }
357#
358# }
359# }
360#
361# Arguments
362# input: Fields necesary to create the segment.
363addMediaSegment(input: AddMediaSegment!): TemporalDataObject!
364
365# Add a media segments to a TemporalDataObject.
366# This mutation will update the manifest asset (`media-mdp`)
367# for the TemporalDataObject.
368# Example:
369# Request:
370# mutation {
371#
372# addMediaSegments(
373#
374# containerId: "1570705980",
375#
376# segments: [
377#
378# {
379#
380# details: [],
381#
382# url:
383# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg",
384#
385# },
386#
387# {
388#
389# details: [],
390#
391# url:
392# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
393#
394# }
395#
396# ]
397#
398# segmentGroupId: "123") {
399#
400# id
401#
402# name
403#
404#
405# }
406# }
407# Response:
408# {
409#
410# "data": {
411#
412# "addMediaSegments": {
413#
414# "id": "1570705980",
415#
416# "name": "example"
417#
418# }
419#
420# }
421# }
422#
423# Arguments
424# containerId: ID of the TemporalDataObject container for the
425# segment
426# segments: Fields necesary to create the segment.
427# segmentGroupId: ID of the segment group (Optional)
428addMediaSegments(
429containerId: ID!,
430segments: [AddMediaSegments]!,
431segmentGroupId: ID
432): TemporalDataObject!
433
434# Start a clone job. A clone creates a new TDO
435# that links back to an existing TDO's assets
436# instead of creating new ones and is used
437# primarily to handle sample media.
438# Only for internal platform components.
439# Example:
440# Request:
441# mutation {
442#
443# requestClone(input: {
444#
445# sourceApplicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a",
446#
447# destinationApplicationId:"5908703b-51b4-4291-9787-b54bada73b0a",
448#
449# cloneBlobs: true}) {
450#
451# id
452#
453# status
454#
455# }
456# }
457# Response:
458# {
459#
460# "data": {
461#
462# "requestClone": null
463#
464# }
465# }
466#
467# Arguments
468# input: Fields needed to request a new clone job.
469requestClone(input: RequestClone): CloneRequest
470
471# Create a new engine. The engine will need to go
472# through a sequence of workflow steps before
473# use in production. See VDA documentation for details.
474# Example:
475# Request:
476# mutation {
477#
478# createEngine(input: {
479#
480# id: "123",
481#
482# name: "example",
483#
484# categoryId: "581dbb32-ea5b-4458-bd15-8094942345e3",
485#
486# deploymentModel: FullyNetworkIsolated
487#
488# useCases: [],
489#
490# industries: []}) {
491#
492# id
493#
494# ownerOrganizationId
495#
496# }
497# }
498# Response:
499# {
500#
501# "data": {
502#
503# "createEngine": {
504#
505# "id": "123",
506#
507# "ownerOrganizationId": "35521"
508#
509# }
510#
511# }
512# }
513#
514# Arguments
515# input: Fields needed to create a new engine
516createEngine(input: CreateEngine): Engine
517
518# Update an engine. Engines are subject to specific
519# workflow steps. An engine's state determines what
520# updates can be made to it. See VDA documentation for
521# details.
522# Example:
523# Request:
524# mutation {
525#
526# updateEngine(input: {
527#
528# id:"123",
529#
530# isPublic: false,
531#
532# name: "example",
533#
534# deploymentModel: FullyNetworkIsolated,
535#
536# price: 1}) {
537#
538# id
539#
540# ownerOrganizationId
541#
542# name
543#
544# price
545#
546# }
547# }
548# Response:
549# {
550#
551# "data": {
552#
553# "updateEngine": {
554#
555# "id": "123",
556#
557# "ownerOrganizationId": "35521",
558#
559# "name": "example",
560#
561# "price": 1
562#
563# }
564#
565# }
566# }
567#
568# Arguments
569# input: Fields needed to update an engine
570updateEngine(input: UpdateEngine): Engine
571
572# Delete an engine
573# Example:
574# Request:
575# mutation {
576#
577# deleteEngine(
578#
579# id: "123") {
580#
581# id
582#
583# message
584#
585# }
586# }
587# Response:
588# {
589#
590# "data": {
591#
592# "deleteEngine": {
593#
594# "id": "123",
595#
596# "message": "engine 123 deleted"
597#
598# }
599#
600# }
601# }
602#
603# Arguments
604# id: Provide the ID of the engine to delete
605deleteEngine(id: ID!): DeletePayload
606
607# Create an engine build.
608# Example:
609# Request:
610#
611# mutation {
612#
613# createEngineBuild(input: {
614#
615# engineId: "1",
616#
617# taskRuntime: [],
618#
619# dockerImage: "build",
620#
621# manifest: [] }) {
622#
623# id
624#
625# name
626#
627# engineId
628#
629# }
630#
631# realeaseNotes: "Includes feature x..."
632#
633# }
634#
635# }
636# Response:
637# {
638#
639# "data": {
640#
641# "createEngineBuild": {
642#
643# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
644#
645# "name": "example Version 1",
646#
647# "engineId": "1",
648#
649# "releaseNotes": "Includes feature x..."
650#
651# }
652#
653# }
654# }
655#
656# Arguments
657# input: Fields needed to create an engine build.
658createEngineBuild(input: CreateBuild!): Build
659
660# Update an engine build. Engine builds are subject to
661# specific workflow steps. A build's state determines what
662# updates can be made to it. See VDA documentation for details.
663# Example:
664# Request:
665# mutation {
666#
667# updateEngineBuild(input: {
668#
669# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
670#
671# engineId: "1",
672#
673# action: update,
674#
675# taskRuntime: []}) {
676#
677# id
678#
679# name
680#
681# }
682#
683# releaseNotes: "Includes feature x..."
684#
685# }
686# }
687# Response:
688# {
689#
690# "data": {
691#
692# "updateEngineBuild": {
693#
694# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
695#
696# "name": "example Version 3"
697#
698# "releaseNotes": "Includes feature x..."
699#
700# }
701#
702# }
703# }
704#
705# Arguments
706# input: Fields needed to update an engine build.
707updateEngineBuild(input: UpdateBuild!): Build
708
709# Delete an engine build
710# Example:
711# Request:
712# mutation {
713#
714# deleteEngineBuild(input: {
715#
716# id: "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
717#
718# engineId: "1"}) {
719#
720# id
721#
722# message
723#
724# }
725# }
726# Response:
727# {
728#
729# "data": {
730#
731# "deleteEngineBuild": {
732#
733# "id": "6f766576-03a9-42c4-8a96-f4cd932e7c6c",
734#
735# "message": "Engine build 6f766576-03a9-42c4-8a96-f4cd932e7c6c deleted"
736#
737# }
738#
739# }
740# }
741#
742# Arguments
743# input: Fields needed to delete an engine build.
744deleteEngineBuild(input: DeleteBuild!): DeletePayload
745
746# Update a task
747#
748# Arguments
749# input: Fields required to update a task.
750updateTask(input: UpdateTask): Task
751
752# Arguments
753# reason: Short string describing the warning
754# message: Optional: the actual problem
755# referenceId: Optional: Reference ID for the warning, such as
756# assetId, or sourceId
757appendWarningToTask(
758taskId: ID,
759reason: String!,
760message: String,
761referenceId: ID
762): ID
763
764addTasksToJobs(input: AddTasksToJobs): AddTasksToJobsResponse
765
766# Create a job
767#
768# Arguments
769# input: Fields required to create a job.
770createJob(input: CreateJob): Job
771
772# Cancel a job. This action effectively deletes the job,
773# although a records of job and task execution remains in
774# Veritone's database.
775#
776# Arguments
777# id: Supply the ID of the job to delete.
778cancelJob(id: ID!): DeletePayload
779
780# Retry a job. This action applies only to jobs
781# that are in a failure state. The task sequence
782# for the job will be restarted in its original
783# configuration.
784#
785# Arguments
786# id: Supply the ID of the job to retry.
787retryJob(id: ID!): Job
788
789# Create and launch a job executing a single engine,
790# using the default engine DAG definition modified with the
791# supplied field values
792launchSingleEngineJob(input: SingleEngineJobInput!): Job
793
794updateJobs(input: UpdateJobs!): JobList
795
796# Create a new application. An application must
797# go through a sequence of workflow steps before
798# it is available in production. See the VDA documentation
799# for details.
800# Example:
801# Request:
802# mutation {
803#
804# createApplication(input: {
805#
806# name: "example123",
807#
808# key: "example123",
809#
810# category: "example",
811#
812# url: "www.veritone.com",
813#
814# checkPermissions: true}) {
815#
816# id
817#
818# name
819#
820# }
821# }
822# Response:
823# {
824#
825# "data": {
826#
827# "createApplication": {
828#
829# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
830#
831# "name": "example123"
832#
833# }
834#
835# }
836# }
837#
838# Arguments
839# input: Fields needed to create a new custom application.
840createApplication(input: CreateApplication): Application
841
842# Delete an application
843# Example:
844# Request:
845# mutation {
846#
847# deleteApplication(
848#
849# id: "7e863365-94de-4ac9-8826-df1a398c9a21") {
850#
851# id
852#
853# message
854#
855# }
856# }
857# Response:
858# {
859#
860# "data": {
861#
862# "deleteApplication": {
863#
864# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
865#
866# "message": null
867#
868# }
869#
870# }
871# }
872#
873# Arguments
874# id: Supply the ID of the application to delete.
875deleteApplication(id: ID!): DeletePayload
876
877# Update a custom application. Applications are subject to
878# specific workflows. The current application state determines
879# what updates can be made to it. See VDA documentation for details.
880# Example:
881# Request:
882# mutation {
883#
884# updateApplication(input: {
885#
886# name: "example123",
887#
888# id: "7e863365-94de-4ac9-8826-df1a398c9a21"
889#
890# category: "example",
891#
892# url: "www.veritone.com",
893#
894# checkPermissions: true,
895#
896# oauth2RedirectUrls: [],
897#
898# permissionsRequired: []}) {
899#
900# id
901#
902# name
903#
904# url
905#
906# }
907# }
908# Response:
909# {
910#
911# "data": {
912#
913# "updateApplication": {
914#
915# "id": "7e863365-94de-4ac9-8826-df1a398c9a21",
916#
917# "name": "example123",
918#
919# "url": "www.veritone.com"
920#
921# }
922#
923# }
924# }
925#
926# Arguments
927# input: Fields required to update a custom application.
928updateApplication(input: UpdateApplication): Application
929
930# Update an application by adding or removing components
931# Example:
932# Request:
933# mutation {
934#
935# updateApplicationComponent(input: {
936#
937# id: "5908703b-51b4-4291-9787-b54bada73b0a",
938#
939# componentIds: ["1"],
940#
941# type: engines,
942#
943# action: add}) {
944#
945# engines{
946#
947# records{
948#
949# id
950#
951# }
952#
953# }
954#
955# }
956# }
957# Response:
958# {
959#
960# "data": {
961#
962# "updateApplicationComponent": {
963#
964# "engines": {
965#
966# "records": [
967#
968# {
969#
970# "id": "1"
971#
972# }
973#
974# ]
975#
976# }
977#
978# }
979#
980# }
981# }
982updateApplicationComponent(
983input: UpdateApplicationComponent!
984): ApplicationComponent!
985
986# Update an application's billing plan id for an organization.
987# Example:
988# Request:
989# mutation {
990#
991# updateApplicationBillingPlanId(
992#
993# applicationId:"32babe30-fb42-11e4-89bc-27b69865858a",
994#
995# organizationId: "35521",
996#
997# billingPlanId: "123") {
998#
999# applicationId
1000#
1001# billingDirty
1002#
1003# }
1004# }
1005# Response:
1006# {
1007#
1008# "data": {
1009#
1010# "updateApplicationBillingPlanId": {
1011#
1012# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1013#
1014# "billingDirty": true
1015#
1016# }
1017#
1018# }
1019# }
1020updateApplicationBillingPlanId(
1021applicationId: ID!,
1022organizationId: ID!,
1023billingPlanId: String!
1024): ApplicationBillingPlanId!
1025
1026# Update an application's billing dirty for an organization.
1027# Example:
1028# Request:
1029# mutation {
1030#
1031# updateApplicationBillingDirty(
1032#
1033# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a",
1034#
1035# organizationId: "35521",
1036#
1037# billingDirty: false) {
1038#
1039# applicationId
1040#
1041# billingDirty
1042#
1043# }
1044# }
1045# Response:
1046# {
1047#
1048# "data": {
1049#
1050# "updateApplicationBillingDirty": {
1051#
1052# "applicationId": "32babe30-fb42-11e4-89bc-27b69865858a",
1053#
1054# "billingDirty": false
1055#
1056# }
1057#
1058# }
1059# }
1060updateApplicationBillingDirty(
1061applicationId: ID!,
1062organizationId: ID!,
1063billingDirty: Boolean!
1064): ApplicationBillingDirty!
1065
1066# Bulk delete context menu extensions.
1067# Example:
1068# Request:
1069# mutation {
1070#
1071# bulkDeleteContextMenuExtensions(input: {
1072#
1073# ids: []}) {
1074#
1075# mentions{
1076#
1077# id
1078#
1079# }
1080#
1081# }
1082# }
1083# Response:
1084# {
1085#
1086# "data": {
1087#
1088# "bulkDeleteContextMenuExtensions": {
1089#
1090# "mentions": []
1091#
1092# }
1093#
1094# }
1095# }
1096bulkDeleteContextMenuExtensions(
1097input: BulkDeleteContextMenuExtensions
1098): ContextMenuExtensionList
1099
1100# Update an organization
1101# Example:
1102# Request:
1103# mutation {
1104#
1105# updateOrganization(input: {
1106#
1107# id: "35521",
1108#
1109# indexTDOsByDefault: true}) {
1110#
1111# id
1112#
1113# status
1114#
1115# }
1116# }
1117# Response:
1118# {
1119#
1120# "data": {
1121#
1122# "updateOrganization": {
1123#
1124# "id": "35521",
1125#
1126# "status": "active"
1127#
1128# }
1129#
1130# }
1131# }
1132#
1133# Arguments
1134# input: Fields required to update an organization.
1135updateOrganization(input: UpdateOrganization!): Organization
1136
1137# Update organization billing policy. Requires superadmin
1138#
1139# Arguments
1140# planId: External billing plan id.
1141# targetOrganizationId: Optional organization id, to use when the
1142# caller is a superadmin from a different org
1143updateOrganizationBilling(
1144planId: String!,
1145targetOrganizationId: ID
1146): OrganizationBilling
1147
1148addToEngineWhitelist(toAdd: SetEngineWhitelist!): EngineWhitelist
1149
1150addToEngineBlacklist(toAdd: SetEngineBlacklist!): EngineBlacklist
1151
1152deleteFromEngineBlacklist(
1153toDelete: SetEngineBlacklist!
1154): EngineBlacklist
1155
1156deleteFromEngineWhitelist(
1157toDelete: SetEngineBlacklist!
1158): EngineWhitelist
1159
1160# Create an entity identifier type, such as "face" or "image".
1161# Entity identifier types are typically created or modified
1162# only by Veritone engineering. Most libraries and
1163# entities will use existing entity identifier types.
1164# Example:
1165# Request:
1166# mutation {
1167#
1168# createEntityIdentifierType(input: {
1169#
1170# label: "example"
1171#
1172# labelPlural: "example"
1173#
1174# iconClass: null
1175#
1176# description: "example"
1177#
1178# dataType: text
1179#
1180# id: "123"}) {
1181#
1182# id
1183#
1184# description
1185#
1186# }
1187# }
1188# Response:
1189# {
1190#
1191# "data": {
1192#
1193# "createEntityIdentifierType": {
1194#
1195# "id": "123",
1196#
1197# "description": null
1198#
1199# }
1200#
1201# }
1202# }
1203#
1204# Arguments
1205# input: Fields required to create an entity identifier type.
1206createEntityIdentifierType(
1207input: CreateEntityIdentifierType!
1208): EntityIdentifierType
1209
1210# Update an entity identifier type.
1211# Example:
1212# Request:
1213# mutation {
1214#
1215# updateEntityIdentifierType(input: {
1216#
1217# id: "123",
1218#
1219# label: "example",
1220#
1221# labelPlural: "example"
1222#
1223# description: "new description",
1224#
1225# dataType: image}) {
1226#
1227# id
1228#
1229# description
1230#
1231# }
1232# }
1233# Response:
1234# {
1235#
1236# "data": {
1237#
1238# "updateEntityIdentifierType": null
1239#
1240# }
1241# }
1242#
1243# Arguments
1244# input: Fields required to update an entity identifier type.
1245updateEntityIdentifierType(
1246input: UpdateEntityIdentifierType!
1247): EntityIdentifierType
1248
1249# Create a library type, such as "ad" or "people".
1250# Entity identifier types are typically created or modified
1251# only by Veritone engineering. Most libraries
1252# will use existing entity identifier types.
1253# Example:
1254# Request:
1255# mutation {
1256#
1257# createLibraryType(input: {
1258#
1259# id: "123",
1260#
1261# label: "example",
1262#
1263# entityIdentifierTypeIds: ["123"],
1264#
1265# entityType: {
1266#
1267# name: "example",
1268#
1269# namePlural: "example",
1270#
1271# schema: {
1272#
1273# example: "example" }}}) {
1274#
1275# id
1276#
1277# label
1278#
1279# }
1280# }
1281# Response:
1282# {
1283#
1284# "data": {
1285#
1286# "createLibraryType": {
1287#
1288# "id": "123",
1289#
1290# "label": "example"
1291#
1292# }
1293#
1294# }
1295# }
1296#
1297# Arguments
1298# input: Fields needed to create a new library type.
1299createLibraryType(input: CreateLibraryType!): LibraryType
1300
1301# Update a library type.
1302# Example:
1303# Request:
1304# mutation {
1305#
1306# updateLibraryType(input: {
1307#
1308# id: "123",
1309#
1310# label: "example",
1311#
1312# entityIdentifierTypeIds: ["123"],
1313#
1314# entityType: {
1315#
1316# name: "example",
1317#
1318# namePlural: "example",
1319#
1320# schema: {
1321#
1322# example: "new example" }}}) {
1323#
1324# id
1325#
1326# label
1327#
1328# }
1329# }
1330# Response:
1331# {
1332#
1333# "data": {
1334#
1335# "updateLibraryType": null
1336#
1337# }
1338# }
1339#
1340# Arguments
1341# input: Fields needed to update a library type.
1342updateLibraryType(input: UpdateLibraryType!): LibraryType
1343
1344# Create a new library.
1345# Once the library is created, the client can add
1346# entities and entity identifiers. Note that the
1347# library type determines what types of entity identifiers
1348# can be used within the library.
1349# Example:
1350# Request:
1351# mutation {
1352#
1353# createLibrary(input: {
1354#
1355# name: "example"
1356#
1357# applicationId: "32babe30-fb42-11e4-89bc-27b69865858a"
1358#
1359# organizationId: "35521"
1360#
1361# libraryTypeId: "123"
1362#
1363# coverImageUrl:
1364# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1365#
1366# description: "example"}) {
1367#
1368# id
1369#
1370# name
1371#
1372# }
1373# }
1374# Response:
1375# {
1376#
1377# "data": {
1378#
1379# "createLibrary": {
1380#
1381# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1382#
1383# "name": "example"
1384#
1385# }
1386#
1387# }
1388# }
1389#
1390# Arguments
1391# input: Fields needed to create a new library.
1392createLibrary(input: CreateLibrary!): Library
1393
1394# Update an existing library.
1395# Example:
1396# Request:
1397# mutation {
1398#
1399# updateLibrary(input: {
1400#
1401# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1402#
1403# name: "example"
1404#
1405# coverImageUrl:
1406# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"
1407#
1408# description: "new description"
1409#
1410# libraryTypeId: "123"
1411#
1412# version: 2}) {
1413#
1414# id
1415#
1416# name
1417#
1418# description
1419#
1420# }
1421# }
1422# Response:
1423# {
1424#
1425# "data": {
1426#
1427# "updateLibrary": {
1428#
1429# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1430#
1431# "name": "example",
1432#
1433# "description": "new description"
1434#
1435# }
1436#
1437# }
1438# }
1439#
1440# Arguments
1441# input: Fields needed to update a library
1442updateLibrary(input: UpdateLibrary!): Library
1443
1444# Delete a library. This mutation will also delete all entities,
1445# entity identifiers, library engine models, and associated objects.
1446# Example:
1447# Request:
1448# mutation {
1449#
1450# deleteLibrary(id:"d232c90f-ae47-4125-b884-0d35fbed7e5f") {
1451#
1452# message
1453#
1454# }
1455# }
1456# Response:
1457# {
1458#
1459# "data": {
1460#
1461# "deleteLibrary": {
1462#
1463# "message": "d232c90f-ae47-4125-b884-0d35fbed7e5f deleted"
1464#
1465# }
1466#
1467# }
1468# }
1469#
1470# Arguments
1471# id: Provide the ID of the library to delete.
1472deleteLibrary(id: ID!): DeletePayload
1473
1474# Publish a new version of a library.
1475# Increments library version by one and trains compatible engines.
1476# Example:
1477# Request:
1478# mutation {
1479#
1480# publishLibrary(
1481#
1482# id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1483#
1484# name
1485#
1486# description
1487#
1488# version
1489#
1490# }
1491# }
1492# Response:
1493# {
1494#
1495# "data": {
1496#
1497# "publishLibrary": {
1498#
1499# "name": "example",
1500#
1501# "description": "new description",
1502#
1503# "version": 2
1504#
1505# }
1506#
1507# }
1508# }
1509#
1510# Arguments
1511# id: ID of the library to publish
1512publishLibrary(id: ID!): Library
1513
1514# Create a new entity.
1515# Example:
1516# Request:
1517# mutation {
1518#
1519# createEntity(input: {
1520#
1521# name: "example",
1522#
1523# description: "example",
1524#
1525# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1526#
1527# jsondata: {
1528#
1529# example: "new example" }}) {
1530#
1531# id
1532#
1533# name
1534#
1535# }
1536# }
1537# Response:
1538# {
1539#
1540# "data": {
1541#
1542# "createEntity": {
1543#
1544# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1545#
1546# "name": "example"
1547#
1548# }
1549#
1550# }
1551# }
1552#
1553# Arguments
1554# input: Fields required to create a new entity.
1555createEntity(input: CreateEntity!): Entity
1556
1557# Update an entity.
1558# Example:
1559# Request:
1560# mutation {
1561#
1562# updateEntity(input: {
1563#
1564# id: "85b700fa-f327-4fea-b94b-ed83054170db",
1565#
1566# name: "example",
1567#
1568# description: "example",
1569#
1570# jsondata: {
1571#
1572# example: "updated example" }}) {
1573#
1574# id
1575#
1576# name
1577#
1578# jsondata
1579#
1580# }
1581# }
1582# Response:
1583# {
1584#
1585# "data": {
1586#
1587# "updateEntity": {
1588#
1589# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1590#
1591# "name": "example",
1592#
1593# "jsondata": {
1594#
1595# "example": "updated example"
1596#
1597# }
1598#
1599# }
1600#
1601# }
1602# }
1603#
1604# Arguments
1605# input: Fields required to update an entity.
1606updateEntity(input: UpdateEntity!): Entity
1607
1608# Delete an entity. This mutation will also delete all associated
1609# entity identifiers and associated objects.
1610# Example:
1611# Request:
1612# mutation {
1613#
1614# deleteEntity(id: "522bc6cf-5b7c-47bd-bd30-10cd77016a49") {
1615#
1616# message
1617#
1618# }
1619# }
1620# Response:
1621# {
1622#
1623# "data": {
1624#
1625# "deleteEntity": {
1626#
1627# "message": "Entity 522bc6cf-5b7c-47bd-bd30-10cd77016a49 deleted."
1628#
1629# }
1630#
1631# }
1632# }
1633#
1634# Arguments
1635# id: Supply the ID of the entity to delete.
1636deleteEntity(id: ID!): DeletePayload
1637
1638# Create an entity identifier.
1639# This mutation accepts file uploads. To use this mutation and upload a file,
1640# send a multipart form POST containing two parameters: `query`, with the
1641# GraphQL query, and `file` containing the file itself.
1642# For more information see the documentation at
1643# https://veritone-developer.atlassian.net/wiki/spaces/DOC/pages/13893791/GraphQL.
1644# Example:
1645# Request:
1646# mutation {
1647#
1648# createEntityIdentifier(input: {
1649#
1650# entityId: "85b700fa-f327-4fea-b94b-ed83054170db",
1651#
1652# identifierTypeId: "123",
1653#
1654# title: "example",
1655#
1656# isPriority: false,
1657#
1658# contentType: "example",
1659#
1660# url:
1661# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1662# {
1663#
1664# id
1665#
1666# isPriority
1667#
1668# }
1669# }
1670# Result:
1671# {
1672#
1673# "data": {
1674#
1675# "createEntityIdentifier": {
1676#
1677# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1678#
1679# "isPriority": false,
1680#
1681# }
1682#
1683# }
1684# }
1685#
1686# Arguments
1687# input: Fields needed to create an entity identifier.
1688createEntityIdentifier(input: CreateEntityIdentifier!): EntityIdentifier
1689
1690# Updates an entity identifier.
1691# Example:
1692# Request:
1693# mutation {
1694#
1695# updateEntityIdentifier(input: {
1696#
1697# id: "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1698#
1699# title: "example",
1700#
1701# isPriority: true,
1702#
1703# url:
1704# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1705# {
1706#
1707# id
1708#
1709# isPriority
1710#
1711# }
1712# }
1713# Response:
1714# {
1715#
1716# "data": {
1717#
1718# "updateEntityIdentifier": {
1719#
1720# "id": "bf67e595-3666-4a0c-9f4b-0ad99a1770fe",
1721#
1722# "isPriority": true
1723#
1724# }
1725#
1726# }
1727# }
1728#
1729# Arguments
1730# input: Fields required to update an entity identifier.
1731updateEntityIdentifier(input: UpdateEntityIdentifier!): EntityIdentifier
1732
1733# Delete an entity identifier
1734# Example:
1735# Request:
1736# mutation {
1737#
1738# deleteEntityIdentifier(id: "0bda9fa6-9fad-4025-8f03-07cc73321050") {
1739#
1740# message
1741#
1742# }
1743# }
1744# Response:
1745# {
1746#
1747# "data": {
1748#
1749# "deleteEntityIdentifier": {
1750#
1751# "message": "Entity identifier0bda9fa6-9fad-4025-8f03-07cc73321050 deleted."
1752#
1753# }
1754#
1755# }
1756# }
1757#
1758# Arguments
1759# id: Supply the ID of the entity identifier to delete.
1760deleteEntityIdentifier(id: ID!): DeletePayload
1761
1762# Create a library engine model.
1763# Example:
1764# Request:
1765# mutation {
1766#
1767# createLibraryEngineModel(input: {
1768#
1769# engineId: "1",
1770#
1771# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1772#
1773# trainJobId: "123",
1774#
1775# dataUrl:
1776# "https://edit.co.uk/uploads/2016/12/Image-1-Alternatives-to-stock-photography-Thinkstock.jpg"})
1777# {
1778#
1779# id
1780#
1781# engineId
1782#
1783# }
1784# }
1785# Response:
1786# {
1787#
1788# "data": {
1789#
1790# "createLibraryEngineModel": {
1791#
1792# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1793#
1794# "engineId": "1"
1795#
1796# }
1797#
1798# }
1799# }
1800#
1801# Arguments
1802# input: Fields required to create a library engine model.
1803createLibraryEngineModel(
1804input: CreateLibraryEngineModel!
1805): LibraryEngineModel
1806
1807# Update a library engine model
1808# Example:
1809# Request:
1810# mutation {
1811#
1812# updateLibraryEngineModel(input: {
1813#
1814# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1815#
1816# trainJobId: "1234"}) {
1817#
1818# trainJobId
1819#
1820# }
1821# }
1822# Response:
1823# {
1824#
1825# "data": {
1826#
1827# "updateLibraryEngineModel": {
1828#
1829# "trainJobId": "1234"
1830#
1831# }
1832#
1833# }
1834# }
1835#
1836# Arguments
1837# input: Fields required to update a library engine model
1838updateLibraryEngineModel(
1839input: UpdateLibraryEngineModel!
1840): LibraryEngineModel
1841
1842# Delete a library engine model
1843# Example:
1844# Request:
1845# mutation {
1846#
1847# deleteLibraryEngineModel(
1848#
1849# id: "0e9c25f7-d994-4363-af41-c00b37de9a1b") {
1850#
1851# id
1852#
1853# message
1854#
1855# }
1856# }
1857# Response:
1858# {
1859#
1860# "data": {
1861#
1862# "deleteLibraryEngineModel": {
1863#
1864# "id": "0e9c25f7-d994-4363-af41-c00b37de9a1b",
1865#
1866# "message": "library engine model 0e9c25f7-d994-4363-af41-c00b37de9a1b deleted."
1867#
1868# }
1869#
1870# }
1871# }
1872#
1873# Arguments
1874# id: Supply the ID of the library engine model to delete.
1875deleteLibraryEngineModel(id: ID!): DeletePayload
1876
1877# Create a library collaborator.
1878# Example:
1879# Request:
1880# mutation {
1881#
1882# createLibraryCollaborator(input: {
1883#
1884# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1885#
1886# organizationId: 35521,
1887#
1888# permissions: ["job.create"]}) {
1889#
1890# organizationId
1891#
1892# status
1893#
1894# }
1895# }
1896# Response:
1897# {
1898#
1899# "data": {
1900#
1901# "createLibraryCollaborator": {
1902#
1903# "organizationId": "35521",
1904#
1905# "status": "active"
1906#
1907# }
1908#
1909# }
1910# }
1911#
1912# Arguments
1913# input: Fields required to create a library collaborator.
1914createLibraryCollaborator(
1915input: CreateLibraryCollaborator!
1916): LibraryCollaborator
1917
1918# Update a library collaborator
1919# Example:
1920# Request:
1921# mutation {
1922#
1923# updateLibraryCollaborator(input: {
1924#
1925# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1926#
1927# organizationId: 35521,
1928#
1929# permissions: ["job.create", "job.read"]}) {
1930#
1931# status
1932#
1933# permissions
1934#
1935# }
1936# }
1937# Response:
1938# {
1939#
1940# "data": {
1941#
1942# "updateLibraryCollaborator": {
1943#
1944# "status": "active",
1945#
1946# "permissions": [
1947#
1948# "job.create"
1949#
1950# ]
1951#
1952# }
1953#
1954# }
1955# }
1956#
1957# Arguments
1958# input: Fields required to update a library collaborator
1959updateLibraryCollaborator(
1960input: UpdateLibraryCollaborator!
1961): LibraryCollaborator
1962
1963# Delete a library collaborator
1964# Example:
1965# Request:
1966# mutation {
1967#
1968# deleteLibraryCollaborator(
1969#
1970# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1971#
1972# organizationId: "35521") {
1973#
1974# id
1975#
1976# message
1977#
1978# }
1979# }
1980# Response:
1981# {
1982#
1983# "data": {
1984#
1985# "deleteLibraryCollaborator": {
1986#
1987# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599 - 35521",
1988#
1989# "message": "library collaborator model libraryId:
1990# e0a6e5ad-dec8-49a1-ad33-3f1194c2e599, organizationId: 35521 deleted."
1991#
1992# }
1993#
1994# }
1995# }
1996#
1997# Arguments
1998# libraryId: Supply the ID of the library collaborator to delete.
1999# organizationId: Supply the ID of the library collaborator to
2000# delete.
2001deleteLibraryCollaborator(
2002libraryId: ID!,
2003organizationId: ID!
2004): DeletePayload
2005
2006# Create Dataset Library Configuration
2007# Example
2008# Request:
2009# mutation {
2010#
2011# createLibraryConfiguration(input: {
2012#
2013# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2014#
2015# engineCategoryId: "c1e5f177-ca10-433a-a155-bb5e4872cf9a",
2016#
2017# targetEngineIds: ["1"],
2018#
2019# confidence: {}}) {
2020#
2021# id
2022#
2023# }
2024# }
2025# Response:
2026# {
2027#
2028# "data": {
2029#
2030# "createLibraryConfiguration": {
2031#
2032# "id": "7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7"
2033#
2034# }
2035#
2036# }
2037# }
2038#
2039# Arguments
2040# input: Fields required to create library configuration
2041createLibraryConfiguration(
2042input: CreateLibraryConfiguration!
2043): LibraryConfiguration
2044
2045# Update Dataset Library Configuration
2046#
2047# Arguments
2048# input: Fields required to create library configuration
2049updateLibraryConfiguration(
2050input: UpdateLibraryConfiguration!
2051): LibraryConfiguration
2052
2053# Delete Dataset Library Configuration
2054#
2055# Arguments
2056# id: Supply configuration ID to delete.
2057deleteLibraryConfiguration(id: ID!): DeletePayload
2058
2059# Add recordings to a dataset library
2060# Example:
2061# Request:
2062# mutation {
2063#
2064# addLibraryDataset(input: {
2065#
2066# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2067#
2068# tdoIds: ["1570899328"]}) {
2069#
2070# tdoIds
2071#
2072# }
2073# }
2074# Response:
2075# {
2076#
2077# "data": {
2078#
2079# "addLibraryDataset": {
2080#
2081# "tdoIds": [
2082#
2083# "1570899328"
2084#
2085# ]
2086#
2087# }
2088#
2089# }
2090# }
2091addLibraryDataset(input: AddLibraryDataset!): LibraryDataset
2092
2093# Remove recordings from a dataset library
2094# Example:
2095# Request:
2096# mutation {
2097#
2098# deleteLibraryDataset(input: {
2099#
2100# libraryId: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
2101#
2102# tdoIds: ["1570899328"]}) {
2103#
2104# tdoIds
2105#
2106# message
2107#
2108# }
2109# }
2110# Response:
2111# {
2112#
2113# "data": {
2114#
2115# "deleteLibraryDataset": {
2116#
2117# "tdoIds": [
2118#
2119# "1570899328"
2120#
2121# ],
2122#
2123# "message": "[1570899328] are removed from e0a6e5ad-dec8-49a1-ad33-3f1194c2e599"
2124#
2125# }
2126#
2127# }
2128# }
2129deleteLibraryDataset(input: DeleteLibraryDataset!): DeleteLibraryDatasetPayload
2130
2131# Apply an application workflow step, such as "submit" or "approve"
2132# Example:
2133# Request:
2134# mutation {
2135#
2136# applicationWorkflow(input: {
2137#
2138# id: "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2139#
2140# action: submit}) {
2141#
2142# id
2143#
2144# name
2145#
2146# }
2147# }
2148# Response:
2149# {
2150#
2151# "data": {
2152#
2153# "applicationWorkflow": {
2154#
2155# "id": "dcc6a08e-1114-43e9-b74a-2b469a32f437",
2156#
2157# "name": "appexamplebill2"
2158#
2159# }
2160#
2161# }
2162# }
2163#
2164# Arguments
2165# input: Fields required to apply a application workflow step
2166applicationWorkflow(input: ApplicationWorkflow): Application
2167
2168# Apply an engine workflow step, such as "submit" or "approve"
2169#
2170# Arguments
2171# input: Fields required to apply a engine workflow step
2172engineWorkflow(input: EngineWorkflow): Engine
2173
2174# Creates a widget associated with a collection
2175# Example:
2176# Request:
2177# mutation {
2178#
2179# createWidget(input:{
2180#
2181# collectionId: "242361",
2182#
2183# name: "example",
2184#
2185# nextButtonColor: "000000"}) {
2186#
2187# id
2188#
2189# name
2190#
2191# }
2192# }
2193# Response:
2194# {
2195#
2196# "data": {
2197#
2198# "createWidget": {
2199#
2200# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2201#
2202# "name": ""
2203#
2204# }
2205#
2206# }
2207# }
2208#
2209# Arguments
2210# input: Fields needed to create a new widget
2211createWidget(input: CreateWidget): Widget
2212
2213# Updates a widget
2214# Example:
2215# Request:
2216# mutation {
2217#
2218# updateWidget(input: {
2219#
2220# id: "fwSwWdRWTm2fdFMoPQDKkg",
2221#
2222# name: "new example name"}) {
2223#
2224# id
2225#
2226# name
2227#
2228# }
2229# }
2230# Response:
2231# {
2232#
2233# "data": {
2234#
2235# "updateWidget": {
2236#
2237# "id": "fwSwWdRWTm2fdFMoPQDKkg",
2238#
2239# "name": "new example name"
2240#
2241# }
2242#
2243# }
2244# }
2245#
2246# Arguments
2247# input: Fields needed to update a widget
2248updateWidget(input: UpdateWidget): Widget
2249
2250# Create a new user within an organization.
2251# Example:
2252# Request:
2253# mutation {
2254#
2255# createUser(input: {
2256#
2257# name: "example",
2258#
2259# password: "example",
2260#
2261# organizationId: "35521"}) {
2262#
2263# id
2264#
2265# }
2266# }
2267# Response:
2268# {
2269#
2270# "data": {
2271#
2272# "createUser": {
2273#
2274# "id": "267de7e1-efb2-444a-a524-210328b78503"
2275#
2276# }
2277#
2278# }
2279# }
2280#
2281# Arguments
2282# input: Fields needed to create a user.
2283createUser(input: CreateUser): User
2284
2285# Create a new organization.
2286#
2287# Arguments
2288# input: Fields needed to create an organization. Requires
2289# superadmin
2290createOrganization(input: CreateOrganization!): Organization
2291
2292# Update an existing user'
2293# Example:
2294# Request:
2295# mutation {
2296#
2297# updateUser(input: {
2298#
2299# id: "267de7e1-efb2-444a-a524-210328b78503",
2300#
2301# firstName: "example",
2302#
2303# lastName: "example"}) {
2304#
2305# firstName
2306#
2307# lastName
2308#
2309# }
2310# }
2311# Response:
2312# {
2313#
2314# "data": {
2315#
2316# "updateUser": {
2317#
2318# "firstName": "example",
2319#
2320# "lastName": "example"
2321#
2322# }
2323#
2324# }
2325# }
2326#
2327# Arguments
2328# input: Fields needed to update a user
2329updateUser(input: UpdateUser): User
2330
2331# Add an existing user to an organization.
2332# One of the user identifiers (userId or userName) has to be specified.
2333#
2334# Arguments
2335# userId: UUID of user
2336# userName: User name to uniquely identify a user
2337# organizationGuid: UUID of organization
2338# roleIds: Role Ids.
2339# priority: Priority of the organization. If not provided, max
2340# priority plus one will be used.
2341addUserToOrganization(
2342userId: ID,
2343userName: String,
2344organizationGuid: ID!,
2345roleIds: [ID],
2346priority: Int
2347): User
2348
2349# Remove an existing user for organization.
2350# One of the user identifiers (userId or userName) has to be specified.
2351# The operation fails if the organization is the last one to which user belongs.
2352#
2353# Arguments
2354# userId: UUID of user
2355# userName: User name to uniquely identify a user
2356# organizationGuid: UUID of organization
2357removeUserFromOrganization(
2358userId: ID,
2359userName: String,
2360organizationGuid: ID!
2361): User
2362
2363# #Switch user to organization
2364#
2365# Arguments
2366# token: User token that should be logout
2367# userName: The user login name -- typically, email address.
2368# organizationGuid: GUID of organization.
2369switchUserToOrganization(
2370token: String!,
2371userName: String!,
2372organizationGuid: ID!
2373): LoginInfo
2374
2375# Force a user to update password on next login.
2376# This mutation is used by administrators.
2377# Example:
2378# Request:
2379# mutation {
2380#
2381# createPasswordUpdateRequest(input: {
2382#
2383# id: "267de7e1-efb2-444a-a524-210328b78503",
2384#
2385# skipPasswordResetEmail: true}) {
2386#
2387# id
2388#
2389# name
2390#
2391# }
2392# }
2393# Response:
2394# {
2395#
2396# "data": {
2397#
2398# "createPasswordUpdateRequest": {
2399#
2400# "id": "267de7e1-efb2-444a-a524-210328b78503",
2401#
2402# "name": "example"
2403#
2404# }
2405#
2406# }
2407# }
2408#
2409# Arguments
2410# input: Fields needed to create a password update request
2411createPasswordUpdateRequest(
2412input: CreatePasswordUpdateRequest
2413): User
2414
2415# Create a password reset request. This mutation is used on behalf
2416# of a user who needs to reset their password. It operates only on
2417# the currently authenicated user (based on the authentication token provided).
2418# Example:
2419# Request:
2420# mutation {
2421#
2422# createPasswordResetRequest(input: {
2423#
2424# userName: "example",
2425#
2426# skipPasswordResetEmail:true}) {
2427#
2428# message
2429#
2430# }
2431# }
2432# Response:
2433# {
2434#
2435# "data": {
2436#
2437# "createPasswordResetRequest": {
2438#
2439# "message": "Reset request issued for example. Email will not be sent."
2440#
2441# }
2442#
2443# }
2444# }
2445createPasswordResetRequest(
2446input: CreatePasswordResetRequest
2447): CreatePasswordResetRequestPayload
2448
2449# Update the current authenticated user
2450# Example:
2451# Request:
2452# mutation {
2453#
2454# updateCurrentUser(input: {
2455#
2456# title: "undefined"}) {
2457#
2458# id
2459#
2460# }
2461# }
2462# Response:
2463# {
2464#
2465# "data": {
2466#
2467# "updateCurrentUser": {
2468#
2469# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008"
2470#
2471# }
2472#
2473# }
2474# }
2475updateCurrentUser(input: UpdateCurrentUser!): User!
2476
2477# Get password token info for current user
2478# Example:
2479# Request:
2480# mutation {
2481#
2482# getCurrentUserPasswordToken(input: {
2483#
2484# password: "Example password"}) {
2485#
2486# passwordToken
2487#
2488# }
2489# }
2490# Response:
2491# {
2492#
2493# "data": {
2494#
2495# "getCurrentUserPasswordToken": {
2496#
2497# "passwordToken": "e4cb86c7-34a4-4a52-b458-3ebbb2cca9c3"
2498#
2499# }
2500#
2501# }
2502# }
2503getCurrentUserPasswordToken(
2504input: GetCurrentUserPasswordToken!
2505): PasswordTokenInfo!
2506
2507# Change the current authenticated user's password
2508#
2509# Arguments
2510# input: Fields needed to change password
2511changePassword(input: ChangePassword!): User
2512
2513# Delete a user
2514# Example:
2515# Request:
2516# mutation {
2517#
2518# deleteUser(
2519#
2520# id: "267de7e1-efb2-444a-a524-210328b78503") {
2521#
2522# message
2523#
2524# }
2525# }
2526# Response:
2527# {
2528#
2529# "data": {
2530#
2531# "deleteUser": {
2532#
2533# "message": null
2534#
2535# }
2536#
2537# }
2538# }
2539#
2540# Arguments
2541# id: Supply the ID of the user to delete.
2542deleteUser(id: ID!): DeletePayload
2543
2544# Create a structured data registry schema metadata.
2545# Example:
2546# Request:
2547# mutation {
2548#
2549# createDataRegistry(input: {
2550#
2551# name: "example",
2552#
2553# description: "example"
2554#
2555# source: "example"}) {
2556#
2557# id
2558#
2559# organizationId
2560#
2561# }
2562# }
2563# Response:
2564# {
2565#
2566# "data": {
2567#
2568# "createDataRegistry": {
2569#
2570# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2571#
2572# "organizationId": "35521"
2573#
2574# }
2575#
2576# }
2577# }
2578createDataRegistry(input: CreateDataRegistry!): DataRegistry
2579
2580# Update a structured data registry schema metadata.
2581# Example:
2582# Request:
2583# mutation {
2584#
2585# updateDataRegistry(input: {
2586#
2587# id: "230f95e4-95c9-47c4-a845-61ca67ad6ba6"
2588#
2589# name: "example"
2590#
2591# description: "example"
2592#
2593# source: "new source"}) {
2594#
2595# id
2596#
2597# source
2598#
2599# }
2600# }
2601# Response:
2602# {
2603#
2604# "data": {
2605#
2606# "updateDataRegistry": {
2607#
2608# "id": "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2609#
2610# "source": "new source"
2611#
2612# }
2613#
2614# }
2615# }
2616updateDataRegistry(input: UpdateDataRegistry!): DataRegistry
2617
2618# Update a structured data registry schema.
2619# Example:
2620# Request:
2621# mutation {
2622#
2623# upsertSchemaDraft(input: {
2624#
2625# dataRegistryId: "230f95e4-95c9-47c4-a845-61ca67ad6ba6",
2626#
2627# schema: {
2628#
2629# example: "example"
2630#
2631# }}) {
2632#
2633# id
2634#
2635# }
2636# }
2637# Response:
2638# {
2639#
2640# "data": {
2641#
2642# "upsertSchemaDraft": {
2643#
2644# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2645#
2646# }
2647#
2648# }
2649# }
2650upsertSchemaDraft(input: UpsertSchemaDraft!): Schema
2651
2652# Update the state of a schema
2653# Example:
2654# Request:
2655# mutation {
2656#
2657# updateSchemaState(input: {
2658#
2659# id: "0bd05e43-ddac-4b1a-9238-f3b177439b91",
2660#
2661# status: deleted}) {
2662#
2663# id
2664#
2665# }
2666# }
2667# Response:
2668# {
2669#
2670# "data": {
2671#
2672# "updateSchemaState": {
2673#
2674# "id": "0bd05e43-ddac-4b1a-9238-f3b177439b91"
2675#
2676# }
2677#
2678# }
2679# }
2680updateSchemaState(input: UpdateSchemaState!): Schema
2681
2682# Create (ingest) a structured data object
2683# Example:
2684# Request:
2685# mutation {
2686#
2687# createStructuredData(input: {
2688#
2689# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa",
2690#
2691# data: {
2692#
2693# example: "example"
2694#
2695# }}) {
2696#
2697# id
2698#
2699# }
2700# }
2701# Response:
2702# {
2703#
2704# "data": {
2705#
2706# "createStructuredData": {
2707#
2708# "id": "e180f94f-866e-4454-92f9-7ee20d6448fa"
2709#
2710# }
2711#
2712# }
2713# }
2714createStructuredData(input: CreateStructuredData!): StructuredData
2715
2716# Delete a structured data object
2717# Example:
2718# Request:
2719# mutation {
2720#
2721# deleteStructuredData(input:{
2722#
2723# id: "e180f94f-866e-4454-92f9-7ee20d6448fa",
2724#
2725# schemaId: "b79b7ff3-0b80-4d7c-ac51-d5f3459d13fa"}) {
2726#
2727# message
2728#
2729# }
2730# }
2731# Response:
2732# {
2733#
2734# "data": {
2735#
2736# "deleteStructuredData": {
2737#
2738# "message": null
2739#
2740# }
2741#
2742# }
2743# }
2744deleteStructuredData(input: DeleteStructuredData!): DeletePayload
2745
2746# Create (ingest) a structured data object
2747# Example:
2748# Request:
2749# mutation {
2750#
2751# createCollection(input: {
2752#
2753# name: "example",
2754#
2755# folderDescription: "example",
2756#
2757# image:"",
2758#
2759# parentFolderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2"}) {
2760#
2761# id
2762#
2763# }
2764# }
2765# Response:
2766# {
2767#
2768# "data": {
2769#
2770# "createCollection": {
2771#
2772# "id": "242361"
2773#
2774# }
2775#
2776# }
2777# }
2778#
2779# Arguments
2780# input: Fields required to create new collection
2781createCollection(input: CreateCollection): Collection
2782
2783# Update a collection
2784# Example:
2785# Request:
2786# mutation {
2787#
2788# updateCollection(input: {
2789#
2790# folderId: "242361"
2791#
2792# name: "new name"
2793#
2794# folderDescription: "new description"}) {
2795#
2796# id
2797#
2798# name
2799#
2800# }
2801# }
2802# Response:
2803# {
2804#
2805# "data": {
2806#
2807# "updateCollection": {
2808#
2809# "id": "242361",
2810#
2811# "name": "new name"
2812#
2813# }
2814#
2815# }
2816# }
2817#
2818# Arguments
2819# input: Fields needed to update a collection
2820updateCollection(input: UpdateCollection): Collection
2821
2822# Delete Collection
2823# Example:
2824# Request:
2825# mutation {
2826#
2827# deleteCollection(
2828#
2829# id: "242361") {
2830#
2831# message
2832#
2833# }
2834# }
2835# Response:
2836# {
2837#
2838# "data": {
2839#
2840# "deleteCollection": {
2841#
2842# "message": "Deleted Successfully"
2843#
2844# }
2845#
2846# }
2847# }
2848#
2849# Arguments
2850# id: Supply the ID of the folder or collection to delete
2851deleteCollection(folderId: ID, id: ID): DeletePayload
2852
2853# Share a collection, allowing other organizations to view the data
2854# it contains.
2855# Example:
2856# Request:
2857# mutation {
2858#
2859# shareCollection(input: {
2860#
2861# folderId: "242599",
2862#
2863# shareMessage: "example",
2864#
2865# recipients: [] }) {
2866#
2867# id
2868#
2869# }
2870# }
2871# Response:
2872# {
2873#
2874# "data": {
2875#
2876# "shareCollection": {
2877#
2878# "id": "FhQrlAwfRMaTy0blR_eHRw"
2879#
2880# }
2881#
2882# }
2883# }
2884#
2885# Arguments
2886# input: Fields needed to share a collection
2887shareCollection(input: ShareCollection): Share
2888
2889# Arguments
2890# shareId: ID of the shared collection to update
2891# mentionIds: List of mentionIds to add or remove
2892# type: Indicates whether or not the mentions are to be added or
2893# deleted
2894updateSharedCollectionMentions(
2895shareId: String!,
2896mentionIds: [ID!],
2897type: SharedCollectionUpdateType!
2898): Share
2899
2900updateSharedCollectionHistory(
2901input: UpdateSharedCollectionHistory
2902): SharedCollectionHistory
2903
2904# Share a mention from a collection
2905#
2906# Arguments
2907# input: Fields needed to share a mention
2908shareMentionFromCollection(
2909input: ShareMentionFromCollection
2910): Share
2911
2912# Share mention
2913shareMention(input: ShareMention): Share
2914
2915# Share mentions in bulk
2916shareMentionInBulk(input: ShareMentionInBulk): [Share]
2917
2918# Add a mention to a collection
2919#
2920# Arguments
2921# input: Fields needed to add a mention to a collection
2922createCollectionMention(input: CollectionMentionInput): CollectionMention
2923
2924# Arguments
2925# input: Fields needed to add mentions to a collection
2926createCollectionMentions(
2927input: CreateCollectionMentions
2928): [CollectionMention!]!
2929
2930# Update a mention in a collection
2931#
2932# Arguments
2933# input: Fields needed to add mentions to a collection
2934updateCollectionMention(
2935input: UpdateCollectionMention!
2936): CollectionMention!
2937
2938# Remove a mention from a collection
2939#
2940# Arguments
2941# input: Fields needed to delete a mention from a collection
2942deleteCollectionMention(input: CollectionMentionInput): CollectionMention
2943
2944# Create a new folder
2945# Example:
2946# Request:
2947# mutation {
2948#
2949# createFolder(input: {
2950#
2951# name: "example",
2952#
2953# description: "example",
2954#
2955# parentId: "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2956#
2957# rootFolderType:watchlist}) {
2958#
2959# id
2960#
2961# name
2962#
2963# }
2964# }
2965# Response:
2966# {
2967#
2968# "data": {
2969#
2970# "createFolder": {
2971#
2972# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
2973#
2974# "name": "example"
2975#
2976# }
2977#
2978# }
2979# }
2980#
2981# Arguments
2982# input: Fields needed to create a new folder.
2983createFolder(input: CreateFolder): Folder
2984
2985# Update an existing folder
2986# Example:
2987# Request:
2988# mutation {
2989#
2990# updateFolder(input: {
2991#
2992# id: "d551fbd6-7354-4b0e-abfb-654ab8583be2",
2993#
2994# name: "new name"}) {
2995#
2996# name
2997#
2998# }
2999# }
3000# Response:
3001# {
3002#
3003# "data": {
3004#
3005# "updateFolder": {
3006#
3007# "name": "new name"
3008#
3009# }
3010#
3011# }
3012# }
3013#
3014# Arguments
3015# input: Fields needed to update a folder.
3016updateFolder(input: UpdateFolder): Folder
3017
3018# Move a folder from one parent folder to another.
3019# Example:
3020# Request:
3021# mutation {
3022#
3023# moveFolder(input: {
3024#
3025# treeObjectId: "68a5833a-f573-41fe-840a-adb5f6888e2d",
3026#
3027# prevParentTreeObjectId: "3104f61f-4bd1-4175-9fe6-27436d591c54",
3028#
3029# newParentTreeObjectId: "ad7839a7-d088-4202-9db1-5ed4992f915d",
3030#
3031# prevOrderIndex: 1,
3032#
3033# newOrderIndex: 1}) {
3034#
3035# id
3036#
3037# name
3038#
3039# }
3040# }
3041# Response:
3042# {
3043#
3044# "data": {
3045#
3046# "moveFolder": {
3047#
3048# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3049#
3050# "name": "new name"
3051#
3052# }
3053#
3054# }
3055# }
3056#
3057# Arguments
3058# input: Fields needed to move a folder
3059moveFolder(input: MoveFolder): Folder
3060
3061# Delete a folder
3062# Example:
3063# Request:
3064# mutation {
3065#
3066# deleteFolder(input: {
3067#
3068# id:"d551fbd6-7354-4b0e-abfb-654ab8583be2",
3069#
3070# orderIndex: 1}) {
3071#
3072# message
3073#
3074# }
3075# }
3076# Response:
3077# {
3078#
3079# "data": {
3080#
3081# "deleteFolder": {
3082#
3083# "message": null
3084#
3085# }
3086#
3087# }
3088# }
3089#
3090# Arguments
3091# input: Fields needed to delete a folder
3092deleteFolder(input: DeleteFolder): DeletePayload
3093
3094# Create a mention comment
3095#
3096# Arguments
3097# input: Fields needed to create a mention comment
3098createMentionComment(input: CreateMentionComment): MentionComment
3099
3100# Update a mention comment
3101#
3102# Arguments
3103# input: Fields needed to update a mention comment
3104updateMentionComment(input: UpdateMentionComment): MentionComment
3105
3106# Delete a mention comment
3107#
3108# Arguments
3109# input: Fields needed to delete a mention comment
3110deleteMentionComment(input: DeleteMentionComment): DeletePayload
3111
3112# Create a mention rating
3113#
3114# Arguments
3115# input: Fields needed to create a mention rating
3116createMentionRating(input: CreateMentionRating): MentionRating
3117
3118# Update a mention rating
3119#
3120# Arguments
3121# input: Fields needed to update a mention rating
3122updateMentionRating(input: UpdateMentionRating): MentionRating
3123
3124# Delete a mention rating
3125#
3126# Arguments
3127# input: Fields needed to delete a mention rating.
3128deleteMentionRating(input: DeleteMentionRating): DeletePayload
3129
3130# Login as a user. This mutation does not require an existing authentication
3131# context (via `Authorization` header with bearer token, cookie, etc.).
3132# Instead, the client supplies credentials to this mutation, which then
3133# authenticates the user and sets up the authentication context.
3134# The returned tokens can be used to authenticate future requests.
3135# Example:
3136# Request:
3137# mutation {
3138#
3139# userLogin(input: {
3140#
3141# userName: "example1",
3142#
3143# password: "example1"}) {
3144#
3145# apiToken
3146#
3147# lastLoggedIn
3148#
3149# }
3150# }
3151# Response:
3152# {
3153#
3154# "data": {
3155#
3156# "userLogin": {
3157#
3158# "apiToken": null,
3159#
3160# "lastLoggedIn": "2021-06-15T02:04:52.000Z",
3161#
3162# "token": "a0bbdb23-058c-4b44-901f-aa3efc056a3a"
3163#
3164# }
3165#
3166# }
3167# }
3168#
3169# Arguments
3170# input: Fields needed to log in
3171userLogin(input: UserLogin): LoginInfo
3172
3173# Logout user and invalidate user token
3174# Example:
3175# Request:
3176# mutation {
3177#
3178# userLogout(
3179#
3180# token: "a5610058-260d-46ac-aa3e-ee529c4feaab")
3181# }
3182# Response:
3183# {
3184#
3185# "data": {
3186#
3187# "userLogout": null
3188#
3189# }
3190# }
3191#
3192# Arguments
3193# token: User token that should be invalidated
3194userLogout(token: String!): Boolean
3195
3196# Refresh a user token, returning a fresh token so that the client
3197# can continue to authenticate to the API.\
3198# Example:
3199# Request:
3200# mutation {
3201#
3202# refreshToken(
3203#
3204# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3205#
3206# hasPassword
3207#
3208# user{id}
3209#
3210# }
3211# }
3212# Response:
3213# {
3214#
3215# "data": {
3216#
3217# "refreshToken": {
3218#
3219# "hasPassword": true,
3220#
3221# "user": {
3222#
3223# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3224#
3225# }
3226#
3227# }
3228#
3229# }
3230# }
3231refreshToken(token: String!): LoginInfo
3232
3233# Validate a user token. This mutation is used by services to determine
3234# if the token provided by a given client is valid.
3235# Example:
3236# Request:
3237# mutation {
3238#
3239# validateToken(
3240#
3241# token: "32abe146-4e07-4f5e-8e1e-f7f2e0142cf7") {
3242#
3243# hasPassword
3244#
3245# user{id}
3246#
3247# }
3248# }
3249# Response:
3250# {
3251#
3252# "data": {
3253#
3254# "validateToken": {
3255#
3256# "hasPassword": true,
3257#
3258# "user": {
3259#
3260# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066"
3261#
3262# }
3263#
3264# }
3265#
3266# }
3267# }
3268validateToken(token: String!): LoginInfo
3269
3270# Create a mention object
3271createMention(input: CreateMention!): Mention
3272
3273# Update a mention object
3274updateMention(input: UpdateMention!): Mention
3275
3276# Update a set of mentions
3277updateMentions(input: UpdateMentions!): [Mention]
3278
3279# Create root folder for an organization
3280# Example:
3281# Request:
3282# mutation {
3283#
3284# createRootFolders {
3285#
3286# id
3287#
3288# treeObjectId
3289#
3290# rootFolderTypeId
3291#
3292# }
3293# }
3294# Response:
3295# {
3296#
3297# "data": {
3298#
3299# "createRootFolders": [
3300#
3301# {
3302#
3303# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3304#
3305# "treeObjectId": "3104f61f-4bd1-4175-9fe6-27436d591c54",
3306#
3307# "rootFolderTypeId": 1
3308#
3309# },
3310#
3311# {
3312#
3313# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
3314#
3315# "treeObjectId": "4c9f1c95-f6a3-4355-8831-c77719850eaa",
3316#
3317# "rootFolderTypeId": 1
3318#
3319# }
3320#
3321# ]
3322#
3323# }
3324# }
3325#
3326# Arguments
3327# rootFolderType: The type of root folder to create
3328createRootFolders(rootFolderType: RootFolderType): [Folder]
3329
3330# Apply bulk updates to watchlists.
3331# This mutation is currently available only to Veritone operations.
3332#
3333# Arguments
3334# filter: A filter indicating which watchlists should be updated.
3335# At least one filter condition must be provided.
3336# Only watchlists for the user's organization will be updated.
3337# input: Fields used to update a watchlist.
3338bulkUpdateWatchlist(
3339filter: BulkUpdateWatchlistFilter!,
3340input: BulkUpdateWatchlist
3341): WatchlistList
3342
3343# File a TemporalDataObject in a folder. A given TemporalDataObject can
3344# be filed in any number of folders, or none. Filing causes the TemporalDataObject
3345# and its assets to be visible within the folder.
3346# Example:
3347# Request:
3348# mutation {
3349#
3350# fileTemporalDataObject(input:{
3351#
3352# tdoId: "1580388995",
3353#
3354# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3355#
3356# id
3357#
3358# folders{
3359#
3360# id
3361#
3362# }
3363#
3364# }
3365# }
3366# Response:
3367# {
3368#
3369# "data": {
3370#
3371# "fileTemporalDataObject": {
3372#
3373# "id": "1580388995",
3374#
3375# "folders": [
3376#
3377# {
3378#
3379# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
3380#
3381# }
3382#
3383# ]
3384#
3385# }
3386#
3387# }
3388# }
3389#
3390# Arguments
3391# input: The fields needed to file a TemporalDataObject in a
3392# folder
3393fileTemporalDataObject(input: FileTemporalDataObject!): TemporalDataObject
3394
3395# Unfile a TemporalDataObject from a folder. This causes the TemporalDataObject
3396# and its assets to disappear from the folder, but does not otherwise affect
3397# either the TDO or the folder and does not change access controls.
3398# Example:
3399# Request:
3400# mutation {
3401#
3402# unfileTemporalDataObject(input: {
3403#
3404# tdoId: "1580388995",
3405#
3406# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3407#
3408# id
3409#
3410# description
3411#
3412# }
3413# }
3414# Response:
3415# {
3416#
3417# "data": {
3418#
3419# "unfileTemporalDataObject": {
3420#
3421# "id": "1580388995",
3422#
3423# "description": null
3424#
3425# }
3426#
3427# }
3428# }
3429#
3430# Arguments
3431# input: The fields needed to file a TemporalDataObject in a
3432# folder
3433unfileTemporalDataObject(
3434input: UnfileTemporalDataObject!
3435): TemporalDataObject
3436
3437# Moves a TemporalDataObject from one parent folder to another.
3438# Any other folders the TemporalDataObject is filed in are unaffected.
3439# Example:
3440# Request:
3441# mutation {
3442#
3443# moveTemporalDataObject(input: {
3444#
3445# tdoId: "1580388995",
3446#
3447# oldFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3448#
3449# newFolderId: "2ac28573-917a-4c4b-be91-a0ac64cbc982"}) {
3450#
3451# id
3452#
3453# folders{
3454#
3455# folderPath{id}
3456#
3457# }
3458#
3459# }
3460# }
3461# Response:
3462# {
3463#
3464# "data": {
3465#
3466# "moveTemporalDataObject": {
3467#
3468# "id": "1580388995",
3469#
3470# "folders": [
3471#
3472# {
3473#
3474# "folderPath": [
3475#
3476# {
3477#
3478# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982"
3479#
3480# }
3481#
3482# ]
3483#
3484# }
3485#
3486# ]
3487#
3488# }
3489#
3490# }
3491# }
3492#
3493# Arguments
3494# input: Fields need to move a TemporalDataObject
3495moveTemporalDataObject(input: MoveTemporalDataObject!): TemporalDataObject
3496
3497# Upload and store an engine result. The result will be stored as an
3498# asset associated with the target TemporalDataObject and the
3499# task will be updated accordingly.
3500# Use a multipart form POST to all this mutation.
3501#
3502# Arguments
3503# input: Fields needed to upload and store an engine result
3504uploadEngineResult(input: UploadEngineResult!): Asset
3505
3506# Create a watchlist
3507# Example:
3508# Request:
3509# mutation {
3510#
3511# createWatchlist(input: {
3512#
3513# stopDateTime: 1623851655,
3514#
3515# name: "example",
3516#
3517# searchIndex: mine,
3518#
3519# parentFolderId: "9d639f1b-a0d4-47b0-8149-3568f048f320",
3520#
3521# cognitiveSearches: [],
3522#
3523# subscriptions: [],
3524#
3525# details: {
3526#
3527# example: "example"}}) {
3528#
3529# id
3530#
3531# }
3532# }
3533# Response:
3534# {
3535#
3536# "data": {
3537#
3538# "createWatchlist": {
3539#
3540# "id": "325783"
3541#
3542# }
3543#
3544# }
3545# }
3546createWatchlist(input: CreateWatchlist!): Watchlist
3547
3548bulkCreateWatchlist(input: BulkCreateWatchlist!): WatchlistList
3549
3550# Update a watchlist
3551# Example:
3552# Request:
3553# mutation {
3554#
3555# updateWatchlist(input: {
3556#
3557# id: "325783"
3558#
3559# name: "new name"
3560#
3561# details: {
3562#
3563# example: "new details"}}) {
3564#
3565# id
3566#
3567# name
3568#
3569# }
3570# }
3571# Response:
3572#
3573# {
3574#
3575# "data": {
3576#
3577# "updateWatchlist": {
3578#
3579# "id": "325783",
3580#
3581# "name": "new name"
3582#
3583# }
3584#
3585# }
3586# }
3587updateWatchlist(input: UpdateWatchlist!): Watchlist
3588
3589# Delete a watchlist
3590# Example:
3591# Request:
3592# mutation {
3593#
3594# deleteWatchlist(
3595#
3596# id:"325783") {
3597#
3598# message
3599#
3600# }
3601# }
3602# Response:
3603# {
3604#
3605# "data": {
3606#
3607# "deleteWatchlist": {
3608#
3609# "message": "Watchlist deleted along with 0 subscriptions, 0 cognitive search
3610# profiles, 0 mention comments, and 0 mention ratings."
3611#
3612# }
3613#
3614# }
3615# }
3616deleteWatchlist(id: ID!): DeletePayload
3617
3618updateCognitiveSearch(input: UpdateCognitiveSearch): CognitiveSearch
3619
3620createCognitiveSearch(input: CreateCognitiveSearch): CognitiveSearch
3621
3622deleteCognitiveSearch(id: ID!): DeletePayload
3623
3624fileWatchlist(input: FileWatchlist!): Watchlist
3625
3626# Unfile a watchlist from a folder
3627# Example:
3628# Request:
3629# mutation {
3630#
3631# unfileWatchlist(input: {
3632#
3633# watchlistId:"325786",
3634#
3635# folderId: "9d639f1b-a0d4-47b0-8149-3568f048f320"}) {
3636#
3637# id
3638#
3639# folders{
3640#
3641# folderPath{
3642#
3643# id
3644#
3645# }
3646#
3647# }
3648#
3649# }
3650# }
3651# Response:
3652# {
3653#
3654# "data": {
3655#
3656# "unfileWatchlist": {
3657#
3658# "id": "325786",
3659#
3660# "folders": []
3661#
3662# }
3663#
3664# }
3665# }
3666unfileWatchlist(input: UnfileWatchlist!): Watchlist
3667
3668# Share a folder with other organizations
3669# Requires superadmin
3670shareFolder(input: ShareFolderInput): Folder
3671
3672# Create a TDO and an asset with a single call
3673# Example:
3674# Request:
3675# mutation {
3676#
3677# createTDOWithAsset(input: {
3678#
3679# startDateTime: 1623841655,
3680#
3681# stopDateTime: 1623851655,
3682#
3683# contentType: "video/mp4",
3684#
3685# assetType: "media",
3686#
3687# addToIndex: false,
3688#
3689# uri: "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"}) {
3690#
3691# id
3692#
3693# status
3694#
3695# assets {
3696#
3697# records {
3698#
3699# id
3700#
3701# assetType
3702#
3703# contentType
3704#
3705# signedUri
3706#
3707# }
3708#
3709# }
3710#
3711# }
3712# }
3713# Response:
3714# {
3715#
3716# "data": {
3717#
3718# "createTDOWithAsset": {
3719#
3720# "id": "1580507556",
3721#
3722# "status": "recorded",
3723#
3724# "assets": {
3725#
3726# "records": [
3727#
3728# {
3729#
3730# "id": "1580507556_DQ2nU8cTDh",
3731#
3732# "assetType": "media",
3733#
3734# "contentType": "video/mp4",
3735#
3736# "signedUri": "https://s3.amazonaws.com/hold4fisher/s3Test.mp4"
3737#
3738# }
3739#
3740# ]
3741#
3742# }
3743#
3744# }
3745#
3746# }
3747# }
3748#
3749# Arguments
3750# input: Input fields necessary to create the TDO and asset
3751createTDOWithAsset(input: CreateTDOWithAsset): TemporalDataObject
3752
3753# Create a subscription
3754# Example:
3755# Request:
3756# mutation {
3757#
3758# createSubscription(input: {
3759#
3760# targetId: "325791",
3761#
3762# contact: {
3763#
3764# emailAddress: "example email"},
3765#
3766# scheduledDay: Friday}) {
3767#
3768# id
3769#
3770# }
3771# }
3772# Response:
3773# {
3774#
3775# "data": {
3776#
3777# "createSubscription": {
3778#
3779# "id": "274939"
3780#
3781# }
3782#
3783# }
3784# }
3785createSubscription(input: CreateSubscription!): Subscription
3786
3787# Update a subscription
3788# Example:
3789# Request:
3790# mutation {
3791#
3792# updateSubscription(input: {
3793#
3794# id: "274939"}) {
3795#
3796# id
3797#
3798# }
3799# }
3800# Response:
3801# mutation {
3802#
3803# updateSubscription(input: {
3804#
3805# id: "274939"}) {
3806#
3807# id
3808#
3809# }
3810# }
3811updateSubscription(input: UpdateSubscription!): Subscription
3812
3813# Delete a subscription
3814# Example:
3815# Request:
3816# mutation {
3817#
3818# deleteSubscription(
3819#
3820# id: "274939") {
3821#
3822# message
3823#
3824# }
3825# }
3826# Response:
3827# mutation {
3828#
3829# deleteSubscription(
3830#
3831# id: "274939") {
3832#
3833# message
3834#
3835# }
3836# }
3837deleteSubscription(id: ID!): DeletePayload
3838
3839# Create trigger for events or types.
3840# Example:
3841# Request:
3842# mutation {
3843#
3844# createTriggers(input: {
3845#
3846# events: "*",
3847#
3848# targets: {
3849#
3850# name: Email,
3851#
3852# params: {
3853#
3854# address: "example@veritone.com"}}}) {
3855#
3856# id
3857#
3858# }
3859# }
3860# Response:
3861# {
3862#
3863# "data": {
3864#
3865# "createTriggers": [
3866#
3867# {
3868#
3869# "id": "2936"
3870#
3871# }
3872#
3873# ]
3874#
3875# }
3876# }
3877createTriggers(input: CreateTriggers!): [Trigger]
3878
3879# Delete a registed trigger by ID.
3880# Example:
3881# Request:
3882# mutation {
3883#
3884# deleteTrigger(
3885#
3886# id: "2936") {
3887#
3888# message
3889#
3890# }
3891# }
3892# Response:
3893# {
3894#
3895# "data": {
3896#
3897# "deleteTrigger": {
3898#
3899# "message": "Trigger 2936 has been removed from organization 35521"
3900#
3901# }
3902#
3903# }
3904# }
3905deleteTrigger(id: ID!): DeletePayload
3906
3907# Validates if an engine output conforms to the engine output guidelines
3908# Example:
3909# Request:
3910# mutation {
3911#
3912# validateEngineOutput(input:
3913#
3914# {
3915#
3916# schemaId: "https://docs.veritone.com/schemas/vtn-standard/master.json",
3917#
3918# validationContracts: [
3919#
3920# "structured-data"
3921#
3922# ],
3923#
3924# series: [
3925#
3926# {
3927#
3928# startTimeMs: 0,
3929#
3930# stopTimeMs: 10000,
3931#
3932# structuredData: {
3933#
3934# exampleschemaid: {
3935#
3936# key: "value",
3937#
3938# any: "data you'd like",
3939#
3940# as_long: "as it conforms to the schema"
3941#
3942# }
3943#
3944# }
3945#
3946# }
3947#
3948# ]
3949#
3950# }
3951#
3952# )
3953# }
3954# Response:
3955# {
3956#
3957# "data": {
3958#
3959# "validateEngineOutput": true
3960#
3961# }
3962# }
3963validateEngineOutput(input: JSONData!): Boolean!
3964
3965# JWT tokens with a more limited scoped token to specific
3966# resources to the recording, task, and job
3967# and also has no organization association.
3968# Example:
3969# Request:
3970# mutation {
3971#
3972# getEngineJWT(input: {
3973#
3974# engineId: "1",
3975#
3976# resource:{
3977#
3978# tdoId: "1580701928"
3979#
3980# }}) {
3981#
3982# token
3983#
3984# }
3985# }
3986#
3987# Response:
3988# {
3989#
3990# "data": {
3991#
3992# "getEngineJWT": {
3993#
3994# "token": "eyJh...Tw_z3BKRA"
3995#
3996# }
3997#
3998# }
3999# }
4000getEngineJWT(input: getEngineJWT!): JWTTokenInfo!
4001
4002# Verify JWT token
4003# Example:
4004# Request:
4005# mutation {
4006#
4007# verifyJWT(jwtToken:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb250ZW
4008#
4009# 50QXBwbGljYXRpb25JZCI6IjQ5YTRjYmJjLTVlODMtNGM0Mi1iOWEzLWJlNmVjMDczMmY
4010#
4011# wOSIsImNvbnRlbnRPcmdhbml6YXRpb25JZCI6MzU1MjEsImVuZ2luZUlkIjoiMSIsInVzZ
4012#
4013# XJJZCI6IjU5Y2I0ZTc0LTdjMzEtNDI2Ny1iOTFlLWQ0NjAwYmMwODAwOCIsInNjb3BlIjpb
4014#
4015# eyJhY3Rpb25zIjpbImFzc2V0OnVyaSIsImFzc2V0OmFsbCIsInJlY29yZGluZzpyZWFkIiw
4016#
4017# icmVjb3JkaW5nOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsicmVjb3JkaW5nSWRzIjpbIjE1OD
4018#
4019# A3MDE5MjgiXX19LHsiYWN0aW9ucyI6WyJ0YXNrOnVwZGF0ZSJdLCJyZXNvdXJjZXMiOnsia
4020#
4021# m9iSWRzIjpbXSwidGFza0lkcyI6W10sInNvdXJjZUlkcyI6W119fV0sImlhdCI6MTYyNDAz
4022#
4023# NjEyMiwiZXhwIjoxNjI0NjQwOTIyLCJzdWIiOiJlbmdpbmUtcnVuIiwianRpIjoiMTViYjI
4024#
4025# 3YzAtNGI1Yy00NjNhLWFkMTgtOWFkNDI0ODFiMTMzIn0.R7qYdPkA1wjJUiTdb1ryvTnZASPN9FEuGATw_z3BKRA")
4026# {
4027#
4028# payload
4029#
4030# }
4031# }
4032# Response:
4033# {
4034#
4035# "data": {
4036#
4037# "verifyJWT": {
4038#
4039# "payload": {
4040#
4041# "contentApplicationId": "49a4cbbc-5e83-4c42-b9a3-be6ec0732f09",
4042#
4043# "contentOrganizationId": 35521,
4044#
4045# "engineId": "1",
4046#
4047# "userId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4048#
4049# "scope": [
4050#
4051# {
4052#
4053# "actions": [
4054#
4055# "asset:uri",
4056#
4057# "asset:all",
4058#
4059# "recording:read",
4060#
4061# "recording:update"
4062#
4063# ],
4064#
4065# "resources": {
4066#
4067# "recordingIds": [
4068#
4069# "1580701928"
4070#
4071# ]
4072#
4073# }
4074#
4075# },
4076#
4077# {
4078#
4079# "actions": [
4080#
4081# "task:update"
4082#
4083# ],
4084#
4085# "resources": {
4086#
4087# "jobIds": [],
4088#
4089# "taskIds": [],
4090#
4091# "sourceIds": []
4092#
4093# }
4094#
4095# }
4096#
4097# ],
4098#
4099# "iat": 1624036122,
4100#
4101# "exp": 1624640922,
4102#
4103# "sub": "engine-run",
4104#
4105# "jti": "15bb27c0-4b5c-463a-ad18-9ad42481b133"
4106#
4107# }
4108#
4109# }
4110#
4111# }
4112# }
4113verifyJWT(jwtToken: String!): VerifyJWTPayload
4114
4115# Create a new Saved Search
4116# Example:
4117# Request:
4118# mutation {
4119#
4120# createSavedSearch(input: {
4121#
4122# name: "example",
4123#
4124# csp: {
4125#
4126# example: "example"}}) {
4127#
4128# id
4129#
4130# }
4131# }
4132# Response:
4133# {
4134#
4135# "data": {
4136#
4137# "createSavedSearch": {
4138#
4139# "id": "a29f2255-e509-4454-89ec-e425390ca4ca"
4140#
4141# }
4142#
4143# }
4144# }
4145createSavedSearch(input: CreateSavedSearch!): SavedSearch!
4146
4147# Delete a saved search
4148# Example:
4149# Request:
4150# mutation {
4151#
4152# deleteSavedSearch(
4153#
4154# id:"a29f2255-e509-4454-89ec-e425390ca4ca") {
4155#
4156# message
4157#
4158# }
4159# }
4160# Response:
4161# {
4162#
4163# "data": {
4164#
4165# "deleteSavedSearch": {
4166#
4167# "message": null
4168#
4169# }
4170#
4171# }
4172# }
4173deleteSavedSearch(id: ID!): DeletePayload!
4174
4175# Mark existing saved search profile as deleted
4176# Create new saved search profile
4177# Example:
4178# Request:
4179# mutation {
4180#
4181# replaceSavedSearch(input: {
4182#
4183# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4184#
4185# name: "example",
4186#
4187# csp: {
4188#
4189# example: "new csp"}}) {
4190#
4191# id
4192#
4193# }
4194# }
4195# Response:
4196# mutation {
4197#
4198# replaceSavedSearch(input: {
4199#
4200# id: "3d4f04c5-7855-4b9c-ba65-9bd6c2932a7e",
4201#
4202# name: "example",
4203#
4204# csp: {
4205#
4206# example: "new csp"}}) {
4207#
4208# id
4209#
4210# }
4211# }
4212replaceSavedSearch(input: ReplaceSavedSearch!): SavedSearch!
4213
4214# Send a basic email. Mutation returns true for a success message.
4215# The email from field will be automatically set the default platform email
4216# address
4217# Example:
4218# Request:
4219# mutation {
4220#
4221# sendEmail(input: {
4222#
4223# to: "example@veritone.com"
4224#
4225# subject: "example"
4226#
4227# message: "email body"
4228#
4229# replyTo: "example@veritone.com"
4230#
4231# })
4232# }
4233# Response:
4234# {
4235#
4236# "data": {
4237#
4238# "sendEmail": true
4239#
4240# }
4241# }
4242sendEmail(input: SendEmail!): Boolean!
4243
4244# Create new content template into a folder
4245createFolderContentTempate(
4246input: CreateFolderContentTempate!
4247): FolderContentTemplate!
4248
4249# Update existing content template by folderContentTemplateId
4250updateFolderContentTempate(
4251input: UpdateFolderContentTempate!
4252): FolderContentTemplate!
4253
4254# Delete existing folder content template by folderContentTemplateId
4255#
4256# Arguments
4257# id: Folder Content Template Id
4258deleteFolderContentTempate(id: ID!): DeletePayload!
4259
4260# Create an export request. The requested TDO data, possibly including
4261# TDO media and engine results, will be exported offline.
4262# Example:
4263# Request:
4264# mutation {
4265#
4266# createExportRequest(input: {
4267#
4268# tdoData: {
4269#
4270# tdoId: "1580388995",
4271#
4272# }}) {
4273#
4274# id
4275#
4276# }
4277# }
4278# Response:
4279# {
4280#
4281# "data": {
4282#
4283# "createExportRequest": {
4284#
4285# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad"
4286#
4287# }
4288#
4289# }
4290# }
4291#
4292# Arguments
4293# input: Input data required to create the export request
4294createExportRequest(input: CreateExportRequest!): ExportRequest!
4295
4296# Update an export request
4297# Example:
4298# Request:
4299# mutation {
4300#
4301# updateExportRequest(input: {
4302#
4303# id: "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4304#
4305# status: complete}) {
4306#
4307# id
4308#
4309# status
4310#
4311# }
4312# }
4313# Response:
4314# {
4315#
4316# "data": {
4317#
4318# "updateExportRequest": {
4319#
4320# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4321#
4322# "status": "complete"
4323#
4324# }
4325#
4326# }
4327# }
4328#
4329# Arguments
4330# input: Input data required to update an export request
4331updateExportRequest(input: UpdateExportRequest!): ExportRequest!
4332
4333# Create Mention in bulk. The input should be an array of createMentions
4334createMentions(input: CreateMentions!): MentionList
4335
4336# Create Media Share. Returning the url of the share
4337createMediaShare(input: CreateMediaShare!): CreatedMediaShare!
4338
4339# Create a new event
4340#
4341# Example:
4342#
4343# Request:
4344#
4345# mutation {
4346#
4347# createEvent(input: {
4348#
4349# eventName: "example",
4350#
4351# eventType: "example",
4352#
4353# application: ""
4354#
4355# description: "example"}) {
4356#
4357# id
4358#
4359# }
4360# }
4361# Response:
4362# {
4363#
4364# "data": {
4365#
4366# "createEvent": {
4367#
4368# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d"
4369#
4370# }
4371#
4372# }
4373# }
4374createEvent(input: CreateEvent!): Event!
4375
4376# Update an event
4377# Example:
4378# Request:
4379# mutation {
4380#
4381# updateEvent(input: {
4382#
4383# id: "55fc7c51-1521-4043-902f-f0f3a357da6d",
4384#
4385# description: "new example description"}) {
4386#
4387# id
4388#
4389# description
4390#
4391# }
4392# }
4393# Response:
4394# {
4395#
4396# "data": {
4397#
4398# "updateEvent": {
4399#
4400# "id": "55fc7c51-1521-4043-902f-f0f3a357da6d",
4401#
4402# "description": "new example description"
4403#
4404# }
4405#
4406# }
4407# }
4408updateEvent(input: UpdateEvent!): Event!
4409
4410# Subscribe to an event
4411# Example:
4412# Request:
4413# mutation {
4414#
4415# subscribeEvent(input: {
4416#
4417# eventName: "example",
4418#
4419# eventType: "example",
4420#
4421# application: "",
4422#
4423# delivery: {
4424#
4425# name: CreateJob,
4426#
4427# params: {
4428#
4429# targetId: "1580701928"
4430#
4431# engineId: "1"
4432#
4433# }
4434#
4435# }
4436#
4437# })
4438# }
4439# Response:
4440# {
4441#
4442# "data": {
4443#
4444# "subscribeEvent": "a0d04eeb-c32d-4852-9273-bb0acda970b9"
4445#
4446# }
4447# }
4448subscribeEvent(input: SubscribeEvent!): ID!
4449
4450# Unsubscribe to an event
4451# Example:
4452# Request:
4453# mutation {
4454#
4455# unsubscribeEvent(
4456#
4457# id: "a0d04eeb-c32d-4852-9273-bb0acda970b9") {
4458#
4459# id
4460#
4461# message
4462#
4463# }
4464# }
4465# Response:
4466# {
4467#
4468# "data": {
4469#
4470# "unsubscribeEvent": {
4471#
4472# "id": "a0d04eeb-c32d-4852-9273-bb0acda970b9",
4473#
4474# "message": "Unsubscribed from event"
4475#
4476# }
4477#
4478# }
4479# }
4480unsubscribeEvent(id: ID!): UnsubscribeEvent!
4481
4482# Emit an event
4483# Example:
4484# Request:
4485# mutation {
4486#
4487# emitEvent(input: {
4488#
4489# eventName: "example",
4490#
4491# eventType: "example",
4492#
4493# application: "",
4494#
4495# payload: ""}) {
4496#
4497# id
4498#
4499# }
4500# }
4501# Response:
4502# {
4503#
4504# "data": {
4505#
4506# "emitEvent": {
4507#
4508# "id": "0952fe68-5652-4804-857d-26e21ef3d7e8"
4509#
4510# }
4511#
4512# }
4513# }
4514emitEvent(input: EmitEvent!): EmitEventResponse!
4515
4516# Create a new event trigger template
4517# Example:
4518# Request:
4519# mutation {
4520#
4521# createEventActionTemplate(input: {
4522#
4523# name: "example"
4524#
4525# inputType: event
4526#
4527# inputValidation: {
4528#
4529# example: "example"
4530#
4531# }
4532#
4533# inputAttributes: {
4534#
4535# example: "example"
4536#
4537# }
4538#
4539# actionType: job
4540#
4541# actionValidation: {
4542#
4543# example: "example"
4544#
4545# }
4546#
4547# actionDestination: "1"
4548#
4549# actionAttributes: {
4550#
4551# example: "example"
4552#
4553# }}) {
4554#
4555# id
4556#
4557# }
4558# }
4559# Response:
4560# {
4561#
4562# "data": {
4563#
4564# "createEventActionTemplate": {
4565#
4566# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92"
4567#
4568# }
4569#
4570# }
4571# }
4572createEventActionTemplate(
4573input: CreateEventActionTemplate!
4574): EventActionTemplate!
4575
4576# Update an event trigger template
4577# Example:
4578# Request:
4579# mutation {
4580#
4581# updateEventActionTemplate(input: {
4582#
4583# id: "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4584#
4585# name: "example",
4586#
4587# actionValidation: {
4588#
4589# example: "new validation"}}) {
4590#
4591# id
4592#
4593# actionValidation
4594#
4595# }
4596# }
4597# Response:
4598# {
4599#
4600# "data": {
4601#
4602# "updateEventActionTemplate": {
4603#
4604# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4605#
4606# "actionValidation": {
4607#
4608# "example": "new validation"
4609#
4610# }
4611#
4612# }
4613#
4614# }
4615# }
4616updateEventActionTemplate(
4617input: UpdateEventActionTemplate!
4618): EventActionTemplate!
4619
4620# Create a new event custom rule
4621# Example:
4622# Request:
4623# mutation {
4624#
4625# createEventCustomRule(input: {
4626#
4627# name: "example"
4628#
4629# eventType: "example"