OBJECT

Source

A source represents a source of data and is used by adapters to ingest data into the platform for use by an engine workflow.

GraphQL Schema definition

1 type Source {
2 
3 #   Unique ID of this source
4 id: ID! 
5 
6 #   ID of the source type for this source.
7 sourceTypeId: ID! 
8 
9 #   The source type for this source
10 sourceType: SourceType 
11 
12 #   A name for this source
13 name: String! 
14 
15 #   Metadata associated with this source. The schema for this data is
16 #   specific to the source type and controlled by a schema.
17 details: JSONData 
18 
19 #   Indicates whether this source is public and available to all organizations
20 #   or restricted to the organization that owns id.
21 isPublic: Boolean! 
22 
23 #   ID of the organization that owns this source
24 organizationId: ID! 
25 
26 #   The organization that owns this source
27 organization: Organization 
28 
29 #   Date and time this source was created
30 createdDateTime: DateTime 
31 
32 #   Date and time this source was last modified
33 modifiedDateTime: DateTime 
34 
35 #   An optional thumbnail image URL for the source
36 thumbnailUrl: String 
37 
38 contentTemplates: [SourceContentTemplate!]! 
39 
40 #   Id of a published data registry schema
41 correlationSchemaId: ID 
42 
43 #   Id of a structured data object for the correlationSchemaId
44 correlationSDOId: ID 
45 
46 #   Corresponding SDO created for the source
47 sdo: StructuredData 
48 
49 #   permission the currently authenticated principal has on this source.
50 permission: SourcePermission! 
51 
52 #   Permissions granted to other organizations. Only the source owner
53 #   can view or edit this field.
54 collaborators(
55 orderBy: SourceCollaboratorOrderBy,
56 orderDirection: OrderDirection
57 ): SourceCollaboratorList! 
58 
59 #   Current state for the source object. This is controlled by
60 #   the adapters that use the source and should not be set by
61 #   other clients.
62 state: JSONData 
63 
64 #   Get signed url from the provided url or object name.
65 #   The storage type, bucket, region, default ttl and credentials are set in the 
66 #   storageConfig on the source object.
67 #   When url is passed in and the bucket/region or storage type differs from the 
68 #   source storageConfig error will be thrown.
69 getStorageSignedUrl(input: GetStorageSignedUrlInput!): SignedUrlInfo 
70 
71 }

1	type Source {
2
3	# Unique ID of this source
4	id: ID!
5
6	# ID of the source type for this source.
7	sourceTypeId: ID!
8
9	# The source type for this source
10	sourceType: SourceType
11
12	# A name for this source
13	name: String!
14
15	# Metadata associated with this source. The schema for this data is
16	# specific to the source type and controlled by a schema.
17	details: JSONData
18
19	# Indicates whether this source is public and available to all organizations
20	# or restricted to the organization that owns id.
21	isPublic: Boolean!
22
23	# ID of the organization that owns this source
24	organizationId: ID!
25
26	# The organization that owns this source
27	organization: Organization
28
29	# Date and time this source was created
30	createdDateTime: DateTime
31
32	# Date and time this source was last modified
33	modifiedDateTime: DateTime
34
35	# An optional thumbnail image URL for the source
36	thumbnailUrl: String
37
38	contentTemplates: [SourceContentTemplate!]!
39
40	# Id of a published data registry schema
41	correlationSchemaId: ID
42
43	# Id of a structured data object for the correlationSchemaId
44	correlationSDOId: ID
45
46	# Corresponding SDO created for the source
47	sdo: StructuredData
48
49	# permission the currently authenticated principal has on this source.
50	permission: SourcePermission!
51
52	# Permissions granted to other organizations. Only the source owner
53	# can view or edit this field.
54	collaborators(
55	orderBy: SourceCollaboratorOrderBy,
56	orderDirection: OrderDirection
57	): SourceCollaboratorList!
58
59	# Current state for the source object. This is controlled by
60	# the adapters that use the source and should not be set by
61	# other clients.
62	state: JSONData
63
64	# Get signed url from the provided url or object name.
65	# The storage type, bucket, region, default ttl and credentials are set in the
66	# storageConfig on the source object.
67	# When url is passed in and the bucket/region or storage type differs from the
68	# source storageConfig error will be thrown.
69	getStorageSignedUrl(input: GetStorageSignedUrlInput!): SignedUrlInfo
70
71	}

Source

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by