Skip to content

Return one UTF-8 source file from a Workspace UI revision.

GET
/api/workspace/admin/ui-project/source-files
curl --request GET \
--url https://example.com/api/workspace/admin/ui-project/source-files
  • None
revisionId
string
path
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

One UTF-8 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
ContentUtf8

UTF-8 source text.

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

One UTF-8 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
ContentUtf8

UTF-8 source text.

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
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}