OBJECT

Engine

link GraphQL Schema definition

1type Engine {
2
3id: ID!
4
5ownerOrganizationId: ID!
6
7isPublic: Boolean
8
9logoPath: String
10
11iconPath: String
12
13# The signed URL for the engine icon; will fallback to raw iconPath if unable to
14# sign.
15signedIconPath: String
16
17# The signed URL for the engine logo; will fallback to raw logoPath if unable to
18# sign.
19signedLogoPath: String
20
21name: String
22
23ownerOrganization: Organization
24
25description: String
26
27categoryId: String
28
29state: EngineState
30
31price: Int
32
33asset: String
34
35displayName: String
36
37validateUri: String
38
39executeUri: String
40
41applicationId: ID
42
43# True if the engine creates a TemporalDataObject (TDO) as part of its
44# execution. False otherwise.
45createsTDO: Boolean
46
47website: String
48
49rating: Int
50
51edgeVersion: Int
52
53createdDateTime: DateTime
54
55modifiedDateTime: DateTime
56
57createdBy: String
58
59modifiedBy: String
60
61# True if the engine requires a library to run. If so, a library ID must
62# be provided in the engine payload.
63libraryRequired: Boolean
64
65deploymentModel: DeploymentModel
66
67# Arguments
68# offset: Provide an offset to skip to a certain element in the
69# result, for paging.
70# limit: Specify maximum number of results to retrieve in this
71# result. Page size.
72# dateTimeFilter: Filter the tasks by date/time field.
73# If a filter is not provided, a default of `createdDateTime` between
74# three months ago and the current date will be applied.
75tasks(
76status: [String],
77offset: Int,
78limit: Int,
79id: ID,
80dateTimeFilter: [TaskDateTimeFilter],
81hasSourceAsset: Boolean
82): TaskList
83
84# Retrieve builds for the engine.
85# By default, deleted builds are not included.
86# Deleted builds can be retrieved by including the `deleted` status parameter.
87#
88# Arguments
89# offset: Provide an offset to skip to a certain element in the
90# result, for paging.
91# limit: Specify maximum number of results to retrieve in this
92# result. Page size.
93# orderBy: Set order information on the query. Multiple fields
94# are supported.
95builds(
96buildStatus: [BuildStatus!],
97status: [String],
98offset: Int,
99limit: Int,
100id: ID,
101orderBy: [EngineBuildOrderBy!]
102): BuildList
103
104# Dependency information for this engine
105dependency: EngineDependency
106
107# The list of custom fields on the engine. Users will be prompted to
108# set or change these values when they run the engine. For example, a
109# translation engine might have a field for the target language.
110fields: [EngineField!]
111
112# The engine category
113category: EngineCategory
114
115validStateActions: [EngineStateAction]
116
117# Get the engine's preferred input format, based on the latest deployed build.
118# If there is no deployed build this field cannot be populated.
119preferredInputFormat: String
120
121# Get the engine's supported input formats, based on the latest deployed build.
122# If there is no deployed build this field cannot be populated.
123supportedInputFormats: [String!]
124
125# Get the engine's output formats, based on the latest deployed build.
126# If there is no deployed build this field cannot be populated.
127outputFormats: [String!]
128
129# List of IDs of source types that the engine supports,
130# based on the latest deployed build.
131# If there is no deployed build this field cannot be populated.
132# Applies only to adapter engines that ingest data from a source.
133# Will be a list of IDs of SourceType objects.
134supportedSourceTypes: [String!]
135
136# Get the ingestion flag which determines whether the adapter has a scan phase
137# during ingestion.
138# If there is no deployed build this field cannot be populated.
139hasScanPhase: Boolean
140
141# Get the deployed build version of this engine. If there is no deployed
142# build, this field will be null.
143deployedVersion: Int
144
145# Specifies the mode in which the engine process input
146mode: EngineMode
147
148# Specifies the runtime type, such as "iron" or "edge"
149runtimeType: String
150
151# Get oauth information based on the deployed build. If there is no deployed
152# build, this field will be null.
153oauth: String
154
155# Get engine flag which determines whether the engine is a conductor,
156# this field will be null
157isConductor: Boolean
158
159# List of schedule types that the engine supports,
160# based on the latest deployed build.
161# If there is no deployed build, this field cannot be populated.
162supportedScheduleTypes: [EngineScheduleType!]
163
164# Retrieve task metrics for the engine
165#
166# Arguments
167# fromDateTime: Provide a starting date in ISO format (maximum
168# range of 7 days)
169# toDateTime: Provide an end date in ISO format (maximum range of
170# 7 days)
171taskMetrics(fromDateTime: DateTime, toDateTime: DateTime): EngineTaskMetrics
172
173# List of use cases the engine serves
174useCases: [String!]
175
176# List of industries where the capabilities of the engine can be applied
177industries: [String!]
178
179# Generic Manifest for the engine based on data supplied during onboarding
180manifest: JSONData
181
182# Testing detail includes necessary data for engine certification process
183testingDetails: TestingDetailsType
184
185# JWT rights for engine, which is used for generating jwtToken rights later
186jwtRights: JSONData
187
188# Template Job definitions for standalone engine execution
189#
190# Arguments
191# type: Retrieve sepcific template type
192standaloneJobTemplates(type: JobTemplateEnumType): [EngineJobTemplate]
193
194}