OBJECT

Application

An application is a set of Veritone functionality that customers can sign up for.

link GraphQL Schema definition

1type Application {
2
3id: ID!
4
5isPublic: Boolean
6
7metadataVersion: Int
8
9details: JSONData
10
11key: String! @deprecated( reason: "Application name/key validation issues." )
12
13name: String!
14
15category: String
16
17description: String
18
19iconUrl: String
20
21iconSvg: String
22
23# The signed URL for the application icon; will fallback to raw iconSvg if unable
24# to sign.
25signedIconSvg: String
26
27# The signed URL for the application logo; will fallback to raw iconUrl if unable
28# to sign.
29signedIconUrl: String
30
31url: String
32
33deploymentModel: DeploymentModel
34
35createdDateTime: DateTime
36
37modifiedDateTime: DateTime
38
39# OAuth2 client secret. This field is server-generated and is only
40# returned on application creation.
41clientSecret(password: String): String
42
43# OAuth2 redirect URLs
44oauth2RedirectUrls: [String]
45
46organizationId: ID
47
48ownerOrganizationId: ID!
49
50status: ApplicationStatus
51
52permissionsRequired: [String]
53
54contextMenuExtensions: ContextMenuExtensionList
55
56validStateActions: [ApplicationStateAction]
57
58components: ApplicationComponent @deprecated( reason: "No longer supported. Components are replaced by package resources." )
59
60dailyTaskMetrics: DailyTaskMetricsList
61
62# Billing
63billingPlanId: ID
64
65billingDirty: Boolean
66
67sharedWithOrganizationId: ID
68
69# The Application event endpoint.
70# The event is delivered to the application via the Event Routing for Applications
71# mechanism.
72eventEndpoint: String
73
74# The tags associated with the application
75entityTags: [EntityTag]
76
77# Whether or not the application will be wrapped in aiWare as an iframe
78headerbarEnabled: Boolean
79
80# The subscription events with this application
81eventSubscriptions: [EventSubscription]
82
83# The configs associated with this application
84#
85# Arguments
86# orgId: Optional. Organization ID.
87#
88# If not specified, this will be the user's organization
89# userId: Optional. If specified, returned the configs for this
90# user and organization combo
91# includeDefaults: If true, include defaults not specified
92# configKeyRegexp: If specified, filter the configKey
93applicationConfig(
94offset: Int,
95limit: Int,
96orgId: ID,
97userId: ID,
98includeDefaults: Boolean,
99configKeyRegexp: String
100): ApplicationConfigList!
101
102# The headerbar associated with this application
103#
104# Arguments
105# orgId: Optional. Organization ID.
106#
107# If not specified, this will be the user's organization
108applicationHeaderbar(orgId: ID): ApplicationHeaderbar
109
110# Arguments
111# includeDeleted: Include node modules with "deleted" status
112nodeModules(includeDeleted: Boolean): [NodeModule]
113
114# The config definition associated with this application
115#
116# Arguments
117# configKey: If specified, grab definition for this config key
118# offset: Specify maximum number of results to retrieve in this
119# result. Page size.
120# limit: Specify maximum number of results to retrieve in this
121# result.
122applicationConfigDefinition(
123configKey: String,
124offset: Int,
125limit: Int
126): ApplicationConfigDefinitionList
127
128# The roles of this application
129#
130# Arguments
131# ownedOnly: If it is 'false': get all available roles
132# If it is 'true': only get the roles assigned to the user in the org
133applicationRoles(ownedOnly: Boolean): [ApplicationRole!]!
134
135# The events of this application
136events: [Event!]
137
138}