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