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