Disable the Boards module lifecycle.
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/boards/disable"), Content = new StringContent("{ \"Reason\": \"example\", \"RowVersion\": \"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/boards/disable';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Reason":"example","RowVersion":"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/boards/disable \ --header 'Content-Type: application/json' \ --data '{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Disables the Boards module lifecycle.
object
Administrator reason.
Optional expected module row version.
Examplegenerated
{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Disables the Boards module lifecycle.
object
Administrator reason.
Optional expected module row version.
Examplegenerated
{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Disables the Boards module lifecycle.
object
Administrator reason.
Optional expected module row version.
Examplegenerated
{ "Reason": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “Responses”OK
object
Administration detail for the Boards module.
object
Administration summary for the Boards module.
object
Stable module key.
Module display name.
Module description.
Whether the module is enabled.
Timestamp when the module was enabled.
Timestamp when the module was disabled.
Latest disable reason.
Module lifecycle row version.
Allowed administration actions for the Boards module.
object
Whether the module can be enabled.
Whether the module can be disabled.
Whether a board can be created.
Total configured board count.
Active board count.
Configured boards.
Board list item for administration screens.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Whether board due dates are enabled.
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Number of attached target definitions.
Number of non-deleted statuses.
Number of transitions.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "Boards": [ { "BoardType": 0, "BoardCycleActivationMode": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Administration detail for the Boards module.
object
Administration summary for the Boards module.
object
Stable module key.
Module display name.
Module description.
Whether the module is enabled.
Timestamp when the module was enabled.
Timestamp when the module was disabled.
Latest disable reason.
Module lifecycle row version.
Allowed administration actions for the Boards module.
object
Whether the module can be enabled.
Whether the module can be disabled.
Whether a board can be created.
Total configured board count.
Active board count.
Configured boards.
Board list item for administration screens.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Whether board due dates are enabled.
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Number of attached target definitions.
Number of non-deleted statuses.
Number of transitions.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "Boards": [ { "BoardType": 0, "BoardCycleActivationMode": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
Administration detail for the Boards module.
object
Administration summary for the Boards module.
object
Stable module key.
Module display name.
Module description.
Whether the module is enabled.
Timestamp when the module was enabled.
Timestamp when the module was disabled.
Latest disable reason.
Module lifecycle row version.
Allowed administration actions for the Boards module.
object
Whether the module can be enabled.
Whether the module can be disabled.
Whether a board can be created.
Total configured board count.
Active board count.
Configured boards.
Board list item for administration screens.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Whether board due dates are enabled.
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Number of attached target definitions.
Number of non-deleted statuses.
Number of transitions.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "Boards": [ { "BoardType": 0, "BoardCycleActivationMode": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}