Update a work plan template
patch
/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}
Request
Path Parameters
-
WorkPlanTemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CurrencyCode: string
Title:
Work Plan Template Currency Code
Maximum Length:15
Default Value:USD
The required currency code for the work plan template. The value defaults from the project plan when creating the work plan template from an existing project plan. -
Description: string
Title:
Work Plan Template Description
Maximum Length:2000
Description of the work plan template. -
Name: string
Title:
Work Plan Template Name
Maximum Length:240
Default Value:DEFAULT
The required name of the work plan template. -
PublicFlag: boolean
Title:
Public
Maximum Length:1
Default Value:false
Indicates whether the work plan template is shared with other project managers. True indicates the template is public and false indicates only the owner can use the template. -
ScheduleType: string
Title:
Work Plan Template Schedule Type
Maximum Length:30
The required schedule type for the work plan template. Values are FIXED_EFFORT and FIXED_DURATION. The value defaults from the project plan when creating the work plan template from an existing project plan. -
TaskDeliverables: array
Task Deliverables
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a task. For example, a task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task. -
TaskDependencies: array
Task Dependencies
Title:
Task Dependencies
The Task Dependency resource is used to view dependencies between tasks in a work plan template. For example, a task that has a finish-to-start dependency with another task can start only after the predecessor task is completed. You can have many dependencies for each task. -
TaskExpenseResourceAssignments: array
Task Expense Resource Assignments
Title:
Task Expense Resource Assignments
The Task Expenses Resource Assignments resource is used to view the assignment of an expense resource for a task. For example, hotel expenses can be planned for a task. You can have multiple expense resource assignments for each task. -
TaskLaborResourceAssignments: array
Task Labor Resource Assignments
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view the assignment of a labor resource for a task. For example, a Database Analyst can be assigned as a labor resource for a task. You can have many labor resource assignments for each task. -
Tasks: array
Tasks
Title:
Tasks
The Tasks resource is used to view task details. A task is an activity that needs to be performed by the assigned resources within the defined time period.
Nested Schema : Task Deliverables
Type:
array
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a task. For example, a task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task.
Show Source
Nested Schema : Task Dependencies
Type:
array
Title:
Task Dependencies
The Task Dependency resource is used to view dependencies between tasks in a work plan template. For example, a task that has a finish-to-start dependency with another task can start only after the predecessor task is completed. You can have many dependencies for each task.
Show Source
Nested Schema : Task Expense Resource Assignments
Type:
array
Title:
Task Expense Resource Assignments
The Task Expenses Resource Assignments resource is used to view the assignment of an expense resource for a task. For example, hotel expenses can be planned for a task. You can have multiple expense resource assignments for each task.
Show Source
Nested Schema : Task Labor Resource Assignments
Type:
array
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view the assignment of a labor resource for a task. For example, a Database Analyst can be assigned as a labor resource for a task. You can have many labor resource assignments for each task.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The Tasks resource is used to view task details. A task is an activity that needs to be performed by the assigned resources within the defined time period.
Show Source
Nested Schema : workPlanTemplates-TaskDeliverables-item-patch-request
Type:
Show Source
object
-
TaskDeliverableAssociationId: integer
(int64)
Title:
Deliverable Association ID
Unique identifier of the association between task and deliverable.
Nested Schema : workPlanTemplates-TaskDependencies-item-patch-request
Type:
Show Source
object
-
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency between tasks. Valid values are finish-to-start, start-to-start, finish-to-finish, and start-to-finish. -
Lag: number
Title:
Lag
Default Value:0
The number of days after which the dependency is activated. For example, if there is a finish-to-start dependency and a lag of 2 days, the successor task will start 2 days after the predecessor task is completed. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Unique identifier of the predecessor task. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task ID
Unique identifier of the successor task.
Nested Schema : workPlanTemplates-TaskExpenseResourceAssignments-item-patch-request
Type:
Show Source
object
-
ExpenseAmount: number
Title:
Expense Resource Planned Amount
Default Value:0
The planned expense cost amount of a specific expense resource assigned to the task. -
ExpenseResourceId: integer
(int64)
Title:
Expense Resource ID
Identifier of the expense resource assigned to the task. -
ResourceName: string
Title:
Expense Resource Name
Name of the expense resource assigned to the task.
Nested Schema : workPlanTemplates-TaskLaborResourceAssignments-item-patch-request
Type:
Show Source
object
-
CostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount of the labor resource for the task. -
EffortInHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource for the task. -
LaborBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount of the labor resource for the task. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource for the task. -
ResourceEmail: string
Title:
Labor Resource Email
Email address of the labor resource assigned to the task. -
ResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the task. -
TemplateResourceAssignmentId: integer
Title:
Template Resource Assignment ID
Unique identifier of the assignment of the labor resource.
Nested Schema : workPlanTemplates-Tasks-item-patch-request
Type:
Show Source
object
-
Allocation: number
Title:
Allocation Percentage
The percentage of resource's hours allocated to the task for the task duration. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable. -
ChargeableFlag: boolean
Title:
Chargeable
Maximum Length:1
Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable. -
Description: string
Title:
Task Description
Maximum Length:2000
Text description of the task. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
For internal use. The order in which the task is displayed. -
Duration: number
Title:
Planned Duration
The planned duration of the task. -
Effort: number
Title:
Planned Effort in Hours
The estimated effort, in hours, required to complete a task. -
ExpenseAmount: number
Title:
Planned Expense Amount
Default Value:0
The planned expense amount for the task. -
GateApprovers: array
Gate Approvers
Title:
Gate Approvers
The Gate Approvers resource is used to view gate approver details. -
LaborBillAmount: number
Title:
Planned Labor Bill Amount
The planned bill amount for all the labor resources associated with the task. -
LaborCost: number
Title:
Planned Labor Cost
The planned cost amount for all the labor resources associated with the task. -
LeafIndicator: string
Title:
Leaf Indicator
Maximum Length:1
Default Value:Y
Indicates whether the task is a lowest-level task. -
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. -
MilestoneFlag: boolean
Title:
Milestone
Maximum Length:1
Default Value:false
Indicates whether the task is a milestone. -
Name: string
Title:
Task Name
Maximum Length:255
Name of the task. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
ParentTaskId: integer
(int64)
Title:
Parent Task ID
Identifier of the parent task of the task. -
PeerReferenceTaskId: integer
Title:
Peer Reference Task ID
Unique identifier of the peer task. -
Priority: number
Title:
Priority
Priority of the task for the assigned resource. -
ScheduleTypeCode: string
Title:
Task Schedule Type Code
Maximum Length:30
Schedule type of the task. Valid values are fixed effort and fixed duration. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskDFF: array
TaskDFF
-
TaskLevel: integer
(int32)
Title:
Task Level
Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The number assigned to a task. It's used to uniquely identify a task. -
TextAttr01: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr02: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr03: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr04: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr05: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr06: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr07: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr08: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr09: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr10: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr11: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr12: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr13: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr14: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr15: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr16: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr17: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr18: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr19: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr20: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TotalCost: number
Title:
Total Cost
The total cost of the task. It's the sum of expense and labor costs. -
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date. -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.
Nested Schema : Gate Approvers
Type:
array
Title:
Gate Approvers
The Gate Approvers resource is used to view gate approver details.
Show Source
Nested Schema : workPlanTemplates-Tasks-GateApprovers-item-patch-request
Type:
Show Source
object
-
GateApproverEmail: string
Title:
Gate Approver Email
Email address of the gate approver. -
GateApproverId: integer
(int64)
Title:
Gate Approver ID
Unique identifier of the gate approver. -
GateApproverName: string
Title:
Gate Approver Name
Name of the gate approver.
Nested Schema : workPlanTemplates-Tasks-TaskDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ProjElementId: integer
(int64)
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 : workPlanTemplates-item-response
Type:
Show Source
object
-
CopyFromProjectId: integer
(int64)
Title:
Project ID to Copy Work Plan Template From
The unique identifier of the project plan to copy from when creating the work plan template. The value isn't stored and is required only when creating the work plan template. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CurrencyCode: string
Title:
Work Plan Template Currency Code
Maximum Length:15
Default Value:USD
The required currency code for the work plan template. The value defaults from the project plan when creating the work plan template from an existing project plan. -
Description: string
Title:
Work Plan Template Description
Maximum Length:2000
Description of the work plan template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Work Plan Template Name
Maximum Length:240
Default Value:DEFAULT
The required name of the work plan template. -
OwnerId: integer
(int64)
Title:
Work Plan Template Owner ID
Read Only:true
Identifier of the work plan template owner. The owner is the user who creates the work plan template. -
PublicFlag: boolean
Title:
Public
Maximum Length:1
Default Value:false
Indicates whether the work plan template is shared with other project managers. True indicates the template is public and false indicates only the owner can use the template. -
ScheduleType: string
Title:
Work Plan Template Schedule Type
Maximum Length:30
The required schedule type for the work plan template. Values are FIXED_EFFORT and FIXED_DURATION. The value defaults from the project plan when creating the work plan template from an existing project plan. -
TaskDeliverables: array
Task Deliverables
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a task. For example, a task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task. -
TaskDependencies: array
Task Dependencies
Title:
Task Dependencies
The Task Dependency resource is used to view dependencies between tasks in a work plan template. For example, a task that has a finish-to-start dependency with another task can start only after the predecessor task is completed. You can have many dependencies for each task. -
TaskExpenseResourceAssignments: array
Task Expense Resource Assignments
Title:
Task Expense Resource Assignments
The Task Expenses Resource Assignments resource is used to view the assignment of an expense resource for a task. For example, hotel expenses can be planned for a task. You can have multiple expense resource assignments for each task. -
TaskLaborResourceAssignments: array
Task Labor Resource Assignments
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view the assignment of a labor resource for a task. For example, a Database Analyst can be assigned as a labor resource for a task. You can have many labor resource assignments for each task. -
Tasks: array
Tasks
Title:
Tasks
The Tasks resource is used to view task details. A task is an activity that needs to be performed by the assigned resources within the defined time period. -
WorkPlanTemplateId: integer
(int64)
Title:
Project Work Plan Template ID
Read Only:true
Unique identifier of the work plan template generated when creating the work plan template.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Task Deliverables
Type:
array
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a task. For example, a task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task.
Show Source
Nested Schema : Task Dependencies
Type:
array
Title:
Task Dependencies
The Task Dependency resource is used to view dependencies between tasks in a work plan template. For example, a task that has a finish-to-start dependency with another task can start only after the predecessor task is completed. You can have many dependencies for each task.
Show Source
Nested Schema : Task Expense Resource Assignments
Type:
array
Title:
Task Expense Resource Assignments
The Task Expenses Resource Assignments resource is used to view the assignment of an expense resource for a task. For example, hotel expenses can be planned for a task. You can have multiple expense resource assignments for each task.
Show Source
Nested Schema : Task Labor Resource Assignments
Type:
array
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view the assignment of a labor resource for a task. For example, a Database Analyst can be assigned as a labor resource for a task. You can have many labor resource assignments for each task.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The Tasks resource is used to view task details. A task is an activity that needs to be performed by the assigned resources within the defined time period.
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 : workPlanTemplates-TaskDeliverables-item-response
Type:
Show Source
object
-
DeliverableDescription: string
Title:
Deliverable Description
Read Only:true
Maximum Length:1000
The description of the deliverable. -
DeliverableId: integer
(int64)
Title:
Deliverable ID
Read Only:true
Identifier of the deliverable associated with the task. -
DeliverablePriorityCode: string
Title:
Deliverable Priority Code
Read Only:true
Maximum Length:30
Internal code for the priority of the deliverable. -
DeliverableTypeCode: integer
(int64)
Title:
Deliverable Type Code
Read Only:true
Internal code for the type of the deliverable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaskDeliverableAssociationId: integer
(int64)
Title:
Deliverable Association ID
Unique identifier of the association between task and deliverable. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
Identifier of the task associated with the deliverable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-TaskDependencies-item-response
Type:
Show Source
object
-
DependencyId: integer
(int64)
Title:
Dependency ID
Read Only:true
Identifier of the dependency between two tasks. -
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency between tasks. Valid values are finish-to-start, start-to-start, finish-to-finish, and start-to-finish. -
Lag: number
Title:
Lag
Default Value:0
The number of days after which the dependency is activated. For example, if there is a finish-to-start dependency and a lag of 2 days, the successor task will start 2 days after the predecessor task is completed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Unique identifier of the predecessor task. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task ID
Unique identifier of the successor task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-TaskExpenseResourceAssignments-item-response
Type:
Show Source
object
-
ExpenseAmount: number
Title:
Expense Resource Planned Amount
Default Value:0
The planned expense cost amount of a specific expense resource assigned to the task. -
ExpenseResourceId: integer
(int64)
Title:
Expense Resource ID
Identifier of the expense resource assigned to the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceName: string
Title:
Expense Resource Name
Name of the expense resource assigned to the task. -
TaskExpenseResourceAssignmentId: integer
(int64)
Title:
Task Expense Resource Assignment ID
Read Only:true
Unique identifier of the expense resource assignment to the task. Value is auto-generated. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the expense resource is assigned.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-TaskLaborResourceAssignments-item-response
Type:
Show Source
object
-
CostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount of the labor resource for the task. -
EffortInHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource for the task. -
LaborBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount of the labor resource for the task. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the task. The value is True if the resource is the primary labor resource. The value is False if the resource isn't the primary labor resource. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource for the task. -
ResourceEmail: string
Title:
Labor Resource Email
Email address of the labor resource assigned to the task. -
ResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task to which the labor resource is assigned. -
TaskLaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the task. Value is auto-generated. -
TemplateResourceAssignmentId: integer
Title:
Template Resource Assignment ID
Unique identifier of the assignment of the labor resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-Tasks-item-response
Type:
Show Source
object
-
Allocation: number
Title:
Allocation Percentage
The percentage of resource's hours allocated to the task for the task duration. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable. -
ChargeableFlag: boolean
Title:
Chargeable
Maximum Length:1
Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the task. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the task was created. -
Description: string
Title:
Task Description
Maximum Length:2000
Text description of the task. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
For internal use. The order in which the task is displayed. -
Duration: number
Title:
Planned Duration
The planned duration of the task. -
Effort: number
Title:
Planned Effort in Hours
The estimated effort, in hours, required to complete a task. -
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. -
ExpenseAmount: number
Title:
Planned Expense Amount
Default Value:0
The planned expense amount for the task. -
GateApprovers: array
Gate Approvers
Title:
Gate Approvers
The Gate Approvers resource is used to view gate approver details. -
GateFlag: boolean
Title:
Gate
Maximum Length:1
Default Value:false
Indicates whether the task is a gate. -
LaborBillAmount: number
Title:
Planned Labor Bill Amount
The planned bill amount for all the labor resources associated with the task. -
LaborCost: number
Title:
Planned Labor Cost
The planned cost amount for all the labor resources associated with the task. -
LeafIndicator: string
Title:
Leaf Indicator
Maximum Length:1
Default Value:Y
Indicates whether the task is a lowest-level task. -
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. -
MilestoneFlag: boolean
Title:
Milestone
Maximum Length:1
Default Value:false
Indicates whether the task is a milestone. -
Name: string
Title:
Task Name
Maximum Length:255
Name of the task. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
ParentTaskId: integer
(int64)
Title:
Parent Task ID
Identifier of the parent task of the task. -
PeerReferenceTaskId: integer
Title:
Peer Reference Task ID
Unique identifier of the peer 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 work on a task. -
Priority: number
Title:
Priority
Priority of the task for the assigned resource. -
ScheduleTypeCode: string
Title:
Task Schedule Type Code
Maximum Length:30
Schedule type of the task. Valid values are fixed effort and fixed duration. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskDFF: array
TaskDFF
-
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task. -
TaskLevel: integer
(int32)
Title:
Task Level
Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The number assigned to a task. It's used to uniquely identify a task. -
TextAttr01: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr02: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr03: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr04: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr05: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr06: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr07: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr08: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr09: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr10: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr11: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr12: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr13: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr14: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr15: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr16: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr17: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr18: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr19: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr20: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TotalCost: number
Title:
Total Cost
The total cost of the task. It's the sum of expense and labor costs. -
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date. -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.
Nested Schema : Gate Approvers
Type:
array
Title:
Gate Approvers
The Gate Approvers resource is used to view gate approver details.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-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. -
GateApproverEmail: string
Title:
Gate Approver Email
Email address of the gate approver. -
GateApproverId: integer
(int64)
Title:
Gate Approver ID
Unique identifier of the gate approver. -
GateApproverName: string
Title:
Gate Approver Name
Name of the gate approver. -
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 : workPlanTemplates-Tasks-TaskDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- TaskDeliverables
-
Operation: /fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/TaskDeliverablesParameters:
- WorkPlanTemplateId:
$request.path.WorkPlanTemplateId
The Task Deliverables resource is used to view the association of a deliverable with a task. For example, a task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task. - WorkPlanTemplateId:
- TaskDependencies
-
Operation: /fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/TaskDependenciesParameters:
- WorkPlanTemplateId:
$request.path.WorkPlanTemplateId
The Task Dependency resource is used to view dependencies between tasks in a work plan template. For example, a task that has a finish-to-start dependency with another task can start only after the predecessor task is completed. You can have many dependencies for each task. - WorkPlanTemplateId:
- TaskExpenseResourceAssignments
-
Parameters:
- WorkPlanTemplateId:
$request.path.WorkPlanTemplateId
The Task Expenses Resource Assignments resource is used to view the assignment of an expense resource for a task. For example, hotel expenses can be planned for a task. You can have multiple expense resource assignments for each task. - WorkPlanTemplateId:
- TaskLaborResourceAssignments
-
Parameters:
- WorkPlanTemplateId:
$request.path.WorkPlanTemplateId
The Task Labor resource assignments resource is used to view the assignment of a labor resource for a task. For example, a Database Analyst can be assigned as a labor resource for a task. You can have many labor resource assignments for each task. - WorkPlanTemplateId:
- Tasks
-
Parameters:
- WorkPlanTemplateId:
$request.path.WorkPlanTemplateId
The Tasks resource is used to view task details. A task is an activity that needs to be performed by the assigned resources within the defined time period. - WorkPlanTemplateId:
Examples
The following example shows how to update a work plan template by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100113819490
Request Body Example
The following shows an example of the request body in JSON format.
{ "Name": "Updated Work Plan Template Name", "Description": "This is an updated work plan template description", "PublicFlag": false, "CurrencyCode": "INR", "ScheduleType": "FIXED_EFFORT" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "WorkPlanTemplateId": 100100113819490, "Name": "Updated Work Plan Template Name", "Description": "This is an updated work plan template description", "PublicFlag": false, "CopyFromProjectId": null, "OwnerId": 300100024326655, "CurrencyCode": "INR", "ScheduleType": "FIXED_EFFORT", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100113819490", "name": "workPlanTemplates", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000278" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100113819490", "name": "workPlanTemplates", "kind": "item" } ] }