Creates a work plan

post

http://localhost:3001/api/{team_id}/work_plan

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

At least one of daily_hours, total_hours, or percent_capacity must be greater than zero.

Path Params

team_id

number

required

Team ID

Body Params

api_request_metadata

object

API Request Metadata

budget_status

string

Budget Status: one of 'proposal', 'proposal', 'active', 'complete'

daily_hours

number

Daily Hours. Applicable when schedule_unit is 'day'.
Must be greater than zero.
Required if total_hours and percent_capacity are not set.

day_lock

string

Locks day value: one of none or work_day

description

string

Work Plan Description

end_date

date

required

End Date (YYYY-MM-DD)

hour_lock

string

Locks hour value: one of daily_hour, total_hour, or percent_capacity

lock_hour

boolean

If true, locks total hour

member_id

number

Member ID

percent_capacity

number

Percent Capacity as a decimal (e.g. 0.5 = 50%, 1.0 = 100%).
Must be greater than zero. Values above 1.0 are allowed.
Mutually exclusive with daily_hours/weekly_hours.
Required if daily_hours and total_hours are not set.

phase_id

number

required

Phase ID

project_id

number

required

Project ID

role_id

number

Role ID for creating unassigned work plans

schedule_unit

string

enum

Defaults to day

Schedule unit: one of 'day' or 'week'. Defaults to 'day'.

Allowed:

standard_work_category_id

number

required

Standard Work Category ID

start_date

date

required

Start Date (YYYY-MM-DD)

total_hours

number

Total Hours.
Must be greater than zero.
Required if daily_hours and percent_capacity are not set.

weekly_hours

number

Weekly Hours. Applicable when schedule_unit is 'week'.

working_days_off

boolean

Include days off as available capacity. Defaults to false.

working_holidays

boolean

Include holidays and time off as available capacity. Defaults to false.

Responses

200

Success

401

Invalid Authentication Key and/or Team ID

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!