Get a project task
get
/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
TasksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Tasks resource and used to uniquely identify an instance of Tasks. The client should not generate the hash key value. Instead, the client should query on the Tasks collection resource in order to navigate to a specific instance of Tasks to get the hash key.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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:
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 : projects-Tasks-item-response
Type:
Show Source
object
-
ActualQuantity: number
Title:
Project Plan Actual Hours
Read Only:true
Default Value:0
Actual effort spent on the project task. -
AllowCrossChargeTransactionsFlag: boolean
Maximum Length:
1
Indicates if the task can accept charges from other business units. -
BaselineAllocation: number
Read Only:
true
Original planned allocation of the task in the primary work plan baseline. -
BaselineDuration: number
Read Only:
true
Original planned duration of the task in the primary work plan baseline. -
BaselineFinishDate: string
(date)
Read Only:
true
Original planned finish date of the task in the primary work plan baseline. -
BaselineQuantity: number
Read Only:
true
Original planned effort of the task in the primary work plan baseline. -
BaselineStartDate: string
(date)
Read Only:
true
Original planned start date of the task in the primary work plan baseline. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates that transactions charged to that task can be billed to customers. -
BurdenSchedule: string
Title:
Burden Schedule
Maximum Length:30
Name of the burden schedule associated with the task. A burden schedule is a set of burden multipliers that is maintained for use across projects. Also referred to as a standard burden schedule. -
CapitalizableFlag: boolean
Title:
Capitalizable
Maximum Length:1
Specifies if the project task is capitalizable. A value of true means that the task is capitalizable and a value of false means that the task is not capitalizable. The default value is false for a summary task belonging to a noncapital project. The default value is true for a summary task belonging to a capital project. For a subtask belonging to a capital project, the default value is the corresponding value of the parent task. -
ChargeableFlag: boolean
Title:
Chargeable
Maximum Length:1
Indicates that something is eligible to be charged to a task. -
ConstraintDate: string
(date)
Title:
Constraint Date
The date when a task must start or complete based on the constraint type for the task. -
ConstraintType: string
Title:
Constraint Type
Maximum Length:30
The type of scheduling constraint applied on the task. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
A task that must be completed on schedule or it will impact the finish date of the entire project. -
CrossChargeLaborFlag: boolean
Maximum Length:
1
Indicates that the task will allow processing of cross-charge transactions between business units for labor costs. -
CrossChargeNonLaborFlag: boolean
Maximum Length:
1
Indicates that the task will allow processing of cross-charge transactions between business units for nonlabor costs. -
CurrentFinishDate: string
(date)
Title:
Current Finish Date
Read Only:true
The date when the task is estimated to end. -
CurrentQuantity: number
Title:
Actual Hours
Read Only:true
Total estimated effort on the task at completion. -
CurrentStartDate: string
(date)
Title:
Current Start Date
Read Only:true
The date when the task is estimated to start. -
ElementType: string
Maximum Length:
30
Title for the exposed attribute for element type task attributes in OTBI. -
ExecutionDisplaySequence: integer
(int64)
Title:
Display Sequence
Read Only:true
The order in which the task is displayed in the project. -
ExpenseResourceAssignments: array
Expense Resource Assignments
Title:
Expense Resource Assignments
An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task. -
ExternalParentTaskId: string
Title:
External Parent Task ID
Maximum Length:100
Unique identifier of the parent project task that is created in the third-party application. -
ExternalTaskId: string
Title:
External Task ID
Maximum Length:100
Unique identifier of the project task that is created in the third-party application. -
LaborResourceAssignments: array
Labor Resource Assignments
Title:
Labor Resource Assignments
An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as labor resource for a project task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowestLevelTask: string
Title:
Lowest Level Task
Read Only:true
Maximum Length:1
Default Value:Y
Indicates the task is at the lowest level. -
ManualSchedule: string
Maximum Length:
1
The schedule mode where you need to schedule the task manually and can???t update it automatically using the scheduling process. -
MilestoneFlag: boolean
Title:
Milestone Indicator
Maximum Length:1
Indicates the project milestone during which the task must be completed. -
ParentTaskId: integer
(int64)
Title:
Parent Task ID
Read Only:true
Identifier of the parent task of the task. -
ProgressStatusCode: string
Maximum Length:
20
The status of work completed on the task. Valid values are NOT_STARTED, IN_PROGRESS, and COMPLETED. -
ReceiveIntercompanyAndInterprojectInvoicesFlag: boolean
Title:
Receive Intercompany and Interproject Invoices
Maximum Length:1
Indicates if the task can receive invoices from other projects and organizations. A value of true means that the task can be included on intercompany and interproject invoices and a value of false means that the task cannot be included on intercompany and interproject invoices. The default value is false. -
RemainingQuantity: number
Title:
Project Plan Remaining Hours
Read Only:true
Effort remaining on the project task. -
RequirementCode: string
Title:
Requirement Code
The unique code corresponding to a requirement. -
RequirementName: string
Title:
Requirement Name
The name of the requirement. -
ServiceType: string
Title:
Service Type
Maximum Length:80
Specifies an activity assigned to the project task for tracking purposes. You can enter a value either for this attribute or Service Type Code but not both while creating or updating a project task. A list of valid values is defined in the lookup type PJF_SERVICE_TYPE. The default value is derived from the project to which the task belongs. -
ServiceTypeCode: string
Title:
Service Type Code
Maximum Length:30
Code that specifies an activity assigned to the project task for tracking purposes. You can enter a value either for this attribute or Service Type but not both while creating or updating a project task. A list of valid values is defined in the lookup type PJF_SERVICE_TYPE. The default value is derived from the project to which the task belongs. -
SourceApplication: string
Maximum Length:
30
The external application from which the task is imported. -
SourceReference: string
Maximum Length:
100
Identifier of the task in the external system where it was originally entered. -
Sprint: string
Title:
Sprint
The sprint in which the task was completed or is estimated to be completed. You can configure the valid values during application set up. -
TaskActualFinishDate: string
(date)
Title:
Actual Finish Date
The actual finish date for the task as opposed to a planned finish date for the task. -
TaskActualStartDate: string
(date)
Title:
Actual Start Date
The date that work commenced on a task as opposed to the planned start date for the task. -
TaskCode01Id: integer
(int64)
Title:
List of Values Task Code 1
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode02Id: integer
(int64)
Title:
List of Values Task Code 2
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode03Id: integer
(int64)
Title:
List of Values Task Code 3
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode04Id: integer
(int64)
Title:
List of Values Task Code 4
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode05Id: integer
(int64)
Title:
List of Values Task Code 5
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode06Id: integer
(int64)
Title:
List of Values Task Code 6
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode07Id: integer
(int64)
Title:
List of Values Task Code 7
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode08Id: integer
(int64)
Title:
List of Values Task Code 8
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode09Id: integer
(int64)
Title:
List of Values Task Code 9
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode10Id: integer
(int64)
Title:
List of Values Task Code 10
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode11Id: integer
(int64)
Title:
List of Values Task Code 11
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode12Id: integer
(int64)
Title:
List of Values Task Code 12
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode13Id: integer
(int64)
Title:
List of Values Task Code 13
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode14Id: integer
(int64)
Title:
List of Values Task Code 14
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode15Id: integer
(int64)
Title:
List of Values Task Code 15
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode16Id: integer
(int64)
Title:
List of Values Task Code 16
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode17Id: integer
(int64)
Title:
List of Values Task Code 17
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode18Id: integer
(int64)
Title:
List of Values Task Code 18
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode19Id: integer
(int64)
Title:
List of Values Task Code 19
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode20Id: integer
(int64)
Title:
List of Values Task Code 20
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode21Id: integer
(int64)
Title:
List of Values Task Code 21
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode22Id: integer
(int64)
Title:
List of Values Task Code 22
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode23Id: integer
(int64)
Title:
List of Values Task Code 23
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode24Id: integer
(int64)
Title:
List of Values Task Code 24
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode25Id: integer
(int64)
Title:
List of Values Task Code 25
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode26Id: integer
(int64)
Title:
List of Values Task Code 26
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode27Id: integer
(int64)
Title:
List of Values Task Code 27
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode28Id: integer
(int64)
Title:
List of Values Task Code 28
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode29Id: integer
(int64)
Title:
List of Values Task Code 29
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode30Id: integer
(int64)
Title:
List of Values Task Code 30
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode31Id: integer
(int64)
Title:
List of Values Task Code 31
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode32Id: integer
(int64)
Title:
List of Values Task Code 32
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode33Id: integer
(int64)
Title:
List of Values Task Code 33
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode34Id: integer
(int64)
Title:
List of Values Task Code 34
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode35Id: integer
(int64)
Title:
List of Values Task Code 35
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode36Id: integer
(int64)
Title:
List of Values Task Code 36
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode37Id: integer
(int64)
Title:
List of Values Task Code 37
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode38Id: integer
(int64)
Title:
List of Values Task Code 38
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode39Id: integer
(int64)
Title:
List of Values Task Code 39
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskCode40Id: integer
(int64)
Title:
List of Values Task Code 40
Task code defined during implementation that provides a list of values to capture additional information for a project task. -
TaskDescription: string
Title:
Task Description
Maximum Length:2000
Text description of the project task that is being created. -
TaskDuration: number
Title:
Task Duration
Length of time within which the project task is scheduled to be completed. -
TaskFinishDate: string
(date)
Title:
Task Finish Date
Scheduled end date of the project task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the project task. -
TaskLevel: integer
(int32)
Title:
Task Level
Read Only:true
Indicates level of the task in the WBS. -
TaskManagerEmail: string
Title:
Task Manager Email
Maximum Length:240
Email of the person who is assigned as task manager to the task. -
TaskManagerName: string
Title:
Task Manager
Maximum Length:240
The resource who manages the task. -
TaskManagerPersonId: integer
(int64)
Title:
Task Manager ID
Unique identifier of the person who leads the project task and who has the authority and responsibility for meeting the task objectives. -
TaskName: string
Title:
Task Name
Maximum Length:255
The name of the task. A task is a subdivision of the project work. Each project can have a set of top tasks and a hierarchy of subtasks below each top task. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The number of a task. -
TaskNumberAttr01: number
Title:
Numeric Task Code 1
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr02: number
Title:
Numeric Task Code 2
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr03: number
Title:
Numeric Task Code 3
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr04: number
Title:
Numeric Task Code 4
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr05: number
Title:
Numeric Task Code 5
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr06: number
Title:
Numeric Task Code 6
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr07: number
Title:
Numeric Task Code 7
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr08: number
Title:
Numeric Task Code 8
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr09: number
Title:
Numeric Task Code 9
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskNumberAttr10: number
Title:
Numeric Task Code 10
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task. -
TaskOrganizationId: integer
(int64)
Title:
Organization
Unique identifier of the task organization. -
TaskOrganizationName: string
Title:
Organization
Maximum Length:240
The name of the task organzation. -
TaskPercentComplete: number
Title:
Percent Complete
Default Value:0
Percentage of work completed for a task. -
TaskPhysicalPercentComplete: number
Title:
Physical Percent Complete
Default Value:0
The amount of physical work achieved on a task. -
TaskPriority: number
Title:
Task Priority
Indicates the importance of a project task based on a predefined scale. -
TaskQuantity: number
Title:
Task Quantity
Measure of the effort required to complete the project task. -
TaskResourceAllocationPercent: number
Title:
Resource Allocation Percentage
Percentage of hours that a resource is allocated to the project task for a specified duration. -
TasksDFF: array
Tasks Descriptive Flexfields
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks. -
TaskSequence: integer
(int64)
Title:
Task Sequence
Read Only:true
Position of the project task in a hierarchical arrangement. -
TaskStartDate: string
(date)
Title:
Task Start Date
Scheduled start date of the project task. -
TaskTextAttr01: string
Title:
Text Task Code 1
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr02: string
Title:
Text Task Code 2
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr03: string
Title:
Text Task Code 3
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr04: string
Title:
Text Task Code 4
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr05: string
Title:
Text Task Code 5
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr06: string
Title:
Text Task Code 6
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr07: string
Title:
Text Task Code 7
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr08: string
Title:
Text Task Code 8
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr09: string
Title:
Text Task Code 9
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr10: string
Title:
Text Task Code 10
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr11: string
Title:
Text Task Code 11
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr12: string
Title:
Text Task Code 12
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr13: string
Title:
Text Task Code 13
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr14: string
Title:
Text Task Code 14
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr15: string
Title:
Text Task Code 15
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr16: string
Title:
Text Task Code 16
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr17: string
Title:
Text Task Code 17
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr18: string
Title:
Text Task Code 18
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr19: string
Title:
Text Task Code 19
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTextAttr20: string
Title:
Text Task Code 20
Maximum Length:200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TaskTransactionControls: array
Task Transaction Controls
Title:
Task Transaction Controls
The Task Transaction Control resource is used to view, create, update, and delete a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task. -
TopTaskId: integer
(int64)
Title:
Top Task ID
Read Only:true
Identifier of the top task to which the task rolls up. If the task is a top task, the identifier of the top task is same as the identifier of the task. -
TransactionCompletionDate: string
(date)
Title:
Transaction Finish Date
Transaction finish date of a task. -
TransactionControlFlag: boolean
Title:
Transaction Control
Maximum Length:1
Type of transaction controls, inclusive or exclusive, defined for the selected task. A value of true means inclusive and a value of false means exclusive. -
TransactionStartDate: string
(date)
Title:
Transaction Start Date
Transaction start date of a task. -
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. You can enter a value for either this attribute or Work Type ID but not both while creating a project task. The work type must be active within the planned task dates. The default value is derived from the project type or the project to which the task belongs. -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. You can enter a value for either this attribute or Work Type ID but not both while creating a project task. The work type must be active within the planned task dates. The default value is derived from the project type or the project to which the task belongs.
Nested Schema : Expense Resource Assignments
Type:
array
Title:
Expense Resource Assignments
An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task.
Show Source
Nested Schema : Labor Resource Assignments
Type:
array
Title:
Labor Resource Assignments
An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as 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 : Tasks Descriptive Flexfields
Type:
array
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks.
Show Source
Nested Schema : Task Transaction Controls
Type:
array
Title:
Task Transaction Controls
The Task Transaction Control resource is used to view, create, update, and delete a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task.
Show Source
Nested Schema : projects-Tasks-ExpenseResourceAssignments-item-response
Type:
Show Source
object
-
ExpenseResourceActualAmount: number
Title:
Actual Amount
Default Value:0
Specifies the actual expense cost amount of a specific expense resource assigned to the task. -
ExpenseResourceAssignmentId: integer
(int64)
Title:
Expense Resource Assignment ID
Unique identifier of the expense resource assignment to the project task. -
ExpenseResourceId: integer
(int64)
Title:
Expense Resource ID
Identifier of the expense resource assigned to the project task. -
ExpenseResourceName: string
Name of the expense resource assigned to the project task.
-
ExpenseResourcePlannedAmount: number
Title:
Planned Expense Amount
Default Value:0
Specifies the planned expense cost amount of a specific expense resource assigned to the task. -
ExpenseResourceRemainingAmount: number
Title:
Remaining Amount
Default Value:0
The sum of remaining expense cost amounts of a specific expense resource assigned to the task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Title:
Task ID
Identifier of the task to which the expense resource is assigned.
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 : projects-Tasks-LaborResourceAssignments-item-response
Type:
Show Source
object
-
LaborBilledAmount: number
Title:
Planned Labor Bill Amount
Specifies the labor bill amount of the task. -
LaborCostAmount: number
Title:
Labor Cost
Specifies the labor cost of the task. -
LaborPrimaryResource: string
Title:
Primary Labor Resource ID
Indicates that the resource is the primary labor resource for the project task. -
LaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the project task. -
LaborResourceEmail: string
Title:
Resource Email
E-mail address of the labor resource assigned to the task. Required if the resource type is Labor. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. -
LaborResourceName: string
Title:
Labor Resource Name
Name of the labor resource assigned to the project task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
ProjElementId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. -
ResourceAllocationPercent: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projects-Tasks-TasksDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Code that identifies the context for the segments of the project tasks. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Name of the context for the segments of the project tasks. -
ElementType: string
Maximum Length:
30
Internal attribute that indicates the nature of the project task, whether financial, execution, or both. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectType: string
Maximum Length:
30
Default Value:PJF_TASKS
Internal attribute that indicates the basis of the project task. -
ProjElementId: integer
(int64)
The identifier of the project task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projects-Tasks-TaskTransactionControls-item-response
Type:
Show Source
object
-
Billable: string
Title:
Billable Code
Maximum Length:1
Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T. -
BillableHint: string
Title:
Billable
Maximum Length:80
Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task. -
Capitalizable: string
Title:
Capitalizable Code
Maximum Length:1
Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T. -
CapitalizableHint: string
Title:
Capitalizable
Maximum Length:80
Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task. -
Chargeable: string
Title:
Chargeable Code
Maximum Length:1
Indicates that something is eligible to be charged to the task. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N. -
ChargeableHint: string
Title:
Chargeable
Maximum Length:80
Indicates that something is eligible to be charged to the task. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No. -
EmailAddress: string
Title:
Email
Maximum Length:240
Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes. -
EndDateActive: string
(date)
Title:
To Date
The date after which the transaction control is no longer effective. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category ID
Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them. -
ExpenditureCategoryName: string
Title:
Expenditure Category
Maximum Length:240
A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type ID
Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them. -
ExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them. -
Job: string
Title:
Job
Maximum Length:240
The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
JobId: integer
(int64)
Title:
Job ID
Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonLaborResourceId: integer
(int64)
Title:
Nonlabor Resource ID
Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them. -
NonLaborResourceName: string
Title:
Nonlabor Resource
Maximum Length:240
An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them. -
Organization: string
Title:
Organization
Maximum Length:240
The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
OrganizationId: integer
(int64)
Title:
Organization ID
Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute. -
PersonId: integer
(int64)
Title:
Person ID
Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes. -
PersonName: string
Title:
Person Name
Maximum Length:240
The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes. -
PersonType: string
Title:
Person Type Code
Maximum Length:20
Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type or both of them. -
PersonTypeHint: string
Title:
Person Type
Maximum Length:80
The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type Code or both of them. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Identifier of the project. Default value is the identifier of the project for which the transaction control is created. -
RuleNumber: integer
(int64)
Title:
Rule Number
Read Only:true
Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number. -
StartDateActive: string
(date)
Title:
From Date
The date from which the transaction control is effective. Default value is the system date. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
Identifier of the project task. Default value is the identifier of the project task for which the transaction control is created. -
TransactionControlId: integer
(int64)
Title:
Transaction Control ID
Read Only:true
Identifier of the transaction control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ExpenseResourceAssignments
-
Parameters:
- ProjectId:
$request.path.ProjectId
- TasksUniqID:
$request.path.TasksUniqID
An object that includes the attributes that are used to store values while creating or updating expense resource assignments for a project task. For example, hotel expenses can be planned on a project task. - ProjectId:
- LaborResourceAssignments
-
Parameters:
- ProjectId:
$request.path.ProjectId
- TasksUniqID:
$request.path.TasksUniqID
An object that includes the attributes that are used to store values while creating or updating labor resource assignments for a project task. For example, a DBA can be assigned as labor resource for a project task. - ProjectId:
- TaskTransactionControls
-
Parameters:
- ProjectId:
$request.path.ProjectId
- TasksUniqID:
$request.path.TasksUniqID
The Task Transaction Control resource is used to view, create, update, and delete a task transaction control. Task transaction controls are a set of criteria that control whether a transaction can be charged to a task. - ProjectId:
- TasksDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TasksDFFParameters:
- ProjectId:
$request.path.ProjectId
- TasksUniqID:
$request.path.TasksUniqID
The Tasks Descriptive Flexfields resource is used to view, create, and update additional information for project tasks. - ProjectId:
Examples
The following example shows how to get a project task by submitting a GET request on the REST resource using cURL. Keep in mind that the URL contains the hash key.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projects/300100071398882/child/Tasks/00040000000EACED00057708000110F084EAC9590000000EACED00057708000110F084EAC9580000000EACED00057708000110F084EAC95AFFFFFFFF
Response Body Example
The following shows an example of the response body in JSON format.
{ "BillableFlag": true "ChargeableFlag": false "CriticalFlag": null "ElementType": "FINANCIAL" "ExternalParentTaskId": null "ExternalTaskId": "1.0" "MilestoneFlag": null "TaskActualFinishDate": null "TaskActualStartDate": null ... "TaskFinishDate": "2015-10-10" "TaskId": 100100040358534 "TaskManagerEmail": null "TaskManagerName": null "TaskManagerPersonId": null "TaskName": "Planning" ... "TaskPercentComplete": 0 "TaskPhysicalPercentComplete": 0 "TaskPriority": null "TaskQuantity": null "TaskResourceAllocationPercent": null "TaskSequence": null "TaskStartDate": "2015-09-10" ... -"links": [5] -0: { "rel": "self" ... } }