OBJECT

SourceType

A source type represents a category of sources that share common attributes, such as "TV station" or "Real-time camera feed".

link GraphQL Schema definition

1type SourceType {
2
3# Unique ID of this source type
4id: ID!
5
6# A name for this source type
7name: String!
8
9organizationId: ID
10
11isPublic: Boolean
12
13# The ID of an optional schema for instances (sources) of
14# this source type
15sourceSchemaId: ID
16
17# The icon representing the type of source
18iconClass: String
19
20# The schema object used to validate details for instances (sources)
21# of this source type
22sourceSchema: Schema
23
24# The ID of an optional schema for credentials associated with
25# sources of this type.
26credentialSchemaId: ID
27
28# The schema used to validate credentials associated with sources
29# of this type.
30credentialSchema: Schema
31
32# Date and time this object was created.
33createdDateTime: DateTime
34
35# Date and time this object was last modified
36modifiedDateTime: DateTime
37
38credentialType: CredentialType
39
40# Indicates whether or not the source is "live", such as a camera feed
41isLive: Boolean
42
43# Indicates whether the source requires a scan job pipeline
44requiresScanPipeline: Boolean
45
46supportedRunModes: [RunMode!]!
47
48# The source type category ID for this source type.
49# Used primarily by Veritone platform components.
50categoryId: ID!
51
52# The source type category for this source type.
53# Used primarily by Veritone platform components.
54category: SourceTypeCategory!
55
56# List of source formats applicable to this source type.
57# Only applies to certain source types; many will have an
58# empty list.
59sourceFormats: [String!]!
60
61# List of program formats applicable to this source type.
62# Only applies to certain source types; many will have an
63# empty list.
64programFormats: [String!]!
65
66# Sources created under this source type
67#
68# Arguments
69# id: Optionally, provide a list of IDs to retrieve sources by ID
70# name: Provide a name or partial name value to filter by name.
71# The `nameMatch` parameter can be used to determine the string
72# match strategy used in the filter. Default is "starts with".
73# Note that all matching is case-insensitive.
74# nameMatch: String matching strategy. Default is "starts with".
75# offset: Provide an offset to skip to a certain element in the
76# result, for paging.
77# limit: Specify maximum number of results to retrieve in this
78# result. Page size.
79# hasContentTemplates: Set this flag to true or false to return
80# only sources that do or do
81# not have content templates associated with them.
82# The default is neither (do not filter on the presence of content templates).
83# includePublic: Set this flag to true to include public sources
84# or false to include
85# only sources owned by the
86# user's org, not public sources.
87# Public sources owned by the caller's org will always be returned.
88# correlationSchemaId: #Provide a correlation schama ID to filter
89# for sources that correlate using specified schema.
90# orderBy: Provide optional sort information. If not provided, a
91# default sort
92# by createdDateTime descending will be applied.
93sources(
94id: [ID!],
95name: String,
96nameMatch: StringMatch,
97offset: Int,
98limit: Int,
99hasContentTemplates: Boolean,
100includePublic: Boolean,
101correlationSchemaId: ID,
102orderBy: [SourceSortField!]
103): SourceList!
104
105}