Skip to main content
GET
/
projects
/
{project}
/
versionsets
/
{number}
/
components
/
{component}
/
{
  "$schema": "https://example.com/schemas/ProjectComponent.json",
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "last_modified_by": "<string>",
  "last_modified_on": "2023-11-07T05:31:56Z",
  "name": "server",
  "primary": true,
  "project": "proj_fc8c119c-0741-4062-8959-fe1a04b3842f",
  "title": "Main server",
  "versionset_number": 1
}

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.

Examples:

"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.

Examples:

"proj_fc8c119c-0741-4062-8959-fe1a04b3842f"

​
title
string
required

Display name for the ProjectComponent.

Examples:

"Main server"

​
versionset_number
integer
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
Examples:

1

​
$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

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

​
description
string

Optional long-form description of the ProjectComponent.

⌘I