Enable or disable a project plan area, task, or subtask

POST 
/api/project-plans:set-enabled

It applies the cascade rules across the area → task → subtask hierarchy. Returns the full owning area tree after the change.

Required permissions:

• project_plan.edit: allows updating project plan entities.

Cascade rules:

• Area: enable/disable cascades to all its tasks and subtasks.
• Task: disable cascades to its subtasks; enable also enables the parent area (siblings untouched).
• Subtask: enable also enables the parent task and area; disable leaves parents untouched.

Request

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

application/json

Body

type stringrequired

Possible values: [area, task, subtask]

The type of project plan entity to enable/disable

id integerrequired

The ID of the project plan entity to enable/disable

enabled booleanrequired

Whether the entity should be enabled. Cascades across the area/task/subtask hierarchy.

Responses

200

Returns the full owning area tree (area → tasks → subtasks) after the enabled cascade.

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "id": 1,
  "name": "Design",
  "enabled": false,
  "project_plan_tasks": [
    {
      "id": 10,
      "enabled": false,
      "project_plan_subtasks": [
        {
          "id": 100,
          "enabled": false
        }
      ]
    }
  ]
}

400

Validation failed

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "not_found",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

headers

object

oneOf

ResponseHeaderBag
content string
version string
status_code integer
status_text string
charset string
callback string
encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "precondition_failure",
  "message": "string"
}

Loading...