Update a project task
patch
/fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks/{ProjectTasksUniqID}
Request
Path Parameters
-
ProjectTasksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Tasks resource and used to uniquely identify an instance of Project Tasks. The client should not generate the hash key value. Instead, the client should query on the Project Tasks collection resource in order to navigate to a specific instance of Project Tasks to get the hash key.
-
ResourceId(required): integer(int64)
The unique identifier of the resource assigned to the task.
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
-
FinancialParentTaskId: integer
Unique identifier of the lowest financial parent task.
-
FinancialParentTaskName: string
The name of the lowest financial parent task.
-
FinancialParentTaskNumber: string
The number of the lowest financial parent task.
-
LaborResourceAssignments: array
Labor Resource Assignments
Title:
Labor Resource Assignments
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task. -
MilestoneFlag: boolean
Title:
Milestone
Maximum Length:1
Indicates whether a task is a milestone in the Team Member Dashboard and Task Management page. If the value is true, then the task is a milestone. The default value is false. -
PlanLineId: integer
(int64)
The unique identifier of the plan line of the task.
-
PlanVersionId(required): integer
(int64)
The unique identifier of the plan version of the proejct task.
-
TaskActualFinishDate: string
(date)
Title:
Actual Finish Date
The date when work was completed on a task as opposed to the planned end date of the task. -
TaskActualQuantity: number
Title:
ITD Hours
Default Value:0
The number of hours that the project team member reports working on the task. -
TaskActualStartDate: string
(date)
Title:
Actual Start Date
The date when work started on a task as opposed to the planned start date of the task. -
TaskDescription: string
Title:
Description
Maximum Length:2000
The description of the task. -
TaskExceptions: string
The exceptions generated by the progress entry for the task.
-
TaskFollowers: array
Project Task Followers
Title:
Project Task Followers
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion. -
TaskName(required): string
Title:
Task Name
Maximum Length:255
The name of the task. -
TaskPercentComplete: number
Title:
Percent Complete
Default Value:0
The percent of work completed for a particular task. -
TaskPlannedFinishDate: string
(date)
Title:
Finish Date
The date when the task is scheduled to end. -
TaskPlannedStartDate: string
(date)
Title:
Start Date
The date when task is scheduled to start. -
TaskPriority: number
Title:
Priority
The priority of the task. -
TaskProgressEnteredDate: string
(date)
The date when progress on a task was last entered.
-
TaskProgressStatusCode: string
Maximum Length:
20
The code of the progress status of the task. -
TaskProposedFinishDate: string
(date)
Title:
Proposed Finish Date
The date when the task is expected to be completed. -
TaskProposedQuantity: number
Title:
Proposed Hours
The total number of hours estimated for the resource to complete a task. -
TaskProposedStartDate: string
(date)
Title:
Proposed Start Date
The date when the task is expected to be started. -
TaskQuantity: number
Title:
Planned Effort in Hours
The scheduled number of hours that the resource is assigned to work on a task. -
TaskRemainingQuantity: number
Title:
Remaining Hours
The number of hours the project team member has left to complete a task. -
TopTaskName: string
Name of the top task to which the task rolls up. The top task identifier and task identifier are same for a top task.
-
TopTaskNumber: string
The number of the top task to which the task rolls up. The top task identifier and task identifier are same for a top task.
Nested Schema : Labor Resource Assignments
Type:
array
Title:
Labor Resource Assignments
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task.
Show Source
Nested Schema : Project Task Followers
Type:
array
Title:
Project Task Followers
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion.
Show Source
Nested Schema : projectsUsers-ProjectTasks-LaborResourceAssignments-item-patch-request
Type:
Show Source
object
Nested Schema : projectsUsers-ProjectTasks-TaskFollowers-item-patch-request
Type:
Show Source
object
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 : projectsUsers-ProjectTasks-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The unique identifier of the user who created the task. -
CreationDate: string
(date-time)
Read Only:
true
The date when the task is created. -
ElementType: string
Read Only:
true
Maximum Length:30
The element type of the task. -
ElementVersionId: integer
(int64)
Read Only:
true
The unique identifier of the element version of the task. -
ExecutionDisplaySequence: integer
(int64)
Read Only:
true
The order in which the task is displayed in the project. -
FinancialParentTaskId: integer
Unique identifier of the lowest financial parent task.
-
FinancialParentTaskName: string
The name of the lowest financial parent task.
-
FinancialParentTaskNumber: string
The number of the lowest financial parent task.
-
LaborResourceAssignments: array
Labor Resource Assignments
Title:
Labor Resource Assignments
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the task is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The unique identifier of the user who last updated the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneFlag: boolean
Title:
Milestone
Maximum Length:1
Indicates whether a task is a milestone in the Team Member Dashboard and Task Management page. If the value is true, then the task is a milestone. The default value is false. -
ObjectType: string
Read Only:
true
Maximum Length:30
Default Value:PJF_TASKS
The object type of the task. - OsnSharedTaskFlag: boolean
-
ParentTaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the parent task to a new task. -
ParentTaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
The number of the parent task. If the task is the top task, then parent task is null. -
PlanLineId: integer
(int64)
The unique identifier of the plan line of the task.
-
PlanVersionId: integer
(int64)
The unique identifier of the plan version of the proejct task.
-
ProjectId: integer
(int64)
Read Only:
true
The unique identifier of the project to which the task is associated. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project to which a task is associated. -
ProjectStatusCode: string
Read Only:
true
Maximum Length:30
The code corresponding to the label that displays the status of the project. -
ProjectStatusName: string
Read Only:
true
Maximum Length:80
The label to display the status of the project. -
ProjectSystemStatusCode: string
Read Only:
true
Maximum Length:30
The code of the system status corresponding to the status of the project. -
ProjElementId: integer
(int64)
Read Only:
true
The unique identifier of the project Element of the task. -
TaskActualFinishDate: string
(date)
Title:
Actual Finish Date
The date when work was completed on a task as opposed to the planned end date of the task. -
TaskActualQuantity: number
Title:
ITD Hours
Default Value:0
The number of hours that the project team member reports working on the task. -
TaskActualStartDate: string
(date)
Title:
Actual Start Date
The date when work started on a task as opposed to the planned start date of the task. -
TaskCurrentActualQuantity: number
Title:
Actual Hours
Read Only:true
Current estimated effort to complete the task. -
TaskCurrentFinishDate: string
(date)
Read Only:
true
The date when the task is estimated to end. -
TaskCurrentStartDate: string
(date)
Read Only:
true
The date when the task is estimated to start. -
TaskDescription: string
Title:
Description
Maximum Length:2000
The description of the task. -
TaskExceptions: string
The exceptions generated by the progress entry for the task.
-
TaskFollowers: array
Project Task Followers
Title:
Project Task Followers
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion. -
TaskId: integer
(int64)
Read Only:
true
The unique identifier of the task. -
TaskLevel: integer
(int32)
Read Only:
true
The level of the task in the project work plan. -
TaskName: string
Title:
Task Name
Maximum Length:255
The name of the task. -
TaskPercentComplete: number
Title:
Percent Complete
Default Value:0
The percent of work completed for a particular task. -
TaskPlannedFinishDate: string
(date)
Title:
Finish Date
The date when the task is scheduled to end. -
TaskPlannedStartDate: string
(date)
Title:
Start Date
The date when task is scheduled to start. -
TaskPrimaryResourceId: integer
(int64)
Read Only:
true
The unique identifier of the primary resource assigned to the task. -
TaskPriority: number
Title:
Priority
The priority of the task. -
TaskProgressEnteredDate: string
(date)
The date when progress on a task was last entered.
-
TaskProgressStatus: string
Read Only:
true
Maximum Length:80
The status of work completed on the task. -
TaskProgressStatusCode: string
Maximum Length:
20
The code of the progress status of the task. -
TaskProposedFinishDate: string
(date)
Title:
Proposed Finish Date
The date when the task is expected to be completed. -
TaskProposedQuantity: number
Title:
Proposed Hours
The total number of hours estimated for the resource to complete a task. -
TaskProposedStartDate: string
(date)
Title:
Proposed Start Date
The date when the task is expected to be started. -
TaskQuantity: number
Title:
Planned Effort in Hours
The scheduled number of hours that the resource is assigned to work on a task. -
TaskRemainingQuantity: number
Title:
Remaining Hours
The number of hours the project team member has left to complete a task. -
TaskResourceAllocationPercent: number
Title:
Resource Allocation Percentage
Read Only:true
The percentage of total time that resources are planned to work on the task they are assigned to. -
TopTaskId: integer
(int64)
Title:
Top Task ID
Read Only:true
Identifier of the top task to which the task rolls up. The top task identifier and task identifier are the same for a top task. -
TopTaskName: string
Name of the top task to which the task rolls up. The top task identifier and task identifier are same for a top task.
-
TopTaskNumber: string
The number of the top task to which the task rolls up. The top task identifier and task identifier are same for a top task.
Nested Schema : Labor Resource Assignments
Type:
array
Title:
Labor Resource Assignments
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Task Followers
Type:
array
Title:
Project Task Followers
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion.
Show Source
Nested Schema : projectsUsers-ProjectTasks-LaborResourceAssignments-item-response
Type:
Show Source
object
-
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
The name of the resource assigned to the task. -
ElementVersionId: integer
(int64)
Read Only:
true
The unique identifier of the element version of the task. -
Email: string
Title:
Email
Read Only:true
Maximum Length:240
The e-mail address of the resource. -
LaborResourceAssignmentId: integer
(int64)
Read Only:
true
The unique identifier of the resource assignment on the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Phone: string
Title:
Phone
Read Only:true
Maximum Length:240
The telephone number of a resource. -
PrimaryResource: string
Read Only:
true
Indicates whether a resource is the primary resource on the task. -
Quantity: number
Title:
Planned Effort in Hours
Read Only:true
The number of hours that the resource is assigned to work on a task. -
ResourceAllocationPercent: number
Title:
Resource Allocation Percentage
Read Only:true
The percentage of total time that resources are planned to work on the task they are assigned to. -
ResourceId: integer
(int64)
Read Only:
true
The unique identifier of the resource assigned to the task. -
TaskId: integer
(int64)
Read Only:
true
The unique identifier of the task.
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 : projectsUsers-ProjectTasks-TaskFollowers-item-response
Type:
Show Source
object
-
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
The name of projects user. -
ElementVersionId: integer
(int64)
Read Only:
true
The unique identifier of the element version of the task. -
Email: string
Title:
Email
Read Only:true
Maximum Length:240
The e-mail address of the resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Phone: string
Title:
Phone
Read Only:true
Maximum Length:240
The telephone number of the projects user. -
ResourceId: integer
(int64)
Read Only:
true
Unique identifier of the resource assigned to the task. -
TaskFollowerId: integer
(int64)
Read Only:
true
The unique identifier of the task follower.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- LaborResourceAssignments
-
Parameters:
- ProjectTasksUniqID:
$request.path.ProjectTasksUniqID
- ResourceId:
$request.path.ResourceId
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task. - ProjectTasksUniqID:
- TaskFollowers
-
Parameters:
- ProjectTasksUniqID:
$request.path.ProjectTasksUniqID
- ResourceId:
$request.path.ResourceId
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion. - ProjectTasksUniqID:
Examples
The following example shows how to update a project task by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X PATCH https://<host>:<port>/fscmRestApi/resources/latest/projectsUsers/<ResourceId>/child/ProjectTasks/<ProjElementId>
Example of Request Header
The following shows an example of the request header.
{ "TaskRemainingQuantity" : 60, "ObjectType" : "PJF_TASKS", "ElementType" : "EXECUTION" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "TaskName" : "Task 4", "ProjElementId" : 300100090030088, "ObjectType" : "PJF_TASKS", "ElementType" : "EXECUTION", "ExecutionDisplaySequence" : 400000, "ElementVersionId" : 300100090030086, "ProjectId" : 300100090030066, "TaskActualFinishDate" : null, "TaskActualStartDate" : null, "TaskPlannedFinishDate" : null, "TaskPlannedStartDate" : null, "TaskPriority" : null, "TaskPercentComplete" : 0, "ProjectName" : "Tet schedule mode", "TaskDescription" : "Manual in both", "TaskProposedFinishDate" : null, "TaskProposedStartDate" : null, "TaskProgressStatus" : "Not started", "TaskQuantity" : 8, "TaskProposedQuantity" : 8, "TaskRemainingQuantity" : 8, "TaskResourceAllocationPercent" : 100, "ProjectStatusName" : "Active_1", "ProjectStatusCode" : "ACTIVE", "ProjectSystemStatusCode" : "ACTIVE", "PlanVersionId" : 300100090030071, "TaskPrimaryResourceId" : 300100024326655, "TaskProgressStatusCode" : "NOT_STARTED", "TaskProgressEnteredDate" : null, "ParentTaskName" : "Tet schedule mode", "MilestoneFlag" : false, "TaskExceptions" : null, "TaskId" : 300100090030088, "TaskActualQuantity" : 0, "TaskCurrentActualQuantity" : 8, "TaskCurrentFinishDate" : null, "TaskCurrentStartDate" : null, "LastUpdatedBy" : "ABRAHAM.MASON", "LastUpdateDate" : "2017-01-03T21:16:30-08:00", "CreatedBy" : "ABRAHAM.MASON", "CreationDate" : "2017-01-03T21:16:30-08:00", "links" : [ ... { "rel" : "child", "href" : "https://slc11iiy.dev.oraclecorp.com:10606/projectsManagementApi/resources/11.1.13/projectsUsers/300100024326655/child/ProjectTasks/00030000000EACED00057708000110F07F4368080000000EACED00057708000110F07F4368070000000EACED00057708000110F07F43683B/child/LaborResourceAssignments", "name" : "LaborResourceAssignments", "kind" : "collection" }, ... ] }