Skip to main content
PUT
Update 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 ProjectComponent. Must be unique for the Project.

Example:

"server"

primary
boolean
required

Indicates this ProjectComponent is considered the primary component within the Project.

project
string
required

ID of the Project for this ProjectVersionSet.

Example:

"proj_fc8c119c-0741-4062-8959-fe1a04b3842f"

title
string
required

Display name for the ProjectComponent.

Example:

"Main server"

versionset_number
integer<int64>
required

The sequence number of this ProjectVersionSet. Represents the number of times a change to the Project'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/ProjectComponent.json"

description
string

Optional long-form description of the ProjectComponent.