Skip to content

Start asynchronous apply for one planned .NET package.

POST
/api/workspace/admin/net-packages/packages/{packageId}/apply
curl --request POST \
--url https://example.com/api/workspace/admin/net-packages/packages/example/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "CancelOldPackageJobsOnActivation": true }'
packageId
required
string
access_token
string

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

Request payload for starting asynchronous .NET package apply.

object
CancelOldPackageJobsOnActivation

Request cancellation for queued or running jobs that are pinned to older artifacts of the same package after activation.

boolean
Examplegenerated
{
"CancelOldPackageJobsOnActivation": true
}

OK

Media typeapplication/json
object
Data

Async .NET package apply operation status for polling UI.

object
OperationId

Apply operation identifier.

string
nullable
PackageId

Applied package artifact identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3
Stage
integer format: int32
Allowed values: 0 1 2 3 4 5 6
ProgressPercent

Progress percent for a UI progress bar.

integer format: int32
StageDisplayName

Localized current stage text.

string
nullable
WorkerId

Identifier of the worker currently processing the operation, when claimed.

string
nullable
HeartbeatAt

Last worker heartbeat timestamp, when the operation is running.

string format: date-time
nullable
AttemptCount

Number of apply attempts made for this operation.

integer format: int32
StartedAt

Operation start timestamp.

string format: date-time
nullable
CompletedAt

Operation completion timestamp.

string format: date-time
nullable
CancelOldPackageJobsOnActivation

Whether unresolved queued jobs from the previously active package artifact should be cancelled when this artifact activates.

boolean
Errors

Localized operation 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

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

Async .NET package apply operation status for polling UI.

object
OperationId

Apply operation identifier.

string
nullable
PackageId

Applied package artifact identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3
Stage
integer format: int32
Allowed values: 0 1 2 3 4 5 6
ProgressPercent

Progress percent for a UI progress bar.

integer format: int32
StageDisplayName

Localized current stage text.

string
nullable
WorkerId

Identifier of the worker currently processing the operation, when claimed.

string
nullable
HeartbeatAt

Last worker heartbeat timestamp, when the operation is running.

string format: date-time
nullable
AttemptCount

Number of apply attempts made for this operation.

integer format: int32
StartedAt

Operation start timestamp.

string format: date-time
nullable
CompletedAt

Operation completion timestamp.

string format: date-time
nullable
CancelOldPackageJobsOnActivation

Whether unresolved queued jobs from the previously active package artifact should be cancelled when this artifact activates.

boolean
Errors

Localized operation 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

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

Conflict

Media typeapplication/json
object
Data

Async .NET package apply operation status for polling UI.

object
OperationId

Apply operation identifier.

string
nullable
PackageId

Applied package artifact identifier.

string
nullable
Status
integer format: int32
Allowed values: 0 1 2 3
Stage
integer format: int32
Allowed values: 0 1 2 3 4 5 6
ProgressPercent

Progress percent for a UI progress bar.

integer format: int32
StageDisplayName

Localized current stage text.

string
nullable
WorkerId

Identifier of the worker currently processing the operation, when claimed.

string
nullable
HeartbeatAt

Last worker heartbeat timestamp, when the operation is running.

string format: date-time
nullable
AttemptCount

Number of apply attempts made for this operation.

integer format: int32
StartedAt

Operation start timestamp.

string format: date-time
nullable
CompletedAt

Operation completion timestamp.

string format: date-time
nullable
CancelOldPackageJobsOnActivation

Whether unresolved queued jobs from the previously active package artifact should be cancelled when this artifact activates.

boolean
Errors

Localized operation 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

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