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