Get all tasks
get
/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/Tasks
Request
Path Parameters
-
WorkPlanTemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 the task with the specified primary key.
Finder Variables- TaskId; integer; Unique identifier of the task.
- findByTaskId Finds the task with the specified task ID.
Finder Variables- TaskId; integer; Unique identifier of the task.
- findByTaskNumber Finds the task with the specified task number.
Finder Variables- TaskNumber; string; Unique identifier of the task.
- PrimaryKey Finds the task with the specified primary key.
-
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:- Allocation; number; The percentage of resource's hours allocated to the task for the task duration.
- BillableFlag; boolean; Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable.
- ChargeableFlag; boolean; Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable.
- CreatedBy; string; The user who created the task.
- CreationDate; string; The date when the task was created.
- Description; string; Text description of the task.
- DisplaySequence; integer; For internal use. The order in which the task is displayed.
- Duration; number; The planned duration of the task.
- Effort; number; The estimated effort, in hours, required to complete a task.
- ElementType; string; Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL.
- ExpenseAmount; number; The planned expense amount for the task.
- GateFlag; boolean; Indicates whether the task is a gate.
- LaborBillAmount; number; The planned bill amount for all the labor resources associated with the task.
- LaborCost; number; The planned cost amount for all the labor resources associated with the task.
- LeafIndicator; string; Indicates whether the task is a lowest-level task.
- ManualScheduleFlag; boolean; Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process.
- MilestoneFlag; boolean; Indicates whether the task is a milestone.
- Name; string; Name of the task.
- NumberAttr01; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr02; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr03; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr04; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr05; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr06; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr07; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr08; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr09; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- NumberAttr10; number; Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
- ParentTaskId; integer; Identifier of the parent task of the task.
- PeerReferenceTaskId; integer; Unique identifier of the peer task.
- PrimaryResourceEmail; string; Email of the person who leads the task.
- PrimaryResourceName; string; Name of the resource who leads the work on a task.
- Priority; number; Priority of the task for the assigned resource.
- ScheduleTypeCode; string; Schedule type of the task. Valid values are fixed effort and fixed duration.
- TaskCode01Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode02Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode03Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode04Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode05Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode06Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode07Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode08Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode09Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode10Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode11Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode12Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode13Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode14Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode15Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode16Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode17Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode18Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode19Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode20Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode21Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode22Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode23Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode24Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode25Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode26Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode27Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode28Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode29Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode30Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode31Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode32Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode33Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode34Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode35Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode36Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode37Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode38Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode39Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskCode40Id; integer; Task code defined during implementation that provides a list of values to capture additional information for a task.
- TaskId; integer; Unique identifier of the task.
- TaskLevel; integer; Indicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0.
- TaskNumber; string; The number assigned to a task. It's used to uniquely identify a task.
- TextAttr01; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr02; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr03; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr04; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr05; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr06; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr07; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr08; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr09; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr10; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr11; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr12; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr13; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr14; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr15; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr16; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr17; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr18; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr19; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TextAttr20; string; Task code defined during implementation that provides free-form text entry to capture additional information for a task.
- TotalCost; number; The total cost of the task. It's the sum of expense and labor costs.
- WorkType; string; Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date.
- WorkTypeId; integer; Unique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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 : workPlanTemplates-Tasks
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-Tasks-item-response
Type:
Show Source
object-
Allocation: number
Title:
Allocation PercentageThe percentage of resource's hours allocated to the task for the task duration. -
BillableFlag: boolean
Title:
BillableMaximum Length:1Indicates whether the transactions charged to the task can be billed to customers. Only the lowest-level financial tasks can be billable. -
ChargeableFlag: boolean
Title:
ChargeableMaximum Length:1Indicates whether transactions can be charged to the task. Only the lowest-level financial tasks can be chargeable. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the task. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the task was created. -
Description: string
Title:
Task DescriptionMaximum Length:2000Text description of the task. -
DisplaySequence: integer
(int64)
Title:
Display SequenceFor internal use. The order in which the task is displayed. -
Duration: number
Title:
Planned DurationThe planned duration of the task. -
Effort: number
Title:
Planned Effort in HoursThe estimated effort, in hours, required to complete a task. -
ElementType: string
Title:
Task Element TypeMaximum Length:30Default Value:EXECUTIONIndicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL. -
ExpenseAmount: number
Title:
Planned Expense AmountDefault Value:0The planned expense amount for the task. -
GateApprovers: array
Gate Approvers
Title:
Gate ApproversThe Gate Approvers resource is used to view gate approver details. -
GateFlag: boolean
Title:
GateMaximum Length:1Default Value:falseIndicates whether the task is a gate. -
LaborBillAmount: number
Title:
Planned Labor Bill AmountThe planned bill amount for all the labor resources associated with the task. -
LaborCost: number
Title:
Planned Labor CostThe planned cost amount for all the labor resources associated with the task. -
LeafIndicator: string
Title:
Leaf IndicatorMaximum Length:1Default Value:YIndicates whether the task is a lowest-level task. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualScheduleFlag: boolean
Title:
Manual ScheduleMaximum Length:1Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process. -
MilestoneFlag: boolean
Title:
MilestoneMaximum Length:1Default Value:falseIndicates whether the task is a milestone. -
Name: string
Title:
Task NameMaximum Length:255Name of the task. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a task.
-
ParentTaskId: integer
(int64)
Title:
Parent Task IDIdentifier of the parent task of the task. -
PeerReferenceTaskId: integer
Title:
Peer Reference Task IDUnique identifier of the peer task. -
PrimaryResourceEmail: string
Title:
Primary Resource EmailRead Only:trueMaximum Length:240Email of the person who leads the task. -
PrimaryResourceName: string
Title:
Primary Resource NameRead Only:trueMaximum Length:240Name of the resource who leads the work on a task. -
Priority: number
Title:
PriorityPriority of the task for the assigned resource. -
ScheduleTypeCode: string
Title:
Task Schedule Type CodeMaximum Length:30Schedule type of the task. Valid values are fixed effort and fixed duration. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a task.
-
TaskDFF: array
TaskDFF
-
TaskId: integer
(int64)
Title:
Task IDUnique identifier of the task. -
TaskLevel: integer
(int32)
Title:
Task LevelIndicates the level of the task in the hierarchy. The level of the task that holds the rollup values of the project is 0. -
TaskNumber: string
Title:
Task NumberMaximum Length:100The number assigned to a task. It's used to uniquely identify a task. -
TextAttr01: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr02: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr03: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr04: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr05: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr06: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr07: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr08: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr09: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr10: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr11: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr12: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr13: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr14: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr15: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr16: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr17: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr18: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr19: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TextAttr20: string
Maximum Length:
200Task code defined during implementation that provides free-form text entry to capture additional information for a task. -
TotalCost: number
Title:
Total CostThe total cost of the task. It's the sum of expense and labor costs. -
WorkType: string
Title:
Work TypeMaximum Length:240Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date. -
WorkTypeId: integer
(int64)
Title:
Work Type IDUnique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.
Nested Schema : Gate Approvers
Type:
arrayTitle:
Gate ApproversThe Gate Approvers resource is used to view gate approver details.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workPlanTemplates-Tasks-GateApprovers-item-response
Type:
Show Source
object-
ApprovalId: integer
(int64)
Title:
Approval IDRead Only:trueUnique identifier of the Gate Approver. Value is auto-generated. -
GateApproverEmail: string
Title:
Gate Approver EmailEmail address of the gate approver. -
GateApproverId: integer
(int64)
Title:
Gate Approver IDUnique identifier of the gate approver. -
GateApproverName: string
Title:
Gate Approver NameName of the gate approver. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : workPlanTemplates-Tasks-TaskDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all tasks by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization:port/projectsFinancialsApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks
Response Body Example
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"BillableFlag": null,
"ChargeableFlag": null,
"Description": null,
"DisplaySequence": 0,
"ElementType": "FIN_EXEC",
"GateFlag": false,
"ManualScheduleFlag": false,
"MilestoneFlag": false,
"Name": "Test - WPT",
"ParentTaskId": null,
"Allocation": null,
"Duration": 2,
"Effort": 0,
"PrimaryResourceEmail": "prj_connor_horton_grp@oracle.com",
"PrimaryResourceName": "Connor Horton",
"TaskId": 100100148369455,
"TaskLevel": 0,
"TaskNumber": "0",
"NumberAttr01": null,
"NumberAttr02": null,
"NumberAttr03": null,
"NumberAttr04": null,
"NumberAttr05": null,
"NumberAttr06": null,
"NumberAttr07": null,
"NumberAttr08": null,
"NumberAttr09": null,
"NumberAttr10": null,
"TaskCode01Id": null,
"TaskCode02Id": null,
"TaskCode03Id": null,
"TaskCode04Id": null,
"TaskCode05Id": null,
"TaskCode06Id": null,
"TaskCode07Id": null,
"TaskCode08Id": null,
"TaskCode09Id": null,
"TaskCode10Id": null,
"TaskCode11Id": null,
"TaskCode12Id": null,
"TaskCode13Id": null,
"TaskCode14Id": null,
"TaskCode15Id": null,
"TaskCode16Id": null,
"TaskCode17Id": null,
"TaskCode18Id": null,
"TaskCode19Id": null,
"TaskCode20Id": null,
"TaskCode21Id": null,
"TaskCode22Id": null,
"TaskCode23Id": null,
"TaskCode24Id": null,
"TaskCode25Id": null,
"TaskCode26Id": null,
"TaskCode27Id": null,
"TaskCode28Id": null,
"TaskCode29Id": null,
"TaskCode30Id": null,
"TaskCode31Id": null,
"TaskCode32Id": null,
"TaskCode33Id": null,
"TaskCode34Id": null,
"TaskCode35Id": null,
"TaskCode36Id": null,
"TaskCode37Id": null,
"TaskCode38Id": null,
"TaskCode39Id": null,
"TaskCode40Id": null,
"TextAttr01": null,
"TextAttr02": null,
"TextAttr03": null,
"TextAttr04": null,
"TextAttr05": null,
"TextAttr06": null,
"TextAttr07": null,
"TextAttr08": null,
"TextAttr09": null,
"TextAttr10": null,
"TextAttr11": null,
"TextAttr12": null,
"TextAttr13": null,
"TextAttr14": null,
"TextAttr15": null,
"TextAttr16": null,
"TextAttr17": null,
"TextAttr18": null,
"TextAttr19": null,
"TextAttr20": null,
"LaborCost": 0,
"LaborBillAmount": 0,
"ExpenseAmount": 1500,
"TotalCost": 1500,
"Priority": null,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369455",
"name": "Tasks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000017371007E0002000000117372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369455",
"name": "Tasks",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454",
"name": "workPlanTemplates",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369455/child/GateApprovers",
"name": "GateApprovers",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369455/child/TaskDFF",
"name": "TaskDFF",
"kind": "collection"
}
]
}...
],
"count": 5,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks",
"name": "Tasks",
"kind": "collection"
}
]
}