1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Work Plan Templates

Get a work plan template

get

/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}

Request

Path Parameters
  • 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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : workPlanTemplates-item-response
Type: object
Show Source
  • 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.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • 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.
  • Title: Work Plan Template Description
    Maximum Length: 2000
    Description of the work plan template.
  • Links
  • Title: Work Plan Template Name
    Maximum Length: 240
    Default Value: DEFAULT
    The required name of the work plan template.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
    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.
  • 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 : 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-response
Type: object
Show Source
Nested Schema : workPlanTemplates-TaskDependencies-item-response
Type: object
Show Source
  • Title: Dependency ID
    Read Only: true
    Identifier of the dependency between two tasks.
  • 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.
  • 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
  • Title: Predecessor Task ID
    Unique identifier of the predecessor task.
  • Title: Successor Task ID
    Unique identifier of the successor task.
Nested Schema : workPlanTemplates-TaskExpenseResourceAssignments-item-response
Type: object
Show Source
Nested Schema : workPlanTemplates-TaskLaborResourceAssignments-item-response
Type: object
Show Source
Nested Schema : workPlanTemplates-Tasks-item-response
Type: object
Show Source
  • Title: Allocation Percentage
    The percentage of resource's hours allocated to the task for the task duration.
  • 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.
  • Title: Chargeable
    Maximum Length: 1
    Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the task.
  • Title: Creation Date
    Read Only: true
    The date when the task was created.
  • Title: Task Description
    Maximum Length: 2000
    Text description of the task.
  • Title: Display Sequence
    For internal use. The order in which the task is displayed.
  • Title: Planned Duration
    The planned duration of the task.
  • Title: Planned Effort in Hours
    The estimated effort, in hours, required to complete a task.
  • 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.
  • Title: Planned Expense Amount
    Default Value: 0
    The planned expense amount for the task.
  • Gate Approvers
    Title: Gate Approvers
    The Gate Approvers resource is used to view gate approver details.
  • Title: Gate
    Maximum Length: 1
    Default Value: false
    Indicates whether the task is a gate.
  • Title: Planned Labor Bill Amount
    The planned bill amount for all the labor resources associated with the task.
  • Title: Planned Labor Cost
    The planned cost amount for all the labor resources associated with the task.
  • Title: Leaf Indicator
    Maximum Length: 1
    Default Value: Y
    Indicates whether the task is a lowest-level task.
  • Links
  • 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.
  • Title: Milestone
    Maximum Length: 1
    Default Value: false
    Indicates whether the task is a milestone.
  • Title: Task Name
    Maximum Length: 255
    Name of the task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
  • Title: Parent Task ID
    Identifier of the parent task of the task.
  • Title: Peer Reference Task ID
    Unique identifier of the peer task.
  • Title: Primary Resource Email
    Read Only: true
    Maximum Length: 240
    Email of the person who leads the task.
  • Title: Primary Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the resource who leads the work on a task.
  • Title: Priority
    Priority of the task for the assigned resource.
  • Title: Task Schedule Type Code
    Maximum Length: 30
    Schedule type of the task. Valid values are fixed effort and fixed duration.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • Task code defined during implementation that provides a list of values to capture additional information for a task.
  • TaskDFF
  • Title: Task ID
    Unique identifier of the task.
  • 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.
  • Title: Task Number
    Maximum Length: 100
    The number assigned to a task. It's used to uniquely identify a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a task.
  • Title: Total Cost
    The total cost of the task. It's the sum of expense and labor costs.
  • 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.
  • 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 : TaskDFF
Type: array
Show Source
Nested Schema : workPlanTemplates-Tasks-GateApprovers-item-response
Type: object
Show Source
Nested Schema : workPlanTemplates-Tasks-TaskDFF-item-response
Type: object
Show Source
Links
TaskDeliverables
Parameters:
  • 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.
TaskDependencies
Parameters:
  • 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.
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.
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.
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.
Back to Top

Examples

The following example shows how to get a work plan templates by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454

Response Body Example

The following shows an example of the response body in JSON format of the award budget period.

{
"WorkPlanTemplateId": 100100148369454,
"Name": "Test - WPT",
"Description": null,
"PublicFlag": true,
"CopyFromProjectId": null,
"OwnerId": 300100024326655,
"CurrencyCode": "USD",
"ScheduleType": "FIXED_EFFORT",
"CreatedBy": "Connor.Horton",
"CreationDate": "2020-11-26T05:26:59.293+00:00",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454",
"name": "workPlanTemplates",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000278"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454",
"name": "workPlanTemplates",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskDeliverables",
"name": "TaskDeliverables",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskDependencies",
"name": "TaskDependencies",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskExpenseResourceAssignments",
"name": "TaskExpenseResourceAssignments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/TaskLaborResourceAssignments",
"name": "TaskLaborResourceAssignments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks",
"name": "Tasks",
"kind": "collection"
}
]
}
Back to Top