Skip to main content
GET
Get Component

Response

OK

created_by
string
required

user who created the record.

created_on
string<date-time>
required

timestamp of when the record was created.

last_modified_by
string
required

user who last modified the record.

last_modified_on
string<date-time>
required

timestamp of when the record was last modified.

name
string
required

String name of the PackageComponent. Must be unique for the Package.

Example:

"server"

package
string
required

ID of the Package for this PackageVersionSet.

Example:

"pkg_fc8c119c-0741-4062-8959-fe1a04b3842f"

primary
boolean
required

Indicates this PackageComponent is considered the primary component within the Package.

title
string
required

Display name for the PackageComponent.

Example:

"Main server"

versionset_number
integer<int64>
required

The sequence number of this PackageVersionSet. Represents the number of times a change to the Package's configuration, component breakdown or architecture has been tracked.

Required range: x >= 0
Example:

1

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/PackageComponent.json"

description
string

Optional long-form description of the PackageComponent.