Skip to content

Disables Tasks while preserving settings and role associations.

POST
/api/workspace/admin/tasks/disable
curl --request POST \
--url https://example.com/api/workspace/admin/tasks/disable \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
access_token
string

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

Disables Tasks while preserving configuration.

object
Reason
string
nullable
RowVersion
string format: uuid
nullable
Examplegenerated
{
"Reason": "example",
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

Tasks module administration detail.

object
Summary

Tasks lifecycle summary.

object
ModuleKey
string
nullable
DisplayName
string
nullable
Description
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
EnabledAtUtc
string format: date-time
nullable
DisabledAtUtc
string format: date-time
nullable
DisabledReason
string
nullable
RowVersion
string format: uuid
nullable
AllowedActions

Allowed lifecycle actions for the current module state.

object
CanEnable
boolean
CanReconcileSecurity
boolean
CanDisable
boolean
CanCreateReportingPages

Creation is available to the administration endpoint’s authorized caller while Tasks is enabled.

boolean
Readiness

Readiness of the installed Tasks foundation and its dependencies.

object
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one delivered Tasks capability.

object
Key
integer format: int32
Allowed values: 0 1 2 3 4
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Blockers
Array<object>
nullable

One safe, machine-readable readiness problem.

object
Code
string
nullable
SuggestedAction
string
nullable
Dependencies
Array<object>
nullable

Detailed readiness of one module dependency.

object
Key
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one dependency capability.

object
Key
string
nullable
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Prerequisites
Array<object>
nullable

State and diagnostics of one dependency prerequisite.

object
Key
string
nullable
State
string
nullable
DiagnosticCodes
Array<string>
nullable
HealthIssueCodes
Array<string>
nullable
BlockerKeys
Array<string>
nullable
Contract

Installed public automation contract identity.

object
PackageId
string
nullable
ContractVersion
string
nullable
AssemblyVersion
string
nullable
TimeResultsReportDefinitionId

Local binding used to reopen the generated report, including an unpublished/archived report.

string
nullable
TimeResultsDashboardDefinitionId

Local binding used to reopen the generated dashboard without replacing user customizations.

string
nullable
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": {
"Summary": {
"ConfigurationState": 0
},
"Readiness": {
"Capabilities": [
{
"Key": 0
}
],
"Dependencies": [
{
"ConfigurationState": 0
}
]
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Tasks module administration detail.

object
Summary

Tasks lifecycle summary.

object
ModuleKey
string
nullable
DisplayName
string
nullable
Description
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
EnabledAtUtc
string format: date-time
nullable
DisabledAtUtc
string format: date-time
nullable
DisabledReason
string
nullable
RowVersion
string format: uuid
nullable
AllowedActions

Allowed lifecycle actions for the current module state.

object
CanEnable
boolean
CanReconcileSecurity
boolean
CanDisable
boolean
CanCreateReportingPages

Creation is available to the administration endpoint’s authorized caller while Tasks is enabled.

boolean
Readiness

Readiness of the installed Tasks foundation and its dependencies.

object
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one delivered Tasks capability.

object
Key
integer format: int32
Allowed values: 0 1 2 3 4
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Blockers
Array<object>
nullable

One safe, machine-readable readiness problem.

object
Code
string
nullable
SuggestedAction
string
nullable
Dependencies
Array<object>
nullable

Detailed readiness of one module dependency.

object
Key
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one dependency capability.

object
Key
string
nullable
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Prerequisites
Array<object>
nullable

State and diagnostics of one dependency prerequisite.

object
Key
string
nullable
State
string
nullable
DiagnosticCodes
Array<string>
nullable
HealthIssueCodes
Array<string>
nullable
BlockerKeys
Array<string>
nullable
Contract

Installed public automation contract identity.

object
PackageId
string
nullable
ContractVersion
string
nullable
AssemblyVersion
string
nullable
TimeResultsReportDefinitionId

Local binding used to reopen the generated report, including an unpublished/archived report.

string
nullable
TimeResultsDashboardDefinitionId

Local binding used to reopen the generated dashboard without replacing user customizations.

string
nullable
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": {
"Summary": {
"ConfigurationState": 0
},
"Readiness": {
"Capabilities": [
{
"Key": 0
}
],
"Dependencies": [
{
"ConfigurationState": 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"
}

Conflict

Media typeapplication/json
object
Data

Tasks module administration detail.

object
Summary

Tasks lifecycle summary.

object
ModuleKey
string
nullable
DisplayName
string
nullable
Description
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
EnabledAtUtc
string format: date-time
nullable
DisabledAtUtc
string format: date-time
nullable
DisabledReason
string
nullable
RowVersion
string format: uuid
nullable
AllowedActions

Allowed lifecycle actions for the current module state.

object
CanEnable
boolean
CanReconcileSecurity
boolean
CanDisable
boolean
CanCreateReportingPages

Creation is available to the administration endpoint’s authorized caller while Tasks is enabled.

boolean
Readiness

Readiness of the installed Tasks foundation and its dependencies.

object
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one delivered Tasks capability.

object
Key
integer format: int32
Allowed values: 0 1 2 3 4
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Blockers
Array<object>
nullable

One safe, machine-readable readiness problem.

object
Code
string
nullable
SuggestedAction
string
nullable
Dependencies
Array<object>
nullable

Detailed readiness of one module dependency.

object
Key
string
nullable
IsEnabled
boolean
ConfigurationState
integer format: int32
Allowed values: 0 1 2 3 4 5
IsOperationallyHealthy
boolean
IsFullyReady
boolean
Capabilities
Array<object>
nullable

Availability of one dependency capability.

object
Key
string
nullable
IsAvailable
boolean
BlockerKeys
Array<string>
nullable
Prerequisites
Array<object>
nullable

State and diagnostics of one dependency prerequisite.

object
Key
string
nullable
State
string
nullable
DiagnosticCodes
Array<string>
nullable
HealthIssueCodes
Array<string>
nullable
BlockerKeys
Array<string>
nullable
Contract

Installed public automation contract identity.

object
PackageId
string
nullable
ContractVersion
string
nullable
AssemblyVersion
string
nullable
TimeResultsReportDefinitionId

Local binding used to reopen the generated report, including an unpublished/archived report.

string
nullable
TimeResultsDashboardDefinitionId

Local binding used to reopen the generated dashboard without replacing user customizations.

string
nullable
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": {
"Summary": {
"ConfigurationState": 0
},
"Readiness": {
"Capabilities": [
{
"Key": 0
}
],
"Dependencies": [
{
"ConfigurationState": 0
}
]
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}