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: Query to filter SDO. Supports operations such as and,
3481# or, eq, gt, lt, etc.
3482# TODO link to syntax documentation
3483structuredDataObjects(
3484id: ID,
3485ids: [ID!],
3486schemaId: ID!,
3487orderBy: [StructuredDataOrderBy!],
3488limit: Int,
3489offset: Int,
3490owned: Boolean,
3491filter: JSONData
3492): StructuredDataList
3493
3494# Returns information about the GraphQL server, useful
3495# for diagnostics. This data is primarily used by Veritone
3496# development, and some fields may be restricted to Veritone administrators.
3497graphqlServiceInfo: GraphQLServiceInfo
3498
3499# Returns a signed writable S3 URL. A client can then
3500# upload to this URL with an HTTP PUT without providing
3501# any additional authorization (_note_: it must be a PUT.
3502# A POST will fail.)
3503# Example:
3504# Request:
3505# query {
3506#
3507# getSignedWritableUrl(type: "preview") {
3508#
3509# bucket
3510#
3511# key
3512#
3513# url
3514#
3515# }
3516# }
3517# Response:
3518# {
3519#
3520# "data": {
3521#
3522# "getSignedWritableUrl": {
3523#
3524# "bucket": "prod-api.veritone.com",
3525#
3526# "key":
3527# "35521/preview/2021/5/5/_/19-50-374_ed2c10a7-6f96-4d7c-a498-7bedeb383c7e",
3528#
3529# "url":
3530# "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"
3531#
3532# }
3533#
3534# }
3535# }
3536#
3537# Arguments
3538# key: Optional key of the object to generate a writable
3539# URL for. If not provided, a new, unique key will
3540# be generated. If a key is provided and resembles a file name
3541# (with extension delimited by .), a UUID will be inserted
3542# into the file name, leaving the extension intact.
3543# If a key is provided and does not resemble
3544# a file name, a UUID will be appended.
3545# type: Optional type of resource, such as `asset`, `thumbnail`,
3546# `discovery-analytics` or `preview`
3547# path: Optional extended path information. If the uploaded
3548# content will be contained
3549# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3550# (for `entityIdentifier`), the ID of the object should be provided here.
3551# expiresInSeconds: Optional expiresInSeconds custom expiration
3552# to signedUrlExpires
3553# Max expiresInSeconds up to 604800
3554# organizationId: Optional organization ID. Normally this value
3555# is computed by the server
3556# based on the authorization token used for the request.
3557# Is is used only by Veritone platform components.
3558getSignedWritableUrl(
3559key: String,
3560type: String,
3561path: String,
3562expiresInSeconds: Int,
3563organizationId: ID
3564): WritableUrlInfo
3565
3566# Return writable storage URLs in bulk.
3567# A maximum of 1000 can be created in one call.
3568# See `getSignedWritableUrl` for details on usage of the
3569# response contents.
3570# Example:
3571# Request:
3572# query {
3573#
3574# getSignedWritableUrls(number: 2) {
3575#
3576# bucket
3577#
3578# key
3579#
3580# url
3581#
3582# }
3583# }
3584# Response:
3585# {
3586#
3587# "data": {
3588#
3589# "getSignedWritableUrls": [
3590#
3591# {
3592#
3593# "bucket": "prod-api.veritone.com",
3594#
3595# "key": "35521/other/2021/5/5/_/19-19-384_723ca284-cee6-4883-af16-edcbfed86433",
3596#
3597# "url":
3598# "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"
3599#
3600# },
3601#
3602# {
3603#
3604# "bucket": "prod-api.veritone.com",
3605#
3606# "key": "35521/other/2021/5/6/_/19-19-384_76af4aeb-5d9b-4bc4-b1d0-251e3f57b651",
3607#
3608# "url":
3609# "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"
3610#
3611# }
3612#
3613# ]
3614#
3615# }
3616# }
3617#
3618# Arguments
3619# number: Number of signed URLs to return
3620# type: Optional type of resource, such as `asset`, `thumbnail`,
3621# or `preview`
3622# path: Optional extended path information. If the uploaded
3623# content will be contained
3624# within a container such as a `TemporalDataObject` (for `asset`) or `Library`
3625# (for `entityIdentifier`), the ID of the object should be provided here.
3626# organizationId: Optional organization ID. Normally this value
3627# is computed by the server
3628# based on the authorization token used for the request.
3629# Is is used only by Veritone platform components.
3630getSignedWritableUrls(
3631number: Int!,
3632type: String,
3633path: String,
3634organizationId: ID
3635): [WritableUrlInfo!]!
3636
3637# Retrieve the rights of the current user
3638# Example:
3639# Request:
3640# query {
3641#
3642# myRights {
3643#
3644# resources
3645#
3646# operations
3647#
3648# }
3649# }
3650# Response:
3651# {
3652#
3653# "data": {
3654#
3655# "myRights": {
3656#
3657# "resources": {},
3658#
3659# "operations": [
3660#
3661# "admin.access",
3662#
3663# "admin.org.read",
3664#
3665# "admin.org.update",
3666#
3667# "admin.user.create",
3668#
3669# "admin.user.read",
3670#
3671# "admin.user.update",
3672#
3673# "admin.user.delete",
3674#
3675# ...
3676#
3677# ]
3678#
3679# }
3680#
3681# }
3682# }
3683myRights: RightsListing
3684
3685# Retrieve the shared folders for an organization
3686# Example:
3687# Request:
3688# query {
3689#
3690# sharedFolders {
3691#
3692# id
3693#
3694# }
3695# }
3696# Response:
3697# {
3698#
3699# "data": {
3700#
3701# "sharedFolders": []
3702#
3703# }
3704# }
3705sharedFolders: [Folder]
3706
3707# Retrieve multiple watchlists
3708# Example:
3709# Request:
3710# query {
3711#
3712# watchlists(limit: 2) {
3713#
3714# records {
3715#
3716# id
3717#
3718# name
3719#
3720# }
3721#
3722# }
3723# }
3724# Response:
3725# {
3726#
3727# "data": {
3728#
3729# "watchlists": {
3730#
3731# "records": [
3732#
3733# {
3734#
3735# "id": "326916",
3736#
3737# "name": "example"
3738#
3739# },
3740#
3741# {
3742#
3743# "id": "325791",
3744#
3745# "name": "example"
3746#
3747# }
3748#
3749# ]
3750#
3751# }
3752#
3753# }
3754# }
3755#
3756# Arguments
3757# isDisabled: Set `true` to include only disabled watchlist or
3758# `false` to include only enabled watchlists. By default,
3759# both are included.
3760# names: Provide a list of names to filter folders
3761watchlists(
3762id: ID,
3763maxStopDateTime: DateTime,
3764minStopDateTime: DateTime,
3765minStartDateTime: DateTime,
3766maxStartDateTime: DateTime,
3767name: String,
3768offset: Int,
3769limit: Int,
3770orderBy: WatchlistOrderBy,
3771orderDirection: OrderDirection,
3772isDisabled: Boolean,
3773names: [String],
3774nameMatch: StringMatch
3775): WatchlistList
3776
3777# Retrieve a single watchlist by id
3778# Example:
3779# Request:
3780# query {
3781#
3782# watchlist(id: "325791") {
3783#
3784# name
3785#
3786# watchlistType
3787#
3788# }
3789# }
3790# Response:
3791# {
3792#
3793# "data": {
3794#
3795# "watchlist": {
3796#
3797# "name": "example",
3798#
3799# "watchlistType": "tracking"
3800#
3801# }
3802#
3803# }
3804# }
3805watchlist(id: ID!): Watchlist
3806
3807# Example:
3808# Request:
3809# query {
3810#
3811# mentionStatusOptions {
3812#
3813# id
3814#
3815# name
3816#
3817# }
3818# }
3819# Response:
3820# {
3821#
3822# "data": {
3823#
3824# "mentionStatusOptions": [
3825#
3826# {
3827#
3828# "id": "7",
3829#
3830# "name": "Auto Verified"
3831#
3832# },
3833#
3834# {
3835#
3836# "id": "5",
3837#
3838# "name": "Invalid"
3839#
3840# },
3841#
3842# {
3843#
3844# "id": "3",
3845#
3846# "name": "Needs Review"
3847#
3848# },
3849#
3850# {
3851#
3852# "id": "1",
3853#
3854# "name": "Pending Verification"
3855#
3856# },
3857#
3858# {
3859#
3860# "id": "6",
3861#
3862# "name": "Processing Verification"
3863#
3864# },
3865#
3866# {
3867#
3868# "id": "4",
3869#
3870# "name": "Request Bonus"
3871#
3872# },
3873#
3874# {
3875#
3876# "id": "2",
3877#
3878# "name": "Verified"
3879#
3880# }
3881#
3882# ]
3883#
3884# }
3885# }
3886mentionStatusOptions: [MentionStatus!]!
3887
3888# Retrieve multiple data registries
3889# Example:
3890# Request:
3891# query {
3892#
3893# dataRegistries(limit: 2) {
3894#
3895# records {
3896#
3897# id
3898#
3899# name
3900#
3901# }
3902#
3903# }
3904# }
3905# Response:
3906# {
3907#
3908# "data": {
3909#
3910# "dataRegistries": {
3911#
3912# "records": [
3913#
3914# {
3915#
3916# "id": "532ef261-d3a4-4c09-8fc7-0653a5131577",
3917#
3918# "name": "example"
3919#
3920# },
3921#
3922# {
3923#
3924# "id": "317c941d-30d0-455e-882b-34a26e513364",
3925#
3926# "name": "example"
3927#
3928# }
3929#
3930# ]
3931#
3932# }
3933#
3934# }
3935# }
3936dataRegistries(
3937id: ID,
3938ids: [ID!],
3939name: String,
3940nameMatch: StringMatch,
3941offset: Int,
3942limit: Int,
3943orderBy: DataRegistryOrderBy,
3944orderDirection: OrderDirection,
3945filterByOwnership: SchemaOwnership
3946): DataRegistryList
3947
3948# Retrieve a single data registry
3949# Example:
3950# Request:
3951# query {
3952#
3953# dataRegistry(id: "532ef261-d3a4-4c09-8fc7-0653a5131577") {
3954#
3955# name
3956#
3957# organizationId
3958#
3959# source
3960#
3961# }
3962# }
3963# Response:
3964# {
3965#
3966# "data": {
3967#
3968# "dataRegistry": {
3969#
3970# "name": "example",
3971#
3972# "organizationId": "35521",
3973#
3974# "source": "veritone-35521.datasets"
3975#
3976# }
3977#
3978# }
3979# }
3980dataRegistry(id: ID!): DataRegistry
3981
3982# Retrieve a subscription by id
3983# Example:
3984# Request:
3985# query {
3986#
3987# subscription(id: "275818") {
3988#
3989# isActive
3990#
3991# jsondata
3992#
3993# }
3994# }
3995# Response:
3996# {
3997#
3998# "data": {
3999#
4000# "subscription": {
4001#
4002# "isActive": true,
4003#
4004# "jsondata": {
4005#
4006# "tracking_unit_id": "325791",
4007#
4008# "creator_email": "example email",
4009#
4010# "unsubscribe_hash":
4011# "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0cmFja2luZ1VuaXQiOiJ0cmFja2luZ191bml0X2lkIiwiZW1haWxBZGRyZXNzIjoiZW1haWxfYWRkcmVzcyIsInRyYWNraW5nX3VuaXRfaWQiOiIzMjU3OTEiLCJlbWFpbF9hZGRyZXNzIjoiZXhhbXBsZSBlbWFpbCIsImlhdCI6MTYyNDAyMjY4OCwiaXNzIjoidmVyaXRvbmU6ZGlzY292ZXJ5Iiwic3ViIjoidW5zdWJzY3JpYmUifQ.stYGS_goXaEhwLbKtYRohPirUT-q6vuY5hMHt74BWMUuEWYhwAQBxMItoFjZSXc3lHolQutxsl_BDiMOWNS4snRvcn-jI-5HG_4A3gEjQc6sYbgtyeVGxuDAg4urtj5sSBz0AU0xXZwLp2NI0Q39dqQSi1v1ZFANFE-jGULHreE3h617hLKf6CvegaOyrn_wqNONsB6VKDbXoLxdWoYJu3k7UztbvD1SC_bYHc7ltd1Ua2blUXSH0eBlk7pSv1vWdpw9KwMeuPJdC3R3qOB3-0xtp7KzTs0f5TelSZbk-6keVJz4LQt2mDxs6uivd8wb6GJ6Ikw-uKUYuo3T-vL0p-hFA5DkwiToomqTIqXvF5DGJxx762bKLLEKALAC55LdJ7eCZc6DmrnRbYLYNVfc2jK9YBDKeZxUAjNmYvlRsQTpLIrLoxWWmCbOJznfEjrzp_gI24rUh5qZ_-KUHr0pEYd5DuURy_geCmwSedq-nHV8tlE7op1bX8k9fwWFjIS7JIjYquUJq9T2wqIORO0WN6DGhgqkL7texbx9IYSWRkAY26KQxUF08jm5Vh_jrkmRyXsS9r5kVn_AGXbMA_HqtFo2jvXw5OXDcuaRjYwJpf8YtMvjNuDl8t9gbSmKwbeG1FsErPX0ne5K2TRWIqolohIvdHTTfsZLVvWdwmASnYw"
4012#
4013# }
4014#
4015# }
4016#
4017# }
4018# }
4019subscription(id: ID!): Subscription!
4020
4021cognitiveSearch(id: ID!): CognitiveSearch!
4022
4023# Retrieve multiple collections
4024# Example:
4025# Request:
4026# query {
4027#
4028# collections {
4029#
4030# records {
4031#
4032# id
4033#
4034# name
4035#
4036# }
4037#
4038# }
4039# }
4040# Response:
4041# {
4042#
4043# "data": {
4044#
4045# "collections": {
4046#
4047# "records": [
4048#
4049# {
4050#
4051# "id": "241121",
4052#
4053# "name": "example"
4054#
4055# },
4056#
4057# {
4058#
4059# "id": "242599",
4060#
4061# "name": "example"
4062#
4063# },
4064#
4065# {
4066#
4067# "id": "243625",
4068#
4069# "name": "example"
4070#
4071# }
4072#
4073# ]
4074#
4075# }
4076#
4077# }
4078# }
4079collections(id: ID, name: String, mentionId: ID, offset: Int, limit: Int): CollectionList!
4080
4081# Retrieve a collection by id
4082# Example:
4083# Request:
4084# query {
4085#
4086# collection(id: "241121") {
4087#
4088# name
4089#
4090# isActive
4091#
4092# }
4093# }
4094# Response:
4095# {
4096#
4097# "data": {
4098#
4099# "collection": {
4100#
4101# "name": "example",
4102#
4103# "isActive": true
4104#
4105# }
4106#
4107# }
4108# }
4109collection(id: ID!): Collection!
4110
4111collectionMention(folderId: ID!, mentionId: ID!): CollectionMention!
4112
4113# Retrieve a list of collection mentions
4114# Specify at least one of folderId or mentionId
4115collectionMentions(
4116folderId: ID,
4117mentionId: ID,
4118orderBy: CollectionMentionOrderBy,
4119limit: Int,
4120offset: Int
4121): CollectionMentionList!
4122
4123# Retrieve multiple mentions
4124# Example:
4125# Request:
4126# query {
4127#
4128# mentions {
4129#
4130# records {
4131#
4132# id
4133#
4134# }
4135#
4136# }
4137# }
4138# Response:
4139# {
4140#
4141# "data": {
4142#
4143# "mentions": {
4144#
4145# "records": []
4146#
4147# }
4148#
4149# }
4150# }
4151#
4152# Arguments
4153# watchlistId: Get mentions created from the specified watchlist
4154# sourceId: Get mentions associated with the specified source
4155# sourceTypeId: Get mentions associated with sources of the
4156# specified source type
4157# tdoId: Get mentions associated directly with the specific TDO
4158# dateTimeFilter: Specify date/time filters against mention
4159# fields.
4160# Querying for mentions can be expensive. If the query does not
4161# include a filter by `id`, `tdoId`, `sourceId`, `watchlistId`, or
4162# a user-provided `dateTimeFilter`, a default filter of the
4163# past 7 days is applied.
4164# orderBy: Set order information on the query. Multiple fields
4165# are supported.
4166# folderId: Provide a folder ID to filter by collection
4167mentions(
4168id: ID,
4169watchlistId: ID,
4170sourceId: ID,
4171sourceTypeId: ID,
4172tdoId: ID,
4173dateTimeFilter: [MentionDateTimeFilter!],
4174orderBy: [MentionOrderBy!],
4175offset: Int,
4176limit: Int,
4177folderId: ID
4178): MentionList
4179
4180# Retrieves engine results by TDO and engine ID or by job ID.
4181# Example:
4182# Request:
4183# query {
4184#
4185# engineResults(
4186#
4187# tdoId: "1580507556",
4188#
4189# engineIds: "4") {
4190#
4191# sourceId
4192#
4193# records {
4194#
4195# tdoId
4196#
4197# }
4198#
4199# }
4200# }
4201# Response:
4202# {
4203#
4204# "data": {
4205#
4206# "engineResults": {
4207#
4208# "sourceId": null,
4209#
4210# "records": []
4211#
4212# }
4213#
4214# }
4215# }
4216#
4217# Arguments
4218# tdoId: Provide the ID of the TDO containing engine results to
4219# retrieve.
4220# If this parameter is used, engineIds or engineCategoryIds must also be set.
4221# Results for _only_ the specified TDO will be returned.
4222# sourceId: Provide the ID of the Source containing engine
4223# results to retrieve.
4224# If this parameter is used, engineIds or engineCategoryIds must also be set.
4225# This takes priority over tdoId.
4226# engineIds: Provide one or more engine IDs to retrieve engine
4227# results by
4228# ID. This parameter is mandatory if tdoId is used, but optional
4229# if jobId or engineCategory is used.
4230# engineCategoryIds: Provide one or more category IDs to get all
4231# results from that categroy.
4232# jobId: Provide a job ID to retrieve engine results for the job.
4233# mentionId: Provide a mention ID to retrieve engine results for
4234# the mention.
4235# startOffsetMs: Start offset ms for the results.
4236# stopOffsetMs: End offset ms for the results.
4237# startDate: Start date for the results. Takes priority over
4238# startOffsetMs.
4239# stopDate: End date for the results. Takes priority over
4240# stopOffsetMs.
4241# ignoreUserEdited: Whether or not to exclude user edited engine
4242# results. Defaults to false.
4243# fallbackTdoId: A TDO ID can be provided for use if the provided
4244# `sourceId` and/or
4245# `mentionId` parameters do not resolve to a logical set of TDOs.
4246# Depending on parameter settings and available data,
4247# results from other TDOs can be included in the response.
4248engineResults(
4249tdoId: ID,
4250sourceId: ID,
4251engineIds: [ID!],
4252engineCategoryIds: [ID!],
4253jobId: ID,
4254mentionId: ID,
4255startOffsetMs: Int,
4256stopOffsetMs: Int,
4257startDate: DateTime,
4258stopDate: DateTime,
4259ignoreUserEdited: Boolean,
4260fallbackTdoId: ID
4261): EngineResultList
4262
4263# Retrieve a trigger by id
4264# Example:
4265# Request:
4266# query {
4267#
4268# trigger(id: "2998") {
4269#
4270# target
4271#
4272# createdDateTime
4273#
4274# }
4275# }
4276# Response:
4277# {
4278#
4279# "data": {
4280#
4281# "trigger": {
4282#
4283# "target": "Email",
4284#
4285# "createdDateTime": "2021-06-18T13:35:08.631Z"
4286#
4287# }
4288#
4289# }
4290# }
4291trigger(id: ID!): Trigger
4292
4293# Retrieve triggers
4294# Example:
4295# Request:
4296# query {
4297#
4298# triggers {
4299#
4300# id
4301#
4302# }
4303# }
4304# Response:
4305# {
4306#
4307# "data": {
4308#
4309# "triggers": [
4310#
4311# {
4312#
4313# "id": "2998"
4314#
4315# }
4316#
4317# ]
4318#
4319# }
4320# }
4321triggers: [Trigger]
4322
4323# Fetch all saved searches that the current user has made
4324# Fetch all saved searches that have been shared with
4325# the current users organization
4326# Include any saved searches that the user has created
4327# Example:
4328# Request:
4329# query {
4330#
4331# savedSearches {
4332#
4333# records {
4334#
4335# id
4336#
4337# name
4338#
4339# }
4340#
4341# }
4342# }
4343# Response:
4344# {
4345#
4346# "data": {
4347#
4348# "savedSearches": {
4349#
4350# "records": [
4351#
4352# {
4353#
4354# "id": "3aa9fecb-d3cb-4fa5-a11b-20e02ae494b9",
4355#
4356# "name": "example"
4357#
4358# }
4359#
4360# ]
4361#
4362# }
4363#
4364# }
4365# }
4366savedSearches(
4367offset: Int,
4368limit: Int,
4369includeShared: Boolean,
4370filterByName: String,
4371orderBy: SavedSearchOrderBy,
4372orderDirection: OrderDirection
4373): SavedSearchList!
4374
4375# Retrieve a list of export requests
4376# Example:
4377# Request:
4378# query {
4379#
4380# exportRequests(limit: 2) {
4381#
4382# records {
4383#
4384# id
4385#
4386# organizationId
4387#
4388# }
4389#
4390# }
4391# }
4392# Response:
4393# {
4394#
4395# "data": {
4396#
4397# "exportRequests": {
4398#
4399# "records": [
4400#
4401# {
4402#
4403# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4404#
4405# "organizationId": "35521"
4406#
4407# }
4408#
4409# ]
4410#
4411# }
4412#
4413# }
4414# }
4415#
4416# Arguments
4417# id: Provide an ID to retrieve a single export request
4418# offset: Provide an offset to skip to a certain element in the
4419# result, for paging.
4420# limit: Specify maximum number of results to retrieve in this
4421# result. Page size.
4422# status: Provide a list of status options to filter by status
4423# event: Provide an event to retrieve export request. Should be
4424# 'exportRequest' or 'mentionExportRequest'
4425# Default value is 'exportRequest'
4426exportRequests(
4427id: ID,
4428offset: Int,
4429limit: Int,
4430status: [ExportRequestStatus!],
4431event: ExportRequestEvent
4432): ExportRequestList!
4433
4434# Retrieve a single export request by id
4435# Example:
4436# Request:
4437# query {
4438#
4439# exportRequest(id: "938b2d64-6df1-486b-b6ea-29d33dee49ad") {
4440#
4441# id
4442#
4443# organizationId
4444#
4445# requestorId
4446#
4447# status
4448#
4449# }
4450# }
4451# Response:
4452# {
4453#
4454# "data": {
4455#
4456# "exportRequest": {
4457#
4458# "id": "938b2d64-6df1-486b-b6ea-29d33dee49ad",
4459#
4460# "organizationId": "35521",
4461#
4462# "requestorId": "59cb4e74-7c31-4267-b91e-d4600bc08008",
4463#
4464# "status": "complete"
4465#
4466# }
4467#
4468# }
4469# }
4470#
4471# Arguments
4472# event: Provide an event to retrieve export request. Should be
4473# 'exportRequest' or 'mentionExportRequest'
4474# Default value is 'exportRequest'
4475exportRequest(id: ID!, event: ExportRequestEvent): ExportRequest!
4476
4477# Retrieve a event by id
4478# Example:
4479# Request:
4480# query {
4481#
4482# event(id: "55fc7c51-1521-4043-902f-f0f3a357da6d") {
4483#
4484# eventName
4485#
4486# eventType
4487#
4488# description
4489#
4490# }
4491# }
4492# Response:
4493# {
4494#
4495# "data": {
4496#
4497# "event": {
4498#
4499# "eventName": "example",
4500#
4501# "eventType": "example",
4502#
4503# "description": "new example description"
4504#
4505# }
4506#
4507# }
4508# }
4509event(id: ID!): Event
4510
4511# Retrieve a list of events by application
4512# Example:
4513# Request:
4514# query {
4515#
4516# events(
4517#
4518# application: "system",
4519#
4520# limit: 2) {
4521#
4522# records {
4523#
4524# id
4525#
4526# eventName
4527#
4528# }
4529#
4530# }
4531# }
4532# Response:
4533# {
4534#
4535# "data": {
4536#
4537# "events": {
4538#
4539# "records": [
4540#
4541# {
4542#
4543# "id": "8876aa2f-1068-411d-b746-28c867c151cc",
4544#
4545# "eventName": "ActionTokenForbidden"
4546#
4547# },
4548#
4549# {
4550#
4551# "id": "d5082d0e-3c96-4c71-9f27-c679650f2adf",
4552#
4553# "eventName": "ActionUserForbidden"
4554#
4555# }
4556#
4557# ]
4558#
4559# }
4560#
4561# }
4562# }
4563#
4564# Arguments
4565# application: Provide an application to retrieve all its events.
4566# Use 'system' to list all public system events.
4567# offset: Provide an offset to skip to a certain element in the
4568# result, for paging.
4569# limit: Specify maximum number of results to retrieve in this
4570# result. Page size.
4571events(application: String!, offset: Int, limit: Int): EventList!
4572
4573# Retrieve a list of subscriptions by organization
4574# Example:
4575# Request:
4576# query {
4577#
4578# eventSubscriptions(limit: 2) {
4579#
4580# records {
4581#
4582# id
4583#
4584# eventName
4585#
4586# }
4587#
4588# }
4589# }
4590# Response:
4591# {
4592#
4593# "data": {
4594#
4595# "eventSubscriptions": {
4596#
4597# "records": [
4598#
4599# {
4600#
4601# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4602#
4603# "eventName": "LibraryTrainingComplete"
4604#
4605# },
4606#
4607# {
4608#
4609# "id": "c7c4a969-4500-4d7b-b77f-81b1e64bf112",
4610#
4611# "eventName": "LibraryTrainingComplete"
4612#
4613# }
4614#
4615# ]
4616#
4617# }
4618#
4619# }
4620# }
4621#
4622# Arguments
4623# ids: The event subscription ids
4624# eventName: The name of the event
4625# eventType: The type of event, such as `mention`, `job`,
4626# `engine`.
4627# offset: Provide an offset to skip to a certain element in the
4628# result, for paging.
4629# limit: Specify maximum number of results to retrieve in this
4630# result. Page size.
4631# orgId: The organization ID with which these event subscriptions
4632# are associated.
4633# appId: The application ID with which these event subscriptions
4634# are associated.
4635# scope: Event subscription scope
4636eventSubscriptions(
4637ids: [ID!],
4638eventName: String,
4639eventType: String,
4640offset: Int,
4641limit: Int,
4642orgId: ID,
4643appId: ID,
4644scope: EventSubscriptionScope
4645): EventSubscriptionList!
4646
4647# Retrieve a subscription by id
4648# Example:
4649# Request:
4650# query {
4651#
4652# eventSubscription(id: "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194") {
4653#
4654# id
4655#
4656# organizationId
4657#
4658# eventName
4659#
4660# targetName
4661#
4662# }
4663# }
4664# Response:
4665# {
4666#
4667# "data": {
4668#
4669# "eventSubscription": {
4670#
4671# "id": "4a81cdf7-e85b-4dc4-85ce-7c2d300cd194",
4672#
4673# "organizationId": "35521",
4674#
4675# "eventName": "LibraryTrainingComplete",
4676#
4677# "targetName": "NotificationMailbox"
4678#
4679# }
4680#
4681# }
4682# }
4683eventSubscription(id: ID!): EventSubscription!
4684
4685# Example:
4686# Request:
4687# query {
4688#
4689# eventActionTemplate(id: "d02522d7-ef5f-448f-981a-d2cfc7603d92") {
4690#
4691# organizationId
4692#
4693# actionType
4694#
4695# name
4696#
4697# }
4698# }
4699# Response:
4700# {
4701#
4702# "data": {
4703#
4704# "eventActionTemplate": {
4705#
4706# "organizationId": "35521",
4707#
4708# "actionType": "job",
4709#
4710# "name": "example"
4711#
4712# }
4713#
4714# }
4715# }
4716eventActionTemplate(id: ID!): EventActionTemplate
4717
4718# Example:
4719# Request:
4720# query {
4721#
4722# eventActionTemplates(
4723#
4724# inputType: event,
4725#
4726# actionType: job
4727#
4728# limit:2) {
4729#
4730# records {
4731#
4732# id
4733#
4734# name
4735#
4736# }
4737#
4738# }
4739# }
4740# Response:
4741# {
4742#
4743# "data": {
4744#
4745# "eventActionTemplates": {
4746#
4747# "records": [
4748#
4749# {
4750#
4751# "id": "d02522d7-ef5f-448f-981a-d2cfc7603d92",
4752#
4753# "name": "example"
4754#
4755# },
4756#
4757# {
4758#
4759# "id": "49d28375-b6b2-418e-b965-8e939d1189ae",
4760#
4761# "name": "example"
4762#
4763# }
4764#
4765# ]
4766#
4767# }
4768#
4769# }
4770# }
4771#
4772# Arguments
4773# ownerApplicationId: The application id
4774# inputType: use "event" for now. In the future, we allow
4775# additional input_type types. For example, a schedule or a tweet.
4776# actionType: Either "job", "webhook", "sms", "email". Future
4777# action_type could be "gql" where action is purely a function call.
4778# offset: Provide an offset to skip to a certain element in the
4779# result, for paging.
4780# limit: Specify maximum number of results to retrieve in this
4781# result. Page size.
4782eventActionTemplates(
4783ownerApplicationId: ID,
4784inputType: EventActionTemplateInputType,
4785actionType: EventActionTemplateActionType,
4786offset: Int,
4787limit: Int
4788): EventActionTemplateList!
4789
4790# Example:
4791# Request:
4792# query {
4793#
4794# eventCustomRule(id: "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5") {
4795#
4796# name
4797#
4798# eventName
4799#
4800# description
4801#
4802# }
4803# }
4804# Response:
4805# {
4806#
4807# "data": {
4808#
4809# "eventCustomRule": {
4810#
4811# "name": "example",
4812#
4813# "eventName": "example",
4814#
4815# "description": "example description"
4816#
4817# }
4818#
4819# }
4820# }
4821eventCustomRule(id: ID!): EventCustomRule
4822
4823# Example:
4824# Request:
4825# query {
4826#
4827# eventCustomRules(limit: 2) {
4828#
4829# records {
4830#
4831# id
4832#
4833# name
4834#
4835# }
4836#
4837# }
4838# }
4839# Response:
4840# {
4841#
4842# "data": {
4843#
4844# "eventCustomRules": {
4845#
4846# "records": [
4847#
4848# {
4849#
4850# "id": "c2c1ee13-37d2-4f92-9156-5cb1a3c59ed5",
4851#
4852# "name": "example"
4853#
4854# }
4855#
4856# ]
4857#
4858# }
4859#
4860# }
4861# }
4862#
4863# Arguments
4864# offset: the offset to skip to a certain element in the result
4865# limit: the maximum number of rows in the results
4866eventCustomRules(offset: Int, limit: Int): EventCustomRuleList!
4867
4868# This query returns information about time zones recognized by this
4869#
4870# server. The information is static and does not change.
4871#
4872# Example:
4873#
4874# Request:
4875#
4876# query {
4877#
4878# timeZones {
4879#
4880# name
4881#
4882# abbreviations{
4883#
4884# name
4885#
4886# }
4887#
4888# }
4889# }
4890# Response:
4891# {
4892#
4893# "data": {
4894#
4895# "timeZones": [
4896#
4897# {
4898#
4899# "name": "Africa/Abidjan",
4900#
4901# "abbreviations": [
4902#
4903# {
4904#
4905# "name": "GMT"
4906#
4907# }
4908#
4909# ]
4910#
4911# },
4912#
4913# {
4914#
4915# "name": "Africa/Accra",
4916#
4917# "abbreviations": [
4918#
4919# {
4920#
4921# "name": "GMT"
4922#
4923# },
4924#
4925# {
4926#
4927# "name": "+0020"
4928#
4929# }
4930#
4931# ]
4932#
4933# },
4934#
4935# {
4936#
4937# "name": "Africa/Lagos",
4938#
4939# "abbreviations": [
4940#
4941# {
4942#
4943# "name": "WAT"
4944#
4945# }
4946#
4947# ]
4948#
4949# },
4950#
4951# ...
4952#
4953# ...
4954#
4955# ]
4956#
4957# }
4958#
4959# ]
4960#
4961# }
4962# }
4963timeZones: [TimeZone!]!
4964
4965# Examine entries from the audit log. All operations that modify data are
4966# written to the audit log. Only entries for the user's own organization
4967# can be queried.
4968# All queries are bracketed by a time window. A default time window is applied
4969# if the `toDateTime` and/or `fromDateTime` parameters are not provided.
4970# The maximum time window length is 30 days.
4971# Only Veritone and organization administrators can use this query.
4972# Example:
4973# Request:
4974# query {
4975#
4976# auditLog(limit: 2) {
4977#
4978# records {
4979#
4980# id
4981#
4982# objectId
4983#
4984# description
4985#
4986# }
4987#
4988# }
4989# }
4990# Response:
4991# {
4992#
4993# "data": {
4994#
4995# "auditLog": {
4996#
4997# "records": [
4998#
4999# {
5000#
5001# "id": "735915311",
5002#
5003# "objectId": "*********",
5004#
5005# "description": "Changed password"
5006#
5007# },
5008#
5009# {
5010#
5011# "id": "735915307",
5012#
5013# "objectId": "********",
5014#
5015# "description": "Changed password"
5016#
5017# }
5018#
5019# ]
5020#
5021# }
5022#
5023# }
5024# }
5025#
5026# Arguments
5027# toDateTime: Date/time up to which entries will be returned. In
5028# other words, the
5029# end of the query time window.
5030# Defaults to the current time.
5031# fromDateTime: Date/time from which entries will be returned. In
5032# other words, the
5033# start of the query time window.
5034# Defaults to the `toDateTime` minus 7 days.
5035# organizationId: Organization ID to query records for. This
5036# value can only be used by
5037# Veritone administrators. Any value provided by user administrators will
5038# be ignored.
5039# userName: User name on audit entry. Must be exact match.
5040# clientIpAddress: IP address of the client that generated the
5041# audit action. Must be exact match.
5042# clientUserAgent: HTTP user agent of the client that generated
5043# the audit action. Must be exact match.
5044# eventType: The event type, such as `Create`, `Update`, or
5045# `Delete`.
5046# Must be exact match.
5047# objectId: The ID of the object involved in the audit action.
5048# The format of this ID
5049# varies by object type. Must be exact match.
5050# objectType: The type of the object involved in the audit
5051# action, such as `Watchlist`
5052# or `TemporalDataObject`. Must be exact match.
5053# success: Whether or not the action was successful.
5054# id: The unique ID of an audit log entry. Multiple values can be
5055# provided.
5056# offset: Offset into result set, for paging.
5057# limit: Limit on result size, for paging (page size). Audit
5058# queries are
5059# lightweight so the default of 100 is higher than the default offset
5060# used elsewhere in the API.
5061# orderBy: Order information. Default is order by
5062# `createdDateTime` descending.
5063auditLog(
5064toDateTime: DateTime,
5065fromDateTime: DateTime,
5066organizationId: ID,
5067userName: String,
5068clientIpAddress: String,
5069clientUserAgent: String,
5070eventType: String,
5071objectId: ID,
5072objectType: String,
5073success: Boolean,
5074id: [ID!],
5075offset: Int,
5076limit: Int,
5077orderBy: [AuditLogOrderBy!]
5078): AuditLogEntryList! @deprecated( reason: "No longer supported." )
5079
5080# Get the media share by media shareId
5081mediaShare(id: ID!): MediaShare!
5082
5083# Retrieve a shared collection
5084#
5085# Arguments
5086# shareId: share token
5087sharedCollection(shareId: ID!): SharedCollection
5088
5089# Retrieve shared collection history records
5090# Example:
5091# Request:
5092# query {
5093#
5094# sharedCollectionHistory(limit: 2,
5095#
5096# folderId: "d551fbd6-7354-4b0e-abfb-654ab8583be2") {
5097#
5098# records {
5099#
5100# id
5101#
5102# status
5103#
5104# shareId
5105#
5106# }
5107#
5108# }
5109# }
5110# Response:
5111# {
5112#
5113# "data": {
5114#
5115# "sharedCollectionHistory": {
5116#
5117# "records": []
5118#
5119# }
5120#
5121# }
5122# }
5123#
5124# Arguments
5125# ids: Provide an ID to retrieve a single history record
5126# folderId: Provide a folder ID to filter by collection
5127# shareId: Provide a share ID to filter by share ID
5128# offset: Specify maximum number of results to retrieve in this
5129# result. Page size.
5130# limit: Specify maximum number of results to retrieve in this
5131# result.
5132sharedCollectionHistory(
5133ids: [ID!],
5134folderId: ID,
5135shareId: String,
5136offset: Int,
5137limit: Int
5138): SharedCollectionHistoryList!
5139
5140# Get list process templates by id or current organizationId
5141# Example:
5142# Request:
5143# query {
5144#
5145# processTemplates(limit: 2) {
5146#
5147# records {
5148#
5149# id
5150#
5151# organizationId
5152#
5153# name
5154#
5155# }
5156#
5157# }
5158# }
5159# Response:
5160# {
5161#
5162# "data": {
5163#
5164# "processTemplates": {
5165#
5166# "records": [
5167#
5168# {
5169#
5170# "id": "762",
5171#
5172# "organizationId": "35521",
5173#
5174# "name": "example"
5175#
5176# }
5177#
5178# ]
5179#
5180# }
5181#
5182# }
5183# }
5184processTemplates(id: ID, offset: Int, limit: Int): ProcessTemplateList!
5185
5186# Get process templates by id
5187# Example:
5188# Request:
5189# query {
5190#
5191# processTemplate(id: "762") {
5192#
5193# name
5194#
5195# organizationId
5196#
5197# }
5198# }
5199# Response:
5200# {
5201#
5202# "data": {
5203#
5204# "processTemplate": {
5205#
5206# "name": "example",
5207#
5208# "organizationId": "35521"
5209#
5210# }
5211#
5212# }
5213# }
5214processTemplate(id: ID!): ProcessTemplate!
5215
5216# Get creative by id with current organizationId
5217# Example:
5218# Request:
5219# query {
5220#
5221# creative(id: "25209") {
5222#
5223# organizationId
5224#
5225# brandId
5226#
5227# }
5228# }
5229# Response:
5230# {
5231#
5232# "data": {
5233#
5234# "creative": {
5235#
5236# "organizationId": "35521",
5237#
5238# "brandId": null
5239#
5240# }
5241#
5242# }
5243# }
5244creative(id: ID!): Creative!
5245
5246# Retrieve list of engine classes
5247# Example:
5248# Request:
5249# query {
5250#
5251# engineClasses(limit: 2) {
5252#
5253# records {
5254#
5255# id
5256#
5257# name
5258#
5259# description
5260#
5261# }
5262#
5263# }
5264# }
5265# Response:
5266# {
5267#
5268# "data": {
5269#
5270# "engineClasses": {
5271#
5272# "records": [
5273#
5274# {
5275#
5276# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5277#
5278# "name": "audio",
5279#
5280# "description": "The input to engines in the Audio class is an audio or video
5281# file or stream. If your engine processes human speech or voice, it likely
5282# belongs in the Speech class instead. Audio engines may recognize a specific
5283# audio segment, such as an advertisement, identify sounds like that of a crying
5284# baby or detect the presence of audio or music in an audio or video file, for
5285# example."
5286#
5287# },
5288#
5289# {
5290#
5291# "id": "1bcfdd35-1e9b-4694-8273-00b19510d164",
5292#
5293# "name": "biometrics",
5294#
5295# "description": "The input to engines in the Biometrics class may be an image,
5296# speech or other audio or video file or stream. By definition, the Biometrics
5297# class covers cognitive analysis related to data points from the human body.
5298# Biometrics engines may detect or recognize faces, identify face attributes to
5299# estimate a person's age or ethnicity or verify a person based on their unique
5300# iris, for example."
5301#
5302# }
5303#
5304# ]
5305#
5306# }
5307#
5308# }
5309# }
5310#
5311# Arguments
5312# id: Provide an ID to retrieve a single specific engine class.
5313# name: Provide a name, or part of one, to search by class name
5314# offset: Specify maximum number of results to retrieve in this
5315# result. Page size.
5316# limit: Specify maximum number of results to retrieve in this
5317# result.
5318engineClasses(id: ID, name: String, offset: Int, limit: Int): EngineClassList
5319
5320# Retrieve a specific engine class
5321# Example:
5322# Request:
5323# query {
5324#
5325# engineClass(id: "e0283fdf-7f85-472e-b367-59cc8d205ba7") {
5326#
5327# id
5328#
5329# name
5330#
5331# description
5332#
5333# }
5334# }
5335# Response:
5336# {
5337#
5338# "data": {
5339#
5340# "engineClass": {
5341#
5342# "id": "e0283fdf-7f85-472e-b367-59cc8d205ba7",
5343#
5344# "name": "audio",
5345#
5346# "description": "The input to engines in the Audio class is an audio or video
5347# file or stream. If your engine processes human speech or voice, it likely
5348# belongs in the Speech class instead. Audio engines may recognize a specific
5349# audio segment, such as an advertisement, identify sounds like that of a crying
5350# baby or detect the presence of audio or music in an audio or video file, for
5351# example."
5352#
5353# }
5354#
5355# }
5356# }
5357#
5358# Arguments
5359# id: Supply the ID of the engine class to retrieve
5360engineClass(id: ID!): EngineClass
5361
5362# Retrieve list entity tags where tag key contains user input
5363# Example:
5364# Request:
5365# query {
5366#
5367# matchEntityTags(input: { tagKey: "test}) {
5368#
5369# records {
5370#
5371# tagKey
5372#
5373# tagValue
5374#
5375# }
5376#
5377# }
5378# }
5379# Response:
5380# {
5381#
5382# "data": {
5383#
5384# "matchEntityTags": {
5385#
5386# "records": [
5387#
5388# {
5389#
5390# "tagKey": "test-tag",
5391#
5392# "tagValue": "test-value"
5393#
5394# },
5395#
5396# {
5397#
5398# "tagKey": "another-testtag",
5399#
5400# "tagValue": ""
5401#
5402# },
5403#
5404# ]
5405#
5406# }
5407#
5408# }
5409# }
5410#
5411# Arguments
5412# input: User provided text and entity type input.
5413# offset: Specify maximum number of results to retrieve in this
5414# result. Page size.
5415# limit: Specify maximum number of results to retrieve in this
5416# result.
5417matchEntityTags(input: MatchEntityTagInput!, offset: Int, limit: Int): MatchedEntityTagsList
5418
5419# Returns all custom dashboards created by user
5420# Example:
5421# Request:
5422# query {
5423#
5424# customDashboards {
5425#
5426# records {
5427#
5428# id
5429#
5430# description
5431#
5432# hostAppId
5433#
5434# }
5435#
5436# }
5437# }
5438# Response:
5439# {
5440#
5441# "data": {
5442#
5443# "customDashboards": {
5444#
5445# "records": [
5446#
5447# {
5448#
5449# "id": "a20ae938-e827-4b0b-a62a-6c9af0b98cc9",
5450#
5451# "description": "example",
5452#
5453# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f"
5454#
5455# }
5456#
5457# ]
5458#
5459# }
5460#
5461# }
5462# }
5463#
5464# Arguments
5465# offset: Provide an offset to skip to a certain element in the
5466# result, for paging.
5467# limit: Specify maximum number of results to retrieve in this
5468# result. Page size.
5469# hostAppId: Include only dashboards created by specific
5470# host_app_id
5471customDashboards(offset: Int, limit: Int, hostAppId: ID): CustomDashboardList
5472
5473# Returns custom dashboard by id
5474# Example:
5475# Request:
5476# query {
5477#
5478# customDashboard(id: "a20ae938-e827-4b0b-a62a-6c9af0b98cc9") {
5479#
5480# hostAppId
5481#
5482# name
5483#
5484# }
5485# }
5486# Response:
5487# {
5488#
5489# "data": {
5490#
5491# "customDashboard": {
5492#
5493# "hostAppId": "80354999-d633-4595-9578-d82f59a5134f",
5494#
5495# "name": "example"
5496#
5497# }
5498#
5499# }
5500# }
5501customDashboard(id: ID!): CustomDashboard
5502
5503# Gets engine usage for an organization based on their billing type.
5504# Example:
5505# Request:
5506# query {
5507#
5508# getUsageByTaskType {
5509#
5510# totalDuration
5511#
5512# totalCost
5513#
5514# }
5515# }
5516# Response:
5517# {
5518#
5519# "data": {
5520#
5521# "getUsageByTaskType": {
5522#
5523# "totalDuration": 0,
5524#
5525# "totalCost": "0"
5526#
5527# }
5528#
5529# }
5530# }
5531getUsageByTaskType: UsageByTaskType!
5532
5533# Retrives the specific Dataset
5534#
5535# Arguments
5536# id: Supply the ID of the Dataset to retrieve
5537dataset(id: ID!): Dataset
5538
5539# Retrieve list of Datasets
5540# Example:
5541# Request:
5542# query {
5543#
5544# datasets(limit:2, filter: {operation:OR}) {
5545#
5546# records {
5547#
5548# datasetId
5549#
5550# name
5551#
5552# }
5553#
5554# }
5555# }
5556# Response:
5557# {
5558#
5559# "data": {
5560#
5561# "datasets": {
5562#
5563# "records": []
5564#
5565# }
5566#
5567# }
5568# }
5569#
5570# Arguments
5571# offset: Provide an offset to skip to a certain element in the
5572# result, for paging.
5573# limit: Specify maximum number of results to retrieve in this
5574# result. Page size.
5575# filter: Filters for Dataset attributes
5576datasets(offset: Int, limit: Int, filter: DatasetFilter): DatasetList
5577
5578# Arguments
5579# datasetId: Supply the ID of the Dataset to retrieve
5580# offset: Provide an offset to skip to a certain element in the
5581# result, for paging.
5582# limit: Specify maximum number of results to retrieve in this
5583# result. Page size.
5584# filter: Query to filter SDO. Supports operations such as and,
5585# or, eq, gt, lt, etc.
5586# TODO link to syntax documentation
5587# orderBy: Order by
5588datasetDataQuery(
5589datasetId: ID!,
5590offset: Int,
5591limit: Int,
5592filter: JSONData,
5593orderBy: [StructuredDataOrderBy!]
5594): DatasetEntryList!
5595
5596# Retrive list of Engine Replacement
5597# Example:
5598# Request:
5599# query {
5600#
5601# taskReplacementEngines {
5602#
5603# records {
5604#
5605# sourceEngineId
5606#
5607# replacementEngineId
5608#
5609# }
5610#
5611# }
5612# }
5613# Response:
5614# {
5615#
5616# "data": {
5617#
5618# "taskReplacementEngines": {
5619#
5620# "records": [
5621#
5622# {
5623#
5624# "sourceEngineId": "1",
5625#
5626# "replacementEngineId": "2"
5627#
5628# }
5629#
5630# ]
5631#
5632# }
5633#
5634# }
5635# }
5636#
5637# Arguments
5638# organizationId: Only superadmin can get engine replacement of
5639# other orgs
5640# engineId: Filter by the source engineId
5641# offset: Provide an offset to skip to a certain element in the
5642# result, for paging.
5643# limit: Specify maximum number of results to retrieve in this
5644# result. Page size.
5645taskReplacementEngines(
5646organizationId: ID,
5647engineId: ID,
5648offset: Int,
5649limit: Int
5650): TaskReplacementEngineList
5651
5652# Retrive Notification Mailboxes by list of mailboxIds
5653# Example:
5654# Request:
5655# query {
5656#
5657# notificationMailboxes {
5658#
5659# id
5660#
5661# name
5662#
5663# }
5664# }
5665# Response:
5666# {
5667#
5668# "data": {
5669#
5670# "notificationMailboxes": [
5671#
5672# {
5673#
5674# "id": "6fda80b5-3d1a-4eb8-bd32-277be5104149",
5675#
5676# "name": "example"
5677#
5678# },
5679#
5680# {
5681#
5682# "id": "d20e9f37-a887-41bb-aed0-3268884ecebc",
5683#
5684# "name": "Library training mailbox"
5685#
5686# },
5687#
5688# {
5689#
5690# "id": "2d29533b-560e-4354-b794-84f823d33205",
5691#
5692# "name": "Library training mailbox"
5693#
5694# }
5695#
5696# ]
5697#
5698# }
5699# }
5700notificationMailboxes(ids: [ID!]): [NotificationMailbox!]
5701
5702# Retrive Notification Templates
5703# Example:
5704# Request:
5705# query {
5706#
5707# notificationTemplates(limit: 2) {
5708#
5709# records {
5710#
5711# id
5712#
5713# eventName
5714#
5715# }
5716#
5717# }
5718# }
5719# Response:
5720# {
5721#
5722# "data": {
5723#
5724# "notificationTemplates": {
5725#
5726# "records": [
5727#
5728# {
5729#
5730# "id": "3947b833-2be4-4415-8272-2cee62fbca23",
5731#
5732# "eventName": "example"
5733#
5734# }
5735#
5736# ]
5737#
5738# }
5739#
5740# }
5741# }
5742#
5743# Arguments
5744# ids: Get by array of ids
5745# eventName: Get by eventName
5746# eventType: Get by eventType
5747# application: Get by application
5748# mailboxId: Get by mailboxId
5749# ownerOrganizationId: Only super-admin or orgless token can get
5750# templates by ownerOrganizationId
5751# offset: Provide an offset to skip to a certain element in the
5752# result, for paging.
5753# limit: Specify maximum number of results to retrieve in this
5754# result. Page size.
5755notificationTemplates(
5756ids: [ID],
5757eventName: String,
5758eventType: String,
5759application: String,
5760mailboxId: ID,
5761ownerOrganizationId: ID,
5762offset: Int,
5763limit: Int
5764): NotificationTemplateList
5765
5766# Retrieve Notification Actions
5767# Example:
5768# Request:
5769# query {
5770#
5771# notificationActions {
5772#
5773# records {
5774#
5775# id
5776#
5777# actionName
5778#
5779# }
5780#
5781# }
5782# }
5783# Response:
5784# {
5785#
5786# "data": {
5787#
5788# "notificationActions": {
5789#
5790# "records": [
5791#
5792# {
5793#
5794# "id": "866aad9c-9e68-4c33-b523-373bb332aea2",
5795#
5796# "actionName": "example"
5797#
5798# }
5799#
5800# ]
5801#
5802# }
5803#
5804# }
5805# }
5806#
5807# Arguments
5808# ids: Get by array of ids
5809# eventName: Get by eventName
5810# eventType: Get by eventType
5811# application: Get by application
5812# mailboxId: Get by mailboxId
5813# ownerOrganizationId: Only super-admin or orgless token can get
5814# templates by ownerOrganizationId
5815# offset: Provide an offset to skip to a certain element in the
5816# result, for paging.
5817# limit: Specify maximum number of results to retrieve in this
5818# result. Page size.
5819notificationActions(
5820ids: [ID],
5821eventName: String,
5822eventType: String,
5823application: String,
5824mailboxId: ID,
5825ownerOrganizationId: ID,
5826offset: Int,
5827limit: Int
5828): NotificationActionList
5829
5830# Retrieve Application user setting definitions
5831# Example:
5832# Request:
5833# query {
5834#
5835# getUserSettingDefinitions(application: "80354999-d633-4595-9578-d82f59a5134f") {
5836#
5837# key
5838#
5839# value
5840#
5841# }
5842# }
5843# Response:
5844# {
5845#
5846# "data": {
5847#
5848# "getUserSettingDefinitions": [
5849#
5850# {
5851#
5852# "key": "example",
5853#
5854# "value": "example"
5855#
5856# }
5857#
5858# ]
5859#
5860# }
5861# }
5862#
5863# Arguments
5864# application: Specify the applicationId
5865# key: Specify the key of user setting (optional)
5866# organizationGuid: Specify the organizationGuid (require for
5867# internal token)
5868# This can be specified by superadmin to get user setting definitions of other
5869# organization
5870getUserSettingDefinitions(
5871application: ID!,
5872key: String,
5873organizationGuid: ID
5874): [ApplicationSetting]
5875
5876# Retrive User setting
5877# Example:
5878# Request:
5879# query {
5880#
5881# getUserSettings {
5882#
5883# key
5884#
5885# applicationId
5886#
5887# }
5888# }
5889# Response:
5890# {
5891#
5892# "data": {
5893#
5894# "getUserSettings": [
5895#
5896# {
5897#
5898# "key": "example12",
5899#
5900# "applicationId": "80354999-d633-4595-9578-d82f59a5134f"
5901#
5902# }
5903#
5904# ]
5905#
5906# }
5907# }
5908#
5909# Arguments
5910# userId: Filter by userId (optional).
5911# If it's not specified, default is current user
5912# application: Filter by applicationId
5913# keys: Filter by keys
5914getUserSettings(userId: ID, application: ID, keys: [String]): [UserSetting]
5915
5916# Example:
5917# Request:
5918# query {
5919#
5920# staticAppConfig {
5921#
5922# loginUrl
5923#
5924# apiRoot
5925#
5926# }
5927# }
5928# Response:
5929# {
5930#
5931# "data": {
5932#
5933# "staticAppConfig": {
5934#
5935# "loginUrl": "https://login.veritone.com",
5936#
5937# "apiRoot": "https://api.veritone.com"
5938#
5939# }
5940#
5941# }
5942# }
5943staticAppConfig: StaticAppConfig!
5944
5945# Get OpenID Provider by id
5946openIdProvider(id: ID!): OpenIdProvider!
5947
5948# Get OpenID Provides
5949# Example:
5950# Request:
5951# query {
5952#
5953# openIdProviders {
5954#
5955# records {
5956#
5957# id
5958#
5959# isGlobal
5960#
5961# websiteUrl
5962#
5963# }
5964#
5965# }
5966# }
5967# Response:
5968# {
5969#
5970# "data": {
5971#
5972# "openIdProviders": {
5973#
5974# "records": []
5975#
5976# }
5977#
5978# }
5979# }
5980#
5981# Arguments
5982# orgId: Filter Providers by organizationId. This is only used by
5983# superadmin.
5984# If filter with org-admin role, orgId is always the current user org.
5985openIdProviders(
5986ids: [ID],
5987isGlobal: Boolean,
5988orgId: ID,
5989offset: Int,
5990limit: Int
5991): OpenIdProviderList
5992
5993# Arguments
5994# orgId: This returns all packages that the Organization has
5995# access to.
5996#
5997# ___Note: for Super-Admin use only.___
5998# resourceId: This returns packages that have the provided
5999# resource linked to it
6000# resourceAlias: This returns any packages have resources that
6001# have the alias.
6002# primaryResourceId: This returns packages that have the provided
6003# resource as its primary resource
6004# sourceOriginId: This returns the entire lineage of packages
6005# that share the same sourceOriginId.
6006#
6007# This UUID is used to track a package's lineage. This UUID and versions is NOT
6008# guaranteed to be a package ID and should not be used as such.
6009# sourcePackageId: This returns any packages that immediately
6010# derive from the provided ID.
6011#
6012# The sourcePackageId of a package refers to the package that it derived from, if
6013# any.
6014# For example, there is a lineage of packages that contain versions 1.0, 2.0, 3.0,
6015# and 4.0.
6016# If the ID of version 2.0 is provided, this filter will return the package
6017# information for
6018# only version 3.0. This is because version 3.0 is the immediate descendent of
6019# version 2.0.
6020# packageFilter: Fields to filter the results by.
6021# distributionType: This returns packages of a specific
6022# distribution type
6023# distributionTypes: This returns packages of a list of
6024# distribution types
6025# status: This returns packages with a specific status
6026# nameRegexp: name regexp pattern
6027# owned: If true, return only packages owned by the calling org.
6028#
6029# If false, return all packages that the calling org has access to.
6030#
6031# The default behavior when `owned` is not provided assumes `false`.
6032#
6033# __Note__: Superadmin tokens are authorized to change the `orgId` field. If
6034# provided, the above behavior will apply to `orgId` instead of the calling org.
6035# includeDeleted: If true, result includes deleted packages
6036# offset: Provide an offset to skip to a certain element in the
6037# result, for paging.
6038# limit: Specify maximum number of results to retrieve in this
6039# result. Page size.
6040packages(
6041id: ID,
6042ids: [ID!],
6043orgId: ID,
6044resourceId: ID,
6045resourceAlias: String,
6046primaryResourceId: ID,
6047sourceOriginId: ID,
6048sourcePackageId: ID,
6049packageFilter: PackageFilter,
6050distributionType: EngineDistributionType,
6051distributionTypes: [EngineDistributionType!],
6052status: PackageStatus,
6053nameRegexp: String,
6054owned: Boolean,
6055includeDeleted: Boolean,
6056offset: Int,
6057limit: Int
6058): PackageList
6059
6060# List existing package grants.
6061# Either packageId or organizationId must be specified.
6062#
6063# The following examples assume that the caller is the owner of the Packages:
6064# packageGrants(id: 123) - Show Grants for Package 123
6065# packageGrants(organizationId: 12) - Show Grants for all Packages to Org 12
6066# packageGrants(id: 123, organizationId: 12) Show Grants for Package 123 to Org 12
6067#
6068# Arguments
6069# id: Package ID. If specified, show all the Grants for this
6070# Package.
6071#
6072# If calling Org is owner of the Package, show all Grants.
6073#
6074# If calling Org is not owner of the Package, only show Grants for the Package to
6075# the calling Org.
6076#
6077# If Super-Admin, show all Grants for the Package.
6078# orgId: Show all Grants to the specified Org.
6079#
6080# If the input organizationId is different from the calling Org, this will show
6081# Grants for Packages
6082# that are owned by the calling Org to the specified Org.
6083#
6084# If the input organizationId is the same as the caller's Org, this will show
6085# Grants for Packages
6086# to the calling Org.
6087#
6088# If Super-Admin, show Grants for all Packages to the specified Org.
6089# includeDeleted: If true, result includes deleted packages
6090# offset: Provide an offset to skip to a certain element in the
6091# result, for paging.
6092# limit: Specify maximum number of results to retrieve in this
6093# result. Page size.
6094packageGrants(
6095id: ID,
6096orgId: ID,
6097includeDeleted: Boolean,
6098offset: Int,
6099limit: Int,
6100packageFilter: PackageGrantFilter
6101): PackageGrantList
6102
6103# Retrieve the basic user information.
6104# The caller and the queried user are required to be members of the same
6105# organization,
6106# unless the caller is superadmin user.
6107# Example:
6108# Request:
6109# query {
6110#
6111# basicUserInfo(id: "267de7e1-efb2-444a-a524-210328b78503") {
6112#
6113# id
6114#
6115# name
6116#
6117# firstName
6118#
6119# lastName
6120#
6121# email
6122#
6123# imageUrl
6124#
6125# }
6126# }
6127# Response:
6128# {
6129#
6130# "data": {
6131#
6132# "basicUserInfo": {
6133#
6134# "id": "267de7e1-efb2-444a-a524-210328b78503",
6135#
6136# "name": "username",
6137#
6138# "firstName": "first",
6139#
6140# "lastName": "last",
6141#
6142# "email": "email@test.com",
6143#
6144# "imageUrl": null
6145#
6146# }
6147#
6148# }
6149# }
6150#
6151# Arguments
6152# id: The user ID.
6153# A user ID is a string in UUID format.
6154basicUserInfo(id: ID!): BasicUserInfo
6155
6156apiTokens: [ApiTokenInfo]!
6157
6158# Gets the most up to date package linked to this automate flow
6159#
6160# Arguments
6161# engineId: Engine Id for the automate flow.
6162automatePackage(engineId: ID!): Package
6163
6164# Retrieve applicationViewers
6165# Example:
6166# Request:
6167# query {
6168# applicationViewers(limit:2) {
6169# records{
6170# id
6171# name
6172# }
6173# }
6174# }
6175# Response:
6176# {
6177# "data": {
6178# "viewers": {
6179# "records": [
6180# {
6181# "id": "2a1a1b58-6983-4002-b9ed-7b7f325f621a",
6182# "name": "Viewer 1"
6183# },
6184# {
6185# "id": "4a2a1b58-6993-4002-b9ed-7b7f325f662c",
6186# "name": "Viewer 2"
6187# }
6188# ]
6189# }
6190# }
6191# }
6192#
6193# Arguments
6194# ids: Provide an ids to retrieve specific viewers.
6195# offset: Specify maximum number of results to retrieve in this
6196# result. Page size.
6197# limit: Specify maximum number of results to retrieve in this
6198# result.
6199# orderBy: Provide a list of ApplicationViewerSortField to sort
6200# by.
6201applicationViewers(
6202ids: [ID!],
6203offset: Int,
6204limit: Int,
6205orderBy: ApplicationViewerSortField
6206): ApplicationViewerList
6207
6208}

link Required by

This element is not required by anyone