Create a task in a project
post
/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActualCost: number
Title:
Total Actual Cost
The total actual cost amount for all the labor and expense resources associated with the task. -
ActualExpense: number
Title:
Actual Expense
Default Value:0
The actual expense amount for the task. -
ActualFinishDate: string
(date)
Title:
Actual Finish Date
The actual finish date for the task as opposed to a planned finish date for the task. It is recommended to use ActualFinishDateTime attribute. -
ActualFinishDateTime: string
(date-time)
Title:
Actual Finish Date and Time
The date and time when work finished on a task as opposed to the planned finish date and time for the task. -
ActualHours: number
Title:
Actual Hours
Default Value:0
Actual effort spent on the project task. Value is 0 if not provided when using POST. -
ActualLaborBillAmount: number
Title:
Actual Labor Bill Amount
The actual bill amount for all the labor resources associated with the task. -
ActualLaborCost: number
Title:
Actual Labor Cost
The actual cost amount for all the labor resources associated with the task. -
ActualStartDate: string
(date)
Title:
Actual Start Date
The date that work commenced on a task as opposed to the planned start date for the task. It is recommended to use ActualStartDateTime attribute. -
ActualStartDateTime: string
(date-time)
Title:
Actual Start Date and Time
The date and time when work started on a task as opposed to the planned start date and time for the task. -
BaselineAllocation: number
Title:
Primary Baseline Allocation
Original planned allocation of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineDuration: number
Title:
Primary Baseline Duration
Original planned duration of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineEffortinHours: number
Title:
Primary Baseline Effort in Hours
Original planned hours of effort of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineFinishDate: string
(date)
Title:
Primary Baseline Finish Date
Original planned finish date of the task in the primary work plan baseline. It is recommended to use BaselineFinishDateTime attribute. -
BaselineStartDate: string
(date)
Title:
Primary Baseline Start Date
Original planned start date of the task in the primary work plan baseline. It is recommended to use BaselineStartDateTime attribute. -
BillableFlag: boolean
Maximum Length:
1
Indicates that transactions charged to that task can be billed to customers. The transactions are billable when the value is True. The value is False when the transactions are not billable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ChargeableFlag: boolean
Maximum Length:
1
Indicates that something is eligible to be charged to a task. The task is chargeable when the value is True. The value is False when the task is not chargeable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ConstraintDate: string
(date)
Title:
Constraint Date
The date when a task must start or complete based on the constraint type for the task. It is recommended to use ConstraintDateTime attribute. -
ConstraintDateTime: string
(date-time)
Title:
Constraint Date and Time
The date and time when a task must start or finish based on the constraint type for the task. -
ConstraintType: string
Title:
Constraint Type
Maximum Length:30
The type of scheduling constraint applied on the task. Valid values are MUST_START_BY, MUST_START_ON, START_ON_OR_AFTER, MUST_FINISH_BY, MUST_FINISH_ON, and FINISH_ON_OR_AFTER. -
CostPercentComplete: number
Title:
Cost Percent Complete
The percentage of the cost consumed in the task. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
Default Value:false
A task that must be completed on schedule or it will impact the finish date of the entire project. This attribute is not currently used. -
CurrentCost: number
Title:
Total Current Cost
The total current cost amount for all the labor and expense resources associated with the task. -
CurrentDuration: number
Title:
Current Duration
Length of time within which the project task is estimated to be completed. Duration is displayed in days. -
CurrentEffort: number
Title:
Current Effort in Hours
Total estimated effort on the task at completion. Value is auto-calculated as the sum of Remaining Hours and Actual Hours. -
CurrentExpense: number
Title:
Current Expense
The estimated expense amount for the task at completion. -
CurrentFinishDate: string
(date)
Title:
Current Finish Date
The date when the task is estimated to finish. It is recommended to use CurrentFinishDateTime attribute. -
CurrentFinishDateTime: string
(date-time)
Title:
Current Finish Date and Time
The date and time when the task is estimated to finish. -
CurrentLaborBillAmount: number
Title:
Current Labor Bill Amount
The current bill amount for all the labor resources associated with the task. -
CurrentLaborCost: number
Title:
Current Labor Cost
The current cost amount for all the labor resources associated with the task. -
CurrentStartDate: string
(date)
Title:
Current Start Date
The date when the task is estimated to start. It is recommended to use CurrentStartDateTime attribute. -
CurrentStartDateTime: string
(date-time)
Title:
Current Start Date and Time
The date and time when the task is estimated to start. -
Deadline: string
(date)
Title:
Task Deadline
The target date for the project manager when the task needs to be done. This attribute is not currently used. -
DeadlineDateTime: string
(date-time)
Title:
Deadline Date and Time
The target date and time by which the task should be completed. -
Description: string
Title:
Task Description
Maximum Length:2000
Text description of the project task. -
DisplayInTimelineFlag: boolean
Title:
Display in Timeline
Maximum Length:1
Indicates whether a task is visible in timeline when available. Values are True if task will be displayed in Timeline and False if task will not be displayed in Timeline. Default value is False if not provided when using POST. This attribute is not currently used. -
DisplaySequence: integer
(int64)
The order in which the task is displayed in the project plan. Default value is auto-calculated if not provided when using POST.
-
EarlyFinishDate: string
(date)
Title:
Early Finish Date
Date that is the earliest that a task can finish on. It is recommended to use EarlyFinishDateTime attribute. -
EarlyFinishDateTime: string
(date-time)
Title:
Early Finish Date and Time
The earliest date and time that a task can finish on. -
EarlyStartDate: string
(date)
Title:
Early Start Date
Date that is the earliest that a task can start on. It is recommended to use EarlyStartDateTime attribute. -
EarlyStartDateTime: string
(date-time)
Title:
Early Start Date and Time
The earliest date and time that a task can start on. -
ElementType: string
Title:
Task Element Type
Maximum Length:30
Default Value:EXECUTION
Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL. Default value is EXECUTION if not provided when using POST or when invalid value is provided. -
FreeFloat: number
Title:
Free Float
The free float or free slack is the amount of time in days that this task can be delayed without causing a delay to any of its successors. This attribute is not currently used. -
GateApprovers: array
Gate Approvers
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate. -
GateFlag: boolean
Title:
Gate
Maximum Length:1
Default Value:false
Indicates whether the task is a gate within the project. The task is a gate when the value is True. The task is not a gate when the value is False or Null. Default value is False if not provided when using POST. -
GateStatusCode: string
Title:
Gate Status Code
Maximum Length:50
The code for the status of the gate. Valid values are IN_REVIEW, OPEN, CLOSED, and TERMINATED. Value is NULL when the task is not a gate. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LateFinishDate: string
(date)
Title:
Late Finish Date
Date that is the latest that a task can finish on that won't impact the finish date of the project. It is recommended to use LateFinishDateTime attribute. -
LateFinishDateTime: string
(date-time)
Title:
Late Finish Date and Time
The date and time by when a task must finish to avoid a delay in project completion. -
LateStartDate: string
(date)
Title:
Late Start Date
Date that is the latest that a task can start on that won't impact the finish date of the project. It is recommended to use LateStartDateTime attribute. -
LateStartDateTime: string
(date-time)
Title:
Late Start Date and Time
The date and time by when a task must start to avoid a delay in project completion. -
LeafIndicator: string
Title:
Leaf Indicator
Maximum Length:1
Default Value:Y
Indicates whether a task is a leaf task. Value is Y if a task is a leaf and N if a task is not a leaf. -
ManualScheduleFlag: boolean
Title:
Manual Schedule
Maximum Length:1
Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process. The schedule mode of the task is Manual when the value is True. The value is False when the schedule mode of the task is Automatic. Default value is False if not provided when using POST or if task is a summary or financial task. -
MilestoneFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the task is a project milestone. The task is a milestone when the value is True. The value is False when the task is not a milestone. Default value is False if not provided when using POST. -
Name(required): string
Maximum Length:
255
The name of the task. A task is a subdivision of the project work. Each project can have a set of top tasks and a hierarchy of subtasks below each top task. Default value is new task when using POST and Element Type is Execution. Default value is new financial task if Element Type is Financial. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
ParentTaskId: integer
(int64)
Identifier of the parent task of the task. Default value is the project plan task at level 0 if neither Parent Task ID nor Peer Reference Task ID is provided when using POST.
-
PeerReferenceTaskId: integer
Title:
Peer Reference Task ID
The task ID of the previous peer task in the project plan at the time of the creation of the task. If Peer Reference Task ID and Parent Task ID are not provided in POST, then task is created as the last task of the project. -
PendingRollupFlag: boolean
Title:
Pending Rollup Indicator
Maximum Length:1
Indicates that changes done at tasks need to be rolled up at the project level. -
PercentComplete: number
Title:
Task Percent Complete
Default Value:0
Indicates the percentage of work completed for a task. -
PhysicalPercentComplete: number
Title:
Task Physical Percent Complete
Default Value:0
The amount of physical work achieved on a task. Default values is 0 if not provided when using POST. -
PlanLineId: integer
(int64)
Unique identifier of the task planline.
-
PlannedAllocation: number
Title:
Planned Allocation Percentage
Percentage of hours that resources are allocated to the project task for a specified duration. -
PlannedCost: number
Title:
Total Planned Cost
The total planned cost amount for all the labor and expense resources associated with the task. -
PlannedDuration: number
Title:
Planned Duration
Length of time within which the project task is scheduled to be completed. Duration is displayed in days. -
PlannedEffort: number
Title:
Planned Effort in Hours
Measure of the effort required to complete the project task. -
PlannedExpense: number
Title:
Planned Expense
Default Value:0
The planned expense amount for the task. -
PlannedFinishDate: string
(date)
Title:
Planned Finish Date
The date when work is scheduled to end for a project task. It is recommended to use PlannedFinishDateTime attribute. -
PlannedFinishDateTime: string
(date-time)
Title:
Planned Finish Date and Time
The date and time when work is scheduled to finish for a project task. -
PlannedLaborBillAmount: number
Title:
Planned Labor Bill Amount
The planned bill amount for all the labor resources associated with the task. -
PlannedLaborCost: number
Title:
Planned Labor Cost
The planned cost amount for all the labor resources associated with the task. -
PlannedStartDate: string
(date)
Title:
Planned Start Date
The date when work is scheduled to start for a project task. It is recommended to use PlannedStartDateTime attribute. -
PlannedStartDateTime: string
(date-time)
Title:
Planned Start Date and Time
The date and time when work is scheduled to start for a project task. -
Priority: number
Title:
Priority
Priority of the task. -
RemainingCost: number
Title:
Total Remaining Cost
The total remaining cost amount for all the labor and expense resources associated with the task. -
RemainingExpense: number
Title:
Remaining Expense
Default Value:0
The remaining expense amount for the task. -
RemainingHours: number
Title:
Remaining Hours
Effort in hours that is remaining to be completed on the project task. -
RemainingLaborBillAmount: number
Title:
Remaining Labor Bill Amount
The remaining bill amount for all the labor resources associated with the task. -
RemainingLaborCost: number
Title:
Remaining Labor Cost
The remaining cost amount for all the labor resources associated with the task. -
RequirementId: integer
(int64)
Title:
Requirement ID
Unique identifier of the requirement associated to the task. -
ScheduleTypeCode: string
Title:
Task Schedule Type Code
Maximum Length:30
The schedule type of the task. Valid values are FIXED_EFFORT and FIXED_DURATION. Default value is the Project Schedule Type Code if not entered when using POST. -
SprintId: integer
(int64)
Title:
Sprint ID
Unique identifier of the sprint associated to the task. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskDFF: array
Tasks Descriptive Flexfields
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the project task. Value is auto-generated when using POST and mandatory when using PATCH. -
TaskLevel(required): integer
(int32)
Indicates level of the task. Level 0 is reserved for the task that holds the rollup values of the project. Value is auto-calculated.
-
TaskNumber(required): string
Maximum Length:
100
The number of a task that needs to be unique within the project. Value will be auto-generated if not added in POST. -
TaskNumberPrefix: string
A value prefixed to the task number while creating tasks from the work plan template. This attribute is applicable only for PATCH operation and you must enter a different prefix each time you create tasks from the same work plan template in the same project.
-
TaskStatusCode: string
Title:
Task Status Code
Maximum Length:20
The code for the status of work completed on the task. Valid values are NOT_STARTED, IN_PROGRESS, and COMPLETED. Value is NOT_STARTED if not provided when using POST and it is neither a task nor a gate. -
TextAttr01: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr02: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr03: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr04: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr05: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr06: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr07: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr08: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr09: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr10: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr11: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr12: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr13: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr14: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr15: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr16: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr17: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr18: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr19: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr20: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TopTaskId: integer
(int64)
Title:
Top Task ID
Identifier of the top task to which a task rolls up. If the task is a top task, then identifier of the top task is same as the identifier of the task. -
TotalFloat: number
Title:
Total Float
The total float or total slack is the amount of time in days that the task can be delayed without causing a delay to the project. This attribute is not currently used. -
UpdateSource: string
Maximum Length:
30
For internal use. The source from which the task was last updated. -
WorkPlanTemplateId: integer
Unique identifier of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkPlanTemplateName: string
Name of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the work type associated to a task -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Unique identifier of the work type
Nested Schema : Gate Approvers
Type:
array
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate.
Show Source
Nested Schema : Tasks Descriptive Flexfields
Type:
array
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
GateApproverComments: string
Title:
Gate Approver Comments
Maximum Length:1000
Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver Email
Maximum Length:240
Email address of the gate approver. -
GateApproverStatus: string
Title:
Gate Approver Status
Maximum Length:16
Status set for a gate by the approver. -
GateApproverUpdatedDate: string
(date)
Title:
Gate Approver Updated Date
Date when the Approval Status was last changed.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
ProjElementId: integer
(int64)
Unique identifier of the task. The values is the same as Task ID.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPlans-Tasks-item-response
Type:
Show Source
object
-
ActualCost: number
Title:
Total Actual Cost
The total actual cost amount for all the labor and expense resources associated with the task. -
ActualExpense: number
Title:
Actual Expense
Default Value:0
The actual expense amount for the task. -
ActualFinishDate: string
(date)
Title:
Actual Finish Date
The actual finish date for the task as opposed to a planned finish date for the task. It is recommended to use ActualFinishDateTime attribute. -
ActualFinishDateTime: string
(date-time)
Title:
Actual Finish Date and Time
The date and time when work finished on a task as opposed to the planned finish date and time for the task. -
ActualHours: number
Title:
Actual Hours
Default Value:0
Actual effort spent on the project task. Value is 0 if not provided when using POST. -
ActualLaborBillAmount: number
Title:
Actual Labor Bill Amount
The actual bill amount for all the labor resources associated with the task. -
ActualLaborCost: number
Title:
Actual Labor Cost
The actual cost amount for all the labor resources associated with the task. -
ActualStartDate: string
(date)
Title:
Actual Start Date
The date that work commenced on a task as opposed to the planned start date for the task. It is recommended to use ActualStartDateTime attribute. -
ActualStartDateTime: string
(date-time)
Title:
Actual Start Date and Time
The date and time when work started on a task as opposed to the planned start date and time for the task. -
BaselineAllocation: number
Title:
Primary Baseline Allocation
Original planned allocation of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineDuration: number
Title:
Primary Baseline Duration
Original planned duration of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineEffortinHours: number
Title:
Primary Baseline Effort in Hours
Original planned hours of effort of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineExpense: number
Title:
Baseline Expense
Read Only:true
Original expense amount for the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineFinishDate: string
(date)
Title:
Primary Baseline Finish Date
Original planned finish date of the task in the primary work plan baseline. It is recommended to use BaselineFinishDateTime attribute. -
BaselineFinishDateTime: string
(date-time)
Title:
Baseline Finish Date and Time
Read Only:true
The planned finish date and time of the task in the primary work plan baseline. This value is available only if a primary baseline is set. -
BaselineLaborBillAmount: number
Title:
Baseline Labor Bill Amount
Read Only:true
Original bill amount for all the labor resources associated with the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineLaborCost: number
Title:
Baseline Labor Cost
Read Only:true
Original labor cost or all the labor resources associated with the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineStartDate: string
(date)
Title:
Primary Baseline Start Date
Original planned start date of the task in the primary work plan baseline. It is recommended to use BaselineStartDateTime attribute. -
BaselineStartDateTime: string
(date-time)
Title:
Baseline Start Date and Time
Read Only:true
The planned start date and time of the task in the primary work plan baseline. This value is available only if a primary baseline is set. -
BillableFlag: boolean
Maximum Length:
1
Indicates that transactions charged to that task can be billed to customers. The transactions are billable when the value is True. The value is False when the transactions are not billable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ChargeableFlag: boolean
Maximum Length:
1
Indicates that something is eligible to be charged to a task. The task is chargeable when the value is True. The value is False when the task is not chargeable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ConstraintDate: string
(date)
Title:
Constraint Date
The date when a task must start or complete based on the constraint type for the task. It is recommended to use ConstraintDateTime attribute. -
ConstraintDateTime: string
(date-time)
Title:
Constraint Date and Time
The date and time when a task must start or finish based on the constraint type for the task. -
ConstraintType: string
Title:
Constraint Type
Maximum Length:30
The type of scheduling constraint applied on the task. Valid values are MUST_START_BY, MUST_START_ON, START_ON_OR_AFTER, MUST_FINISH_BY, MUST_FINISH_ON, and FINISH_ON_OR_AFTER. -
CostPercentComplete: number
Title:
Cost Percent Complete
The percentage of the cost consumed in the task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Identifier of the user that created the task. Value is auto-generated on POST. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
Default Value:false
A task that must be completed on schedule or it will impact the finish date of the entire project. This attribute is not currently used. -
CurrentCost: number
Title:
Total Current Cost
The total current cost amount for all the labor and expense resources associated with the task. -
CurrentDuration: number
Title:
Current Duration
Length of time within which the project task is estimated to be completed. Duration is displayed in days. -
CurrentEffort: number
Title:
Current Effort in Hours
Total estimated effort on the task at completion. Value is auto-calculated as the sum of Remaining Hours and Actual Hours. -
CurrentExpense: number
Title:
Current Expense
The estimated expense amount for the task at completion. -
CurrentFinishDate: string
(date)
Title:
Current Finish Date
The date when the task is estimated to finish. It is recommended to use CurrentFinishDateTime attribute. -
CurrentFinishDateTime: string
(date-time)
Title:
Current Finish Date and Time
The date and time when the task is estimated to finish. -
CurrentLaborBillAmount: number
Title:
Current Labor Bill Amount
The current bill amount for all the labor resources associated with the task. -
CurrentLaborCost: number
Title:
Current Labor Cost
The current cost amount for all the labor resources associated with the task. -
CurrentStartDate: string
(date)
Title:
Current Start Date
The date when the task is estimated to start. It is recommended to use CurrentStartDateTime attribute. -
CurrentStartDateTime: string
(date-time)
Title:
Current Start Date and Time
The date and time when the task is estimated to start. -
Deadline: string
(date)
Title:
Task Deadline
The target date for the project manager when the task needs to be done. This attribute is not currently used. -
DeadlineDateTime: string
(date-time)
Title:
Deadline Date and Time
The target date and time by which the task should be completed. -
Description: string
Title:
Task Description
Maximum Length:2000
Text description of the project task. -
DisplayInTimelineFlag: boolean
Title:
Display in Timeline
Maximum Length:1
Indicates whether a task is visible in timeline when available. Values are True if task will be displayed in Timeline and False if task will not be displayed in Timeline. Default value is False if not provided when using POST. This attribute is not currently used. -
DisplaySequence: integer
(int64)
The order in which the task is displayed in the project plan. Default value is auto-calculated if not provided when using POST.
-
EarlyFinishDate: string
(date)
Title:
Early Finish Date
Date that is the earliest that a task can finish on. It is recommended to use EarlyFinishDateTime attribute. -
EarlyFinishDateTime: string
(date-time)
Title:
Early Finish Date and Time
The earliest date and time that a task can finish on. -
EarlyStartDate: string
(date)
Title:
Early Start Date
Date that is the earliest that a task can start on. It is recommended to use EarlyStartDateTime attribute. -
EarlyStartDateTime: string
(date-time)
Title:
Early Start Date and Time
The earliest date and time that a task can start on. -
ElementType: string
Title:
Task Element Type
Maximum Length:30
Default Value:EXECUTION
Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL. Default value is EXECUTION if not provided when using POST or when invalid value is provided. -
FreeFloat: number
Title:
Free Float
The free float or free slack is the amount of time in days that this task can be delayed without causing a delay to any of its successors. This attribute is not currently used. -
GateApprovers: array
Gate Approvers
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate. -
GateFlag: boolean
Title:
Gate
Maximum Length:1
Default Value:false
Indicates whether the task is a gate within the project. The task is a gate when the value is True. The task is not a gate when the value is False or Null. Default value is False if not provided when using POST. -
GateStatusCode: string
Title:
Gate Status Code
Maximum Length:50
The code for the status of the gate. Valid values are IN_REVIEW, OPEN, CLOSED, and TERMINATED. Value is NULL when the task is not a gate. -
Integrated: string
Title:
Is Integrated Indicator
Read Only:true
Maximum Length:1
Indicates the task was created in a third-party application. The task was integrated by a third-party application when the value is Y. The value is N when the task is not integrated. Default value is N if not provided when using POST. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LateFinishDate: string
(date)
Title:
Late Finish Date
Date that is the latest that a task can finish on that won't impact the finish date of the project. It is recommended to use LateFinishDateTime attribute. -
LateFinishDateTime: string
(date-time)
Title:
Late Finish Date and Time
The date and time by when a task must finish to avoid a delay in project completion. -
LateStartDate: string
(date)
Title:
Late Start Date
Date that is the latest that a task can start on that won't impact the finish date of the project. It is recommended to use LateStartDateTime attribute. -
LateStartDateTime: string
(date-time)
Title:
Late Start Date and Time
The date and time by when a task must start to avoid a delay in project completion. -
LeafIndicator: string
Title:
Leaf Indicator
Maximum Length:1
Default Value:Y
Indicates whether a task is a leaf task. Value is Y if a task is a leaf and N if a task is not a leaf. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualScheduleFlag: boolean
Title:
Manual Schedule
Maximum Length:1
Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process. The schedule mode of the task is Manual when the value is True. The value is False when the schedule mode of the task is Automatic. Default value is False if not provided when using POST or if task is a summary or financial task. -
MilestoneFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the task is a project milestone. The task is a milestone when the value is True. The value is False when the task is not a milestone. Default value is False if not provided when using POST. -
Name: string
Maximum Length:
255
The name of the task. A task is a subdivision of the project work. Each project can have a set of top tasks and a hierarchy of subtasks below each top task. Default value is new task when using POST and Element Type is Execution. Default value is new financial task if Element Type is Financial. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
ParentTaskId: integer
(int64)
Identifier of the parent task of the task. Default value is the project plan task at level 0 if neither Parent Task ID nor Peer Reference Task ID is provided when using POST.
-
PeerReferenceTaskId: integer
Title:
Peer Reference Task ID
The task ID of the previous peer task in the project plan at the time of the creation of the task. If Peer Reference Task ID and Parent Task ID are not provided in POST, then task is created as the last task of the project. -
PendingRollupFlag: boolean
Title:
Pending Rollup Indicator
Maximum Length:1
Indicates that changes done at tasks need to be rolled up at the project level. -
PercentComplete: number
Title:
Task Percent Complete
Default Value:0
Indicates the percentage of work completed for a task. -
PhysicalPercentComplete: number
Title:
Task Physical Percent Complete
Default Value:0
The amount of physical work achieved on a task. Default values is 0 if not provided when using POST. -
PlanLineId: integer
(int64)
Unique identifier of the task planline.
-
PlannedAllocation: number
Title:
Planned Allocation Percentage
Percentage of hours that resources are allocated to the project task for a specified duration. -
PlannedCost: number
Title:
Total Planned Cost
The total planned cost amount for all the labor and expense resources associated with the task. -
PlannedDuration: number
Title:
Planned Duration
Length of time within which the project task is scheduled to be completed. Duration is displayed in days. -
PlannedEffort: number
Title:
Planned Effort in Hours
Measure of the effort required to complete the project task. -
PlannedExpense: number
Title:
Planned Expense
Default Value:0
The planned expense amount for the task. -
PlannedFinishDate: string
(date)
Title:
Planned Finish Date
The date when work is scheduled to end for a project task. It is recommended to use PlannedFinishDateTime attribute. -
PlannedFinishDateTime: string
(date-time)
Title:
Planned Finish Date and Time
The date and time when work is scheduled to finish for a project task. -
PlannedLaborBillAmount: number
Title:
Planned Labor Bill Amount
The planned bill amount for all the labor resources associated with the task. -
PlannedLaborCost: number
Title:
Planned Labor Cost
The planned cost amount for all the labor resources associated with the task. -
PlannedStartDate: string
(date)
Title:
Planned Start Date
The date when work is scheduled to start for a project task. It is recommended to use PlannedStartDateTime attribute. -
PlannedStartDateTime: string
(date-time)
Title:
Planned Start Date and Time
The date and time when work is scheduled to start for a project task. -
PrimaryResourceEmail: string
Title:
Primary Resource Email
Read Only:true
Maximum Length:240
Email of the person who leads the task. -
PrimaryResourceName: string
Title:
Primary Resource Name
Read Only:true
Maximum Length:240
Name of the resource who leads the task. -
Priority: number
Title:
Priority
Priority of the task. -
ProposedEffort: number
Title:
Proposed Effort in Hours
Read Only:true
Amount of effort to complete the project task proposed by the team member. Value is defaulted on POST and overwritten on PATCH to Planned Effort. -
ProposedFinishDate: string
(date)
Title:
Proposed Finish Date
Read Only:true
Date proposed by the team member to finish the project task. It is recommended to use ProposedFinishDateTime attribute. -
ProposedFinishDateTime: string
(date-time)
Title:
Proposed Finish Date and Time
Read Only:true
The date and time proposed by the team member to finish the project task. Value is defaulted on POST and overwritten on PATCH to Planned Finish Date and Time. -
ProposedStartDate: string
(date)
Title:
Proposed Start Date
Read Only:true
Date proposed by the team member to start the project task. It is recommended to use ProposedStartDateTime attribute. -
ProposedStartDateTime: string
(date-time)
Title:
Proposed Start Date and Time
Read Only:true
The date and time proposed by the team member to start the project task. Value is defaulted on POST and overwritten on PATCH to Planned Start Date and Time. -
RemainingCost: number
Title:
Total Remaining Cost
The total remaining cost amount for all the labor and expense resources associated with the task. -
RemainingExpense: number
Title:
Remaining Expense
Default Value:0
The remaining expense amount for the task. -
RemainingHours: number
Title:
Remaining Hours
Effort in hours that is remaining to be completed on the project task. -
RemainingLaborBillAmount: number
Title:
Remaining Labor Bill Amount
The remaining bill amount for all the labor resources associated with the task. -
RemainingLaborCost: number
Title:
Remaining Labor Cost
The remaining cost amount for all the labor resources associated with the task. -
RequirementId: integer
(int64)
Title:
Requirement ID
Unique identifier of the requirement associated to the task. -
ScheduleTypeCode: string
Title:
Task Schedule Type Code
Maximum Length:30
The schedule type of the task. Valid values are FIXED_EFFORT and FIXED_DURATION. Default value is the Project Schedule Type Code if not entered when using POST. -
SprintId: integer
(int64)
Title:
Sprint ID
Unique identifier of the sprint associated to the task. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskDFF: array
Tasks Descriptive Flexfields
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the project task. Value is auto-generated when using POST and mandatory when using PATCH. -
TaskLevel: integer
(int32)
Indicates level of the task. Level 0 is reserved for the task that holds the rollup values of the project. Value is auto-calculated.
-
TaskNumber: string
Maximum Length:
100
The number of a task that needs to be unique within the project. Value will be auto-generated if not added in POST. -
TaskNumberPrefix: string
A value prefixed to the task number while creating tasks from the work plan template. This attribute is applicable only for PATCH operation and you must enter a different prefix each time you create tasks from the same work plan template in the same project.
-
TaskStatusCode: string
Title:
Task Status Code
Maximum Length:20
The code for the status of work completed on the task. Valid values are NOT_STARTED, IN_PROGRESS, and COMPLETED. Value is NOT_STARTED if not provided when using POST and it is neither a task nor a gate. -
TextAttr01: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr02: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr03: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr04: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr05: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr06: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr07: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr08: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr09: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr10: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr11: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr12: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr13: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr14: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr15: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr16: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr17: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr18: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr19: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr20: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TopTaskId: integer
(int64)
Title:
Top Task ID
Identifier of the top task to which a task rolls up. If the task is a top task, then identifier of the top task is same as the identifier of the task. -
TotalFloat: number
Title:
Total Float
The total float or total slack is the amount of time in days that the task can be delayed without causing a delay to the project. This attribute is not currently used. -
UpdateSource: string
Maximum Length:
30
For internal use. The source from which the task was last updated. -
WorkPlanTemplateId: integer
Unique identifier of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkPlanTemplateName: string
Name of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the work type associated to a task -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Unique identifier of the work type
Nested Schema : Gate Approvers
Type:
array
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tasks Descriptive Flexfields
Type:
array
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task.
Show Source
Nested Schema : projectPlans-Tasks-GateApprovers-item-response
Type:
Show Source
object
-
ApprovalId: integer
(int64)
Title:
Approval ID
Read Only:true
Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH. -
GateApproverComments: string
Title:
Gate Approver Comments
Maximum Length:1000
Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver Email
Maximum Length:240
Email address of the gate approver. -
GateApproverName: string
Title:
Gate Approver Name
Read Only:true
Maximum Length:240
Name of the user who is to approve the gate. -
GateApproverStatus: string
Title:
Gate Approver Status
Maximum Length:16
Status set for a gate by the approver. -
GateApproverUpdatedBy: string
Title:
Gate Approver Updated By
Read Only:true
Maximum Length:240
The name of the user who updated the gate approval status. Nearly always the approver identified in the row, but could be the project manager. -
GateApproverUpdatedDate: string
(date)
Title:
Gate Approver Updated Date
Date when the Approval Status was last changed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectPlans-Tasks-TaskDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Unique identifier of the task. The values is the same as Task ID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- GateApprovers
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/GateApproversParameters:
- ProjectId:
$request.path.ProjectId
- TaskId:
$request.path.TaskId
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate. - ProjectId:
- TaskDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}/child/Tasks/{TaskId}/child/TaskDFFParameters:
- ProjectId:
$request.path.ProjectId
- TaskId:
$request.path.TaskId
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task. - ProjectId:
Examples
The following example shows how to create project assets - key flexfields by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/
Request Body Example
The following shows an example of the request body in JSON format.
{ "Name" : "testtask" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ActualFinishDate": null, "ActualHours": 0, "ActualStartDate": null, "BaselineAllocation": null, "BaselineDuration": null, "BaselineEffortinHours": null, "BaselineFinishDate": null, "BaselineStartDate": null, "BillableFlag": null, "ChargeableFlag": null, "CurrentEffort": null, "CurrentFinishDate": null, "CurrentStartDate": null, "Description": null, "DisplaySequence": 30000000, "ElementType": "EXECUTION", "GateFlag": false, "ManualScheduleFlag": false, "GateStatusCode": null, "MilestoneFlag": false, "Name": "testtask", "ParentTaskId": 300100184801847, "PeerReferenceTaskId": null, "PercentComplete": 0, "PlannedAllocation": null, "PlannedDuration": null, "PlannedEffort": null, "PlannedFinishDate": null, "PlannedStartDate": null, "PrimaryResourceEmail": null, "PrimaryResourceName": null, "RemainingHours": null, "TaskId": 300100184838576, "TaskLevel": 1, "TaskNumber": "36733", "TaskStatusCode": "NOT_STARTED", "TaskNumberPrefix": null, "WorkPlanTemplateId": null, "WorkPlanTemplateName": null, "NumberAttr01": null, "NumberAttr02": null, "NumberAttr03": null, "NumberAttr04": null, "NumberAttr05": null, "NumberAttr06": null, "NumberAttr07": null, "NumberAttr08": null, "NumberAttr09": null, "NumberAttr10": null, "TaskCode01Id": null, "TaskCode02Id": null, "TaskCode03Id": null, "TaskCode04Id": null, "TaskCode05Id": null, "TaskCode06Id": null, "TaskCode07Id": null, "TaskCode08Id": null, "TaskCode09Id": null, "TaskCode10Id": null, "TaskCode11Id": null, "TaskCode12Id": null, "TaskCode13Id": null, "TaskCode14Id": null, "TaskCode15Id": null, "TaskCode16Id": null, "TaskCode17Id": null, "TaskCode18Id": null, "TaskCode19Id": null, "TaskCode20Id": null, "TaskCode21Id": null, "TaskCode22Id": null, "TaskCode23Id": null, "TaskCode24Id": null, "TaskCode25Id": null, "TaskCode26Id": null, "TaskCode27Id": null, "TaskCode28Id": null, "TaskCode29Id": null, "TaskCode30Id": null, "TaskCode31Id": null, "TaskCode32Id": null, "TaskCode33Id": null, "TaskCode34Id": null, "TaskCode35Id": null, "TaskCode36Id": null, "TaskCode37Id": null, "TaskCode38Id": null, "TaskCode39Id": null, "TaskCode40Id": null, "TextAttr01": null, "TextAttr02": null, "TextAttr03": null, "TextAttr04": null, "TextAttr05": null, "TextAttr06": null, "TextAttr07": null, "TextAttr08": null, "TextAttr09": null, "TextAttr10": null, "TextAttr11": null, "TextAttr12": null, "TextAttr13": null, "TextAttr14": null, "TextAttr15": null, "TextAttr16": null, "TextAttr17": null, "TextAttr18": null, "TextAttr19": null, "TextAttr20": null, "PhysicalPercentComplete": 0, "ConstraintDate": null, "ConstraintType": null, "ScheduleTypeCode": "FIXED_EFFORT", "Deadline": null, "DisplayInTimelineFlag": false, "LeafIndicator": "Y", "PlannedLaborCost": null, "PlannedLaborBillAmount": null, "PlannedExpense": null, "ActualLaborCost": null, "ActualLaborBillAmount": null, "CurrentLaborCost": null, "CurrentLaborBillAmount": null, "RemainingLaborCost": null, "RemainingLaborBillAmount": null, "BaselineLaborCost": null, "BaselineLaborBillAmount": null, "ActualExpense": null, "RemainingExpense": null, "CurrentExpense": null, "BaselineExpense": null, "PlannedCost": null, "ActualCost": null, "RemainingCost": null, "CurrentCost": null, "CostPercentComplete": null, "CreatedBy": "ABRAHAM.MASON", "ProposedEffort": null, "ProposedStartDate": null, "ProposedFinishDate": null, "Integrated": null, "CurrentDuration": null, "IntegrationSource": "", "CurrentStartDateTime": null, "CurrentFinishDateTime": null, "FreeFloat": null, "TotalFloat": null, "EarlyFinishDate": null, "EarlyStartDate": null, "LateFinishDate": null, "LateStartDate": null, "CriticalFlag": false, "TopTaskId": 300100184838576, "PendingRollupFlag": null, "ProposedFinishDateTime": null, "ProposedStartDateTime": null, "ActualStartDateTime": null, "ActualFinishDateTime": null, "PlannedFinishDateTime": null, "PlannedStartDateTime": null, "BaselineFinishDateTime": null, "BaselineStartDateTime": null, "DeadlineDateTime": null, "EarlyFinishDateTime": null, "EarlyStartDateTime": null, "LateFinishDateTime": null, "LateStartDateTime": null, "ConstraintDateTime": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184838576", "name": "Tasks", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184838576", "name": "Tasks", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843", "name": "projectPlans", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184838576/child/GateApprovers", "name": "GateApprovers", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100184801843/child/Tasks/300100184838576/child/TaskDFF", "name": "TaskDFF", "kind": "collection" } ] }