OBJECT

TemporalDataObject

link GraphQL Schema definition

1type TemporalDataObject {
2
3# Object creation timestamp. Does not change. In seconds since epoch (TODO
4# change!).
5createdDateTime: DateTime
6
7# Object modification timestamp. In seconds since epoch (TODO change!).
8modifiedDateTime: DateTime
9
10# The object's unique ID
11id: ID!
12
13createdBy: String
14
15modifiedBy: String
16
17description: String
18
19name: String
20
21mediaId: 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.
26thumbnailUrl: 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.
31previewUrl: 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.
36sourceImageUrl: String
37
38# Modular metadata
39metadata: [Metadata] @deprecated( reason: "Duplicate, redundant field" )
40
41# Direct access to metadata in raw JSON format
42jsondata: 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
48details(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://docs.veritone.com/#/apis/tutorials/asset-types 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.
69assets(
70id: ID,
71type: [String!],
72assetType: [String!],
73sourceTaskId: ID,
74offset: Int,
75limit: Int,
76orderBy: AssetOrderBy,
77orderDirection: OrderDirection,
78includeVirtualMediaAsset: Boolean
79): AssetList
80
81assetCount: Int!
82
83# Retrieve the primary asset of a given type
84primaryAsset(assetType: String!): Asset
85
86# Security settings for the asset container
87security: Security
88
89# Recording start time. In seconds since epoch.
90startDateTime: DateTime!
91
92# Recording stop time. In seconds since epoch.
93stopDateTime: DateTime!
94
95source: String
96
97# The "application ID" of the organization that owns this TDO.
98# Maps directly to an organization ID.
99applicationId: ID! @deprecated( reason: "Duplicate, redundant field" )
100
101# The ID of the organization that owns this TDO.
102organizationId: ID!
103
104# The organization that owns this TDO
105organization: Organization
106
107# status. Downloaded, recording, etc.
108status: 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.
116tasks(
117id: ID,
118offset: Int,
119limit: Int,
120hasSourceAsset: Boolean,
121orderBy: [TaskSortField!],
122dateTimeFilter: [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.
131jobs(
132id: ID,
133offset: Int,
134limit: Int,
135orderBy: [JobSortField!],
136dateTimeFilter: [JobDateTimeFilter!]
137): JobList
138
139# Folders that this TDO is filed in
140folders: [Folder!]
141
142# TreeObjectIds of all parents folders in the tdo folder path
143foldersTreeObjectIds: [ID!]
144
145sourceData: TDOSourceData
146
147# If this TDO supports streams, contains stream listings.
148# Might be an empty list but will not be null.
149streams: [TDOStreamData!]!
150
151# Statuses of the engines run on the TDO.
152engineRuns(offset: Int, limit: Int): EngineRunList
153
154# If this is a segmented TDO, returns the stream manifest
155# contents in normalized JSON form.
156streamManifest: TDOStreamManifest
157
158# Indicates whether or not media contained in this TDO is
159# public (accessible to all orgs).
160isPublic: Boolean
161
162}