Upload a ZIP and create one immutable source revision without automatically queuing a build.

POST

/api/workspace/admin/ui-project/upload

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/ui-project/upload"),
    Content = new MultipartFormDataContent
    {
        new StringContent("")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("application/octet-stream"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "File",
                    FileName = "file",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Comment",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/ui-project/upload';
const form = new FormData();
form.append('File', 'file');
form.append('Comment', 'example');

const options = {method: 'POST'};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/admin/ui-project/upload \
  --header 'Content-Type: multipart/form-data' \
  --form File=@file \
  --form Comment=example

Authorizations

None

Parameters

Query Parameters

access_token

string

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

Request Body

multipart/form-data

object

File

Uploaded ZIP archive.

string format: binary

Comment

Optional source revision comment.

string

Responses

200

application/json

object

Data

Immutable Workspace UI source revision metadata.

object

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

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

400

Bad Request

application/json

object

Data

Immutable Workspace UI source revision metadata.

object

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

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

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Upload a ZIP and create one immutable source revision without automatically queuing a build.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

Example^generated