Get all followed project tasks
get
/fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/FollowedProjectTasks
Request
Path Parameters
-
ResourceId(required): integer(int64)
The unique identifier of the resource assigned to the task.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all the followed project tasks with the specified task follower ID.
Finder Variables:- PlanLineId; integer; The unique identifier of a plan line on the followed project task.
- ProjElementId; integer; Finds all the followed project tasks with the specified project element ID.
- TaskFollowerId; integer; The unique identifier of a task follower on a project task.
- PrimaryKey: Finds all the followed project tasks with the specified task follower ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The unique identifier of the user who created the task.
- CreationDate; string; The date when the task is created.
- ElementType; string; The element type of the task.
- ElementVersionId; integer; The unique identifier of the element version of the task.
- ExecutionDisplaySequence; integer; 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; The date when the task is last updated.
- LastUpdatedBy; string; The unique identifier of the user who last updated the task.
- MilestoneFlag; boolean; 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; The object type of the task.
- OsnSharedTaskFlag; boolean; Indicates whether a task is shared on OSN. If the value is true, then the task is shared. The default value is false.
- ParentTaskId; integer; The unique identifier of the parent task.
- ParentTaskName; string; The name of the parent task to a new task.
- ParentTaskNumber; string; The number of the parent task. If the task is the top task, then parent task is null.
- PlanLineId; integer; The unique identifier of the plan line of the followed project task.
- ProjElementId; integer; The unique identifier of the project element of the task.
- ProjectId; integer; The unique identifier of the project of the task.
- ProjectName; string; The name of the project to which the task is associated.
- ProjectStatusCode; string; The code corresponding to the label that displays the status of the project.
- ProjectStatusName; string; The label to display the status of the project.
- TaskActualFinishDate; string; The date when work was completed on a task as opposed to the planned end date of the task.
- TaskActualQuantity; number; The number of hours that the project team member reports working on the task.
- TaskActualStartDate; string; The date on which the work started on a task as opposed to the planned start date of the task.
- TaskCurrentActualQuantity; number; Current estimated effort to complete the task.
- TaskCurrentFinishDate; string; The date when the task is estimated to end.
- TaskCurrentStartDate; string; The date when the task is estimated to start.
- TaskFollowerId; integer; The unique identifier of the task follower.
- TaskId; integer; The unique identifier of the task.
- TaskLevel; integer; The level of the task in the project work plan.
- TaskName; string; The name of the task.
- TaskPercentComplete; number; The percent of work complete for a particular task.
- TaskPlannedFinishDate; string; The date when work is scheduled to end.
- TaskPlannedStartDate; string; The date when work is scheduled to start.
- TaskPrimaryResourceId; integer; The unique identifier of the primary resource assigned to the task.
- TaskPriority; number; The priority of the task.
- TaskProgressEnteredDate; string; The date when progress on a task was last entered.
- TaskProgressStatus; string; The status of work completed on the task.
- TaskProgressStatusCode; string; The Code for the progress status of the task.
- TaskProposedFinishDate; string; The date when work on the task is expected to be completed.
- TaskProposedQuantity; number; The estimated number of hours a resource takes to complete a task.
- TaskProposedStartDate; string; The date when work on the task is expected to start.
- TaskQuantity; number; The scheduled number of hours that a resource is assigned to work on a task.
- TaskRemainingQuantity; number; The number of hours the project team member has left to complete the task.
- TaskResourceAllocationPercent; number; The percentage of total time that resources are planned to work on the task they are assigned to.
- TopTaskId; integer; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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-FollowedProjectTasks
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
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
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 : 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.
Examples
The following example shows how to get all followed project tasks by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X GET https://<host>:<port>/fscmRestApi/resources/latest/projectsUsers/<ResourceId>/child/FollowedProjectTasks
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "TaskName": "Task3", "ProjElementId": 300100090650592, "ObjectType": "PJF_TASKS", "ElementType": "EXECUTION", "ProjectId": 300100090650573, "ExecutionDisplaySequence": 30000000, "ElementVersionId": 300100090650590, "TaskFollowerId": 300100090655827, "TaskActualFinishDate": null, "TaskPlannedFinishDate": "2012-03-06", "TaskPercentComplete": null, "TaskPlannedStartDate": "2012-03-01", "TaskPriority": null, "TaskProposedFinishDate": "2012-03-06", "TaskProposedStartDate": "2012-03-01", "TaskProposedQuantity": 32, "TaskRemainingQuantity": 32, "TaskActualQuantity": null, "TaskResourceAllocationPercent": 100, "ProjectName": "FilterTaskAttributes1232017.01.09.06.28.58", "ProjectStatusCode": "ACTIVE", "ProjectStatusName": "Active_1", "TaskPrimaryResourceId": 300100024326751, "TaskQuantity": 32, "MilestoneFlag": false, "TaskActualStartDate": null, "TaskProgressStatus": "Not started", "TaskProgressEnteredDate": null, "ParentTaskName": "FilterTaskAttributes1232017.01.09.06.28.58", "TaskId": 300100090650592, "TaskCurrentFinishDate": "2012-03-06", "TaskCurrentStartDate": "2012-03-01", "TaskCurrentActualQuantity": 32, "CreationDate": "2017-01-09T06:35:38-08:00", "CreatedBy": "ABRAHAM.MASON", "LastUpdatedBy": "ABRAHAM.MASON", "LastUpdateDate": "2017-01-09T10:02:09-08:00", "links": [ ... "name": "FollowedProjectTasks", "kind": "item" }, ... ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/projectsManagementApi/resources/11.1.13/projectsUsers/300100024326655/child/FollowedProjectTasks", "name": "FollowedProjectTasks", "kind": "collection" } ] }