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

link Required by

This element is not required by anyone