OBJECT

Package

A Package is an object that groups dependent aiWARE resources together.

GraphQL Schema definition

1 type Package {
2 
3 #   The UUID of the Package.
4 id: ID! 
5 
6 #   Details for the organization that owns the package.
7 organization: OrganizationInfo 
8 
9 #   The unique name of the package.
10 name: String! 
11 
12 description: String 
13 
14 #   The path for an icon image.
15 icon: String 
16 
17 #   This determines how the package is distributed.
18 distributionType: EngineDistributionType 
19 
20 #   The semantic version of the package.
21 version: String! 
22 
23 #   This UUID is used to track a package's lineage and versions. This UUID is NOT 
24 #   guaranteed to be a package ID and should not be used as such.
25 sourceOriginId: ID 
26 
27 #   The source package ID of a package refers to the package it immediately derives 
28 #   from, if any.
29 # 
30 #   For example, if there are two packages in the same lineage with versions 1.0 and 
31 #   2.0,
32 #   the 2.0 package derives from the 1.0 package. Therefore, the source package ID 
33 #   of the 2.0
34 #   package would be the ID of the 1.0 package.
35 sourcePackageId: ID 
36 
37 #   This specifies an aiWARE version that this package is dependent on, if 
38 #   applicable.
39 aiwareVersion: String 
40 
41 deleted: Boolean 
42 
43 status: PackageStatus 
44 
45 #   The date the package was installed onto the instance.
46 installDate: DateTime 
47 
48 #   The date the package was available for distribution. This depends on the 
49 #   package's status and distribution type.
50 distributionDate: DateTime 
51 
52 #   A flag that indicates whether the package was generated as a result of an 
53 #   automated process or not.
54 autoGenerated: Boolean 
55 
56 primaryResourceId: ID @deprecated( reason: "duplicate"  )
57 
58 #   This is the resource that the package was specifically made for. This is 
59 #   typically set during automatic package
60 #   creation and is usually an engine or application.
61 # 
62 #   For example, if an application was created and a package was created for it, the 
63 #   application would be the package’s
64 #   primary resource. This is especially useful because different packages might 
65 #   share many resources, but one package
66 #   might have an application as a primary resource while another might have an 
67 #   engine as a primary resource.
68 primaryResource: PackageResource 
69 
70 # Arguments
71 #   type: Filter results by Resource Type.
72 resources(type: PackageResourceType, offset: Int, limit: Int): PackageResourceList 
73 
74 #   This is the date of when the package was originally created.
75 createdAt: DateTime! 
76 
77 modifiedAt: DateTime! 
78 
79 createdBy: BasicUserInfo! 
80 
81 modifiedBy: BasicUserInfo! 
82 
83 }

1	type Package {
2
3	# The UUID of the Package.
4	id: ID!
5
6	# Details for the organization that owns the package.
7	organization: OrganizationInfo
8
9	# The unique name of the package.
10	name: String!
11
12	description: String
13
14	# The path for an icon image.
15	icon: String
16
17	# This determines how the package is distributed.
18	distributionType: EngineDistributionType
19
20	# The semantic version of the package.
21	version: String!
22
23	# This UUID is used to track a package's lineage and versions. This UUID is NOT
24	# guaranteed to be a package ID and should not be used as such.
25	sourceOriginId: ID
26
27	# The source package ID of a package refers to the package it immediately derives
28	# from, if any.
29	#
30	# For example, if there are two packages in the same lineage with versions 1.0 and
31	# 2.0,
32	# the 2.0 package derives from the 1.0 package. Therefore, the source package ID
33	# of the 2.0
34	# package would be the ID of the 1.0 package.
35	sourcePackageId: ID
36
37	# This specifies an aiWARE version that this package is dependent on, if
38	# applicable.
39	aiwareVersion: String
40
41	deleted: Boolean
42
43	status: PackageStatus
44
45	# The date the package was installed onto the instance.
46	installDate: DateTime
47
48	# The date the package was available for distribution. This depends on the
49	# package's status and distribution type.
50	distributionDate: DateTime
51
52	# A flag that indicates whether the package was generated as a result of an
53	# automated process or not.
54	autoGenerated: Boolean
55
56	primaryResourceId: ID @deprecated( reason: "duplicate" )
57
58	# This is the resource that the package was specifically made for. This is
59	# typically set during automatic package
60	# creation and is usually an engine or application.
61	#
62	# For example, if an application was created and a package was created for it, the
63	# application would be the package’s
64	# primary resource. This is especially useful because different packages might
65	# share many resources, but one package
66	# might have an application as a primary resource while another might have an
67	# engine as a primary resource.
68	primaryResource: PackageResource
69
70	# Arguments
71	# type: Filter results by Resource Type.
72	resources(type: PackageResourceType, offset: Int, limit: Int): PackageResourceList
73
74	# This is the date of when the package was originally created.
75	createdAt: DateTime!
76
77	modifiedAt: DateTime!
78
79	createdBy: BasicUserInfo!
80
81	modifiedBy: BasicUserInfo!
82
83	}

Package

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by