Skip to content

Return source-tree metadata for one requested revision.

GET
/api/workspace/admin/ui-project/source-tree
curl --request GET \
--url https://example.com/api/workspace/admin/ui-project/source-tree
  • None
revisionId
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Workspace UI source revision with its complete ordered file tree.

object
Revision

Immutable Workspace UI source revision metadata.

object
Id

Revision identifier.

string
nullable
ProjectId

Workspace UI project identifier.

string
nullable
RevisionNumber

Monotonic revision number.

integer format: int32
SourceKind
integer format: int32
Allowed values: 0 1 2 3
Status
integer format: int32
Allowed values: 0 1 2 3 4
Comment

Optional revision comment.

string
nullable
SourceChecksum

SHA-256 checksum of the canonical source tree.

string
nullable
CreatedAt

Creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier.

string
nullable
FileCount

Number of stored source files.

integer format: int32
Files

Source files ordered by normalized path.

Array<object>
nullable

Metadata for one source file in an immutable Workspace UI revision.

object
Id

File row identifier.

string
nullable
RevisionId

Revision identifier.

string
nullable
Path

Normalized relative source path.

string
nullable
ContentHash

SHA-256 hash of the UTF-8 content.

string
nullable
SizeBytes

UTF-8 byte length.

integer format: int64
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Revision": {
"SourceKind": 0,
"Status": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Workspace UI source revision with its complete ordered file tree.

object
Revision

Immutable Workspace UI source revision metadata.

object
Id

Revision identifier.

string
nullable
ProjectId

Workspace UI project identifier.

string
nullable
RevisionNumber

Monotonic revision number.

integer format: int32
SourceKind
integer format: int32
Allowed values: 0 1 2 3
Status
integer format: int32
Allowed values: 0 1 2 3 4
Comment

Optional revision comment.

string
nullable
SourceChecksum

SHA-256 checksum of the canonical source tree.

string
nullable
CreatedAt

Creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier.

string
nullable
FileCount

Number of stored source files.

integer format: int32
Files

Source files ordered by normalized path.

Array<object>
nullable

Metadata for one source file in an immutable Workspace UI revision.

object
Id

File row identifier.

string
nullable
RevisionId

Revision identifier.

string
nullable
Path

Normalized relative source path.

string
nullable
ContentHash

SHA-256 hash of the UTF-8 content.

string
nullable
SizeBytes

UTF-8 byte length.

integer format: int64
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Revision": {
"SourceKind": 0,
"Status": 0
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}