INPUT_OBJECT

CreateTDO

Payload required to create a temporal data object

GraphQL Schema definition

1 input CreateTDO {
6 
2 #   Start date and time. ISO-8601 standard strings
3 #   and numerical format in either Unix format (seconds
4 #   since epoch) or milliseconds since epoch are accepted.
5 startDateTime: DateTime!
11 
7 #   Stop date and time. ISO-8601 standard strings
8 #   and numerical format in either Unix format (seconds
9 #   since epoch) or milliseconds since epoch are accepted.
10 stopDateTime: DateTime!
14 
12 #   Source for the TDO, such as an ingestion type or engine ID.
13 source: String
18 
15 #   Status, such as "downloaded" or "recording".
16 #   The server will set a value if one is not provided.
17 status: String
21 
19 #   A name for the TDO object, such as the name of the primary media file.
20 name: String
24 
22 #   A description for the TDO object.
23 description: String
29 
25 #   True if the new TDO should be made public. If true, security.global
26 #   will be set to true and users from other organizations will be able to
27 #   view, but not modify, the TDO's metadata and assets.
28 isPublic: Boolean
35 
30 #   An optional parent folder ID for the new TemporalDataObject.
31 #   The folder can be filed in additional folders later using 
32 #   `fileTemporalDataObject`,
33 #   or un-filed from this one.
34 parentFolderId: ID
43 
36 #   Optionally, set source data for this TDO. Source data identifies
37 #   that task that generated this TDO. If the TDO was not generated as part
38 #   of engine or adapter execution, this field should not be set.
39 #   However, it is _strongly_ recommended that engines that create TDOs
40 #   set this field. Doing so ensures that later tasks in the same job
41 #   have appropriate access to the new TDO.
42 sourceData: SetTDOSourceData
45 
44 details: JSONData
48 
46 #   Only internal systems can set this value
47 applicationId: ID
53 
49 #   Optionally, specify one or more structured data objects to apply as
50 #   content templates to the TDO. They will be stored as assets of type
51 #   content-template and will contain an immutable copy of the original data.
52 contentTemplates: [CreateTDOContentTemplateWithTDO!]
58 
54 #   Optionally, add the new data to the search index. If the data is not
55 #   indexed on creation, it can be indexed later by using `updateTDO` or
56 #   creating a suitable job.
57 addToIndex: Boolean
61 
59 #   An optional thumbnail URL for the TDO
60 thumbnailUrl: String
64 
62 #   An optional preview asset URL for the TDO
63 previewUrl: String
67 
65 #   An optional image representing the TDO source
66 sourceImageUrl: String
70 
68 #   Optionally, provide information to create one or more assets.
69 assets: [CreateAssetInTDO!]
74 
71 #   Optionally, looks up and launch the scheduleJob that associates with
72 #   media source if it is active
73 launchProgram: Boolean
75 }

Required by

MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.

1	input CreateTDO {
6
2	# Start date and time. ISO-8601 standard strings
3	# and numerical format in either Unix format (seconds
4	# since epoch) or milliseconds since epoch are accepted.
5	startDateTime: DateTime!
11
7	# Stop date and time. ISO-8601 standard strings
8	# and numerical format in either Unix format (seconds
9	# since epoch) or milliseconds since epoch are accepted.
10	stopDateTime: DateTime!
14
12	# Source for the TDO, such as an ingestion type or engine ID.
13	source: String
18
15	# Status, such as "downloaded" or "recording".
16	# The server will set a value if one is not provided.
17	status: String
21
19	# A name for the TDO object, such as the name of the primary media file.
20	name: String
24
22	# A description for the TDO object.
23	description: String
29
25	# True if the new TDO should be made public. If true, security.global
26	# will be set to true and users from other organizations will be able to
27	# view, but not modify, the TDO's metadata and assets.
28	isPublic: Boolean
35
30	# An optional parent folder ID for the new TemporalDataObject.
31	# The folder can be filed in additional folders later using
32	# `fileTemporalDataObject`,
33	# or un-filed from this one.
34	parentFolderId: ID
43
36	# Optionally, set source data for this TDO. Source data identifies
37	# that task that generated this TDO. If the TDO was not generated as part
38	# of engine or adapter execution, this field should not be set.
39	# However, it is _strongly_ recommended that engines that create TDOs
40	# set this field. Doing so ensures that later tasks in the same job
41	# have appropriate access to the new TDO.
42	sourceData: SetTDOSourceData
45
44	details: JSONData
48
46	# Only internal systems can set this value
47	applicationId: ID
53
49	# Optionally, specify one or more structured data objects to apply as
50	# content templates to the TDO. They will be stored as assets of type
51	# content-template and will contain an immutable copy of the original data.
52	contentTemplates: [CreateTDOContentTemplateWithTDO!]
58
54	# Optionally, add the new data to the search index. If the data is not
55	# indexed on creation, it can be indexed later by using `updateTDO` or
56	# creating a suitable job.
57	addToIndex: Boolean
61
59	# An optional thumbnail URL for the TDO
60	thumbnailUrl: String
64
62	# An optional preview asset URL for the TDO
63	previewUrl: String
67
65	# An optional image representing the TDO source
66	sourceImageUrl: String
70
68	# Optionally, provide information to create one or more assets.
69	assets: [CreateAssetInTDO!]
74
71	# Optionally, looks up and launch the scheduleJob that associates with
72	# media source if it is active
73	launchProgram: Boolean
75	}

CreateTDO

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by