Jump to

• Request
• Response
• Examples

Get all project tasks assigned to the user

get

/fscmRestApi/resources/11.13.18.05/projectsUsers/{ResourceId}/child/ProjectTasks

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 project tasks with the specified project element ID.
    Finder Variables:
    • PlanLineId; integer; The unique identifier of a plan line on the project task.
    • ProjElementId; integer; The unique identifier of the project element on the project task.
• 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.
  • 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 task.
  • PlanVersionId; integer; The unique identifier of the plan version of the proejct task.
  • ProjElementId; integer; The unique identifier of the project Element of the task.
  • ProjectId; integer; The unique identifier of the project to which the task is associated.
  • ProjectName; string; The name of the project to which a 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.
  • ProjectSystemStatusCode; string; The code of the system status corresponding to 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 when 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.
  • TaskDescription; string; The description of the task.
  • TaskExceptions; string; The exceptions generated by the progress entry for the task.
  • 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 completed for a particular task.
  • TaskPlannedFinishDate; string; The date when the task is scheduled to end.
  • TaskPlannedStartDate; string; The date when task 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 of the progress status of the task.
  • TaskProposedFinishDate; string; The date when the task is expected to be completed.
  • TaskProposedQuantity; number; The total number of hours estimated for the resource to complete a task.
  • TaskProposedStartDate; string; The date when the task is expected to be started.
  • TaskQuantity; number; The scheduled number of hours that the resource is assigned to work on a task.
  • TaskRemainingQuantity; number; The number of hours the project team member has left to complete a 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 Top

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.

Body ()

Root Schema : projectsUsers-ProjectTasks

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectsUsers-ProjectTasks-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectsUsers-ProjectTasks-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectsUsers-ProjectTasks-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectsUsers-ProjectTasks-item-response

Type: object

Show Source

• 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
  Read Only: true

  Indicates whether a task is shared on OSN. If the value is true, then the task is shared. The default value is false.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the task is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskPriority":{
            "title":"Priority",
            "type":"number",
            "description":"The priority of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskProgressStatusCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The code of the progress status of the task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaskProposedStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "description":"The date when the task is expected to be started.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProjElementId":{
            "type":"integer",
            "description":"The unique identifier of the project Element of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskCurrentStartDate":{
            "type":"string",
            "description":"The date when the task is estimated to start.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FinancialParentTaskName":{
            "type":"string",
            "description":"The name of the lowest financial parent task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskPlannedFinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The date when the task is scheduled to end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskQuantity":{
            "title":"Planned Effort in Hours",
            "type":"number",
            "description":"The scheduled number of hours that the resource is assigned to work on a task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectSystemStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the system status corresponding to the status of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskProgressStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of work completed on the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TaskProgressStatusCode"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the user who last updated the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TopTaskId":{
            "title":"Top Task ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ElementType":{
            "maxLength":"30",
            "type":"string",
            "description":"The element type of the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the user who created the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskFollowers":{
            "title":"Project Task Followers",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/projectsUsers-ProjectTasks-TaskFollowers-item-response"
            }
        },
        "TaskCurrentFinishDate":{
            "type":"string",
            "description":"The date when the task is estimated to end.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LaborResourceAssignments":{
            "title":"Labor Resource Assignments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/projectsUsers-ProjectTasks-LaborResourceAssignments-item-response"
            }
        },
        "TaskPrimaryResourceId":{
            "type":"integer",
            "description":"The unique identifier of the primary resource assigned to the task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the task.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskProgressEnteredDate":{
            "type":"string",
            "description":"The date when progress on a task was last entered.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionDisplaySequence":{
            "type":"integer",
            "description":"The order in which the task is displayed in the project.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OsnSharedTaskFlag":{
            "type":"boolean",
            "description":"Indicates whether a task is shared on OSN. If the value is true, then the task is shared. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TopTaskName":{
            "type":"string",
            "description":"Name of the top task to which the task rolls up. The top task identifier and task identifier are same for a top task.",
            "nullable":true,
            "x-queryable":true
        },
        "FinancialParentTaskNumber":{
            "type":"string",
            "description":"The number of the lowest financial parent task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code corresponding to the label that displays the status of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskExceptions":{
            "type":"string",
            "description":"The exceptions generated by the progress entry for the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskPercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"The percent of work completed for a particular task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the project to which a task is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The object type of the task.",
            "nullable":false,
            "readOnly":true,
            "default":"PJF_TASKS",
            "x-queryable":true
        },
        "ParentTaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The  number of the parent task. If the task is the top task, then parent task is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskActualQuantity":{
            "title":"ITD Hours",
            "type":"number",
            "description":"The number of hours that the project team member reports working on the task.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "TaskDescription":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskRemainingQuantity":{
            "title":"Remaining Hours",
            "type":"number",
            "description":"The number of hours the project team member has left to complete a task.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the parent task to a new task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskProposedQuantity":{
            "title":"Proposed Hours",
            "type":"number",
            "description":"The total number of hours estimated for the resource to complete a task.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanLineId":{
            "type":"integer",
            "description":"The unique identifier of the plan line of the task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MilestoneFlag":{
            "title":"Milestone",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanVersionId":{
            "type":"integer",
            "description":"The unique identifier of the plan version of the proejct task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"The unique identifier of the project to which the task is associated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectStatusName":{
            "maxLength":"80",
            "type":"string",
            "description":"The label to display the status of the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCurrentActualQuantity":{
            "title":"Actual Hours",
            "type":"number",
            "description":"Current estimated effort to complete the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinancialParentTaskId":{
            "type":"integer",
            "description":"Unique identifier of the lowest financial parent task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskResourceAllocationPercent":{
            "title":"Resource Allocation Percentage",
            "type":"number",
            "description":"The percentage of total time that resources are planned to work on the task they are assigned to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskProposedFinishDate":{
            "title":"Proposed Finish Date",
            "type":"string",
            "description":"The date when the task is expected to be completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ElementVersionId":{
            "type":"integer",
            "description":"The unique identifier of the element version of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskLevel":{
            "type":"integer",
            "description":"The level of the task in the project work plan.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "TaskActualFinishDate":{
            "title":"Actual Finish Date",
            "type":"string",
            "description":"The date when work was completed on a task as opposed to the planned end date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TopTaskNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskActualStartDate":{
            "title":"Actual Start Date",
            "type":"string",
            "description":"The date when work started on a task as opposed to the planned start date of the task.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the task is last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskPlannedStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when task is scheduled to start.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object projectsUsers-ProjectTasks-LaborResourceAssignments-item-response

{
    "title":"Labor Resource Assignments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/projectsUsers-ProjectTasks-LaborResourceAssignments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object projectsUsers-ProjectTasks-TaskFollowers-item-response

{
    "title":"Project Task Followers",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/projectsUsers-ProjectTasks-TaskFollowers-item-response"
    }
}

Nested Schema : projectsUsers-ProjectTasks-LaborResourceAssignments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PrimaryResource":{
            "type":"string",
            "description":"Indicates whether a resource is the primary resource on the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceAllocationPercent":{
            "title":"Resource Allocation Percentage",
            "type":"number",
            "description":"The percentage of total time that resources are planned to work on the task they are assigned to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":"240",
            "type":"string",
            "description":"The telephone number of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementVersionId":{
            "type":"integer",
            "description":"The unique identifier of the element version of the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the resource assigned to the task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Planned Effort in Hours",
            "type":"number",
            "description":"The number of hours that the resource is assigned to work on a task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LaborResourceAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the resource assignment on the task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : projectsUsers-ProjectTasks-TaskFollowers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Unique identifier of the resource assigned to the task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ElementVersionId":{
            "type":"integer",
            "description":"The unique identifier of the element version of the task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":"240",
            "type":"string",
            "description":"The telephone number of the projects user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of projects user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskFollowerId":{
            "type":"integer",
            "description":"The unique identifier of the task follower.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

The following example shows how to get all project tasks assigned to the user 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/ProjectTasks

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": "PJT 2.0",
  "ProjElementId": 300100025840853,
  "ObjectType": "PJF_TASKS",
  "ElementType": "EXECUTION",
  "ExecutionDisplaySequence": 600000,
  "ElementVersionId": 300100025840851,
  "ProjectId": 300100025840829,
  "TaskActualFinishDate": "2012-01-06",
  "TaskActualStartDate": "2012-01-01",
  "TaskPlannedFinishDate": "2012-01-06",
  "TaskPlannedStartDate": "2012-01-01",
  "TaskPriority": null,
  "TaskPercentComplete": 100,
  "ProjectName": "PJT Project 01",
  "TaskDescription": null,
  "TaskProposedFinishDate": "2012-01-06",
  "TaskProposedStartDate": "2012-01-01",
  "TaskProgressStatus": "Complete",
  "TaskQuantity": 40,
  "TaskProposedQuantity": 40,
  "TaskRemainingQuantity": 0,
  "TaskResourceAllocationPercent": 100,
  "ProjectStatusName": "Approved",
  "ProjectStatusCode": "APPROVED",
  "ProjectSystemStatusCode": "ACTIVE",
  "PlanVersionId": 300100025840834,
  "TaskPrimaryResourceId": 300100024326655,
  "TaskProgressStatusCode": "COMPLETE",
  "TaskProgressEnteredDate": "2017-01-05",
  "ParentTaskName": "PJT Project 01",
  "MilestoneFlag": false,
  "TaskExceptions": null,
  "TaskId": 300100025840853,
  "TaskActualQuantity": 40,
  "TaskCurrentActualQuantity": 40,
  "TaskCurrentFinishDate": "2012-01-06",
  "TaskCurrentStartDate": "2012-01-01",
  "LastUpdatedBy": "Connor.Horton",
  "LastUpdateDate": "2017-01-05T16:02:05-08:00",
  "CreatedBy": "Mark.Taylor",
  "CreationDate": "2013-08-20T03:25:07-08:00",
  "links": [
    ...
]
}

Back to Top