Request cancellation of one queued or running Workspace UI build.

POST

/api/workspace/admin/ui-project/builds/{buildId}/cancel

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/builds/example/cancel"),
    Content = new StringContent("{ \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
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/builds/example/cancel';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

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/builds/example/cancel \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

buildId

required

string

Query Parameters

access_token

string

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

Request Body

Request cancellation of one queued or running Workspace UI build.

object

ExpectedRowVersion

Expected build concurrency token.

string format: uuid

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request cancellation of one queued or running Workspace UI build.

object

ExpectedRowVersion

Expected build concurrency token.

string format: uuid

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request cancellation of one queued or running Workspace UI build.

object

ExpectedRowVersion

Expected build concurrency token.

string format: uuid

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Workspace UI check or build history record.

object

Build identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionId

Source revision identifier.

string

nullable

BuildNumber

Monotonic project build number.

integer format: int32

Kind

integer format: int32

Allowed values: 0 1

Status

integer format: int32

Allowed values: 0 1 2 3 4

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

StageMessageKey

Optional localization key for the current stage.

string

nullable

ProgressPercent

Progress from zero through one hundred.

integer format: int32

RequestedByUserId

Requesting user identifier.

string

nullable

RequestedAt

Request timestamp.

string format: date-time

ClaimedAt

Worker claim timestamp.

string format: date-time

nullable

WorkerId

Claiming worker identifier.

string

nullable

HeartbeatAt

Latest worker heartbeat.

string format: date-time

nullable

AttemptCount

Number of worker claims.

integer format: int32

StartedAt

Execution start timestamp.

string format: date-time

nullable

CancellationRequestedByUserId

User that requested cancellation.

string

nullable

CancellationRequestedAt

Cancellation request timestamp.

string format: date-time

nullable

CompletedAt

Completion timestamp.

string format: date-time

nullable

GeneratedProjectChecksum

Checksum of the generated build project.

string

nullable

ToolchainFingerprint

Resolved build toolchain fingerprint.

string

nullable

HostContractVersion

Workspace UI host contract version used by the build.

integer format: int32

nullable

Diagnostics

Bounded structured diagnostics persisted for one Workspace UI check or build.

object

FormatVersion

Diagnostics payload format version.

integer format: int32

CompilationId

Content-derived compilation identity.

string

nullable

SourceChecksum

Canonical source checksum.

string

nullable

HostContractFingerprint

Host contract fingerprint used by compilation.

string

nullable

PermissionCatalogFingerprint

Permission catalog fingerprint used by compilation.

string

nullable

Diagnostics

Structured compiler diagnostics.

Array<object>

nullable

One bounded diagnostic emitted by the Workspace UI compiler.

object

Code

Stable compiler diagnostic code.

string

nullable

Severity

integer format: int32

Allowed values: 0 1 2

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

Message

Invariant developer-facing diagnostic text.

string

nullable

Path

Optional canonical source path.

string

nullable

StartLine

Optional one-based start line.

integer format: int32

nullable

StartColumn

Optional one-based start column.

integer format: int32

nullable

EndLine

Optional one-based end line.

integer format: int32

nullable

EndColumn

Optional one-based end column.

integer format: int32

nullable

ErrorSummary

Bounded error summary.

string

nullable

RowVersion

Concurrency token.

string format: uuid

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": {
    "Kind": 0,
    "Status": 0,
    "Stage": 0,
    "Diagnostics": {
      "Diagnostics": [
        {
          "Severity": 0,
          "Stage": 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"
}

404

Not Found

application/json

object

Data

Workspace UI check or build history record.

object

Build identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionId

Source revision identifier.

string

nullable

BuildNumber

Monotonic project build number.

integer format: int32

Kind

integer format: int32

Allowed values: 0 1

Status

integer format: int32

Allowed values: 0 1 2 3 4

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

StageMessageKey

Optional localization key for the current stage.

string

nullable

ProgressPercent

Progress from zero through one hundred.

integer format: int32

RequestedByUserId

Requesting user identifier.

string

nullable

RequestedAt

Request timestamp.

string format: date-time

ClaimedAt

Worker claim timestamp.

string format: date-time

nullable

WorkerId

Claiming worker identifier.

string

nullable

HeartbeatAt

Latest worker heartbeat.

string format: date-time

nullable

AttemptCount

Number of worker claims.

integer format: int32

StartedAt

Execution start timestamp.

string format: date-time

nullable

CancellationRequestedByUserId

User that requested cancellation.

string

nullable

CancellationRequestedAt

Cancellation request timestamp.

string format: date-time

nullable

CompletedAt

Completion timestamp.

string format: date-time

nullable

GeneratedProjectChecksum

Checksum of the generated build project.

string

nullable

ToolchainFingerprint

Resolved build toolchain fingerprint.

string

nullable

HostContractVersion

Workspace UI host contract version used by the build.

integer format: int32

nullable

Diagnostics

Bounded structured diagnostics persisted for one Workspace UI check or build.

object

FormatVersion

Diagnostics payload format version.

integer format: int32

CompilationId

Content-derived compilation identity.

string

nullable

SourceChecksum

Canonical source checksum.

string

nullable

HostContractFingerprint

Host contract fingerprint used by compilation.

string

nullable

PermissionCatalogFingerprint

Permission catalog fingerprint used by compilation.

string

nullable

Diagnostics

Structured compiler diagnostics.

Array<object>

nullable

One bounded diagnostic emitted by the Workspace UI compiler.

object

Code

Stable compiler diagnostic code.

string

nullable

Severity

integer format: int32

Allowed values: 0 1 2

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

Message

Invariant developer-facing diagnostic text.

string

nullable

Path

Optional canonical source path.

string

nullable

StartLine

Optional one-based start line.

integer format: int32

nullable

StartColumn

Optional one-based start column.

integer format: int32

nullable

EndLine

Optional one-based end line.

integer format: int32

nullable

EndColumn

Optional one-based end column.

integer format: int32

nullable

ErrorSummary

Bounded error summary.

string

nullable

RowVersion

Concurrency token.

string format: uuid

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

409

Conflict

application/json

object

Data

Workspace UI check or build history record.

object

Build identifier.

string

nullable

ProjectId

Workspace UI project identifier.

string

nullable

RevisionId

Source revision identifier.

string

nullable

BuildNumber

Monotonic project build number.

integer format: int32

Kind

integer format: int32

Allowed values: 0 1

Status

integer format: int32

Allowed values: 0 1 2 3 4

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

StageMessageKey

Optional localization key for the current stage.

string

nullable

ProgressPercent

Progress from zero through one hundred.

integer format: int32

RequestedByUserId

Requesting user identifier.

string

nullable

RequestedAt

Request timestamp.

string format: date-time

ClaimedAt

Worker claim timestamp.

string format: date-time

nullable

WorkerId

Claiming worker identifier.

string

nullable

HeartbeatAt

Latest worker heartbeat.

string format: date-time

nullable

AttemptCount

Number of worker claims.

integer format: int32

StartedAt

Execution start timestamp.

string format: date-time

nullable

CancellationRequestedByUserId

User that requested cancellation.

string

nullable

CancellationRequestedAt

Cancellation request timestamp.

string format: date-time

nullable

CompletedAt

Completion timestamp.

string format: date-time

nullable

GeneratedProjectChecksum

Checksum of the generated build project.

string

nullable

ToolchainFingerprint

Resolved build toolchain fingerprint.

string

nullable

HostContractVersion

Workspace UI host contract version used by the build.

integer format: int32

nullable

Diagnostics

Bounded structured diagnostics persisted for one Workspace UI check or build.

object

FormatVersion

Diagnostics payload format version.

integer format: int32

CompilationId

Content-derived compilation identity.

string

nullable

SourceChecksum

Canonical source checksum.

string

nullable

HostContractFingerprint

Host contract fingerprint used by compilation.

string

nullable

PermissionCatalogFingerprint

Permission catalog fingerprint used by compilation.

string

nullable

Diagnostics

Structured compiler diagnostics.

Array<object>

nullable

One bounded diagnostic emitted by the Workspace UI compiler.

object

Code

Stable compiler diagnostic code.

string

nullable

Severity

integer format: int32

Allowed values: 0 1 2

Stage

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

Message

Invariant developer-facing diagnostic text.

string

nullable

Path

Optional canonical source path.

string

nullable

StartLine

Optional one-based start line.

integer format: int32

nullable

StartColumn

Optional one-based start column.

integer format: int32

nullable

EndLine

Optional one-based end line.

integer format: int32

nullable

EndColumn

Optional one-based end column.

integer format: int32

nullable

ErrorSummary

Bounded error summary.

string

nullable

RowVersion

Concurrency token.

string format: uuid

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

Request cancellation of one queued or running Workspace UI build.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

403

Examplegenerated

404

Example

409

Example

Example^generated

Example^generated

Example^generated

Example^generated