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.
GraphQL Schema definition

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

This element is not required by anyone
Query

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by
