OBJECT

Query

Queries are used to retrieve data. If you're new to our API, try the me query to explore the information you have access to. Hit ctrl-space at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.

link GraphQL Schema definition

1type Query {
2
3# Retrieve a list of temporal data objects.
4# Example:
5# Request:
6# query {
7#
8# temporalDataObjects(
9#
10# organizationId: "35521"){
11#
12# records{name}
13#
14# offset
15#
16# limit
17#
18# count
19#
20# }
21# }
22# Response:
23# {
24#
25# "data": {
26#
27# "temporalDataObjects": {
28#
29# "records": [
30#
31# {
32#
33# "name": "example"
34#
35# },
36#
37# {
38#
39# "name": "example"
40#
41# },
42#
43# ],
44#
45# "offset": 0,
46#
47# "limit": 30,
48#
49# "count": 8
50#
51# }
52#
53# }
54# }
55#
56# Arguments
57# organizationId: Organization ID to get TDOs for. Defaults to
58# the user's own organization.
59# You can only retrieves content for your own organizations or organizations
60# that have shared data with yours.
61# applicationId: Application ID (an authorization construct that
62# maps directly to organization ID)
63# to get TDOs for. Defaults to the user's own organization.
64# id: Provide a list of IDs to retrieve the specific TDOs.
65# offset: Provide an offset to skip to a certain element in the
66# result, for paging.
67# limit: Specify maximum number of results to retrieve in this
68# result. Page size.
69# sourceId: Optionally, specify a source ID. TDOs ingested from
70# this source will
71# be returned.
72# programId: Optionally, specify a program ID. TDOs belong to
73# this program will
74# be returned.
75# scheduledJobId: Optionally, specify a scheduled job ID. TDOs
76# ingested under this
77# scheduled job will be returned.
78# sampleMedia: Whether to retrieve only tdos with the specified
79# sampleMedia value
80# includePublic: Whether to retrieve public data that is not part
81# of the user's organization.
82# The default is false. Pass true to include public data in the result set.
83# dateTimeFilter: Provide optional filters against any date/time
84# field to filter
85# objects within a given time window.
86# Matching objects must meet all of the given conditions.
87# mentionId: Retrieve TDOs associated with the given mention
88temporalDataObjects(
89organizationId: ID,
90applicationId: ID,
91id: ID,
92ids: [ID],
93offset: Int,
94limit: Int,
95sourceId: ID,
96programId: ID,
97scheduledJobId: ID,
98sampleMedia: Boolean,
99includePublic: Boolean,
100orderBy: TemporalDataObjectOrderBy,
101orderDirection: OrderDirection,
102dateTimeFilter: [TemporalDataObjectDateTimeFilter!],
103mentionId: ID
104): TDOList
105
106# Retrieve a single temporal data object
107# Example:
108# Request:
109# query {
110#
111# temporalDataObject(
112#
113# id: 1570654874) {
114#
115# id
116#
117# name
118#
119# }
120# }
121# Response:
122# {
123#
124# "data": {
125#
126# "temporalDataObject": {
127#
128# "id": "1570654874",
129#
130# "name": "example"
131#
132# }
133#
134# }
135# }
136#
137# Arguments
138# id: the TDO ID
139temporalDataObject(id: ID!): TemporalDataObject
140
141# Retrieve a single Asset
142# Example:
143# Request:
144# query {
145#
146# asset(
147#
148# id: "1570654874_4hJtNKSUXD") {
149#
150# id
151#
152# name
153#
154# description
155#
156# }
157# }
158# Response:
159# {
160#
161# "data": {
162#
163# "asset": {
164#
165# "id": "1570654874_4hJtNKSUXD",
166#
167# "name": "example",
168#
169# "description": "example"
170#
171# }
172#
173# }
174# }
175#
176# Arguments
177# id: The asset ID
178asset(id: ID!): Asset
179
180# Retrieve multiple assets
181# Example:
182# Request:
183# query {
184#
185# assets(
186#
187# ids:["1570654874_4hJtNKSUXD"],
188#
189# contentTypes:[],
190#
191# assetTypes:["text"],
192#
193# sourceEngineIds:[],
194#
195# createdDateFilter:null,
196#
197# scrollId: null){
198#
199# assets{
200#
201# records{id}
202#
203# count
204#
205# }
206#
207# scrollId
208#
209# }
210# }
211# Response:
212# {
213#
214# "data": {
215#
216# "assets": {
217#
218# "assets": {
219#
220# "records": [],
221#
222# "count": 0
223#
224# },
225#
226# "scrollId": ""
227#
228# }
229#
230# }
231# }
232#
233# Arguments
234# ids: List of asset ids
235# contentTypes: Filter assets with content type included in the
236# list
237# See https://www.iana.org/assignments/media-types/media-types.xhtml
238# assetTypes: Filter assets with assetType included in the list
239# See https://support.veritone.com/s/article/000003943 for list of values.
240# sourceEngineIds: Filter by source engine.
241# Not all assets have associated engineId, ex. media assets
242# createdDateFilter: Filter by created date
243# Note createdDateFilter.filter is required, but currently ignored
244# offset: Offset to skip to a certain element in the result, for
245# paging.
246# limit: Maximum number of results to retrieve in this result.
247# Page size.
248# scrollId: Use this field when sequentially iterating over the
249# assets list
250# This is required for when offset + limit exceeds 10000.
251# The value of this field is set from the response of the first/previous
252# assets query
253assets(
254ids: [ID!],
255contentTypes: [String!],
256assetTypes: [String!],
257sourceEngineIds: [String!],
258createdDateFilter: TemporalDataObjectDateTimeFilter,
259offset: Int,
260limit: Int,
261scrollId: String
262): AssetScrollList
263
264# Retrieve a single Widget
265# Example:
266# Request:
267# query {
268#
269# widget(
270#
271# id: "KOIFUT_rT_Oy3Ev9zfKT6A") {
272#
273# collection{
274#
275# id
276#
277# }
278#
279# }
280# }
281# Response:
282# {
283#
284# "data": {
285#
286# "widget": {
287#
288# "collection": {
289#
290# "id": "243625"
291#
292# }
293#
294# }
295#
296# }
297# }
298#
299# Arguments
300# id: The widget ID
301widget(id: ID!): Widget
302
303# Retrieve clone job entries
304# Example:
305# Request:
306# query {
307#
308# cloneRequests {
309#
310# records{
311#
312# id
313#
314# }
315#
316# }
317# }
318#
319# Response:
320#
321# {
322#
323# "data": {
324#
325# "cloneRequests": {
326#
327# "records": []
328#
329# }
330#
331# }
332# }
333#
334# Arguments
335# id: Provide an ID to retrieve a single specific clone request.
336# applicationId: Application ID to get clone requests for.
337# Defaults to the user's own application.
338cloneRequests(id: ID, applicationId: ID, offset: Int, limit: Int): CloneRequestList
339
340# Retrieve most recent builds
341# Example:
342# Request:
343# query {
344#
345# recentBuilds(limit:2) {
346#
347# records{
348#
349# id
350#
351# name
352#
353# }
354#
355# }
356# }
357# Response:
358# {
359#
360# "data": {
361#
362# "recentBuilds": {
363#
364# "records": [
365#
366# {
367#
368# "id": "44193f81-57b4-47dd-9fe0-be95000776d9",
369#
370# "name": "example Version 5"
371#
372# },
373#
374# {
375#
376# "id": "bae12129-2724-40c3-abd2-6bb4021f21ae",
377#
378# "name": "example Version 4"
379#
380# }
381#
382# ]
383#
384# }
385#
386# }
387# }
388#
389# Arguments
390# buildStatus: Engine build status:
391# offset: Specify maximum number of results to retrieve in this
392# result. Page size.
393# limit: Specify maximum number of results to retrieve in this
394# result.
395# orderBy: Set order information on the query. Multiple fields
396# are supported.
397# Default order by modifiedDateTime desc
398recentBuilds(
399buildStatus: [BuildStatus!],
400offset: Int,
401limit: Int,
402orderBy: [EngineBuildOrderBy!]
403): BuildList
404
405# Retrieve engine overview
406# Example:
407# Request:
408# query {
409#
410# engineOverview {
411#
412# ready
413#
414# }
415# }
416#
417# Response:
418#
419# {
420#
421# "data": {
422#
423# "engineOverview": {
424#
425# "ready": 7
426#
427# }
428#
429# }
430# }
431engineOverview: EngineOverview
432
433# Retrieve engines
434# Example:
435# Request:
436# query {
437#
438# engines(limit:2) {
439#
440# records{
441#
442# id
443#
444# state
445#
446# }
447#
448# }
449# }
450# Response:
451# {
452#
453# "data": {
454#
455# "engines": {
456#
457# "records": [
458#
459# {
460#
461# "id": "2",
462#
463# "state": "pending"
464#
465# },
466#
467# {
468#
469# "id": "1",
470#
471# "state": "pending"
472#
473# }
474#
475# ]
476#
477# }
478#
479# }
480# }
481#
482# Arguments
483# id: Provide an ID to retrieve a single specific engine.
484# categoryId: Provide a category ID to filter by engine category.
485# category: provide a category name or ID to filter by engine
486# category
487# state: Provide a list of states to filter by engine state.
488# owned: If true, return only engines owned by the user's
489# organization.
490# libraryRequired: If true, return only engines that require a
491# library.
492# createsTDO: If true, return only engines that create their own
493# TDO.
494# If false, return only engines that do not create a TDO.
495# If not set, return either.
496# name: Provide a name, or part of a name, to search by engine
497# name
498# offset: Specify maximum number of results to retrieve in this
499# result. Page size.
500# limit: Specify maximum number of results to retrieve in this
501# result.
502# filter: Filters for engine attributes
503# orderBy: Provide a list of EngineSortField to sort by.
504# edgeVersion: Edge version to filter
505engines(
506id: ID,
507ids: [ID!],
508categoryId: String,
509category: String,
510state: [EngineState],
511owned: Boolean,
512libraryRequired: Boolean,
513createsTDO: Boolean,
514name: String,
515offset: Int,
516limit: Int,
517filter: EngineFilter,
518orderBy: [EngineSortField],
519edgeVersion: Int
520): EngineList
521
522# Retrieve a single engine by ID
523# Example:
524# Request:
525# query {
526#
527# engine(id:1) {
528#
529# name
530#
531# state
532#
533# }
534# }
535# Response:
536# {
537#
538# "data": {
539#
540# "engine": {
541#
542# "name": "example",
543#
544# "state": "pending"
545#
546# }
547#
548# }
549# }
550#
551# Arguments
552# id: Provide the engine ID
553engine(id: ID!): Engine
554
555# Retrieve an engine build
556# Example:
557# Request:
558# query {
559#
560# engineBuild(id: "2a1a1b58-6983-4002-b9ed-7b7f325f621a"){
561#
562# name
563#
564# engineId
565#
566# }
567# }
568#
569# Response:
570# {
571#
572# "data": {
573#
574# "engineBuild": {
575#
576# "name": "example Version 1",
577#
578# "engineId": "1"
579#
580# }
581#
582# }
583# }
584#
585# Arguments
586# id: Provide the build ID
587engineBuild(id: ID!): Build
588
589# Retrieve engine categories
590# Example:
591# Request:
592# query {
593#
594# engineCategories(limit:2) {
595#
596# records {
597#
598# id
599#
600# type {
601#
602# name
603#
604# }
605#
606# name
607#
608# }
609#
610# }
611# }
612# Response:
613# {
614#
615# "data": {
616#
617# "engineCategories": {
618#
619# "records": [
620#
621# {
622#
623# "id": "581dbb32-ea5b-4458-bd15-8094942345e3",
624#
625# "type": {
626#
627# "name": "Cognition"
628#
629# },
630#
631# "name": "Transcode"
632#
633# },
634#
635# {
636#
637# "id": "67cd4dd0-2f75-445d-a6f0-2f297d6cd182",
638#
639# "type": {
640#
641# "name": "Cognition"
642#
643# },
644#
645# "name": "Transcription"
646#
647# }
648#
649# ]
650#
651# }
652#
653# }
654# }
655#
656# Arguments
657# id: Provide an ID to retrieve a single specific engine
658# category.
659# ids: Provide multiple IDs to retrieve engine categories
660# name: Provide a name, or part of one, to search by category
661# name
662# type: Return all categories of an engine type
663# offset: Specify maximum number of results to retrieve in this
664# result. Page size.
665# limit: Specify maximum number of results to retrieve in this
666# result.
667engineCategories(
668id: ID,
669ids: [ID!],
670name: String,
671type: String,
672offset: Int,
673limit: Int
674): EngineCategoryList
675
676# Retrieve a specific engine category\
677# Example:
678# Request:
679# query {
680#
681# engineCategory(id: "581dbb32-ea5b-4458-bd15-8094942345e3") {
682#
683# name
684#
685# type{
686#
687# name
688#
689# }
690#
691# }
692# }
693# Response:
694# {
695#
696# "data": {
697#
698# "engineCategory": {
699#
700# "name": "Transcode",
701#
702# "type": {
703#
704# "name": "Cognition"
705#
706# }
707#
708# }
709#
710# }
711# }
712#
713# Arguments
714# id: Supply the ID of the engine category to retrieve
715engineCategory(id: ID!): EngineCategory
716
717# Retrieve jobs
718# Example:
719# Request:
720# query {
721#
722# jobs(limit:2) {
723#
724# records{
725#
726# id
727#
728# name
729#
730# }
731#
732# }
733# }
734# Response:
735# {
736#
737# "data": {
738#
739# "jobs": {
740#
741# "records": []
742#
743# }
744#
745# }
746# }
747#
748# Arguments
749# id: Provide an ID to retrieve a single specific job.
750# status: Provide a list of status strings to filter by status
751# offset: Provide an offset to skip to a certain element in the
752# result, for paging.
753# limit: Specify the maximum number of results to included in
754# this response, or page size.
755# applicationId: Provide an application ID to filter jobs for a
756# given application.
757# Defaults to the user's own application.
758# targetId: Provide a target ID to get the set of jobs running
759# against a particular TDO.
760# clusterId: Provide a cluster ID to get the jobs running on a
761# specific cluster
762# scheduledJobIds: Provide a list of scheduled job IDs to get
763# jobs associated with the scheduled jobs
764# hasScheduledJobId: Return only jobs that are (true) or are not
765# (false) associated with a scheduled job
766# orderBy: Provide sort information. The default is to sort by
767# createdDateTime descending.
768# dateTimeFilter: Filter by date/time field
769# applicationIds: Provide list of application IDs to filter jobs.
770# Defaults to the user's own application.
771# engineIds: Provide a list of engine IDs to filter for jobs
772# that contain tasks for the specified engines.
773# engineCategoryIds: Provide a list of engine category IDs to
774# filter for jobs
775# that contain tasks for engines in the specific categories.
776# dagTemplateIds: Provide a list of DAG template IDs to get jobs
777# associated with the DAG templates
778jobs(
779hasTargetTDO: Boolean,
780id: ID,
781status: [JobStatusFilter!],
782applicationStatus: String,
783offset: Int,
784limit: Int,
785applicationId: ID,
786targetId: ID,
787clusterId: ID,
788scheduledJobIds: [ID!],
789hasScheduledJobId: Boolean,
790orderBy: [JobSortField!],
791dateTimeFilter: [JobDateTimeFilter!],
792applicationIds: [ID],
793engineIds: [ID!],
794engineCategoryIds: [ID!],
795dagTemplateIds: [ID]
796): JobList
797
798# Retrieve a single job by ID
799#
800# Arguments
801# id: the job ID.
802job(id: ID!): Job
803
804# Retrieve a single task by ID
805#
806# Arguments
807# id: Provide the task ID.
808task(id: ID!): Task
809
810# Retrieve entity identifier types
811# Example:
812# Request:
813# query {
814#
815# entityIdentifierTypes(limit:2) {
816#
817# records{
818#
819# id
820#
821# label
822#
823# }
824#
825# }
826# }
827# Response:
828# {
829#
830# "data": {
831#
832# "entityIdentifierTypes": {
833#
834# "records": [
835#
836# {
837#
838# "id": "face",
839#
840# "label": "Face"
841#
842# },
843#
844# {
845#
846# "id": "audio-recording",
847#
848# "label": "audio file"
849#
850# }
851#
852# ]
853#
854# }
855#
856# }
857# }
858#
859# Arguments
860# id: Provide an ID to retrieve a single specific entity
861# identifier type.
862# offset: Provide an offset to skip to a certain element in the
863# result, for paging.
864# limit: Specify maximum number of results to retrieve in this
865# result. Page size.
866entityIdentifierTypes(id: ID, offset: Int, limit: Int): EntityIdentifierTypeList
867
868# Retrieve an entity identifier type
869# Example:
870# Request:
871# query {
872#
873# entityIdentifierType(id:"face") {
874#
875# label
876#
877# entityIdentifierItems {
878#
879# libraryTypeId
880#
881# }
882#
883# }
884# }
885# Response:
886# {
887#
888# "data": {
889#
890# "entityIdentifierType": {
891#
892# "label": "Face",
893#
894# "entityIdentifierItems": [
895#
896# {
897#
898# "libraryTypeId": "people"
899#
900# },
901#
902# {
903#
904# "libraryTypeId": "suspect"
905#
906# },
907#
908# {
909#
910# "libraryTypeId": "people-known-offender"
911#
912# },
913#
914# {
915#
916# "libraryTypeId": "people-of-interest"
917#
918# }
919#
920# ]
921#
922# }
923#
924# }
925# }
926#
927# Arguments
928# id: Provide the entity identifier type ID
929entityIdentifierType(id: ID!): EntityIdentifierType
930
931# Retrieve all library types
932# Example:
933# Request:
934# query {
935#
936# libraryTypes(limit:2) {
937#
938# records{
939#
940# id
941#
942# entityTypeName
943#
944# }
945#
946# }
947# }
948# Response:
949# {
950#
951# "data": {
952#
953# "libraryTypes": {
954#
955# "records": [
956#
957# {
958#
959# "id": "people-known-offender",
960#
961# "entityTypeName": "known offender"
962#
963# },
964#
965# {
966#
967# "id": "dataset",
968#
969# "entityTypeName": "dataset"
970#
971# }
972#
973# ]
974#
975# }
976#
977# }
978# }
979#
980# Arguments
981# id: Provide an ID to retrieve a single specific library type.
982# offset: Provide an offset to skip to a certain element in the
983# result, for paging.
984# limit: Specify maximum number of results to retrieve in this
985# result. Page size.
986libraryTypes(id: ID, offset: Int, limit: Int): LibraryTypeList
987
988# Retrieve a single library type
989# Example:
990# Request:
991# query {
992#
993# libraryType(id: "people-known-offender") {
994#
995# entityTypeName
996#
997# label
998#
999# }
1000# }
1001# Response:
1002# {
1003#
1004# "data": {
1005#
1006# "libraryType": {
1007#
1008# "entityTypeName": "known offender",
1009#
1010# "label": "IDentify - Known Offender"
1011#
1012# }
1013#
1014# }
1015# }
1016#
1017# Arguments
1018# id: Provide an ID to retrieve a single specific library type.
1019libraryType(id: ID): LibraryType
1020
1021# Retrieve libraries and entities
1022# Example:
1023# Request:
1024# query {
1025#
1026# libraries(limit:2) {
1027#
1028# records {
1029#
1030# id
1031#
1032# name
1033#
1034# libraryTypeId
1035#
1036# }
1037#
1038# }
1039# }
1040# Response:
1041# {
1042#
1043# "data": {
1044#
1045# "libraries": {
1046#
1047# "records": [
1048#
1049# {
1050#
1051# "id": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1052#
1053# "name": "example",
1054#
1055# "libraryTypeId": "123"
1056#
1057# }
1058#
1059# ]
1060#
1061# }
1062#
1063# }
1064# }
1065#
1066# Arguments
1067# id: Provide an ID to retrieve a single specific library.
1068# name: Provide a name string to search by name.
1069# type: Provide the name or ID of a library to search for
1070# libraries
1071# that contain that type.
1072# entityIdentifierTypeIds: Provide the id of an entity identifier
1073# type to search for libraries that correlate
1074# to that type.
1075# includeOwnedOnly: Specify true if only libraries owned by the
1076# user's organization
1077# should be returned. Otherwise, shared libraries will be included.
1078# offset: Provide an offset to skip to a certain element in the
1079# result, for paging.
1080# limit: Specify maximum number of results to retrieve in this
1081# result. Page size.
1082# orderBy: Specify a field to order by
1083# orderDirection: Specify the direction to order by
1084libraries(
1085id: ID,
1086name: String,
1087type: String,
1088entityIdentifierTypeIds: [String!],
1089includeOwnedOnly: Boolean,
1090offset: Int,
1091limit: Int,
1092orderBy: LibraryOrderBy,
1093orderDirection: OrderDirection
1094): LibraryList
1095
1096# Retrieve a specific library
1097# Example:
1098# Request:
1099# query {
1100#
1101# library(id: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1102#
1103# name
1104#
1105# organizationId
1106#
1107# }
1108# }
1109# Response:
1110# {
1111#
1112# "data": {
1113#
1114# "library": {
1115#
1116# "name": "example",
1117#
1118# "organizationId": "35521"
1119#
1120# }
1121#
1122# }
1123# }
1124#
1125# Arguments
1126# id: Provide a library ID.
1127library(id: ID!): Library
1128
1129# Retrieve a specific library engine model
1130# Example:
1131# Request:
1132# query {
1133#
1134# libraryEngineModel(id: "87714ca6-8dbd-4da0-9dc0-d9233927b00d") {
1135#
1136# trainStatus
1137#
1138# engineId
1139#
1140# }
1141# }
1142# Response:
1143# {
1144#
1145# "data": {
1146#
1147# "libraryEngineModel": {
1148#
1149# "trainStatus": "pending",
1150#
1151# "engineId": "1"
1152#
1153# }
1154#
1155# }
1156# }
1157#
1158# Arguments
1159# id: Provide the library engine model ID
1160libraryEngineModel(id: ID!): LibraryEngineModel
1161
1162# Retrieve a specific entity
1163# Example:
1164# Request:
1165# query {
1166#
1167# entity(id: "85b700fa-f327-4fea-b94b-ed83054170db") {
1168#
1169# name
1170#
1171# libraryId
1172#
1173# isPublished
1174#
1175# }
1176# }
1177# Response:
1178# {
1179#
1180# "data": {
1181#
1182# "entity": {
1183#
1184# "name": "example",
1185#
1186# "libraryId": "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599",
1187#
1188# "isPublished": false
1189#
1190# }
1191#
1192# }
1193# }
1194#
1195# Arguments
1196# id: Provide an entity ID.
1197entity(id: ID!): Entity
1198
1199# Retrieve a list of entities across libraries
1200# Example:
1201# Request:
1202# query {
1203#
1204# entities(libraryIds: "e0a6e5ad-dec8-49a1-ad33-3f1194c2e599") {
1205#
1206# records {
1207#
1208# id
1209#
1210# name
1211#
1212# isPublished
1213#
1214# }
1215#
1216# }
1217# }
1218# Response:
1219# {
1220#
1221# "data": {
1222#
1223# "entities": {
1224#
1225# "records": [
1226#
1227# {
1228#
1229# "id": "85b700fa-f327-4fea-b94b-ed83054170db",
1230#
1231# "name": "example",
1232#
1233# "isPublished": false
1234#
1235# }
1236#
1237# ]
1238#
1239# }
1240#
1241# }
1242# }
1243#
1244# Arguments
1245# ids: Provide a list of entity IDs to retrieve those entities
1246# libraryIds: Provide a list of library IDs to retrieve entities
1247# across
1248# multiple libraries.
1249entities(
1250ids: [ID!],
1251libraryIds: [ID!],
1252isPublished: Boolean,
1253identifierTypeId: ID,
1254name: String,
1255offset: Int,
1256limit: Int,
1257orderBy: LibraryEntityOrderBy,
1258orderDirection: OrderDirection
1259): EntityList
1260
1261# Retrieve library configuration
1262# Example:
1263# Request:
1264# query {
1265#
1266# libraryConfiguration(id:"7396e71b-db5a-4c4c-bf6f-4fc66a5a07f7") {
1267#
1268# confidence{
1269#
1270# min
1271#
1272# max
1273#
1274# }
1275#
1276# }
1277# }
1278# Response:
1279# {
1280#
1281# "data": {
1282#
1283# "libraryConfiguration": {
1284#
1285# "confidence": {
1286#
1287# "min": 0,
1288#
1289# "max": 100
1290#
1291# }
1292#
1293# }
1294#
1295# }
1296# }
1297#
1298# Arguments
1299# id: Provide configuration id
1300libraryConfiguration(id: ID!): LibraryConfiguration
1301
1302# Retrieve applications. These are custom applications integrated into
1303# the Veritone platform using the VDA framework.
1304# Example:
1305# Request:
1306# query {
1307#
1308# applications(limit:2) {
1309#
1310# records {
1311#
1312# id
1313#
1314# name
1315#
1316# }
1317#
1318# }
1319# }
1320# Response:
1321# {
1322#
1323# "data": {
1324#
1325# "applications": {
1326#
1327# "records": [
1328#
1329# {
1330#
1331# "id": "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a",
1332#
1333# "name": "appexamplebill"
1334#
1335# },
1336#
1337# {
1338#
1339# "id": "5908703b-51b4-4291-9787-b54bada73b0a",
1340#
1341# "name": "appexample2"
1342#
1343# }
1344#
1345# ]
1346#
1347# }
1348#
1349# }
1350# }
1351#
1352# Arguments
1353# id: Provide an ID to retrieve a single specific application.
1354# status: Provide a status, such as "draft" or "active"
1355# owned: If true, return only applications owned by the user's
1356# organization.
1357# orgId: For super admin user only, if specified, the query
1358# returns applications for this orgId.
1359# isPublic: Filter applications that are public
1360# excludeViewOnly: Include package grantType==VIEW
1361# filter: Filters for application attributes
1362# offset: Provide an offset to skip to a certain element in the
1363# result, for paging.
1364# limit: Specify maximum number of results to retrieve in this
1365# result. Page size.
1366# orderBy: Provide a list of ApplicationSortField to sort by.
1367# accessScope: Specify one or more access scopes to filter by
1368# accessible applications
1369applications(
1370id: ID,
1371status: ApplicationStatus,
1372owned: Boolean,
1373orgId: ID,
1374isPublic: Boolean,
1375excludeViewOnly: Boolean,
1376filter: ApplicationFilter,
1377offset: Int,
1378limit: Int,
1379orderBy: [ApplicationSortField],
1380accessScope: [AccessScope!]
1381): ApplicationList
1382
1383# Retrieve organizations
1384# Example:
1385# Request:
1386# query {
1387#
1388# organizations(limit:2) {
1389#
1390# records {
1391#
1392# id
1393#
1394# name
1395#
1396# }
1397#
1398# }
1399# }
1400# Response:
1401# {
1402#
1403# "data": {
1404#
1405# "organizations": {
1406#
1407# "records": [
1408#
1409# {
1410#
1411# "id": "35521",
1412#
1413# "name": "WTS API Docs Org"
1414#
1415# }
1416#
1417# ]
1418#
1419# }
1420#
1421# }
1422# }
1423#
1424# Arguments
1425# id: Provide an ID to retrieve a single specific organization.
1426# offset: Provide an offset to skip to a certain element in the
1427# result, for paging.
1428# limit: Specify maximum number of results to retrieve in this
1429# result. Page size.
1430# kvpProperty: Provide a property from the organization kvp to
1431# filter the organization list.
1432# kvpValue: Provide value to for the kvpFeature filter.
1433# If not present the filter becomes kvpProperty existence filter
1434# name: Optionally, supply a string for string match
1435# nameMatch: Supply the type of string match to apply.
1436organizations(
1437id: ID,
1438offset: Int,
1439limit: Int,
1440kvpProperty: String,
1441kvpValue: String,
1442name: String,
1443nameMatch: StringMatch,
1444isHubManaged: Boolean
1445): OrganizationList
1446
1447# Retrieve a single organization
1448# Example:
1449# Request:
1450# query {
1451#
1452# organization(id: "35521") {
1453#
1454# status
1455#
1456# }
1457# }
1458# Response:
1459# {
1460#
1461# "data": {
1462#
1463# "organization": {
1464#
1465# "status": "active"
1466#
1467# }
1468#
1469# }
1470# }
1471#
1472# Arguments
1473# id: The organization ID
1474# TODO take application ID as well as org ID
1475organization(id: ID!): Organization
1476
1477# Retrieve basic organization info about the organizations to which the user
1478# belongs
1479# Example:
1480# Request:
1481# query {
1482#
1483# myOrganizations {
1484#
1485# records {
1486#
1487# id
1488#
1489# name
1490#
1491# }
1492#
1493# }
1494# }
1495# Response:
1496# {
1497#
1498# "data": {
1499#
1500# "myOrganizations": {
1501#
1502# "records": [
1503#
1504# {
1505#
1506# "id": "35521",
1507#
1508# "name": "WTS API Docs Org"
1509#
1510# }
1511#
1512# ]
1513#
1514# }
1515#
1516# }
1517# }
1518#
1519# Arguments
1520# offset: Provide an offset to skip to a certain element in the
1521# result, for paging.
1522# limit: Specify maximum number of results to retrieve in this
1523# result. Page size.
1524# status: Filter by organization status
1525myOrganizations(
1526offset: Int,
1527limit: Int,
1528status: OrganizationStatus,
1529userName: String
1530): OrganizationInfoList
1531
1532# Retrieve the login configuration for an organization
1533# Example:
1534# Request:
1535# query {
1536#
1537# loginConfiguration(slug: "my-organization") {
1538#
1539# organizationInfo {
1540#
1541# id
1542#
1543# name
1544#
1545# }
1546#
1547# }
1548# }
1549# Response:
1550# {
1551#
1552# "data": {
1553#
1554# "loginConfiguration": {
1555#
1556# "organizationInfo": {
1557#
1558# "id": "12345",
1559#
1560# "name": "My Organization"
1561#
1562# }
1563#
1564# }
1565#
1566# }
1567# }
1568#
1569# Arguments
1570# slug: The login slug associated with the login configuration
1571# for an organization
1572loginConfiguration(slug: String!): LoginConfiguration
1573
1574# Retrieve all login configurations for the Instance
1575# Example:
1576# Request:
1577# query {
1578#
1579# instanceLoginConfigurations {
1580#
1581# records {
1582#
1583# slug
1584#
1585# }
1586#
1587# }
1588# }
1589# Response:
1590# {
1591#
1592# "data": {
1593#
1594# "instanceLoginConfigurations": {
1595#
1596# records: [
1597#
1598# {
1599#
1600# "slug": "instance-slug",
1601#
1602# },
1603#
1604# {
1605#
1606# "slug": "other-instance-slug",
1607#
1608# }
1609#
1610# ]
1611#
1612# }
1613#
1614# }
1615# }
1616#
1617# Arguments
1618# offset: Provide an offset to skip to a certain element in the
1619# result, for paging.
1620# limit: Specify maximum number of results to retrieve in this
1621# result. Page size.
1622instanceLoginConfigurations(offset: Int, limit: Int): LoginConfigurationList
1623
1624# Retrieve a single registration configuration
1625#
1626# Example:
1627# Request:
1628# query {
1629#
1630# registrationConfiguration(id: "12345") {
1631#
1632# slug
1633#
1634# }
1635# }
1636# Response:
1637# {
1638#
1639# "data": {
1640#
1641# "registrationConfiguration": {
1642#
1643# "slug": "test"
1644#
1645# }
1646#
1647# }
1648# }
1649#
1650# Arguments
1651# id: The registration configuration ID
1652registrationConfiguration(id: ID!): RegistrationConfiguration
1653
1654# Retrieve a single registration configuration by id:
1655#
1656# Example:
1657# Request:
1658# query {
1659#
1660# registrationConfiguration(id: "12345") {
1661#
1662# slug
1663#
1664# }
1665# }
1666# Response:
1667# {
1668#
1669# "data": {
1670#
1671# "registrationConfiguration": {
1672#
1673# "slug": "test"
1674#
1675# }
1676#
1677# }
1678# }
1679#
1680# Retrieve a registration configuration info by slug:
1681#
1682# Request:
1683# query {
1684#
1685# registrationConfigurationInfo(slug: "test") {
1686#
1687# id
1688#
1689# }
1690# }
1691# Response:
1692# {
1693#
1694# "data": {
1695#
1696# "registrationConfigurationInfo": {
1697#
1698# "id": "12345"
1699#
1700# }
1701#
1702# }
1703# }
1704#
1705# Arguments
1706# id: The registration configuration ID
1707# slug: The registration configuration url slug
1708registrationConfigurationInfo(id: ID, slug: String): RegistrationConfigurationInfo
1709
1710# Retrieve permissions
1711# Example:
1712# Request:
1713# query {
1714#
1715# permissions(limit:5) {
1716#
1717# records {
1718#
1719# id
1720#
1721# name
1722#
1723# }
1724#
1725# }
1726# }
1727#
1728# Response:
1729# {
1730#
1731# "data": {
1732#
1733# "permissions": {
1734#
1735# "records": [
1736#
1737# {
1738#
1739# "id": "2",
1740#
1741# "name": "admin.access"
1742#
1743# },
1744#
1745# {
1746#
1747# "id": "9",
1748#
1749# "name": "admin.group.create"
1750#
1751# },
1752#
1753# {
1754#
1755# "id": "12",
1756#
1757# "name": "admin.group.delete"
1758#
1759# },
1760#
1761# {
1762#
1763# "id": "10",
1764#
1765# "name": "admin.group.read"
1766#
1767# },
1768#
1769# {
1770#
1771# "id": "11",
1772#
1773# "name": "admin.group.update"
1774#
1775# }
1776#
1777# ]
1778#
1779# }
1780#
1781# }
1782# }
1783#
1784# Arguments
1785# id: Provide an ID to retrieve a single specific permission.
1786# offset: Provide an offset to skip to a certain element in the
1787# result, for paging.
1788# limit: Specify maximum number of results to retrieve in this
1789# result. Page size.
1790permissions(id: ID, name: String, offset: Int, limit: Int): PermissionList
1791
1792# Retrieve users
1793# Example:
1794# Request:
1795# query {
1796#
1797# users(
1798#
1799# organizationIds:"35521",
1800#
1801# limit: 2) {
1802#
1803# records {
1804#
1805# id
1806#
1807# name
1808#
1809# }
1810#
1811# }
1812# }
1813# Response:
1814# {
1815#
1816# "data": {
1817#
1818# "users": {
1819#
1820# "records": [
1821#
1822# {
1823#
1824# "id": "267de7e1-efb2-444a-a524-210328b78503",
1825#
1826# "name": "example"
1827#
1828# },
1829#
1830# {
1831#
1832# "id": "d8304ba1-0d4c-4268-a82c-8c62fd455066",
1833#
1834# "name": "example1"
1835#
1836# }
1837#
1838# ]
1839#
1840# }
1841#
1842# }
1843# }
1844#
1845# Arguments
1846# id: Provide an ID to retrieve a single specific user.
1847# A user ID is a string in UUID format.
1848# ids: Provide IDs to retrieve multiple users by ID.
1849# name: Provide a name, or part of one, to search by name.
1850# organizationIds: Provide a list of organization IDs to filter
1851# your search by organization.
1852# offset: Provide an offset to skip to a certain element in the
1853# result, for paging.
1854# limit: Specify maximum number of results to retrieve in this
1855# result. Page size.
1856# includeAllOrgUsers: Include all organization users.
1857# dateTimeFilter: Filter by date/time field
1858# status: Filter by account status
1859# statuses: Filter by account status list. Status field will take
1860# precedence if used
1861# roleIds: Filter by application roles
1862users(
1863id: ID,
1864ids: [ID],
1865name: String,
1866organizationIds: [ID],
1867offset: Int,
1868limit: Int,
1869includeAllOrgUsers: Boolean,
1870dateTimeFilter: [UsersDateTimeFilter!],
1871status: UserStatus,
1872statuses: [UserStatus!],
1873roleIds: [ID]
1874): UserList
1875
1876# Retrieve an individual user
1877# Example:
1878# Request:
1879# query {
1880#
1881# user(id: "267de7e1-efb2-444a-a524-210328b78503") {
1882#
1883# name
1884#
1885# status
1886#
1887# }
1888# }
1889# Response:
1890# {
1891#
1892# "data": {
1893#
1894# "user": {
1895#
1896# "name": "example",
1897#
1898# "status": "deleted"
1899#
1900# }
1901#
1902# }
1903# }
1904#
1905# Arguments
1906# id: The user ID.
1907# A user ID is a string in UUID format.
1908user(id: ID!, organizationIds: [ID]): User
1909
1910# Retrieve user's organization API tokens
1911# Example:
1912# Request:
1913# query {
1914#
1915# tokens {
1916#
1917# id
1918#
1919# applicationId
1920#
1921# }
1922# }
1923# Response:
1924# {
1925#
1926# "data": {
1927#
1928# "tokens": []
1929#
1930# }
1931# }
1932tokens: [Token]
1933
1934# Retrieve information for the current logged-in user
1935# Example:
1936# Request:
1937# query {
1938#
1939# me {
1940#
1941# id
1942#
1943# organizationId
1944#
1945# }
1946# }
1947# Response:
1948# {
1949#
1950# "data": {
1951#
1952# "me": {
1953#
1954# "id": "59cb4e74-7c31-4267-b91e-d4600bc08008",
1955#
1956# "organizationId": "35521"
1957#
1958# }
1959#
1960# }
1961# }
1962me: User
1963
1964# Retrieve groups
1965# Example:
1966# Request:
1967# query {
1968#
1969# groups {
1970#
1971# records {
1972#
1973# id
1974#
1975# name
1976#
1977# }
1978#
1979# }
1980# }
1981# Response:
1982# {
1983#
1984# "data": {
1985#
1986# "groups": {
1987#
1988# "records": [
1989#
1990# {
1991#
1992# "id": "8db639c1-c926-4f83-90de-d86c2ae5973d",
1993#
1994# "name": "WTS API Docs Org"
1995#
1996# }
1997#
1998# ]
1999#
2000# }
2001#
2002# }
2003# }
2004#
2005# Arguments
2006# id: Provide an ID to retrieve a specific group by ID
2007# ids: Provide IDs to retrieve multiple groups by ID
2008# name: Provide a name, or part of one, to search for groups by
2009# name
2010# organizationIds: "
2011# Provide a list of organization IDs to retrieve groups defined
2012# within certain organizations.
2013# offset: Provide an offset to skip to a certain element in the
2014# result, for paging.
2015# limit: Specify maximum number of results to retrieve in this
2016# result. Page size.
2017groups(id: ID, ids: [ID], name: String, organizationIds: [ID], offset: Int, limit: Int): GroupList
2018
2019# Retrieve a single mention
2020#
2021# Arguments
2022# mentionId: The mention ID
2023# limit: Comments pagination - limit
2024# offset: Comments pagination - limit
2025# userId: The user who owns the mention.
2026mention(mentionId: ID!, limit: Int, offset: Int, userId: String): Mention
2027
2028# Retrieve a shared mention
2029#
2030# Arguments
2031# shareId: share token
2032sharedMention(shareId: ID!): SharedMention
2033
2034# Search for mentions across an index.
2035# This query requires a user token.
2036# Known Issues:
2037# - Offset can not go past 10,000. To get around this, the best practice is to
2038# keep updating the start time of the query based on the last mention you have
2039# processed.
2040# Example:
2041# Request:
2042# query{
2043#
2044# searchMentions(search:{
2045#
2046# offset: 0
2047#
2048# limit: 1
2049#
2050# index: ["mine"]
2051#
2052# query:{
2053#
2054# operator: "and"
2055#
2056# conditions: [{
2057#
2058# operator: "term"
2059#
2060# field: "trackingUnitName"
2061#
2062# value: "Dallas Cowboys Super Bowl"
2063#
2064# },
2065#
2066# {
2067#
2068# operator: "term"
2069#
2070# field: "mentionStatusId"
2071#
2072# value: "1"
2073#
2074# }]
2075#
2076# }
2077#
2078# }) {
2079#
2080# jsondata
2081#
2082# }
2083# }
2084# Response:
2085# {
2086#
2087# "data": {
2088#
2089# "searchMentions": {
2090#
2091# "jsondata": {
2092#
2093# "results": [
2094#
2095# {
2096#
2097# "id": 47569938,
2098#
2099# "programFormatName": "Information and News",
2100#
2101# "mentionDate": "2017-01-31T07:59:18.000Z",
2102#
2103# "mediaStartTime": "2017-01-31T07:45:01.000Z",
2104#
2105# "mediaId": 20017455,
2106#
2107# "metadata": {
2108#
2109# "filename": "AM-RADIO",
2110#
2111# "veritone-file": {
2112#
2113# "size": 0,
2114#
2115# "filename": "AM-RADIO",
2116#
2117# "mimetype": "audio/mpeg"
2118#
2119# },
2120#
2121# "veritone-media-source": {
2122#
2123# "mediaSourceId": "14326",
2124#
2125# "mediaSourceTypeId": "1"
2126#
2127# },
2128#
2129# "veritone-program": {
2130#
2131# "programId": "3828",
2132#
2133# "programName": "AM-RADIO Morning Talk",
2134#
2135# "programImage":
2136# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2137#
2138# "programLiveImage":
2139# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG"
2140#
2141# }
2142#
2143# },
2144#
2145# "fileLocation":
2146# "https://inspirent.s3.amazonaws.com/recordings/9605ea97-87df-428e-6740-720df8b8691c_original.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T205111Z&X-Amz-Expires=604800&X-Amz-Signature=00f62a6e2367c109320c98b9aea190cd28d82ac347eeeca030f42810b7ab75e3&X-Amz-SignedHeaders=host",
2147#
2148# "fileType": "audio/mpeg",
2149#
2150# "snippets": [
2151#
2152# {
2153#
2154# "startTime": 857.62,
2155#
2156# "endTime": 887.33,
2157#
2158# "text": "eighty first women's Australian Open final Monica Seles beat Steffi
2159# Graf four six six three six two in one thousand nine hundred twenty eight the
2160# Dallas Cowboys beat the Buffalo Bills thirty to thirteen in Atlanta running back
2161# Emmitt Smith wins the M.V.P. and fourth consecutive Super Bowl game loss to the
2162# Cowboys twenty sixteen at the one hundred fourth women's Australian Open final
2163# six three six six four that time capsule your",
2164#
2165# "hits": [
2166#
2167# {
2168#
2169# "startTime": 865.7,
2170#
2171# "endTime": 865.929,
2172#
2173# "queryTerm": "Dallas"
2174#
2175# },
2176#
2177# {
2178#
2179# "startTime": 865.93,
2180#
2181# "endTime": 866.07,
2182#
2183# "queryTerm": "Cowboys"
2184#
2185# },
2186#
2187# {
2188#
2189# "startTime": 872.74,
2190#
2191# "endTime": 873.31,
2192#
2193# "queryTerm": "Super"
2194#
2195# },
2196#
2197# {
2198#
2199# "startTime": 873.31,
2200#
2201# "endTime": 873.43,
2202#
2203# "queryTerm": "Bowl"
2204#
2205# }
2206#
2207# ]
2208#
2209# }
2210#
2211# ],
2212#
2213# "userSnippets": null,
2214#
2215# "advertiserId": 0,
2216#
2217# "advertiserName": "",
2218#
2219# "brandId": 0,
2220#
2221# "brandImage": "",
2222#
2223# "brandName": "",
2224#
2225# "campaignId": 0,
2226#
2227# "campaignName": "",
2228#
2229# "organizationId": 7295,
2230#
2231# "organizationName": "Demo Organization",
2232#
2233# "trackingUnitId": 10032,
2234#
2235# "trackingUnitName": "Dallas Cowboys Super Bowl",
2236#
2237# "mentionStatusId": 1,
2238#
2239# "mediaSourceTypeId": 1,
2240#
2241# "mediaSourceTypeName": "Audio",
2242#
2243# "mediaSourceId": 14326,
2244#
2245# "mediaSourceName": "AM-RADIO Morning Talk",
2246#
2247# "isNational": true,
2248#
2249# "spotTypeId": null,
2250#
2251# "spotTypeName": null,
2252#
2253# "programId": 3828,
2254#
2255# "programName": "AM-RADIO",
2256#
2257# "programImage":
2258# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e59d4-a986-4e2b-b525-482319df3350%2FbrdProgram%2F2uGsLVKsQeiKN3UuHufC_941478_10151455644772706_951533539_n.jpg",
2259#
2260# "programLiveImage":
2261# "https://s3.amazonaws.com/prod-veritone-ugc/cb5e52b4-a986-4e2b-b525-482319df3350%2FbrdProgram%2FwwEn3Ya9RgmMQwUEGoD1_LUkKlgZQS36ncUbY8Iz7_2520to%2520live2.JPG",
2262#
2263# "impressions": 1894,
2264#
2265# "audience": [
2266#
2267# {
2268#
2269# "gender": "men",
2270#
2271# "age_group": "35-44",
2272#
2273# "audience": 11,
2274#
2275# "isTargetMatch": true
2276#
2277# },
2278#
2279# {
2280#
2281# "gender": "men",
2282#
2283# "age_group": "45-49",
2284#
2285# "audience": 121,
2286#
2287# "isTargetMatch": true
2288#
2289# },
2290#
2291# {
2292#
2293# "gender": "men",
2294#
2295# "age_group": "50-54",
2296#
2297# "audience": 474,
2298#
2299# "isTargetMatch": true
2300#
2301# },
2302#
2303# {
2304#
2305# "gender": "men",
2306#
2307# "age_group": "65+",
2308#
2309# "audience": 95,
2310#
2311# "isTargetMatch": true
2312#
2313# },
2314#
2315# {
2316#
2317# "gender": "women",
2318#
2319# "age_group": "50-54",
2320#
2321# "audience": 19,
2322#
2323# "isTargetMatch": false
2324#
2325# },
2326#
2327# {
2328#
2329# "gender": "women",
2330#
2331# "age_group": "65+",
2332#
2333# "audience": 693,
2334#
2335# "isTargetMatch": false
2336#
2337# },
2338#
2339# {
2340#
2341# "gender": "men",
2342#
2343# "age_group": "55-64",
2344#
2345# "audience": 481,
2346#
2347# "isTargetMatch": true
2348#
2349# }
2350#
2351# ],
2352#
2353# "targetAudience": {
2354#
2355# "gender": 1,
2356#
2357# "genderName": "M",
2358#
2359# "ageGroup": [
2360#
2361# 0,
2362#
2363# 5
2364#
2365# ],
2366#
2367# "ageGroupMin": 18,
2368#
2369# "ageGroupMax": 0,
2370#
2371# "impressions": 1182
2372#
2373# },
2374#
2375# "audienceMarketCount": 3,
2376#
2377# "audienceAffiliateCount": 1,
2378#
2379# "rating": null,
2380#
2381# "ratings": null,
2382#
2383# "comments": null,
2384#
2385# "markets": [
2386#
2387# {
2388#
2389# "marketId": 54,
2390#
2391# "marketName": "Des Moines-Ames, IA"
2392#
2393# }
2394#
2395# ],
2396#
2397# "marketId": null,
2398#
2399# "marketName": null,
2400#
2401# "hourOfDay": 7,
2402#
2403# "dayOfWeek": 2,
2404#
2405# "dayOfMonth": 31,
2406#
2407# "month": 1,
2408#
2409# "year": 2017,
2410#
2411# "isMatch": true,
2412#
2413# "mentionStatusName": "Pending Verification",
2414#
2415# "complianceStatusId": null,
2416#
2417# "cognitiveEngineResults": null,
2418#
2419# "hits": 4
2420#
2421# }
2422#
2423# ],
2424#
2425# "totalResults": 579,
2426#
2427# "limit": 1,
2428#
2429# "from": 0,
2430#
2431# "to": 0,
2432#
2433# "searchToken": "ae882400-e1d9-11e7-947b-339cddca931e",
2434#
2435# "timestamp": 1513371071
2436#
2437# }
2438#
2439# }
2440#
2441# }
2442# }
2443#
2444# Arguments
2445# search: JSON structure containing the search query.
2446# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2447# search query syntax
2448searchMentions(search: JSONData!): SearchResult
2449
2450# Search for media across an index.
2451# This query requires a user token.
2452# Example:
2453# Request:
2454# query{
2455#
2456# searchMedia(search:{
2457#
2458# offset: 0
2459#
2460# limit: 1
2461#
2462# index: ["mine"]
2463#
2464# query:{
2465#
2466# operator: "query_string"
2467#
2468# field: "transcript.transcript"
2469#
2470# value: "paris NOT \"las vegas\""
2471#
2472# }
2473#
2474# }) {
2475#
2476# jsondata
2477#
2478# }
2479# }
2480# Response:
2481# {
2482#
2483# "data": {
2484#
2485# "searchMedia": {
2486#
2487# "jsondata": {
2488#
2489# "results": [
2490#
2491# {
2492#
2493# "recording": {
2494#
2495# "recordingId": "43033727",
2496#
2497# "fileLocation":
2498# "https://inspirent.s3.amazonaws.com/assets/43033727/ea9d9845-775b-48cd-aada-16fa56894ba0.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI7L6G7PCOOOLA7MQ%2F20171215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20171215T181255Z&X-Amz-Expires=604800&X-Amz-Signature=2fd918d5ac20979bd27d365bfa455904cf1726307fddbd362a28a8bd9a0a81a8&X-Amz-SignedHeaders=host",
2499#
2500# "fileType": "video/mp4",
2501#
2502# "programId": "-1",
2503#
2504# "programName": "Weekly Talkshow",
2505#
2506# "programLiveImage":
2507# "https://inspirent.s3.amazonaws.com/assets/43033727/fe693b30-18ae-47c7-984f-530eab61d7.jpeg",
2508#
2509# "mediaSourceId": "-1",
2510#
2511# "mediaSourceTypeId": "5",
2512#
2513# "sliceTime": 1512682022,
2514#
2515# "mediaStartTime": 1512681992,
2516#
2517# "aibDuration": 90,
2518#
2519# "isOwn": true,
2520#
2521# "hitStartTime": 1512682022,
2522#
2523# "hitEndTime": 1512682082
2524#
2525# },
2526#
2527# "startDateTime": 1512682022,
2528#
2529# "stopDateTime": 1512682082,
2530#
2531# "hits": [
2532#
2533# {
2534#
2535# "veritone-file": {
2536#
2537# "filename": "Veritone_v06.mp4",
2538#
2539# "mimetype": "video/mp4",
2540#
2541# "size": 162533502
2542#
2543# }
2544#
2545# }
2546#
2547# ]
2548#
2549# }
2550#
2551# ],
2552#
2553# "totalResults": 733275,
2554#
2555# "limit": 1,
2556#
2557# "from": 0,
2558#
2559# "to": 0,
2560#
2561# "searchToken": "930f0960-e1c3-11e7-9e94-eba5f6b5faf7",
2562#
2563# "timestamp": 1513361576
2564#
2565# }
2566#
2567# }
2568#
2569# }
2570# }
2571#
2572# Arguments
2573# search: JSON structure containing the search query.
2574# See https://docs.veritone.com/#/apis/search-quickstart for full details on the
2575# search query syntax
2576searchMedia(search: JSONData!): SearchResult
2577
2578# Retrieve the root folders for an organization
2579# Example:
2580# Request:
2581# query {
2582#
2583# rootFolders {
2584#
2585# id
2586#
2587# typeId
2588#
2589# }
2590# }
2591# Response:
2592# {
2593#
2594# "data": {
2595#
2596# "rootFolders": [
2597#
2598# {
2599#
2600# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
2601#
2602# "typeId": 4
2603#
2604# },
2605#
2606# {
2607#
2608# "id": "d3e27eb3-7d4a-47ab-af64-bf1529390f4e",
2609#
2610# "typeId": 4
2611#
2612# }
2613#
2614# ]
2615#
2616# }
2617# }
2618#
2619# Arguments
2620# type: The type of root folder to retrieve
2621rootFolders(type: RootFolderType): [Folder]
2622
2623# Retrieve a single folder. Used to navigate the folder tree structure.
2624# Example:
2625# Request:
2626# query {
2627#
2628# folder(id: "2ac28573-917a-4c4b-be91-a0ac64cbc982") {
2629#
2630# typeId
2631#
2632# id
2633#
2634# childFolders{
2635#
2636# records{
2637#
2638# id
2639#
2640# }
2641#
2642# }
2643#
2644# }
2645# }
2646# Response:
2647# {
2648#
2649# "data": {
2650#
2651# "folder": {
2652#
2653# "typeId": 4,
2654#
2655# "id": "3104f61f-4bd1-4175-9fe6-27436d591c54",
2656#
2657# "childFolders": {
2658#
2659# "records": [
2660#
2661# {
2662#
2663# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320"
2664#
2665# },
2666#
2667# {
2668#
2669# "id": "a347319d-72da-43a2-93fc-e677876aca80"
2670#
2671# }
2672#
2673# ]
2674#
2675# }
2676#
2677# }
2678#
2679# }
2680# }
2681#
2682# Arguments
2683# id: Provide an ID to retrieve a single specific user.
2684folder(id: ID!): Folder
2685
2686# Retrieve the current platform information.
2687# Example:
2688# Request:
2689# query {
2690#
2691# platformInfo {
2692#
2693# properties
2694#
2695# aiWAREVersion {
2696#
2697# currentVersion {
2698#
2699# version
2700#
2701# }
2702#
2703# previousVersion {
2704#
2705# version
2706#
2707# }
2708#
2709# nextVersion {
2710#
2711# version
2712#
2713# }
2714#
2715# }
2716#
2717# aiWAREVersionHistory(offset: 0, limit: 30) {
2718#
2719# platformVersion {
2720#
2721# id
2722#
2723# version
2724#
2725# }
2726#
2727# id
2728#
2729# },
2730#
2731# aiWAREVersionList (orderBy: version, orderDirection: desc) {
2732#
2733# count
2734#
2735# records {
2736#
2737# id
2738#
2739# version
2740#
2741# }
2742#
2743# }
2744#
2745# }
2746# }
2747# Response:
2748# {
2749#
2750# "data": {
2751#
2752# "platformInfo": {
2753#
2754# "properties": {
2755#
2756# "Environment": "US West",
2757#
2758# "ClusterSize": "small"
2759#
2760# }
2761#
2762# "aiWAREVersion": {
2763#
2764# "currentVersion": {
2765#
2766# "version": "1.1.0"
2767#
2768# },
2769#
2770# "previousVersion": {
2771#
2772# "version": "1.0.0"
2773#
2774# },
2775#
2776# "nextVersion": {
2777#
2778# "version": "1.2.0"
2779#
2780# }
2781#
2782# },
2783#
2784# "aiWAREVersionHistory": [
2785#
2786# {
2787#
2788# platformVersion:
2789#
2790# {
2791#
2792# "id": "c7a91281-6a1e-46d4-9f2c-7f8b4a1fc493",
2793#
2794# "version": "1.3.0"
2795#
2796# },
2797#
2798# "id": "30c9c2a2-ae6a-4be2-b80c-6893d8b56780"
2799#
2800# },
2801#
2802# {
2803#
2804# platformVersion:
2805#
2806# {
2807#
2808# "id": "f785bc56-2d43-472e-8629-99f9b9a5c57e",
2809#
2810# "version": "1.3.0"
2811#
2812# },
2813#
2814# "id": "7b8a2ab2-00de-4f1b-9fb1-99e7a9cd108f"
2815#
2816# },
2817#
2818# {
2819#
2820# platformVersion:
2821#
2822# {
2823#
2824# "id": "3c4c0b46-1a61-45ab-9f3e-b8f7a14bfaa7",
2825#
2826# "version": "1.3.0"
2827#
2828# },
2829#
2830# "id": "d3499a78-efc7-4a72-a12d-852f53231e33"
2831#
2832# }
2833#
2834# ],
2835#
2836# "aiWAREVersionList": {
2837#
2838# "count": 3,
2839#
2840# "records": [
2841#
2842# {
2843#
2844# "id": "799150bb-8d67-4cd1-b204-d9346e012588",
2845#
2846# "version": "1.0.11"
2847#
2848# },
2849#
2850# {
2851#
2852# "id": "2892e80d-e0bf-4ffc-be17-4bb173d6ad29",
2853#
2854# "version": "1.0.2"
2855#
2856# },
2857#
2858# {
2859#
2860# "id": "095b9558-6fc1-4775-9696-082b9f098c47",
2861#
2862# "version": "1.0.1"
2863#
2864# },
2865#
2866# ]
2867#
2868# }
2869#
2870# }
2871#
2872# }
2873# }
2874platformInfo: PlatformInfo!
2875
2876# Example:
2877# Request:
2878# query {
2879#
2880# auditEvents(limit: 2) {
2881#
2882# records {
2883#
2884# id
2885#
2886# application
2887#
2888# }
2889#
2890# }
2891# }
2892# Response:
2893# {
2894#
2895# "data": {
2896#
2897# "auditEvents": {
2898#
2899# "records": [
2900#
2901# {
2902#
2903# "id": "fdc7b3a3-ab23-4866-a330-c0ad910cd64f",
2904#
2905# "application": ""
2906#
2907# }
2908#
2909# ]
2910#
2911# }
2912#
2913# }
2914# }
2915#
2916# Arguments
2917# query: An elastic query for audit events
2918# application: Filter logs by a specific application
2919# terms: Term filters to filter documents by properties in the
2920# payload
2921auditEvents(
2922query: JSONData,
2923orderDirection: OrderDirection,
2924application: String,
2925terms: [JSONData!],
2926limit: Int,
2927offset: Int
2928): AuditEventList!
2929
2930# Retrieve a folder overview
2931# Example:
2932# Request:
2933# query {
2934#
2935# folderOverview(ids:"3104f61f-4bd1-4175-9fe6-27436d591c54") {
2936#
2937# childFoldersCount
2938#
2939# childNonFolderObjectsCount
2940#
2941# }
2942# }
2943# Response:
2944# {
2945#
2946# "data": {
2947#
2948# "folderOverview": {
2949#
2950# "childFoldersCount": 3,
2951#
2952# "childNonFolderObjectsCount": 0
2953#
2954# }
2955#
2956# }
2957# }
2958#
2959# Arguments
2960# ids: Tree Object Ids
2961folderOverview(ids: [ID!]!, rootFolderType: RootFolderType): FolderOverview
2962
2963# Example:
2964# Request:
2965# query {
2966#
2967# folderSummaryDetails(ids: "3104f61f-4bd1-4175-9fe6-27436d591c54") {
2968#
2969# id
2970#
2971# typeId
2972#
2973# }
2974# }
2975# Response:
2976# {
2977#
2978# "data": {
2979#
2980# "folderSummaryDetails": [
2981#
2982# {
2983#
2984# "id": "1580701928",
2985#
2986# "typeId": 5
2987#
2988# },
2989#
2990# {
2991#
2992# "id": "1580388995",
2993#
2994# "typeId": 5
2995#
2996# },
2997#
2998# {
2999#
3000# "id": "2ac28573-917a-4c4b-be91-a0ac64cbc982",
3001#
3002# "typeId": 4
3003#
3004# },
3005#
3006# {
3007#
3008# "id": "243625",
3009#
3010# "typeId": 3
3011#
3012# },
3013#
3014# {
3015#
3016# "id": "242599",
3017#
3018# "typeId": 3
3019#
3020# },
3021#
3022# {
3023#
3024# "id": "d551fbd6-7354-4b0e-abfb-654ab8583be2",
3025#
3026# "typeId": 1
3027#
3028# },
3029#
3030# {
3031#
3032# "id": "a347319d-72da-43a2-93fc-e677876aca80",
3033#
3034# "typeId": 1
3035#
3036# },
3037#
3038# {
3039#
3040# "id": "9d639f1b-a0d4-47b0-8149-3568f048f320",
3041#
3042# "typeId": 1
3043#
3044# }
3045#
3046# ]
3047#
3048# }
3049# }
3050#
3051# Arguments
3052# ids: Tree Object Ids
3053folderSummaryDetails(
3054ids: [ID!]!,
3055rootFolderType: RootFolderType
3056): [FolderSummaryDetail]
3057
3058# Retrieve configs for a given application
3059# Example:
3060# Request:
3061# query {
3062#
3063# applicationConfig(applicationId: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3064#
3065# records: {
3066#
3067# configType
3068#
3069# configLevel
3070#
3071# }
3072#
3073# offset: 0
3074#
3075# limit: 1
3076#
3077# }
3078# }
3079# Response:
3080# {
3081#
3082# "data": {
3083#
3084# "applicationConfig": {
3085#
3086# "records": {
3087#
3088# "configType": "String",
3089#
3090# "configLevel": "Organization"
3091#
3092# }
3093#
3094# }
3095#
3096# }
3097# }
3098#
3099# Arguments
3100# orgId: Optional. Organization ID.
3101#
3102# If not specified, this will be the user's organization
3103# userId: Optional. If specified, returned the configs for this
3104# user and organization combo
3105# includeDefaults: If true, include defaults not specified
3106# configKeyRegexp: If specified, filter the configKey
3107# offset: Specify maximum number of results to retrieve in this
3108# result. Page size.
3109# limit: Specify maximum number of results to retrieve in this
3110# result.
3111applicationConfig(
3112appId: ID!,
3113orgId: ID,
3114userId: ID,
3115includeDefaults: Boolean,
3116configKeyRegexp: String,
3117offset: Int,
3118limit: Int
3119): ApplicationConfigList!
3120
3121# Retrieve config definitions for a given application
3122# Example:
3123# Request:
3124# query {
3125#
3126# applicationConfigDefinition(applicationId:
3127# "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a", configKey: 'dark mode') {
3128#
3129# records: {
3130#
3131# configType
3132#
3133# defaultValue
3134#
3135# }
3136#
3137# offset: 0
3138#
3139# limit: 1
3140#
3141# }
3142# }
3143# Response:
3144# {
3145#
3146# "data": {
3147#
3148# "applicationConfigDefinition": {
3149#
3150# "records": [{
3151#
3152# "configType": Boolean,
3153#
3154# "defaultValue": true,
3155#
3156# }]
3157#
3158# }
3159#
3160# }
3161# }
3162#
3163# Arguments
3164# configKey: If specified, grab definition for this config key
3165# offset: Specify maximum number of results to retrieve in this
3166# result. Page size.
3167# limit: Specify maximum number of results to retrieve in this
3168# result.
3169applicationConfigDefinition(
3170appId: ID!,
3171configKey: String,
3172offset: Int,
3173limit: Int
3174): ApplicationConfigDefinitionList!
3175
3176# Retrieve a single application
3177# Example:
3178# Request:
3179# query {
3180#
3181# application(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3182#
3183# name
3184#
3185# key
3186#
3187# }
3188# }
3189# Response:
3190# {
3191#
3192# "data": {
3193#
3194# "application": {
3195#
3196# "name": "appexamplebill",
3197#
3198# "key": "appexamplebill"
3199#
3200# }
3201#
3202# }
3203# }
3204#
3205# Arguments
3206# id: The application ID
3207# excludeViewOnly: Only retrieve package grantType=VIEW when
3208# explicitly enter false
3209application(id: ID!, excludeViewOnly: Boolean): Application
3210
3211# Retrieve headerbar information for an application
3212# Example:
3213# Request:
3214# query {
3215#
3216# applicationHeaderbar(id: "47bd3e25-f4ea-435f-b69b-13cb4f9dd60a") {
3217#
3218# name
3219#
3220# config {
3221#
3222# title
3223#
3224# }
3225#
3226# }
3227# }
3228# Response:
3229# {
3230#
3231# "data": {
3232#
3233# "applicationHeaderbar": {
3234#
3235# "name": "APP_BAR",
3236#
3237# "config": {
3238#
3239# "title": "Library"
3240#
3241# }
3242#
3243# }
3244#
3245# }
3246# }
3247#
3248# Arguments
3249# appId: The application ID
3250# orgId: Optional organization ID. Normally this value is
3251# computed by the server
3252# based on the authorization token used for the request.
3253applicationHeaderbar(appId: ID!, orgId: ID): ApplicationHeaderbar
3254
3255# Retrieve a list of schemas for structured data ingestions\
3256# Example:
3257# Request:
3258# query {
3259#
3260# schemas(limit: 2) {
3261#
3262# records {
3263#
3264# id
3265#
3266# organizationId
3267#
3268# }
3269#
3270# }
3271# }
3272# Response:
3273# {
3274#
3275# "data": {
3276#
3277# "schemas": {
3278#
3279# "records": [
3280#
3281# {
3282#
3283# "id": "21a08123-45dc-497e-b329-360d9f3fcaac",
3284#
3285# "organizationId": "35521"
3286#
3287# },
3288#
3289# {
3290#
3291# "id": "57aa1618-344d-4d35-9980-5fe1ec6c3112",
3292#
3293# "organizationId": "35521"
3294#
3295# }
3296#
3297# ]
3298#
3299# }
3300#
3301# }
3302# }
3303#
3304# Arguments
3305# id: Id of a schema to retrieve
3306# ids: Ids of schemas to retrieve
3307# dataRegistryId: Specify the id of the DataRegistry to get
3308# schemas
3309# status: Specify one or more statuses to filter by schema status
3310# majorVersion: Specify a major version to filter schemas
3311# name: Specify a data registry name to filter schemas
3312# nameMatch: The strategy used to find data registry name
3313# accessScope: Specify one or more access scopes to filter by
3314# accessible schemas
3315# limit: Limit
3316# offset: Offset
3317# orderBy: Specify one or more fields and direction to order
3318# results
3319schemas(
3320id: ID,
3321ids: [ID!],
3322dataRegistryId: ID,
3323status: [SchemaStatus!],
3324majorVersion: Int,
3325name: String,
3326nameMatch: StringMatch,
3327accessScope: [AccessScope!],
3328limit: Int,
3329offset: Int,
3330orderBy: [SchemaOrder]
3331): SchemaList
3332
3333# Retrieve a schema for structured data ingestions
3334# Example:
3335# Request:
3336# query {
3337#
3338# schema(id: "21a08123-45dc-497e-b329-360d9f3fcaac") {
3339#
3340# definition
3341#
3342# status
3343#
3344# }
3345# }
3346# Response:
3347# {
3348#
3349# "data": {
3350#
3351# "schema": {
3352#
3353# "definition": {
3354#
3355# "example": "example value"
3356#
3357# },
3358#
3359# "status": "draft"
3360#
3361# }
3362#
3363# }
3364# }
3365#
3366# Arguments
3367# id: Supply the ID of the schema to retrieve
3368schema(id: ID!): Schema
3369
3370# Example:
3371# Request:
3372# query {
3373#
3374# schemaProperties(limit: 2) {
3375#
3376# records {
3377#
3378# type
3379#
3380# dataRegistryId
3381#
3382# }
3383#
3384# }
3385# }
3386# Response:
3387# {
3388#
3389# "data": {
3390#
3391# "schemaProperties": {
3392#
3393# "records": [
3394#
3395# {
3396#
3397# "type": "string",
3398#
3399# "dataRegistryId": "c3c9fa66-15b2-4bc4-b37f-c790e3ea0db6"
3400#
3401# },
3402#
3403# {
3404#
3405# "type": "string",
3406#
3407# "dataRegistryId": "dbfa78af-f935-4ace-8a70-f70ca36ce49c"
3408#
3409# }
3410#
3411# ]
3412#
3413# }
3414#
3415# }
3416# }
3417#
3418# Arguments
3419# limit: Limit
3420# offset: Offset
3421schemaProperties(
3422dataRegistryVersion: [DataRegistryVersion!],
3423search: String,
3424limit: Int,
3425offset: Int
3426): SchemaPropertyList
3427
3428# Retrieve a structured data object
3429# Example:
3430# Request:
3431# query {
3432#
3433# structuredData(
3434#
3435# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3436#
3437# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3438#
3439# data
3440#
3441# }
3442# }
3443# Response:
3444# {
3445#
3446# "data": {
3447#
3448# "structuredData": {
3449#
3450# "data": {
3451#
3452# "example": "example"
3453#
3454# }
3455#
3456# }
3457#
3458# }
3459# }
3460#
3461# Arguments
3462# id: Supply the ID of the structured data object to retrieve.
3463# This will override filters.
3464# schemaId: Schema Id for the structured data object to retrieve
3465structuredData(id: ID!, schemaId: ID!): StructuredData
3466
3467# Retrieve a structured data object
3468# Example:
3469# Request:
3470# query {
3471#
3472# structuredDataObject(
3473#
3474# id: "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3475#
3476# schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3477#
3478# data
3479#
3480# }
3481# }
3482# Response:
3483# {
3484#
3485# "data": {
3486#
3487# "structuredDataObject": {
3488#
3489# "data": {
3490#
3491# "example": "example"
3492#
3493# }
3494#
3495# }
3496#
3497# }
3498# }
3499#
3500# Arguments
3501# id: Supply the ID of the structured data object to retrieve.
3502# This will override filters.
3503# schemaId: Schema Id for the structured data object to retrieve
3504structuredDataObject(id: ID!, schemaId: ID!): StructuredData
3505
3506# Retrieve a paginated list of structured data object
3507# Example:
3508# Request:
3509# query {
3510#
3511# structuredDataObjects(schemaId: "acab8bd9-a4d4-44de-ad4b-cc949d696cf9") {
3512#
3513# records {
3514#
3515# id
3516#
3517# data
3518#
3519# }
3520#
3521# }
3522# }
3523# Response:
3524# {
3525#
3526# "data": {
3527#
3528# "structuredDataObjects": {
3529#
3530# "records": [
3531#
3532# {
3533#
3534# "id": "bbc0d388-b7ed-4073-9760-cb7701130eaf",
3535#
3536# "data": {
3537#
3538# "example": "example"
3539#
3540# }
3541#
3542# },
3543#
3544# {
3545#
3546# "id": "f914eafe-ed9b-46b1-a48d-effd5575764a",
3547#
3548# "data": {
3549#
3550# "example": "example"
3551#
3552# }
3553#
3554# }
3555#
3556# ]
3557#
3558# }
3559#
3560# }
3561# }
3562#
3563# Arguments
3564# id: Supply the ID of the structured data object to retrieve.
3565# This will override filters.
3566# ids: List of Ids of the structured data objects to retrieve.
3567# This will override filters.
3568# schemaId: Schema Id for the structured data object to retrieve
3569# filter: Passing id or ids argument will override the filter.
3570# Any field in the SDO's data column can be used as a filter with 'exact match'
3571# comparison.
3572# E.g.:
3573#
3574# filter: {
3575#
3576# name: "This is an example"
3577#
3578# }
3579structuredDataObjects(
3580id: ID,
3581ids: [ID!],
3582schemaId: ID!,
3583orderBy: [StructuredDataOrderBy!],
3584limit: Int,
3585offset: Int,
3586owned: Boolean,
3587filter: JSONData,
3588dateTimeFilter: SdoDateTimeFilter
3589): StructuredDataList
3590
3591# Returns information about the GraphQL server, useful
3592# for diagnostics. This data is primarily used by Veritone
3593# development, and some fields may be restricted to Veritone administrators.
3594graphqlServiceInfo: GraphQLServiceInfo
3595
3596# Returns a signed writable S3 URL. A client can then
3597# upload to this URL with an HTTP PUT without providing
3598# any additional authorization (_note_: it must be a PUT.
3599# A POST will fail.)
3600# Example:
3601# Request:
3602# query {
3603#
3604# getSignedWritableUrl(type: "preview") {
3605#
3606# bucket
3607#
3608# key
3609#
3610# url
3611#
3612# }
3613# }
3614# Response:
3615# {
3616#
3617# "data": {
3618#
3619# "getSignedWritableUrl": {
3620#
3621# "bucket": "prod-api.veritone.com",
3622#
3623# "key":
3624# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3625#
3626# "url":
3627# "https://s3.amazonaws.com/prod-api.veritone.com/35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194850Z&X-Amz-Expires=86400&X-Amz-Signature=44857350a7f0b7311d4b911b557f4171a6ffe126c76e3d26f6e5cd532f645e53&X-Amz-SignedHeaders=host"
3628#
3629# }
3630#
3631# }
3632# }
3633#
3634# Arguments
3635# key: Optional key of the object to generate a writable
3636# URL for. If not provided, a new, unique key will
3637# be generated. If a key is provided and resembles a file name
3638# (with extension delimited by .), a UUID will be inserted
3639# into the file name, leaving the extension intact.
3640# If a key is provided and does not resemble
3641# a file name, a UUID will be appended.
3642# type: Optional type of resource, such as `asset`, `thumbnail`,
3643# `discovery-analytics` or `preview`
3644# path: Optional extended path information. If the uploaded
3645# content will be contained
3646# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3647# (for `entityIdentifier`), the ID of the object should be provided here.
3648# expiresInSeconds: Optional expiresInSeconds custom expiration
3649# to signedUrlExpires
3650# Max expiresInSeconds up to 604800
3651# organizationId: Optional organization ID. Normally this value
3652# is computed by the server
3653# based on the authorization token used for the request.
3654# Is is used only by Veritone platform components.
3655getSignedWritableUrl(
3656key: String,
3657type: String,
3658path: String,
3659expiresInSeconds: Int,
3660organizationId: ID
3661): WritableUrlInfo
3662
3663# Return writable storage URLs in bulk.
3664# A maximum of 1000 can be created in one call.
3665# See `getSignedWritableUrl` for details on usage of the
3666# response contents.
3667# Example:
3668# Request:
3669# query {
3670#
3671# getSignedWritableUrls(number: 2) {
3672#
3673# bucket
3674#
3675# key
3676#
3677# url
3678#
3679# }
3680# }
3681# Response:
3682# {
3683#
3684# "data": {
3685#
3686# "getSignedWritableUrls": [
3687#
3688# {
3689#
3690# "bucket": "prod-api.veritone.com",
3691#
3692# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3693#
3694# "url":
3695# "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=57c8d9046297e6d6839d19e7d22552618e9ff89dd4855ca7f7aceb26e89d3de4&X-Amz-SignedHeaders=host"
3696#
3697# },
3698#
3699# {
3700#
3701# "bucket": "prod-api.veritone.com",
3702#
3703# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3704#
3705# "url":
3706# "https://s3.amazonaws.com/prod-api.veritone.com/35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQMR5VATUHU3MEGOA%2F20210618%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210618T194919Z&X-Amz-Expires=86400&X-Amz-Signature=9e139df517ca85fa0b969f0d3ff55b890b8a5e199c4fa7b3a26ea2f12a65bfec&X-Amz-SignedHeaders=host"
3707#
3708# }
3709#
3710# ]
3711#
3712# }
3713# }
3714#
3715# Arguments
3716# number: Number of signed URLs to return
3717# type: Optional type of resource, such as `asset`, `thumbnail`,
3718# or `preview`
3719# path: Optional extended path information. If the uploaded
3720# content will be contained
3721# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3722# (for `entityIdentifier`), the ID of the object should be provided here.
3723# organizationId: Optional organization ID. Normally this value
3724# is computed by the server
3725# based on the authorization token used for the request.
3726# Is is used only by Veritone platform components.
3727getSignedWritableUrls(
3728number: Int!,
3729type: String,
3730path: String,
3731organizationId: ID
3732): [WritableUrlInfo!]!
3733
3734# Retrieve the rights of the current user
3735# Example:
3736# Request:
3737# query {
3738#
3739# myRights {
3740#
3741# resources
3742#
3743# operations
3744#
3745# }
3746# }
3747# Response:
3748# {
3749#
3750# "data": {
3751#
3752# "myRights": {
3753#
3754# "resources": {},
3755#
3756# "operations": [
3757#
3758# "admin.access",
3759#
3760# "admin.org.read",
3761#
3762# "admin.org.update",
3763#
3764# "admin.user.create",
3765#
3766# "admin.user.read",
3767#
3768# "admin.user.update",
3769#
3770# "admin.user.delete",
3771#
3772# ...
3773#
3774# ]
3775#
3776# }
3777#
3778# }
3779# }
3780myRights: RightsListing
3781
3782# Retrieve the shared folders for an organization
3783# Example:
3784# Request:
3785# query {
3786#
3787# sharedFolders {
3788#
3789# id
3790#
3791# }
3792# }
3793# Response:
3794# {
3795#
3796# "data": {
3797#
3798# "sharedFolders": []
3799#
3800# }
3801# }
3802sharedFolders: [Folder]
3803
3804# Retrieve multiple watchlists
3805# Example:
3806# Request:
3807# query {
3808#
3809# watchlists(limit: 2) {
3810#
3811# records {
3812#
3813# id
3814#
3815# name
3816#
3817# }
3818#
3819# }
3820# }
3821# Response:
3822# {
3823#
3824# "data": {
3825#
3826# "watchlists": {
3827#
3828# "records": [
3829#
3830# {
3831#
3832# "id": "326916",
3833#
3834# "name": "example"
3835#
3836# },
3837#
3838# {
3839#
3840# "id": "325791",
3841#
3842# "name": "example"
3843#
3844# }
3845#
3846# ]
3847#
3848# }
3849#
3850# }
3851# }
3852#
3853# Arguments
3854# isDisabled: Set `true` to include only disabled watchlist or
3855# `false` to include only enabled watchlists. By default,
3856# both are included.
3857# names: Provide a list of names to filter folders
3858watchlists(
3859id: ID,
3860maxStopDateTime: DateTime,
3861minStopDateTime: DateTime,
3862minStartDateTime: DateTime,
3863maxStartDateTime: DateTime,
3864name: String,
3865offset: Int,
3866limit: Int,
3867orderBy: WatchlistOrderBy,
3868orderDirection: OrderDirection,
3869isDisabled: Boolean,
3870names: [String],
3871nameMatch: StringMatch
3872): WatchlistList
3873
3874# Retrieve a single watchlist by id
3875# Example:
3876# Request:
3877# query {
3878#
3879# watchlist(id: "325791") {
3880#
3881# name
3882#
3883# watchlistType
3884#
3885# }
3886# }
3887# Response:
3888# {
3889#
3890# "data": {
3891#
3892# "watchlist": {
3893#
3894# "name": "example",
3895#
3896# "watchlistType": "tracking"
3897#
3898# }
3899#
3900# }
3901# }
3902watchlist(id: ID!): Watchlist
3903
3904# Example:
3905# Request:
3906# query {
3907#
3908# mentionStatusOptions {
3909#
3910# id
3911#
3912# name
3913#
3914# }
3915# }
3916# Response:
3917# {
3918#
3919# "data": {
3920#
3921# "mentionStatusOptions": [
3922#
3923# {
3924#
3925# "id": "7",
3926#
3927# "name": "Auto Verified"
3928#
3929# },
3930#
3931# {
3932#
3933# "id": "5",
3934#
3935# "name": "Invalid"
3936#
3937# },
3938#
3939# {
3940#
3941# "id": "3",
3942#
3943# "name": "Needs Review"
3944#
3945# },
3946#
3947# {
3948#
3949# "id": "1",
3950#
3951# "name": "Pending Verification"
3952#
3953# },
3954#
3955# {
3956#
3957# "id": "6",
3958#
3959# "name": "Processing Verification"
3960#
3961# },
3962#
3963# {
3964#
3965# "id": "4",
3966#
3967# "name": "Request Bonus"
3968#
3969# },
3970#
3971# {
3972#
3973# "id": "2",
3974#
3975# "name": "Verified"
3976#
3977# }
3978#
3979# ]
3980#
3981# }
3982# }
3983mentionStatusOptions: [MentionStatus!]!
3984
3985# Retrieve multiple data registries
3986# Example:
3987# Request:
3988# query {
3989#
3990# dataRegistries(limit: 2) {
3991#
3992# records {
3993#
3994# id
3995#
3996# name
3997#
3998# }
3999#
4000# }
4001# }
4002# Response:
4003# {
4004#
4005# "data": {
4006#
4007# "dataRegistries": {
4008#
4009# "records": [
4010#
4011# {
4012#
4013# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
4014#
4015# "name": "example"
4016#
4017# },
4018#
4019# {
4020#
4021# "id": "317c941d-30d0-455e-882b-34a26e513364",
4022#
4023# "name": "example"
4024#
4025# }
4026#
4027# ]
4028#
4029# }
4030#
4031# }
4032# }
4033dataRegistries(
4034id: ID,
4035ids: [ID!],
4036name: String,
4037nameMatch: StringMatch,
4038offset: Int,
4039limit: Int,
4040orderBy: DataRegistryOrderBy,
4041orderDirection: OrderDirection,
4042filterByOwnership: SchemaOwnership
4043): DataRegistryList
4044
4045# Retrieve a single data registry
4046# Example:
4047# Request:
4048# query {
4049#
4050# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
4051#
4052# name
4053#
4054# organizationId
4055#
4056# source
4057#
4058# }
4059# }
4060# Response:
4061# {
4062#
4063# "data": {
4064#
4065# "dataRegistry": {
4066#
4067# "name": "example",
4068#
4069# "organizationId": "35521",
4070#
4071# "source": "veritone-35521.datasets"
4072#
4073# }
4074#
4075# }
4076# }
4077dataRegistry(id: ID!): DataRegistry
4078
4079# Retrieve a subscription by id
4080# Example:
4081# Request:
4082# query {
4083#
4084# subscription(id: "275818") {
4085#
4086# isActive
4087#
4088# jsondata
4089#
4090# }
4091# }
4092# Response:
4093# {
4094#
4095# "data": {
4096#
4097# "subscription": {
4098#
4099# "isActive": true,
4100#
4101# "jsondata": {
4102#
4103# "tracking_unit_id": "325791",
4104#
4105# "creator_email": "example email",
4106#
4107# "unsubscribe_hash":
4108# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
4109#
4110# }
4111#
4112# }
4113#
4114# }
4115# }
4116subscription(id: ID!): Subscription!
4117
4118cognitiveSearch(id: ID!): CognitiveSearch!
4119
4120# Retrieve multiple collections
4121# Example:
4122# Request:
4123# query {
4124#
4125# collections {
4126#
4127# records {
4128#
4129# id
4130#
4131# name
4132#
4133# }
4134#
4135# }
4136# }
4137# Response:
4138# {
4139#
4140# "data": {
4141#
4142# "collections": {
4143#
4144# "records": [
4145#
4146# {
4147#
4148# "id": "241121",
4149#
4150# "name": "example"
4151#
4152# },
4153#
4154# {
4155#
4156# "id": "242599",
4157#
4158# "name": "example"
4159#
4160# },
4161#
4162# {
4163#
4164# "id": "243625",
4165#
4166# "name": "example"
4167#
4168# }
4169#
4170# ]
4171#
4172# }
4173#
4174# }
4175# }
4176collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
4177
4178# Retrieve a collection by id
4179# Example:
4180# Request:
4181# query {
4182#
4183# collection(id: "241121") {
4184#
4185# name
4186#
4187# isActive
4188#
4189# }
4190# }
4191# Response:
4192# {
4193#
4194# "data": {
4195#
4196# "collection": {
4197#
4198# "name": "example",
4199#
4200# "isActive": true
4201#
4202# }
4203#
4204# }
4205# }
4206collection(id: ID!): Collection!
4207
4208collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
4209
4210# Retrieve a list of collection mentions
4211# Specify at least one of folderId or mentionId
4212collectionMentions(
4213folderId: ID,
4214mentionId: ID,
4215orderBy: CollectionMentionOrderBy,
4216limit: Int,
4217offset: Int
4218): CollectionMentionList!
4219
4220# Retrieve multiple mentions
4221# Example:
4222# Request:
4223# query {
4224#
4225# mentions {
4226#
4227# records {
4228#
4229# id
4230#
4231# }
4232#
4233# }
4234# }
4235# Response:
4236# {
4237#
4238# "data": {
4239#
4240# "mentions": {
4241#
4242# "records": []
4243#
4244# }
4245#
4246# }
4247# }
4248#
4249# Arguments
4250# watchlistId: Get mentions created from the specified watchlist
4251# sourceId: Get mentions associated with the specified source
4252# sourceTypeId: Get mentions associated with sources of the
4253# specified source type
4254# tdoId: Get mentions associated directly with the specific TDO
4255# dateTimeFilter: Specify date/time filters against mention
4256# fields.
4257# Querying for mentions can be expensive. If the query does not
4258# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
4259# a user-provided `dateTimeFilter`, a default filter of the
4260# past 7 days is applied.
4261# orderBy: Set order information on the query. Multiple fields
4262# are supported.
4263# folderId: Provide a folder ID to filter by collection
4264mentions(
4265id: ID,
4266watchlistId: ID,
4267sourceId: ID,
4268sourceTypeId: ID,
4269tdoId: ID,
4270dateTimeFilter: [MentionDateTimeFilter!],
4271orderBy: [MentionOrderBy!],
4272offset: Int,
4273limit: Int,
4274folderId: ID
4275): MentionList
4276
4277# Retrieves engine results by TDO and engine ID or by job ID.
4278# Example:
4279# Request:
4280# query {
4281#
4282# engineResults(
4283#
4284# tdoId: "1580507556",
4285#
4286# engineIds: "4") {
4287#
4288# sourceId
4289#
4290# records {
4291#
4292# tdoId
4293#
4294# }
4295#
4296# }
4297# }
4298# Response:
4299# {
4300#
4301# "data": {
4302#
4303# "engineResults": {
4304#
4305# "sourceId": null,
4306#
4307# "records": []
4308#
4309# }
4310#
4311# }
4312# }
4313#
4314# Arguments
4315# tdoId: Provide the ID of the TDO containing engine results to
4316# retrieve.
4317# If this parameter is used, engineIds or engineCategoryIds must also be set.
4318# Results for _only_ the specified TDO will be returned.
4319# sourceId: Provide the ID of the Source containing engine
4320# results to retrieve.
4321# If this parameter is used, engineIds or engineCategoryIds must also be set.
4322# This takes priority over tdoId.
4323# engineIds: Provide one or more engine IDs to retrieve engine
4324# results by
4325# ID. This parameter is mandatory if tdoId is used, but optional
4326# if jobId or engineCategory is used.
4327# engineCategoryIds: Provide one or more category IDs to get all
4328# results from that categroy.
4329# jobId: Provide a job ID to retrieve engine results for the job.
4330# mentionId: Provide a mention ID to retrieve engine results for
4331# the mention.
4332# startOffsetMs: Start offset ms for the results.
4333# stopOffsetMs: End offset ms for the results.
4334# startDate: Start date for the results. Takes priority over
4335# startOffsetMs.
4336# stopDate: End date for the results. Takes priority over
4337# stopOffsetMs.
4338# ignoreUserEdited: Whether or not to exclude user edited engine
4339# results. Defaults to false.
4340# fallbackTdoId: A TDO ID can be provided for use if the provided
4341# `sourceId` and/or
4342# `mentionId` parameters do not resolve to a logical set of TDOs.
4343# Depending on parameter settings and available data,
4344# results from other TDOs can be included in the response.
4345engineResults(
4346tdoId: ID,
4347sourceId: ID,
4348engineIds: [ID!],
4349engineCategoryIds: [ID!],
4350jobId: ID,
4351mentionId: ID,
4352startOffsetMs: Int,
4353stopOffsetMs: Int,
4354startDate: DateTime,
4355stopDate: DateTime,
4356ignoreUserEdited: Boolean,
4357fallbackTdoId: ID
4358): EngineResultList
4359
4360# Retrieve a trigger by id
4361# Example:
4362# Request:
4363# query {
4364#
4365# trigger(id: "2998") {
4366#
4367# target
4368#
4369# createdDateTime
4370#
4371# }
4372# }
4373# Response:
4374# {
4375#
4376# "data": {
4377#
4378# "trigger": {
4379#
4380# "target": "Email",
4381#
4382# "createdDateTime": "2021-06-18T13:35:08.631Z"
4383#
4384# }
4385#
4386# }
4387# }
4388trigger(id: ID!): Trigger
4389
4390# Retrieve triggers
4391# Example:
4392# Request:
4393# query {
4394#
4395# triggers {
4396#
4397# id
4398#
4399# }
4400# }
4401# Response:
4402# {
4403#
4404# "data": {
4405#
4406# "triggers": [
4407#
4408# {
4409#
4410# "id": "2998"
4411#
4412# }
4413#
4414# ]
4415#
4416# }
4417# }
4418triggers: [Trigger]
4419
4420# Fetch all saved searches that the current user has made
4421# Fetch all saved searches that have been shared with
4422# the current users organization
4423# Include any saved searches that the user has created
4424# Example:
4425# Request:
4426# query {
4427#
4428# savedSearches {
4429#
4430# records {
4431#
4432# id
4433#
4434# name
4435#
4436# }
4437#
4438# }
4439# }
4440# Response:
4441# {
4442#
4443# "data": {
4444#
4445# "savedSearches": {
4446#
4447# "records": [
4448#
4449# {
4450#
4451# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
4452#
4453# "name": "example"
4454#
4455# }
4456#
4457# ]
4458#
4459# }
4460#
4461# }
4462# }
4463savedSearches(
4464offset: Int,
4465limit: Int,
4466includeShared: Boolean,
4467filterByName: String,
4468orderBy: SavedSearchOrderBy,
4469orderDirection: OrderDirection
4470): SavedSearchList!
4471
4472# Retrieve a list of export requests
4473# Example:
4474# Request:
4475# query {
4476#
4477# exportRequests(limit: 2) {
4478#
4479# records {
4480#
4481# id
4482#
4483# organizationId
4484#
4485# }
4486#
4487# }
4488# }
4489# Response:
4490# {
4491#
4492# "data": {
4493#
4494# "exportRequests": {
4495#
4496# "records": [
4497#
4498# {
4499#
4500# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4501#
4502# "organizationId": "35521"
4503#
4504# }
4505#
4506# ]
4507#
4508# }
4509#
4510# }
4511# }
4512#
4513# Arguments
4514# id: Provide an ID to retrieve a single export request
4515# offset: Provide an offset to skip to a certain element in the
4516# result, for paging.
4517# limit: Specify maximum number of results to retrieve in this
4518# result. Page size.
4519# status: Provide a list of status options to filter by status
4520# event: Provide an event to retrieve export request. Should be
4521# 'exportRequest' or 'mentionExportRequest'
4522# Default value is 'exportRequest'
4523exportRequests(
4524id: ID,
4525offset: Int,
4526limit: Int,
4527status: [ExportRequestStatus!],
4528event: ExportRequestEvent
4529): ExportRequestList!
4530
4531# Retrieve a single export request by id
4532# Example:
4533# Request:
4534# query {
4535#
4536# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
4537#
4538# id
4539#
4540# organizationId
4541#
4542# requestorId
4543#
4544# status
4545#
4546# }
4547# }
4548# Response:
4549# {
4550#
4551# "data": {
4552#
4553# "exportRequest": {
4554#
4555# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4556#
4557# "organizationId": "35521",
4558#
4559# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4560#
4561# "status": "complete"
4562#
4563# }
4564#
4565# }
4566# }
4567#
4568# Arguments
4569# event: Provide an event to retrieve export request. Should be
4570# 'exportRequest' or 'mentionExportRequest'
4571# Default value is 'exportRequest'
4572exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4573
4574# Retrieve a event by id
4575# Example:
4576# Request:
4577# query {
4578#
4579# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4580#
4581# eventName
4582#
4583# eventType
4584#
4585# description
4586#
4587# }
4588# }
4589# Response:
4590# {
4591#
4592# "data": {
4593#
4594# "event": {
4595#
4596# "eventName": "example",
4597#
4598# "eventType": "example",
4599#
4600# "description": "new example description"
4601#
4602# }
4603#
4604# }
4605# }
4606event(id: ID!): Event
4607
4608# Retrieve a list of events by application
4609# Example:
4610# Request:
4611# query {
4612#
4613# events(
4614#
4615# application: "system",
4616#
4617# limit: 2) {
4618#
4619# records {
4620#
4621# id
4622#
4623# eventName
4624#
4625# }
4626#
4627# }
4628# }
4629# Response:
4630# {
4631#
4632# "data": {
4633#
4634# "events": {
4635#
4636# "records": [
4637#
4638# {
4639#
4640# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4641#
4642# "eventName": "ActionTokenForbidden"
4643#
4644# },
4645#
4646# {
4647#
4648# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4649#
4650# "eventName": "ActionUserForbidden"
4651#
4652# }
4653#
4654# ]
4655#
4656# }
4657#
4658# }
4659# }
4660#
4661# Arguments
4662# application: Provide an application to retrieve all its events.
4663# Use 'system' to list all public system events.
4664# offset: Provide an offset to skip to a certain element in the
4665# result, for paging.
4666# limit: Specify maximum number of results to retrieve in this
4667# result. Page size.
4668events(application: String!, offset: Int, limit: Int): EventList!
4669
4670# Retrieve a list of subscriptions by organization
4671# Example:
4672# Request:
4673# query {
4674#
4675# eventSubscriptions(limit: 2) {
4676#
4677# records {
4678#
4679# id
4680#
4681# eventName
4682#
4683# }
4684#
4685# }
4686# }
4687# Response:
4688# {
4689#
4690# "data": {
4691#
4692# "eventSubscriptions": {
4693#
4694# "records": [
4695#
4696# {
4697#
4698# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4699#
4700# "eventName": "LibraryTrainingComplete"
4701#
4702# },
4703#
4704# {
4705#
4706# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4707#
4708# "eventName": "LibraryTrainingComplete"
4709#
4710# }
4711#
4712# ]
4713#
4714# }
4715#
4716# }
4717# }
4718#
4719# Arguments
4720# ids: The event subscription ids
4721# eventName: The name of the event
4722# eventType: The type of event, such as `mention`, `job`,
4723# `engine`.
4724# offset: Provide an offset to skip to a certain element in the
4725# result, for paging.
4726# limit: Specify maximum number of results to retrieve in this
4727# result. Page size.
4728# orgId: The organization ID with which these event subscriptions
4729# are associated.
4730# appId: The application ID with which these event subscriptions
4731# are associated.
4732# scope: Event subscription scope
4733eventSubscriptions(
4734ids: [ID!],
4735eventName: String,
4736eventType: String,
4737offset: Int,
4738limit: Int,
4739orgId: ID,
4740appId: ID,
4741scope: EventSubscriptionScope
4742): EventSubscriptionList!
4743
4744# Retrieve a subscription by id
4745# Example:
4746# Request:
4747# query {
4748#
4749# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4750#
4751# id
4752#
4753# organizationId
4754#
4755# eventName
4756#
4757# targetName
4758#
4759# }
4760# }
4761# Response:
4762# {
4763#
4764# "data": {
4765#
4766# "eventSubscription": {
4767#
4768# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4769#
4770# "organizationId": "35521",
4771#
4772# "eventName": "LibraryTrainingComplete",
4773#
4774# "targetName": "NotificationMailbox"
4775#
4776# }
4777#
4778# }
4779# }
4780eventSubscription(id: ID!): EventSubscription!
4781
4782# Example:
4783# Request:
4784# query {
4785#
4786# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4787#
4788# organizationId
4789#
4790# actionType
4791#
4792# name
4793#
4794# }
4795# }
4796# Response:
4797# {
4798#
4799# "data": {
4800#
4801# "eventActionTemplate": {
4802#
4803# "organizationId": "35521",
4804#
4805# "actionType": "job",
4806#
4807# "name": "example"
4808#
4809# }
4810#
4811# }
4812# }
4813eventActionTemplate(id: ID!): EventActionTemplate
4814
4815# Example:
4816# Request:
4817# query {
4818#
4819# eventActionTemplates(
4820#
4821# inputType: event,
4822#
4823# actionType: job
4824#
4825# limit:2) {
4826#
4827# records {
4828#
4829# id
4830#
4831# name
4832#
4833# }
4834#
4835# }
4836# }
4837# Response:
4838# {
4839#
4840# "data": {
4841#
4842# "eventActionTemplates": {
4843#
4844# "records": [
4845#
4846# {
4847#
4848# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4849#
4850# "name": "example"
4851#
4852# },
4853#
4854# {
4855#
4856# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4857#
4858# "name": "example"
4859#
4860# }
4861#
4862# ]
4863#
4864# }
4865#
4866# }
4867# }
4868#
4869# Arguments
4870# ownerApplicationId: The application id
4871# inputType: use "event" for now. In the future, we allow
4872# additional input_type types. For example, a schedule or a tweet.
4873# actionType: Either "job", "webhook", "sms", "email". Future
4874# action_type could be "gql" where action is purely a function call.
4875# offset: Provide an offset to skip to a certain element in the
4876# result, for paging.
4877# limit: Specify maximum number of results to retrieve in this
4878# result. Page size.
4879eventActionTemplates(
4880ownerApplicationId: ID,
4881inputType: EventActionTemplateInputType,
4882actionType: EventActionTemplateActionType,
4883offset: Int,
4884limit: Int
4885): EventActionTemplateList!
4886
4887# Example:
4888# Request:
4889# query {
4890#
4891# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4892#
4893# name
4894#
4895# eventName
4896#
4897# description
4898#
4899# }
4900# }
4901# Response:
4902# {
4903#
4904# "data": {
4905#
4906# "eventCustomRule": {
4907#
4908# "name": "example",
4909#
4910# "eventName": "example",
4911#
4912# "description": "example description"
4913#
4914# }
4915#
4916# }
4917# }
4918eventCustomRule(id: ID!): EventCustomRule
4919
4920# Example:
4921# Request:
4922# query {
4923#
4924# eventCustomRules(limit: 2) {
4925#
4926# records {
4927#
4928# id
4929#
4930# name
4931#
4932# }
4933#
4934# }
4935# }
4936# Response:
4937# {
4938#
4939# "data": {
4940#
4941# "eventCustomRules": {
4942#
4943# "records": [
4944#
4945# {
4946#
4947# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
4948#
4949# "name": "example"
4950#
4951# }
4952#
4953# ]
4954#
4955# }
4956#
4957# }
4958# }
4959#
4960# Arguments
4961# offset: the offset to skip to a certain element in the result
4962# limit: the maximum number of rows in the results
4963eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
4964
4965# This query returns information about time zones recognized by this
4966#
4967# server. The information is static and does not change.
4968#
4969# Example:
4970#
4971# Request:
4972#
4973# query {
4974#
4975# timeZones {
4976#
4977# name
4978#
4979# abbreviations{
4980#
4981# name
4982#
4983# }
4984#
4985# }
4986# }
4987# Response:
4988# {
4989#
4990# "data": {
4991#
4992# "timeZones": [
4993#
4994# {
4995#
4996# "name": "Africa/Abidjan",
4997#
4998# "abbreviations": [
4999#
5000# {
5001#
5002# "name": "GMT"
5003#
5004# }
5005#
5006# ]
5007#
5008# },
5009#
5010# {
5011#
5012# "name": "Africa/Accra",
5013#
5014# "abbreviations": [
5015#
5016# {
5017#
5018# "name": "GMT"
5019#
5020# },
5021#
5022# {
5023#
5024# "name": "+0020"
5025#
5026# }
5027#
5028# ]
5029#
5030# },
5031#
5032# {
5033#
5034# "name": "Africa/Lagos",
5035#
5036# "abbreviations": [
5037#
5038# {
5039#
5040# "name": "WAT"
5041#
5042# }
5043#
5044# ]
5045#
5046# },
5047#
5048# ...
5049#
5050# ...
5051#
5052# ]
5053#
5054# }
5055#
5056# ]
5057#
5058# }
5059# }
5060timeZones: [TimeZone!]!
5061
5062# Examine entries from the audit log. All operations that modify data are
5063# written to the audit log. Only entries for the user's own organization
5064# can be queried.
5065# All queries are bracketed by a time window. A default time window is applied
5066# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
5067# The maximum time window length is 30 days.
5068# Only Veritone and organization administrators can use this query.
5069# Example:
5070# Request:
5071# query {
5072#
5073# auditLog(limit: 2) {
5074#
5075# records {
5076#
5077# id
5078#
5079# objectId
5080#
5081# description
5082#
5083# }
5084#
5085# }
5086# }
5087# Response:
5088# {
5089#
5090# "data": {
5091#
5092# "auditLog": {
5093#
5094# "records": [
5095#
5096# {
5097#
5098# "id": "735915311",
5099#
5100# "objectId": "*********",
5101#
5102# "description": "Changed password"
5103#
5104# },
5105#
5106# {
5107#
5108# "id": "735915307",
5109#
5110# "objectId": "********",
5111#
5112# "description": "Changed password"
5113#
5114# }
5115#
5116# ]
5117#
5118# }
5119#
5120# }
5121# }
5122#
5123# Arguments
5124# toDateTime: Date/time up to which entries will be returned. In
5125# other words, the
5126# end of the query time window.
5127# Defaults to the current time.
5128# fromDateTime: Date/time from which entries will be returned. In
5129# other words, the
5130# start of the query time window.
5131# Defaults to the `toDateTime` minus 7 days.
5132# organizationId: Organization ID to query records for. This
5133# value can only be used by
5134# Veritone administrators. Any value provided by user administrators will
5135# be ignored.
5136# userName: User name on audit entry. Must be exact match.
5137# clientIpAddress: IP address of the client that generated the
5138# audit action. Must be exact match.
5139# clientUserAgent: HTTP user agent of the client that generated
5140# the audit action. Must be exact match.
5141# eventType: The event type, such as `Create`, `Update`, or
5142# `Delete`.
5143# Must be exact match.
5144# objectId: The ID of the object involved in the audit action.
5145# The format of this ID
5146# varies by object type. Must be exact match.
5147# objectType: The type of the object involved in the audit
5148# action, such as `Watchlist`
5149# or `TemporalDataObject`. Must be exact match.
5150# success: Whether or not the action was successful.
5151# id: The unique ID of an audit log entry. Multiple values can be
5152# provided.
5153# offset: Offset into result set, for paging.
5154# limit: Limit on result size, for paging (page size). Audit
5155# queries are
5156# lightweight so the default of 100 is higher than the default offset
5157# used elsewhere in the API.
5158# orderBy: Order information. Default is order by
5159# `createdDateTime` descending.
5160auditLog(
5161toDateTime: DateTime,
5162fromDateTime: DateTime,
5163organizationId: ID,
5164userName: String,
5165clientIpAddress: String,
5166clientUserAgent: String,
5167eventType: String,
5168objectId: ID,
5169objectType: String,
5170success: Boolean,
5171id: [ID!],
5172offset: Int,
5173limit: Int,
5174orderBy: [AuditLogOrderBy!]
5175): AuditLogEntryList! @deprecated( reason: "No longer supported." )
5176
5177# Get the media share by media shareId
5178mediaShare(id: ID!): MediaShare!
5179
5180# Retrieve a shared collection
5181#
5182# Arguments
5183# shareId: share token
5184sharedCollection(shareId: ID!): SharedCollection
5185
5186# Retrieve shared collection history records
5187# Example:
5188# Request:
5189# query {
5190#
5191# sharedCollectionHistory(limit: 2,
5192#
5193# folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") {
5194#
5195# records {
5196#
5197# id
5198#
5199# status
5200#
5201# shareId
5202#
5203# }
5204#
5205# }
5206# }
5207# Response:
5208# {
5209#
5210# "data": {
5211#
5212# "sharedCollectionHistory": {
5213#
5214# "records": []
5215#
5216# }
5217#
5218# }
5219# }
5220#
5221# Arguments
5222# ids: Provide an ID to retrieve a single history record
5223# folderId: Provide a folder ID to filter by collection
5224# shareId: Provide a share ID to filter by share ID
5225# offset: Specify maximum number of results to retrieve in this
5226# result. Page size.
5227# limit: Specify maximum number of results to retrieve in this
5228# result.
5229sharedCollectionHistory(
5230ids: [ID!],
5231folderId: ID,
5232shareId: String,
5233offset: Int,
5234limit: Int
5235): SharedCollectionHistoryList!
5236
5237# Get list process templates by id or current organizationId
5238# Example:
5239# Request:
5240# query {
5241#
5242# processTemplates(limit: 2) {
5243#
5244# records {
5245#
5246# id
5247#
5248# organizationId
5249#
5250# name
5251#
5252# }
5253#
5254# }
5255# }
5256# Response:
5257# {
5258#
5259# "data": {
5260#
5261# "processTemplates": {
5262#
5263# "records": [
5264#
5265# {
5266#
5267# "id": "762",
5268#
5269# "organizationId": "35521",
5270#
5271# "name": "example"
5272#
5273# }
5274#
5275# ]
5276#
5277# }
5278#
5279# }
5280# }
5281processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
5282
5283# Get process templates by id
5284# Example:
5285# Request:
5286# query {
5287#
5288# processTemplate(id: "762") {
5289#
5290# name
5291#
5292# organizationId
5293#
5294# }
5295# }
5296# Response:
5297# {
5298#
5299# "data": {
5300#
5301# "processTemplate": {
5302#
5303# "name": "example",
5304#
5305# "organizationId": "35521"
5306#
5307# }
5308#
5309# }
5310# }
5311processTemplate(id: ID!): ProcessTemplate!
5312
5313# Get creative by id with current organizationId
5314# Example:
5315# Request:
5316# query {
5317#
5318# creative(id: "25209") {
5319#
5320# organizationId
5321#
5322# brandId
5323#
5324# }
5325# }
5326# Response:
5327# {
5328#
5329# "data": {
5330#
5331# "creative": {
5332#
5333# "organizationId": "35521",
5334#
5335# "brandId": null
5336#
5337# }
5338#
5339# }
5340# }
5341creative(id: ID!): Creative!
5342
5343# Retrieve list of engine classes
5344# Example:
5345# Request:
5346# query {
5347#
5348# engineClasses(limit: 2) {
5349#
5350# records {
5351#
5352# id
5353#
5354# name
5355#
5356# description
5357#
5358# }
5359#
5360# }
5361# }
5362# Response:
5363# {
5364#
5365# "data": {
5366#
5367# "engineClasses": {
5368#
5369# "records": [
5370#
5371# {
5372#
5373# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5374#
5375# "name": "audio",
5376#
5377# "description": "The input to engines in the Audio class is an audio or video
5378# file or stream. If your engine processes human speech or voice, it likely
5379# belongs in the Speech class instead. Audio engines may recognize a specific
5380# audio segment, such as an advertisement, identify sounds like that of a crying
5381# baby or detect the presence of audio or music in an audio or video file, for
5382# example."
5383#
5384# },
5385#
5386# {
5387#
5388# "id": "1bcfdd35-1e9b-4694-8273-00b19510d164",
5389#
5390# "name": "biometrics",
5391#
5392# "description": "The input to engines in the Biometrics class may be an image,
5393# speech or other audio or video file or stream. By definition, the Biometrics
5394# class covers cognitive analysis related to data points from the human body.
5395# Biometrics engines may detect or recognize faces, identify face attributes to
5396# estimate a person's age or ethnicity or verify a person based on their unique
5397# iris, for example."
5398#
5399# }
5400#
5401# ]
5402#
5403# }
5404#
5405# }
5406# }
5407#
5408# Arguments
5409# id: Provide an ID to retrieve a single specific engine class.
5410# name: Provide a name, or part of one, to search by class name
5411# offset: Specify maximum number of results to retrieve in this
5412# result. Page size.
5413# limit: Specify maximum number of results to retrieve in this
5414# result.
5415engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
5416
5417# Retrieve a specific engine class
5418# Example:
5419# Request:
5420# query {
5421#
5422# engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") {
5423#
5424# id
5425#
5426# name
5427#
5428# description
5429#
5430# }
5431# }
5432# Response:
5433# {
5434#
5435# "data": {
5436#
5437# "engineClass": {
5438#
5439# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5440#
5441# "name": "audio",
5442#
5443# "description": "The input to engines in the Audio class is an audio or video
5444# file or stream. If your engine processes human speech or voice, it likely
5445# belongs in the Speech class instead. Audio engines may recognize a specific
5446# audio segment, such as an advertisement, identify sounds like that of a crying
5447# baby or detect the presence of audio or music in an audio or video file, for
5448# example."
5449#
5450# }
5451#
5452# }
5453# }
5454#
5455# Arguments
5456# id: Supply the ID of the engine class to retrieve
5457engineClass(id: ID!): EngineClass
5458
5459# Retrieve list entity tags where tag key contains user input
5460# Example:
5461# Request:
5462# query {
5463#
5464# matchEntityTags(input: { tagKey: "test}) {
5465#
5466# records {
5467#
5468# tagKey
5469#
5470# tagValue
5471#
5472# }
5473#
5474# }
5475# }
5476# Response:
5477# {
5478#
5479# "data": {
5480#
5481# "matchEntityTags": {
5482#
5483# "records": [
5484#
5485# {
5486#
5487# "tagKey": "test-tag",
5488#
5489# "tagValue": "test-value"
5490#
5491# },
5492#
5493# {
5494#
5495# "tagKey": "another-testtag",
5496#
5497# "tagValue": ""
5498#
5499# },
5500#
5501# ]
5502#
5503# }
5504#
5505# }
5506# }
5507#
5508# Arguments
5509# input: User provided text and entity type input.
5510# offset: Specify maximum number of results to retrieve in this
5511# result. Page size.
5512# limit: Specify maximum number of results to retrieve in this
5513# result.
5514matchEntityTags(input: MatchEntityTagInput!, offset: Int, limit: Int): MatchedEntityTagsList
5515
5516# Returns all custom dashboards created by user
5517# Example:
5518# Request:
5519# query {
5520#
5521# customDashboards {
5522#
5523# records {
5524#
5525# id
5526#
5527# description
5528#
5529# hostAppId
5530#
5531# }
5532#
5533# }
5534# }
5535# Response:
5536# {
5537#
5538# "data": {
5539#
5540# "customDashboards": {
5541#
5542# "records": [
5543#
5544# {
5545#
5546# "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9",
5547#
5548# "description": "example",
5549#
5550# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f"
5551#
5552# }
5553#
5554# ]
5555#
5556# }
5557#
5558# }
5559# }
5560#
5561# Arguments
5562# offset: Provide an offset to skip to a certain element in the
5563# result, for paging.
5564# limit: Specify maximum number of results to retrieve in this
5565# result. Page size.
5566# hostAppId: Include only dashboards created by specific
5567# host_app_id
5568customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
5569
5570# Returns custom dashboard by id
5571# Example:
5572# Request:
5573# query {
5574#
5575# customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") {
5576#
5577# hostAppId
5578#
5579# name
5580#
5581# }
5582# }
5583# Response:
5584# {
5585#
5586# "data": {
5587#
5588# "customDashboard": {
5589#
5590# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f",
5591#
5592# "name": "example"
5593#
5594# }
5595#
5596# }
5597# }
5598customDashboard(id: ID!): CustomDashboard
5599
5600# Gets engine usage for an organization based on their billing type.
5601# Example:
5602# Request:
5603# query {
5604#
5605# getUsageByTaskType {
5606#
5607# totalDuration
5608#
5609# totalCost
5610#
5611# }
5612# }
5613# Response:
5614# {
5615#
5616# "data": {
5617#
5618# "getUsageByTaskType": {
5619#
5620# "totalDuration": 0,
5621#
5622# "totalCost": "0"
5623#
5624# }
5625#
5626# }
5627# }
5628getUsageByTaskType: UsageByTaskType!
5629
5630# Retrives the specific Dataset
5631#
5632# Arguments
5633# id: Supply the ID of the Dataset to retrieve
5634dataset(id: ID!): Dataset
5635
5636# Retrieve list of Datasets
5637# Example:
5638# Request:
5639# query {
5640#
5641# datasets(limit:2, filter: {operation:OR}) {
5642#
5643# records {
5644#
5645# datasetId
5646#
5647# name
5648#
5649# }
5650#
5651# }
5652# }
5653# Response:
5654# {
5655#
5656# "data": {
5657#
5658# "datasets": {
5659#
5660# "records": []
5661#
5662# }
5663#
5664# }
5665# }
5666#
5667# Arguments
5668# offset: Provide an offset to skip to a certain element in the
5669# result, for paging.
5670# limit: Specify maximum number of results to retrieve in this
5671# result. Page size.
5672# filter: Filters for Dataset attributes
5673datasets(offset: Int, limit: Int, filter: DatasetFilter): DatasetList
5674
5675# Arguments
5676# datasetId: Supply the ID of the Dataset to retrieve
5677# offset: Provide an offset to skip to a certain element in the
5678# result, for paging.
5679# limit: Specify maximum number of results to retrieve in this
5680# result. Page size.
5681# filter: Query to filter SDO. Supports operations such as and,
5682# or, eq, gt, lt, etc.
5683# TODO link to syntax documentation
5684# orderBy: Order by
5685datasetDataQuery(
5686datasetId: ID!,
5687offset: Int,
5688limit: Int,
5689filter: JSONData,
5690orderBy: [StructuredDataOrderBy!]
5691): DatasetEntryList!
5692
5693# Retrive list of Engine Replacement
5694# Example:
5695# Request:
5696# query {
5697#
5698# taskReplacementEngines {
5699#
5700# records {
5701#
5702# sourceEngineId
5703#
5704# replacementEngineId
5705#
5706# }
5707#
5708# }
5709# }
5710# Response:
5711# {
5712#
5713# "data": {
5714#
5715# "taskReplacementEngines": {
5716#
5717# "records": [
5718#
5719# {
5720#
5721# "sourceEngineId": "1",
5722#
5723# "replacementEngineId": "2"
5724#
5725# }
5726#
5727# ]
5728#
5729# }
5730#
5731# }
5732# }
5733#
5734# Arguments
5735# organizationId: Only superadmin can get engine replacement of
5736# other orgs
5737# engineId: Filter by the source engineId
5738# offset: Provide an offset to skip to a certain element in the
5739# result, for paging.
5740# limit: Specify maximum number of results to retrieve in this
5741# result. Page size.
5742taskReplacementEngines(
5743organizationId: ID,
5744engineId: ID,
5745offset: Int,
5746limit: Int
5747): TaskReplacementEngineList
5748
5749# Retrive Notification Mailboxes by list of mailboxIds
5750# Example:
5751# Request:
5752# query {
5753#
5754# notificationMailboxes {
5755#
5756# id
5757#
5758# name
5759#
5760# }
5761# }
5762# Response:
5763# {
5764#
5765# "data": {
5766#
5767# "notificationMailboxes": [
5768#
5769# {
5770#
5771# "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149",
5772#
5773# "name": "example"
5774#
5775# },
5776#
5777# {
5778#
5779# "id": "d20e9f37-a887-41bb-aed0-3268884ecebc",
5780#
5781# "name": "Library training mailbox"
5782#
5783# },
5784#
5785# {
5786#
5787# "id": "2d29533b-560e-4354-b794-84f823d33205",
5788#
5789# "name": "Library training mailbox"
5790#
5791# }
5792#
5793# ]
5794#
5795# }
5796# }
5797notificationMailboxes(ids: [ID!], name: String): [NotificationMailbox!]
5798
5799# Retrive Notification Templates
5800# Example:
5801# Request:
5802# query {
5803#
5804# notificationTemplates(limit: 2) {
5805#
5806# records {
5807#
5808# id
5809#
5810# eventName
5811#
5812# }
5813#
5814# }
5815# }
5816# Response:
5817# {
5818#
5819# "data": {
5820#
5821# "notificationTemplates": {
5822#
5823# "records": [
5824#
5825# {
5826#
5827# "id": "3947b833-2be4-4415-8272-2cee62fbca23",
5828#
5829# "eventName": "example"
5830#
5831# }
5832#
5833# ]
5834#
5835# }
5836#
5837# }
5838# }
5839#
5840# Arguments
5841# ids: Get by array of ids
5842# eventName: Get by eventName
5843# eventType: Get by eventType
5844# application: Get by application
5845# mailboxId: Get by mailboxId
5846# ownerOrganizationId: Only super-admin or orgless token can get
5847# templates by ownerOrganizationId
5848# offset: Provide an offset to skip to a certain element in the
5849# result, for paging.
5850# limit: Specify maximum number of results to retrieve in this
5851# result. Page size.
5852notificationTemplates(
5853ids: [ID],
5854eventName: String,
5855eventType: String,
5856application: String,
5857mailboxId: ID,
5858ownerOrganizationId: ID,
5859offset: Int,
5860limit: Int
5861): NotificationTemplateList
5862
5863# Retrieve Notification Actions
5864# Example:
5865# Request:
5866# query {
5867#
5868# notificationActions {
5869#
5870# records {
5871#
5872# id
5873#
5874# actionName
5875#
5876# }
5877#
5878# }
5879# }
5880# Response:
5881# {
5882#
5883# "data": {
5884#
5885# "notificationActions": {
5886#
5887# "records": [
5888#
5889# {
5890#
5891# "id": "866aad9c-9e68-4c33-b523-373bb332aea2",
5892#
5893# "actionName": "example"
5894#
5895# }
5896#
5897# ]
5898#
5899# }
5900#
5901# }
5902# }
5903#
5904# Arguments
5905# ids: Get by array of ids
5906# eventName: Get by eventName
5907# eventType: Get by eventType
5908# application: Get by application
5909# mailboxId: Get by mailboxId
5910# ownerOrganizationId: Only super-admin or orgless token can get
5911# templates by ownerOrganizationId
5912# offset: Provide an offset to skip to a certain element in the
5913# result, for paging.
5914# limit: Specify maximum number of results to retrieve in this
5915# result. Page size.
5916notificationActions(
5917ids: [ID],
5918eventName: String,
5919eventType: String,
5920application: String,
5921mailboxId: ID,
5922ownerOrganizationId: ID,
5923offset: Int,
5924limit: Int
5925): NotificationActionList
5926
5927# Retrieve Application user setting definitions
5928# Example:
5929# Request:
5930# query {
5931#
5932# getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") {
5933#
5934# key
5935#
5936# value
5937#
5938# }
5939# }
5940# Response:
5941# {
5942#
5943# "data": {
5944#
5945# "getUserSettingDefinitions": [
5946#
5947# {
5948#
5949# "key": "example",
5950#
5951# "value": "example"
5952#
5953# }
5954#
5955# ]
5956#
5957# }
5958# }
5959#
5960# Arguments
5961# application: Specify the applicationId
5962# key: Specify the key of user setting (optional)
5963# organizationGuid: Specify the organizationGuid (require for
5964# internal token)
5965# This can be specified by superadmin to get user setting definitions of other
5966# organization
5967getUserSettingDefinitions(
5968application: ID!,
5969key: String,
5970organizationGuid: ID
5971): [ApplicationSetting]
5972
5973# Retrive User setting
5974# Example:
5975# Request:
5976# query {
5977#
5978# getUserSettings {
5979#
5980# key
5981#
5982# applicationId
5983#
5984# }
5985# }
5986# Response:
5987# {
5988#
5989# "data": {
5990#
5991# "getUserSettings": [
5992#
5993# {
5994#
5995# "key": "example12",
5996#
5997# "applicationId": "80354999-d633-4595-9578-d82f59a5134f"
5998#
5999# }
6000#
6001# ]
6002#
6003# }
6004# }
6005#
6006# Arguments
6007# userId: Filter by userId (optional).
6008# If it's not specified, default is current user
6009# application: Filter by applicationId
6010# keys: Filter by keys
6011getUserSettings(userId: ID, application: ID, keys: [String]): [UserSetting]
6012
6013# Example:
6014# Request:
6015# query {
6016#
6017# staticAppConfig {
6018#
6019# loginUrl
6020#
6021# apiRoot
6022#
6023# }
6024# }
6025# Response:
6026# {
6027#
6028# "data": {
6029#
6030# "staticAppConfig": {
6031#
6032# "loginUrl": "https://login.veritone.com",
6033#
6034# "apiRoot": "https://api.veritone.com"
6035#
6036# }
6037#
6038# }
6039# }
6040staticAppConfig: StaticAppConfig!
6041
6042# Get OpenID Provider by id
6043openIdProvider(id: ID!): OpenIdProvider!
6044
6045# Get OpenID Provides
6046# Example:
6047# Request:
6048# query {
6049#
6050# openIdProviders {
6051#
6052# records {
6053#
6054# id
6055#
6056# isGlobal
6057#
6058# websiteUrl
6059#
6060# }
6061#
6062# }
6063# }
6064# Response:
6065# {
6066#
6067# "data": {
6068#
6069# "openIdProviders": {
6070#
6071# "records": []
6072#
6073# }
6074#
6075# }
6076# }
6077#
6078# Arguments
6079# orgId: Filter Providers by organizationId. This is only used by
6080# superadmin.
6081# If filter with org-admin role, orgId is always the current user org.
6082openIdProviders(
6083ids: [ID],
6084isGlobal: Boolean,
6085orgId: ID,
6086offset: Int,
6087limit: Int
6088): OpenIdProviderList
6089
6090# Arguments
6091# orgId: This returns all packages that the Organization has
6092# access to.
6093#
6094# ___Note: for Super-Admin use only.___
6095# resourceId: This returns packages that have the provided
6096# resource linked to it
6097# resourceAlias: This returns any packages have resources that
6098# have the alias.
6099# primaryResourceId: This returns packages that have the provided
6100# resource as its primary resource
6101# sourceOriginId: This returns the entire lineage of packages
6102# that share the same sourceOriginId.
6103#
6104# This UUID is used to track a package's lineage. This UUID and versions is NOT
6105# guaranteed to be a package ID and should not be used as such.
6106# sourcePackageId: This returns any packages that immediately
6107# derive from the provided ID.
6108#
6109# The sourcePackageId of a package refers to the package that it derived from, if
6110# any.
6111# For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0,
6112# and 4.0.
6113# If the ID of version 2.0 is provided, this filter will return the package
6114# information for
6115# only version 3.0. This is because version 3.0 is the immediate descendent of
6116# version 2.0.
6117# packageFilter: Fields to filter the results by.
6118# distributionType: This returns packages of a specific
6119# distribution type
6120# distributionTypes: This returns packages of a list of
6121# distribution types
6122# status: This returns packages with a specific status
6123# nameRegexp: name regexp pattern
6124# owned: If true, return only packages owned by the calling org.
6125#
6126# If false, return all packages that the calling org has access to.
6127#
6128# The default behavior when `owned` is not provided assumes `false`.
6129#
6130# __Note__: Superadmin tokens are authorized to change the `orgId` field. If
6131# provided, the above behavior will apply to `orgId` instead of the calling org.
6132# includeDeleted: If true, result includes deleted packages
6133# offset: Provide an offset to skip to a certain element in the
6134# result, for paging.
6135# limit: Specify maximum number of results to retrieve in this
6136# result. Page size.
6137packages(
6138id: ID,
6139ids: [ID!],
6140orgId: ID,
6141resourceId: ID,
6142resourceAlias: String,
6143primaryResourceId: ID,
6144sourceOriginId: ID,
6145sourcePackageId: ID,
6146packageFilter: PackageFilter,
6147distributionType: EngineDistributionType,
6148distributionTypes: [EngineDistributionType!],
6149status: PackageStatus,
6150nameRegexp: String,
6151owned: Boolean,
6152includeDeleted: Boolean,
6153offset: Int,
6154limit: Int
6155): PackageList
6156
6157# List existing package grants.
6158# Either packageId or organizationId must be specified.
6159#
6160# The following examples assume that the caller is the owner of the Packages:
6161# packageGrants(id: 123) - Show Grants for Package 123
6162# packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12
6163# packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12
6164#
6165# Arguments
6166# id: Package ID. If specified, show all the Grants for this
6167# Package.
6168#
6169# If calling Org is owner of the Package, show all Grants.
6170#
6171# If calling Org is not owner of the Package, only show Grants for the Package to
6172# the calling Org.
6173#
6174# If Super-Admin, show all Grants for the Package.
6175# orgId: Show all Grants to the specified Org.
6176#
6177# If the input organizationId is different from the calling Org, this will show
6178# Grants for Packages
6179# that are owned by the calling Org to the specified Org.
6180#
6181# If the input organizationId is the same as the caller's Org, this will show
6182# Grants for Packages
6183# to the calling Org.
6184#
6185# If Super-Admin, show Grants for all Packages to the specified Org.
6186# includeDeleted: If true, result includes deleted packages
6187# offset: Provide an offset to skip to a certain element in the
6188# result, for paging.
6189# limit: Specify maximum number of results to retrieve in this
6190# result. Page size.
6191packageGrants(
6192id: ID,
6193orgId: ID,
6194includeDeleted: Boolean,
6195offset: Int,
6196limit: Int,
6197packageFilter: PackageGrantFilter
6198): PackageGrantList
6199
6200# Retrieve the basic user information.
6201# The caller and the queried user are required to be members of the same
6202# organization,
6203# unless the caller is superadmin user.
6204# Example:
6205# Request:
6206# query {
6207#
6208# basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") {
6209#
6210# id
6211#
6212# name
6213#
6214# firstName
6215#
6216# lastName
6217#
6218# email
6219#
6220# imageUrl
6221#
6222# }
6223# }
6224# Response:
6225# {
6226#
6227# "data": {
6228#
6229# "basicUserInfo": {
6230#
6231# "id": "267de7e1-efb2-444a-a524-210328b78503",
6232#
6233# "name": "username",
6234#
6235# "firstName": "first",
6236#
6237# "lastName": "last",
6238#
6239# "email": "email@test.com",
6240#
6241# "imageUrl": null
6242#
6243# }
6244#
6245# }
6246# }
6247#
6248# Arguments
6249# id: The user ID.
6250# A user ID is a string in UUID format.
6251basicUserInfo(id: ID!): BasicUserInfo
6252
6253apiTokens: [ApiTokenInfo]!
6254
6255# Gets the most up to date package linked to this automate flow
6256#
6257# Arguments
6258# engineId: Engine Id for the automate flow.
6259automatePackage(engineId: ID!): Package
6260
6261# Retrieve applicationViewers
6262# Example:
6263# Request:
6264# query {
6265# applicationViewers(limit:2) {
6266# records{
6267# id
6268# name
6269# }
6270# }
6271# }
6272# Response:
6273# {
6274# "data": {
6275# "viewers": {
6276# "records": [
6277# {
6278# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6279# "name": "Viewer 1"
6280# },
6281# {
6282# "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c",
6283# "name": "Viewer 2"
6284# }
6285# ]
6286# }
6287# }
6288# }
6289#
6290# Arguments
6291# ids: Provide an ids to retrieve specific viewers.
6292# offset: Specify maximum number of results to retrieve in this
6293# result. Page size.
6294# limit: Specify maximum number of results to retrieve in this
6295# result.
6296# orderBy: Provide a list of ApplicationViewerSortField to sort
6297# by.
6298applicationViewers(
6299ids: [ID!],
6300offset: Int,
6301limit: Int,
6302orderBy: ApplicationViewerSortField
6303): ApplicationViewerList
6304
6305}

link Required by

This element is not required by anyone