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