OBJECT

Query

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

link GraphQL Schema definition

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

link Required by

This element is not required by anyone