OBJECT

TemporalDataObject

GraphQL Schema definition

1 type TemporalDataObject {
2 
3 #   Object creation timestamp. Does not change. In seconds since epoch (TODO 
4 #   change!).
5 createdDateTime: DateTime 
6 
7 #   Object modification timestamp. In seconds since epoch (TODO change!).
8 modifiedDateTime: DateTime 
9 
10 #   The object's unique ID
11 id: ID! 
12 
13 createdBy: String 
14 
15 modifiedBy: String 
16 
17 description: String 
18 
19 name: String 
20 
21 mediaId: ID @deprecated( reason: "Duplicate, redundant field"  )
22 
23 #   An optional URL for a thumbnail or preview image for
24 #   this object. If the URL is to an object in Veritone's
25 #   object storage, it will be signed.
26 thumbnailUrl: String 
27 
28 #   An optional URL for a preview asset for this document
29 #   object. If the URL is to an object in Veritone's
30 #   object storage, it will be signed.
31 previewUrl: String 
32 
33 #   An optional URL for a source image for this object.
34 #   If the URL is to an object in Veritone's
35 #   object storage, it will be signed.
36 sourceImageUrl: String 
37 
38 #   Modular metadata
39 metadata: [Metadata] @deprecated( reason: "Duplicate, redundant field"  )
40 
41 #   Direct access to metadata in raw JSON format
42 jsondata: JSONData @deprecated( reason: "Duplicate, redundant field"  )
43 
44 # Arguments
45 #   path: optionally, specify a path to retrieve only a specific 
46 #   property
47 #   within the details JSON
48 details(path: String): JSONData 
49 
50 #   Assets this object contains. Can be of any size.
51 #   This field does not support paging.
52 # 
53 # Arguments
54 #   id: Provide an ID to retrieve a single asset.
55 #   type: deprecated - use assetType parameter
56 #   assetType: Specify a list of asset types such as "media" or 
57 #   "transcript" to
58 #   retrieve a specific asset type.
59 #   See https://support.veritone.com/s/article/000003943 for supported values.
60 #   sourceTaskId: Retrieve assets created by a specific task
61 #   offset: Provide an offset to skip to a certain element in the 
62 #   result, for paging.
63 #   limit: Specify maximum number of results to retrieve in this 
64 #   result. Page size.
65 #   includeVirtualMediaAsset: Whether or not to include a virtual 
66 #   media asset
67 #   that streams together all segments on a segmented
68 #   TDO. Most clients should use the default for this.
69 assets(
70 id: ID,
71 type: [String!],
72 assetType: [String!],
73 sourceTaskId: ID,
74 offset: Int,
75 limit: Int,
76 orderBy: AssetOrderBy,
77 orderDirection: OrderDirection,
78 includeVirtualMediaAsset: Boolean
79 ): AssetList 
80 
81 assetCount: Int! 
82 
83 #   Retrieve the primary asset of a given type
84 primaryAsset(assetType: String!): Asset 
85 
86 #   Security settings for the asset container
87 security: Security 
88 
89 #   Recording start time. In seconds since epoch.
90 startDateTime: DateTime! 
91 
92 #   Recording stop time. In seconds since epoch.
93 stopDateTime: DateTime! 
94 
95 source: String 
96 
97 #   The "application ID" of the organization that owns this TDO.
98 #   Maps directly to an organization ID.
99 applicationId: ID! @deprecated( reason: "Duplicate, redundant field"  )
100 
101 #   The ID of the organization that owns this TDO.
102 organizationId: ID! 
103 
104 #   The organization that owns this TDO
105 organization: Organization 
106 
107 #   status. Downloaded, recording, etc.
108 status: String 
109 
110 #   Tasks running against this TemporalDataObject
111 # 
112 # Arguments
113 #   dateTimeFilter: If a filter is not provided, a default of 
114 #   `createdDateTime` between
115 #   the TDO creation time and the current date will be applied.
116 tasks(
117 id: ID,
118 offset: Int,
119 limit: Int,
120 hasSourceAsset: Boolean,
121 orderBy: [TaskSortField!],
122 dateTimeFilter: [TaskDateTimeFilter]
123 ): TaskList 
124 
125 #   Jobs running against this temporalDataObject
126 # 
127 # Arguments
128 #   dateTimeFilter: If a filter is not provided, a default of 
129 #   `createdDateTime` between
130 #   the TDO creation time and the current date will be applied.
131 jobs(
132 id: ID,
133 offset: Int,
134 limit: Int,
135 orderBy: [JobSortField!],
136 dateTimeFilter: [JobDateTimeFilter!]
137 ): JobList 
138 
139 #   Folders that this TDO is filed in
140 folders: [Folder!] 
141 
142 #   TreeObjectIds of all parents folders in the tdo folder path
143 foldersTreeObjectIds: [ID!] @deprecated( reason: "obsolete"  )
144 
145 sourceData: TDOSourceData 
146 
147 #   If this TDO supports streams, contains stream listings.
148 #   Might be an empty list but will not be null.
149 streams: [TDOStreamData!]! 
150 
151 #   Statuses of the engines run on the TDO.
152 engineRuns(offset: Int, limit: Int): EngineRunList 
153 
154 #   If this is a segmented TDO, returns the stream manifest
155 #   contents in normalized JSON form.
156 streamManifest: TDOStreamManifest 
157 
158 #   Indicates whether or not media contained in this TDO is
159 #   public (accessible to all orgs).
160 isPublic: Boolean 
161 
162 }

1	type TemporalDataObject {
2
3	# Object creation timestamp. Does not change. In seconds since epoch (TODO
4	# change!).
5	createdDateTime: DateTime
6
7	# Object modification timestamp. In seconds since epoch (TODO change!).
8	modifiedDateTime: DateTime
9
10	# The object's unique ID
11	id: ID!
12
13	createdBy: String
14
15	modifiedBy: String
16
17	description: String
18
19	name: String
20
21	mediaId: ID @deprecated( reason: "Duplicate, redundant field" )
22
23	# An optional URL for a thumbnail or preview image for
24	# this object. If the URL is to an object in Veritone's
25	# object storage, it will be signed.
26	thumbnailUrl: String
27
28	# An optional URL for a preview asset for this document
29	# object. If the URL is to an object in Veritone's
30	# object storage, it will be signed.
31	previewUrl: String
32
33	# An optional URL for a source image for this object.
34	# If the URL is to an object in Veritone's
35	# object storage, it will be signed.
36	sourceImageUrl: String
37
38	# Modular metadata
39	metadata: [Metadata] @deprecated( reason: "Duplicate, redundant field" )
40
41	# Direct access to metadata in raw JSON format
42	jsondata: JSONData @deprecated( reason: "Duplicate, redundant field" )
43
44	# Arguments
45	# path: optionally, specify a path to retrieve only a specific
46	# property
47	# within the details JSON
48	details(path: String): JSONData
49
50	# Assets this object contains. Can be of any size.
51	# This field does not support paging.
52	#
53	# Arguments
54	# id: Provide an ID to retrieve a single asset.
55	# type: deprecated - use assetType parameter
56	# assetType: Specify a list of asset types such as "media" or
57	# "transcript" to
58	# retrieve a specific asset type.
59	# See https://support.veritone.com/s/article/000003943 for supported values.
60	# sourceTaskId: Retrieve assets created by a specific task
61	# offset: Provide an offset to skip to a certain element in the
62	# result, for paging.
63	# limit: Specify maximum number of results to retrieve in this
64	# result. Page size.
65	# includeVirtualMediaAsset: Whether or not to include a virtual
66	# media asset
67	# that streams together all segments on a segmented
68	# TDO. Most clients should use the default for this.
69	assets(
70	id: ID,
71	type: [String!],
72	assetType: [String!],
73	sourceTaskId: ID,
74	offset: Int,
75	limit: Int,
76	orderBy: AssetOrderBy,
77	orderDirection: OrderDirection,
78	includeVirtualMediaAsset: Boolean
79	): AssetList
80
81	assetCount: Int!
82
83	# Retrieve the primary asset of a given type
84	primaryAsset(assetType: String!): Asset
85
86	# Security settings for the asset container
87	security: Security
88
89	# Recording start time. In seconds since epoch.
90	startDateTime: DateTime!
91
92	# Recording stop time. In seconds since epoch.
93	stopDateTime: DateTime!
94
95	source: String
96
97	# The "application ID" of the organization that owns this TDO.
98	# Maps directly to an organization ID.
99	applicationId: ID! @deprecated( reason: "Duplicate, redundant field" )
100
101	# The ID of the organization that owns this TDO.
102	organizationId: ID!
103
104	# The organization that owns this TDO
105	organization: Organization
106
107	# status. Downloaded, recording, etc.
108	status: String
109
110	# Tasks running against this TemporalDataObject
111	#
112	# Arguments
113	# dateTimeFilter: If a filter is not provided, a default of
114	# `createdDateTime` between
115	# the TDO creation time and the current date will be applied.
116	tasks(
117	id: ID,
118	offset: Int,
119	limit: Int,
120	hasSourceAsset: Boolean,
121	orderBy: [TaskSortField!],
122	dateTimeFilter: [TaskDateTimeFilter]
123	): TaskList
124
125	# Jobs running against this temporalDataObject
126	#
127	# Arguments
128	# dateTimeFilter: If a filter is not provided, a default of
129	# `createdDateTime` between
130	# the TDO creation time and the current date will be applied.
131	jobs(
132	id: ID,
133	offset: Int,
134	limit: Int,
135	orderBy: [JobSortField!],
136	dateTimeFilter: [JobDateTimeFilter!]
137	): JobList
138
139	# Folders that this TDO is filed in
140	folders: [Folder!]
141
142	# TreeObjectIds of all parents folders in the tdo folder path
143	foldersTreeObjectIds: [ID!] @deprecated( reason: "obsolete" )
144
145	sourceData: TDOSourceData
146
147	# If this TDO supports streams, contains stream listings.
148	# Might be an empty list but will not be null.
149	streams: [TDOStreamData!]!
150
151	# Statuses of the engines run on the TDO.
152	engineRuns(offset: Int, limit: Int): EngineRunList
153
154	# If this is a segmented TDO, returns the stream manifest
155	# contents in normalized JSON form.
156	streamManifest: TDOStreamManifest
157
158	# Indicates whether or not media contained in this TDO is
159	# public (accessible to all orgs).
160	isPublic: Boolean
161
162	}

TemporalDataObject

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by