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