Create signed in project enterprise users
post
/fscmRestApi/resources/11.13.18.05/projectsUsers
Request
Header Parameters
- Metadata-Context: string 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: string 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
- ChargeableFinancialTasks: array Chargeable Tasks Title:
Chargeable Tasks
The tasks for which the projects user can report expenditures such as time. - ChargeableProjects: array Chargeable Projects Title:
Chargeable Projects
The projects for which the projects user can report expenditures such as time. - DisplayName(required): string Title:
Name
Maximum Length:240
The name of the projects user. - Email: string Title:
Email
Maximum Length:240
The email address of the projects user. - FollowedProjectTasks: array Followed Project Tasks Title:
Followed Project Tasks
The followed project task resource is used to retrieve attributes for a project task that a project user follows. - FollowedToDoTasks: array Followed To Do Tasks Title:
Followed To Do Tasks
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users. - PersonId: integer (int64) The unique identifier of the projects user in HCM.
- Phone: string Maximum Length:
240
The telephone number of the projects user. - ProjectTasks: array Project Tasks Title:
Project Tasks
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources. - ToDoTasks: array To Do Tasks Title:
To Do Tasks
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
Nested Schema : Chargeable Tasks
Type:
array
Title:
Chargeable Tasks
The tasks for which the projects user can report expenditures such as time.
Show Source Nested Schema : Chargeable Projects
Type:
array
Title:
Chargeable Projects
The projects for which the projects user can report expenditures such as time.
Show Source Nested Schema : Followed Project Tasks
Type:
array
Title:
Followed Project Tasks
The followed project task resource is used to retrieve attributes for a project task that a project user follows.
Show Source Nested Schema : Followed To Do Tasks
Type:
array
Title:
Followed To Do Tasks
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users.
Show Source Nested Schema : Project Tasks
Type:
array
Title:
Project Tasks
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
Show Source Nested Schema : To Do Tasks
Type:
array
Title:
To Do Tasks
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
Show Source Nested Schema : projectsUsers-FollowedProjectTasks-item-post-request
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.
- OsnSharedTaskFlag: boolean
- 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 : projectsUsers-ProjectTasks-item-post-request
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 LaborResourceAssignments
- 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 TaskFollowers
- 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 : projectsUsers-ProjectTasks-LaborResourceAssignments-item-post-request
Type:
Show Source object
Nested Schema : schema
Type:
Show Source object
- ElementType(required): string Title:
Element Type
Maximum Length:30
The element type of the task. - ElementVersionId: integer (int64) The unique identifier of the element version of the task.
- ObjectType: string Maximum Length:
30
Default Value:PJF_TASKS
The object type of the task. - OsnSharedTaskFlag: boolean
- PlanLineId: integer (int64) The unique identifier of the plan line of the to do task.
- TaskDescription: string Title:
Description
Maximum Length:2000
The description of the task. - TaskName(required): string Title:
Task Name
Maximum Length:255
The name of the task. - TaskPlannedFinishDate: string (date) Title:
Finish Date
The date when the task ends. - TaskPlannedStartDate: string (date) Title:
Start Date
The date when the task starts. - 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 progress status of the task. - ToDoTaskFollowers: array To Do Task Followers Title:
To Do Task Followers
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
Nested Schema : To Do Task Followers
Type:
array
Title:
To Do Task Followers
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
Show Source Nested Schema : projectsUsers-ToDoTasks-ToDoTaskFollowers-item-post-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: 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.
Root Schema : projectsUsers-item-response
Type:
Show Source object
- ChargeableFinancialTasks: array Chargeable Tasks Title:
Chargeable Tasks
The tasks for which the projects user can report expenditures such as time. - ChargeableProjects: array Chargeable Projects Title:
Chargeable Projects
The projects for which the projects user can report expenditures such as time. - DisplayName: string Title:
Name
Maximum Length:240
The name of the projects user. - Email: string Title:
Email
Maximum Length:240
The email address of the projects user. - FollowedProjectTasks: array Followed Project Tasks Title:
Followed Project Tasks
The followed project task resource is used to retrieve attributes for a project task that a project user follows. - FollowedToDoTasks: array Followed To Do Tasks Title:
Followed To Do Tasks
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users. - links: array Links Title:
Links
The link relations associated with the resource instance. - PersonId: integer (int64) The unique identifier of the projects user in HCM.
- Phone: string Maximum Length:
240
The telephone number of the projects user. - ProjectTasks: array Project Tasks Title:
Project Tasks
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources. - ResourceId: integer (int64) Read Only:
true
The unique identifier of the resource assigned to the task. - ToDoTasks: array To Do Tasks Title:
To Do Tasks
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
Nested Schema : Chargeable Tasks
Type:
array
Title:
Chargeable Tasks
The tasks for which the projects user can report expenditures such as time.
Show Source Nested Schema : Chargeable Projects
Type:
array
Title:
Chargeable Projects
The projects for which the projects user can report expenditures such as time.
Show Source Nested Schema : Followed Project Tasks
Type:
array
Title:
Followed Project Tasks
The followed project task resource is used to retrieve attributes for a project task that a project user follows.
Show Source Nested Schema : Followed To Do Tasks
Type:
array
Title:
Followed To Do Tasks
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users.
Show Source Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Project Tasks
Type:
array
Title:
Project Tasks
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
Show Source Nested Schema : To Do Tasks
Type:
array
Title:
To Do Tasks
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
Show Source Nested Schema : projectsUsers-ChargeableFinancialTasks-item-response
Type:
Show Source object
- AssignmentId: integer (int64) Read Only:
true
The unique identifier of the organization assignment of the projects user. - AssignmentNumber: string Read Only:
true
Maximum Length:50
The unique reference of the organization assignment of the projects user. - DefaultExpenditureTypeId: integer (int64) Read Only:
true
The unique identifier of the default expenditure type set for a resource class in a project unit. - DefaultExpenditureTypeName: string Read Only:
true
Maximum Length:240
Name of the default expenditure type for a resource class in a project unit. - links: array Links Title:
Links
The link relations associated with the resource instance. - PrimaryAssignment: string Read Only:
true
Maximum Length:30
Indicates whether an assignment is the primary assignment of the projects user. - ProjectId: integer (int64) Read Only:
true
The unique identifier of a project. - ProjectName: string Read Only:
true
Maximum Length:240
Name of the project. - ProjectUnitId: integer (int64) Read Only:
true
The unique identifier of a project unit. - TaskFinishDate: string (date) Read Only:
true
Planning finish date of the financial task as per financial project plan. - TaskId: integer (int64) Read Only:
true
The unique identifier of a task. - TaskManagerId: integer (int64) Read Only:
true
The unique identifier of the resource who manages the task. - TaskManagerName: string Read Only:
true
Maximum Length:240
The resource who manages the task. - TaskName: string Read Only:
true
Maximum Length:255
Name of the task. - TaskNumber: string Read Only:
true
Maximum Length:100
Number of the task. - TaskOrganizationName: string Read Only:
true
Maximum Length:240
The organization that owns the task. - TaskStartDate: string (date) Read Only:
true
Planning start date of the financial task as per financial project plan. - TransactionCompletionDate: string (date) Read Only:
true
Date upto which transactions can be reported for task. - TransactionStartDate: string (date) Read Only:
true
Date from which transactions can be reported for 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-ChargeableProjects-item-response
Type:
Show Source object
- AssignmentId: integer (int64) Read Only:
true
The unique identifier of the organization assignment of the projects user. - AssignmentNumber: string Read Only:
true
Maximum Length:50
The unique reference of the organization assignment of the projects user. - BusinessUnitId: integer (int64) Read Only:
true
The unique identifier of the business unit to which the project belongs. - BusinessUnitName: string Read Only:
true
Maximum Length:240
The name of the business unit to which the project belongs. - DefaultExpenditureTypeId: integer (int64) Read Only:
true
The unique identifier of the default expenditure type set for a resource class in a project unit. - DefaultExpenditureTypeName: string Read Only:
true
Maximum Length:240
The name of the default expenditure type for a resource class in a project unit. - links: array Links Title:
Links
The link relations associated with the resource instance. - OwningOrganizationId: integer (int64) Read Only:
true
The unique identifier of the organization that owns the project. - OwningOrganizationName: string Read Only:
true
Maximum Length:240
An organizing unit in the internal or external structure of the enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the project. - PrimaryAssignment: string Read Only:
true
Maximum Length:30
Indicates whether an assignment is the primary assignment of the projects user. - ProjectDescription: string Read Only:
true
Maximum Length:2000
The description of the project. - ProjectFinishDate: string (date) Read Only:
true
The date that work or information tracking ends on a project. - ProjectId: integer (int64) Read Only:
true
The unique identifier of the project. - ProjectManagerEmail: string Read Only:
true
Maximum Length:240
The email of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. - ProjectManagerName: string Read Only:
true
Maximum Length:240
Name of the person who leads the project team and who has the authority and responsibility for meeting project objectives. - ProjectManagerResourceId: integer (int64) Read Only:
true
The unique identifier of the person who leads the project team and who has the authority and responsibility for meeting the project objectives. - ProjectName: string Read Only:
true
Maximum Length:240
The name of the project that is being created. - ProjectNumber: string Read Only:
true
Maximum Length:25
The project number of the project. - ProjectStartDate: string (date) Read Only:
true
The date that work or information tracking begins on a project. - ProjectUnitId: integer (int64) Read Only:
true
The unique identifier of the project unit assigned to the project. - ProjectUnitName: string Read Only:
true
Maximum Length:240
Name of the project unit assigned to the project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectsUsers-FollowedProjectTasks-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 Title:
Element Type
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.
- 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
Read Only:true
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
- ParentTaskId: integer (int64) Title:
Parent Task ID
Read Only:true
The unique identifier of the parent task. - 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) Read Only:
true
The unique identifier of the plan line of the followed project task. - ProjectId: integer (int64) Read Only:
true
The unique identifier of the project of the task. - ProjectName: string Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project to which the 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. - ProjElementId: integer (int64) Read Only:
true
The unique identifier of the project element of the task. - TaskActualFinishDate: string (date) Title:
Actual Finish Date
Read Only:true
The date when work was completed on a task as opposed to the planned end date of the task. - TaskActualQuantity: number Title:
Actual Hours
Read Only:true
The number of hours that the project team member reports working on the task. - TaskActualStartDate: string (date) Title:
Actual Start Date
Read Only:true
The date on which the 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. - TaskFollowerId: integer (int64) Read Only:
true
The unique identifier of the task follower. - TaskId: integer (int64) Read Only:
true
The unique identifier of the task. - TaskLevel: integer (int32) Title:
Task Level
Read Only:true
The level of the task in the project work plan. - TaskName: string Title:
Task Name
Read Only:true
Maximum Length:255
The name of the task. - TaskPercentComplete: number Title:
Percent Complete
Read Only:true
Default Value:0
The percent of work complete for a particular task. - TaskPlannedFinishDate: string (date) Title:
Finish Date
Read Only:true
The date when work is scheduled to end. - TaskPlannedStartDate: string (date) Title:
Start Date
Read Only:true
The date when work 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
Read Only:true
The priority of the task. - TaskProgressEnteredDate: string (date) Read Only:
true
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 Read Only:
true
Maximum Length:20
The Code for the progress status of the task. - TaskProposedFinishDate: string (date) Title:
Proposed Finish Date
Read Only:true
The date when work on the task is expected to be completed. - TaskProposedQuantity: number Title:
Proposed Hours
Read Only:true
The estimated number of hours a resource takes to complete a task. - TaskProposedStartDate: string (date) Title:
Proposed Start Date
Read Only:true
The date when work on the task is expected to start. - TaskQuantity: number Title:
Planned Effort in Hours
Read Only:true
The scheduled number of hours that a resource is assigned to work on a task. - TaskRemainingQuantity: number Title:
Remaining Hours
Read Only:true
The number of hours the project team member has left to complete the 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectsUsers-FollowedToDoTasks-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 Title:
Element Type
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 followed 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. - ObjectType: string Read Only:
true
Maximum Length:30
Default Value:PJF_TASKS
The object type of the task. - OsnSharedTaskFlag: boolean
- PlanLineId: integer (int64) Read Only:
true
The unique identifier of the plan line of the followed to do task. - ProjElementId: integer (int64) Read Only:
true
The unique identifier of the project element of the task. - ResourceId: integer (int64) Read Only:
true
The unique identifier of the resource assigned to the task. - TaskActualFinishDate: string (date) Title:
Actual Finish Date
Read Only:true
The date when work ended on a task as opposed to the planned end date of the task. - TaskActualStartDate: string (date) Title:
Actual Start Date
Read Only:true
The date when the work started on a task as opposed to the planned start date of the task. - TaskDescription: string Title:
Description
Read Only:true
Maximum Length:2000
The description of the task. - TaskFollowerId: integer (int64) Read Only:
true
The unique identifier of the task follower. - TaskId: integer (int64) Read Only:
true
The unique identifier of the task. - TaskName: string Title:
Task Name
Read Only:true
Maximum Length:255
The name of the task. - TaskPlannedFinishDate: string (date) Title:
Finish Date
Read Only:true
The date when the task ends. - TaskPlannedStartDate: string (date) Title:
Start Date
Read Only:true
The date when the task starts. - TaskPriority: number Title:
Priority
Read Only:true
The priority of the task. - TaskProgressEnteredDate: string (date) Read Only:
true
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 Read Only:
true
Maximum Length:20
The Code of progress status of the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested 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 Title:
Element Type
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 : 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 Nested Schema : projectsUsers-ToDoTasks-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 Title:
Element Type
Maximum Length:30
The element type of the task. - ElementVersionId: integer (int64) The unique identifier of the element version of the 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. - ObjectType: string Maximum Length:
30
Default Value:PJF_TASKS
The object type of the task. - OsnSharedTaskFlag: boolean
- PlanLineId: integer (int64) The unique identifier of the plan line of the to do task.
- ProjElementId: integer (int64) Read Only:
true
The unique identifier of the project element of the task. - TaskDescription: string Title:
Description
Maximum Length:2000
The description of the task. - TaskId: integer (int64) Read Only:
true
The unique identifier of the task. - TaskName: string Title:
Task Name
Maximum Length:255
The name of the task. - TaskPlannedFinishDate: string (date) Title:
Finish Date
The date when the task ends. - TaskPlannedStartDate: string (date) Title:
Start Date
The date when the task starts. - 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 progress status of the task. - ToDoTaskFollowers: array To Do Task Followers Title:
To Do Task Followers
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : To Do Task Followers
Type:
array
Title:
To Do Task Followers
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
Show Source Nested Schema : projectsUsers-ToDoTasks-ToDoTaskFollowers-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
- ChargeableFinancialTasks
- Operation: /fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ChargeableFinancialTasksParameters:
- ResourceId:
$request.path.ResourceId
The tasks for which the projects user can report expenditures such as time. - ResourceId:
- ChargeableProjects
- Parameters:
- ResourceId:
$request.path.ResourceId
The projects for which the projects user can report expenditures such as time. - ResourceId:
- FollowedProjectTasks
- Parameters:
- ResourceId:
$request.path.ResourceId
The followed project task resource is used to retrieve attributes for a project task that a project user follows. - ResourceId:
- FollowedToDoTasks
- Parameters:
- ResourceId:
$request.path.ResourceId
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users. - ResourceId:
- ProjectTasks
- Parameters:
- ResourceId:
$request.path.ResourceId
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources. - ResourceId:
- ToDoTasks
- Parameters:
- ResourceId:
$request.path.ResourceId
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource. - ResourceId: