Get all projects that I manage
get
/fscmRestApi/resources/11.13.18.05/projectPlans
Request
Query Parameters
-
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 project that matches the primary key criteria specified.
Finder Variables:- ProjectId; integer; Unique identifier of the project.
- findByProjectId: Finds the project with the specified project ID.
Finder Variables:- ProjectId; integer; Unique identifier of the project.
- PrimaryKey: Finds the project that matches the primary key criteria specified.
-
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:- CalendarId; integer; Unique identifier of the calendar associated to the project.
- CreationDate; string; Date when the row of data was created.
- CurrencyCode; string; The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.
- Description; string; A description about the project. This might include high-level information about the work being performed.
- EndDate; string; The date that work or information tracking completes for a project.
- FinanciallyEnabledFlag; boolean; Indicates whether the project is enabled for financial management. If the value is True, the project is enabled for financial management. The value is False when the project is not enabled for financial management.
- Name; string; Name of the project.
- NumberAttr01; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr02; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr03; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr04; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr05; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr06; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr07; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr08; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr09; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- NumberAttr10; number; Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
- OrganizationId; integer; Unique identifier of the organization that owns the project.
- PercentComplete; number; Indicates the percentage of work completed for the project.
- PrimaryProjectManagerName; string; Name of the person who leads the project team and who has the authority and responsibility for meeting project objectives.
- ProjectCode01; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode02; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode03; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode04; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode05; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode06; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode07; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode08; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode09; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode10; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode11; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode12; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode13; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode14; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode15; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode16; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode17; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode18; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode19; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode20; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode21; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode22; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode23; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode24; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode25; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode26; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode27; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode28; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode29; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode30; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode31; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode32; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode33; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode34; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode35; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode36; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode37; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode38; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode39; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectCode40; integer; Project code defined during implementation that provides a list of values to capture additional information for a project.
- ProjectId; integer; Unique identifier of the project.
- ProjectLedgerCurrencyCode; string; Code that identifies the ledger currency of the business unit that owns the project.
- ProjectNumber; string; Number of a project.
- ScheduleTypeCode; string; The schedule type of the project. Valid values are FIXED_EFFORT and FIXED_DURATION.
- StartDate; string; The date that work or information tracking begins on a project.
- Status; string; An implementation-defined classification of the status of a project.
- StatusCode; string; The current status set on a project. A project status is an implementation-defined classification of the status of a project. Typical project status names are Active and Closed.
- SystemStatusCode; string; The underlying system project status code associated to the implementation-defined project status. Valid values are ACTIVE, CLOSED, DRAFT, PENDING_CLOSE, SUBMITTED.
- TextAttr01; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr02; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr03; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr04; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr05; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr06; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr07; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr08; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr09; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr10; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr11; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr12; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr13; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr14; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr15; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr16; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr17; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr18; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr19; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- TextAttr20; string; Project code defined during implementation that provides free-form text entry to capture additional information for a project.
- ViewAccessCode; string; Code that specifies who has view-only access to the project plan in task management. Valid values are: ORA_PJT_PRJ_PLAN_VIEW_ALL to indicate that all users can view the project plan, and ORA_PJT_PRJ_PLAN_VIEW_TEAM to indicate that only the project team and all the participants associated to the Project Hierarchy Element can view the project plan.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPlans
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-item-response
Type:
Show Source
object
-
Baselines: array
Baselines
Title:
Baselines
The Baselines resource is used to view, create, or update the baseline containing key planning information about tasks. Baseline information is usually compared against the current schedule of a project. You can create multiple baselines during the project lifecycle, but only one is the primary baseline. By default the first baseline created is your primary baseline. -
CalendarId: integer
(int64)
Unique identifier of the calendar associated to the project.
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the row of data was created. -
CurrencyCode: string
Title:
Project Currency Code
Maximum Length:15
Default Value:USD
The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency. -
Description: string
Maximum Length:
2000
A description about the project. This might include high-level information about the work being performed. -
EndDate: string
(date)
Title:
Project Finish Date
The date that work or information tracking completes for a project. -
FinanciallyEnabledFlag: boolean
Title:
Enabled for Financial Management
Read Only:true
Indicates whether the project is enabled for financial management. If the value is True, the project is enabled for financial management. The value is False when the project is not enabled for financial management. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Project Name
Maximum Length:240
Name of the project. -
NumberAttr01: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr02: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr03: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr04: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr05: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr06: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr07: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr08: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr09: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
NumberAttr10: number
Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
-
OrganizationId: integer
(int64)
Default Value:
-1
Unique identifier of the organization that owns the project. -
PercentComplete: number
Title:
Project Percent Complete
Read Only:true
Default Value:0
Indicates the percentage of work completed for the project. -
PrimaryProjectManagerName: string
Title:
Primary Project Manager Name
Read Only:true
Maximum Length:240
Name of the person who leads the project team and who has the authority and responsibility for meeting project objectives. -
ProjectCalendars: array
Project Calendars
Title:
Project Calendars
The Project Calendars resource is used to view calendars used in a project which are single workday pattern and single shift. A calendar is used when scheduling a project plan. A project plan can use one project calendar as well as each labor resource can have a different calendar assigned. -
ProjectCode01: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode02: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode03: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode04: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode05: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode06: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode07: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode08: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode09: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode10: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode11: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode12: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode13: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode14: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode15: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode16: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode17: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode18: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode19: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode20: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode21: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode22: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode23: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode24: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode25: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode26: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode27: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode28: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode29: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode30: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode31: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode32: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode33: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode34: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode35: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode36: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode37: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode38: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode39: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectCode40: integer
(int64)
Project code defined during implementation that provides a list of values to capture additional information for a project.
-
ProjectDFF: array
Project Descriptive Flexfields
Title:
Project Descriptive Flexfields
The Project Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a project. -
ProjectId: integer
(int64)
Unique identifier of the project.
-
ProjectLedgerCurrencyCode: string
Read Only:
true
Maximum Length:15
Default Value:USD
Code that identifies the ledger currency of the business unit that owns the project. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of a project. -
ScheduleTypeCode: string
Title:
Project Schedule Type Code
Maximum Length:30
The schedule type of the project. Valid values are FIXED_EFFORT and FIXED_DURATION. -
StartDate: string
(date)
Title:
Project Start Date
The date that work or information tracking begins on a project. -
Status: string
Title:
Project Status
Read Only:true
Maximum Length:80
An implementation-defined classification of the status of a project. -
StatusCode: string
Maximum Length:
30
Default Value:ACTIVE
The current status set on a project. A project status is an implementation-defined classification of the status of a project. Typical project status names are Active and Closed. -
SystemStatusCode: string
Title:
System Project Status Code
Read Only:true
Maximum Length:30
The underlying system project status code associated to the implementation-defined project status. Valid values are ACTIVE, CLOSED, DRAFT, PENDING_CLOSE, SUBMITTED. -
TaskDeliverables: array
Task Deliverables
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a project task. For example, a project task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task. -
TaskDependencies: array
Task Dependencies
Title:
Task Dependencies
The Task Dependency resource is used to view, create, or update dependencies between two tasks in a project. For example, a task that has a Finish-to-start dependency with another task, can start only after the predecessor task is completed. You can have many dependencies for each task. -
TaskExpenseResourceAssignments: array
Task Expense Resource Assignments
Title:
Task Expense Resource Assignments
The Task Expenses resource assignment resource is used to view, create, or update the assignment of an expense resource for a project task. For example, hotel expenses can be planned on a project task. You can have multiple expense resource assignments for each task. -
TaskFinancialActuals: array
Task Financial Actuals
Title:
Task Financial Actuals
The Task Financial Actuals resource is used to view the ITD actual effort and actual burdened cost for a project task. -
TaskLaborResourceAssignments: array
Task Labor Resource Assignments
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view, create, or update the assignment of a labor resource for a project task. For example, a Database Analyst can be assigned as a labor resource for a project task. You can have many labor resource assignments for each task. -
Tasks: array
Tasks
Title:
Tasks
The Tasks resource is used to create or update project tasks and view project task details. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. The resource always returns the rolled up values of all tasks as a task payload item with level 0. -
TaskWorkItems: array
Task Work Items
Title:
Task Work Items
The Task Work Items resource is used to view and delete the association of a work item with a project task. You can also update the task completion criteria. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing. When the work item meets the completion criteria, your project task is automatically marked as complete. -
TextAttr01: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr02: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr03: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr04: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr05: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr06: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr07: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr08: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr09: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr10: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr11: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr12: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr13: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr14: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr15: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr16: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr17: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr18: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr19: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
TextAttr20: string
Maximum Length:
200
Project code defined during implementation that provides free-form text entry to capture additional information for a project. -
ViewAccessCode: string
Maximum Length:
30
Default Value:ORA_PJT_PRJ_PLAN_VIEW_TEAM
Code that specifies who has view-only access to the project plan in task management. Valid values are: ORA_PJT_PRJ_PLAN_VIEW_ALL to indicate that all users can view the project plan, and ORA_PJT_PRJ_PLAN_VIEW_TEAM to indicate that only the project team and all the participants associated to the Project Hierarchy Element can view the project plan.
Nested Schema : Baselines
Type:
array
Title:
Baselines
The Baselines resource is used to view, create, or update the baseline containing key planning information about tasks. Baseline information is usually compared against the current schedule of a project. You can create multiple baselines during the project lifecycle, but only one is the primary baseline. By default the first baseline created is your primary baseline.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Calendars
Type:
array
Title:
Project Calendars
The Project Calendars resource is used to view calendars used in a project which are single workday pattern and single shift. A calendar is used when scheduling a project plan. A project plan can use one project calendar as well as each labor resource can have a different calendar assigned.
Show Source
Nested Schema : Project Descriptive Flexfields
Type:
array
Title:
Project Descriptive Flexfields
The Project Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a project.
Show Source
Nested Schema : Task Deliverables
Type:
array
Title:
Task Deliverables
The Task Deliverables resource is used to view the association of a deliverable with a project task. For example, a project task can have an association with a deliverable draft budget. You can have multiple deliverables associated with each task.
Show Source
Nested Schema : Task Dependencies
Type:
array
Title:
Task Dependencies
The Task Dependency resource is used to view, create, or update dependencies between two tasks in a project. For example, a task that has a Finish-to-start dependency with another task, can start only after the predecessor task is completed. You can have many dependencies for each task.
Show Source
Nested Schema : Task Expense Resource Assignments
Type:
array
Title:
Task Expense Resource Assignments
The Task Expenses resource assignment resource is used to view, create, or update the assignment of an expense resource for a project task. For example, hotel expenses can be planned on a project task. You can have multiple expense resource assignments for each task.
Show Source
Nested Schema : Task Financial Actuals
Type:
array
Title:
Task Financial Actuals
The Task Financial Actuals resource is used to view the ITD actual effort and actual burdened cost for a project task.
Show Source
Nested Schema : Task Labor Resource Assignments
Type:
array
Title:
Task Labor Resource Assignments
The Task Labor resource assignments resource is used to view, create, or update the assignment of a labor resource for a project task. For example, a Database Analyst can be assigned as a labor resource for a project task. You can have many labor resource assignments for each task.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The Tasks resource is used to create or update project tasks and view project task details. Tasks are units of project work assigned or performed as part of the duties of a resource. Tasks can be a portion of project work to be performed within a defined period by a specific resource or multiple resources. The resource always returns the rolled up values of all tasks as a task payload item with level 0.
Show Source
Nested Schema : Task Work Items
Type:
array
Title:
Task Work Items
The Task Work Items resource is used to view and delete the association of a work item with a project task. You can also update the task completion criteria. Work items originate in Oracle Innovation Management, Oracle Product Development, and Oracle Sourcing. When the work item meets the completion criteria, your project task is automatically marked as complete.
Show Source
Nested Schema : projectPlans-Baselines-item-response
Type:
Show Source
object
-
BaselineId: integer
(int64)
Title:
Baseline ID
Read Only:true
Unique identifier of the baseline. Value is auto-generated. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the baseline was taken. Value is defaulted to the current date when the baseline is created. -
Description: string
Title:
Baseline Description
Maximum Length:1000
Description of the baseline. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Baseline Name
Maximum Length:100
Name of the baseline. -
PrimaryFlag: boolean
Title:
Primary Indicator
Maximum Length:1
Default Value:false
Indicates whether the baseline is the primary baseline.
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 : projectPlans-ProjectCalendars-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active Indicator
Read Only:true
Indicates if the calendar is active. -
CalendarExceptions: array
Calendar Exceptions
Title:
Calendar Exceptions
The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions. -
CalendarId: integer
(int64)
Title:
Calendar ID
Read Only:true
Unique identifier of the calendar. -
CalendarName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the calendar. -
CategoryCode: string
Title:
Calendar Category Code
Read Only:true
Maximum Length:30
The category of the use of the calendar. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates the resource who created the row of data. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the row of data was created. -
Description: string
Title:
Calendar Description
Read Only:true
Maximum Length:2000
Description of the calendar. -
EffectiveFromDate: string
(date)
Title:
Effective from Date
Read Only:true
The date for which the calendar starts to be effective. -
EffectiveToDate: string
(date)
Title:
Effective to Date
Read Only:true
The inclusive last date of the effectivity of the calendar. -
FirstDayOfWeek: integer
Title:
First Day of Week for Calendar
Read Only:true
The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2. -
FridayWorkFlag: boolean
Title:
Friday Work Indicator
Read Only:true
Indicates if Fridays workable. True if it is workable, False if it is not. -
HoursPerDay: number
Title:
Hours per Day
Read Only:true
Number of hours used to calculate when one day is entered. Value depends on the number of hours of the shift. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last edited the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MondayWorkFlag: boolean
Title:
Monday Work Indicator
Read Only:true
Indicates if Mondays are workable. True if it is workable, False if it is not. -
QuaterlyTypeCode: string
Title:
Quarterly Type Code
Read Only:true
Maximum Length:30
Indicates the quarter type used for the calendar. -
SaturdayWorkFlag: boolean
Title:
Saturday Work Indicator
Read Only:true
Indicates if Saturdays are workable. True if it is workable, False if it is not. -
SundayWorkFlag: boolean
Title:
Sunday Work Indicator
Read Only:true
Indicates if Sundays are workable. True if it is workable, False if it is not. -
ThursdayWorkFlag: boolean
Title:
Thursday Work Indicator
Read Only:true
Indicates if Thursdays are workable. True if it is workable, False if it is not. -
TuesdayWorkFlag: boolean
Title:
Tuesday Work Indicator
Read Only:true
Indicates if Tuesdays are workable. True if it is workable, False if it is not. -
WednesdayWorkFlag: boolean
Title:
Wednesday Work Indicator
Read Only:true
Indicates if Wednesdays are workable. True if it is workable, False if it is not.
Nested Schema : Calendar Exceptions
Type:
array
Title:
Calendar Exceptions
The Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used for example to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-ProjectCalendars-CalendarExceptions-item-response
Type:
Show Source
object
-
AllDayFlag: boolean
Title:
All Day Exception Indicator
Read Only:true
Maximum Length:1
Default Value:true
Indicates if the calendar exception is for the whole day. -
CategoryCode: string
Title:
Calendar Exception Category Code
Read Only:true
Maximum Length:30
Category code in which the exception falls. -
Code: string
Title:
Calendar Exception Code
Read Only:true
Maximum Length:3
Code to identify the exception. -
Description: string
Title:
Calendar Exception Description
Read Only:true
Maximum Length:2000
Description of the exception. -
EndDate: string
(date-time)
Title:
Calendar Exception End Date
Read Only:true
The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long. -
ExceptionId: integer
(int64)
Title:
Calendar Exception ID
Read Only:true
Unique identifier of the exception in the calendar. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Calendar Exception Name
Read Only:true
Maximum Length:240
Name of the exception. -
PeriodType: string
Title:
Calendar Exception Period Type
Read Only:true
Maximum Length:30
Indicates if the calendar exception is a workable period or not. Valid values are 'OFF_PERIOD' and 'WORK_PERIOD'. -
StartDate: string
(date-time)
Title:
Calendar Exception Start Date
Read Only:true
The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-ProjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Unique identifier of the project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskDeliverables-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The Attachments resource is used to view a deliverable attachment. -
DeliverableDescription: string
Title:
Deliverable Description
Read Only:true
Maximum Length:1000
The description of the deliverable. -
DeliverableId: integer
(int64)
Title:
Deliverable ID
Read Only:true
Identifier of the deliverable associated with the task. -
DeliverableName: string
Title:
Deliverable Name
Read Only:true
Maximum Length:150
Name of the deliverable associated with the task. -
DeliverablePriorityCode: string
Title:
Deliverable Priority Code
Read Only:true
Maximum Length:30
Internal code for the priority assigned to the deliverable. -
DeliverableShortName: string
Title:
Deliverable Short Name
Read Only:true
Maximum Length:30
Short name of the deliverable. -
DeliverableStatusCode: string
Title:
Deliverable Status Code
Read Only:true
Maximum Length:30
Internal code for the status of the deliverable. -
DeliverableTypeId: integer
(int64)
Title:
Deliverable Type Code
Read Only:true
Identifier of the type of the deliverable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date by which the deliverable is expected. -
Owner: integer
(int64)
Title:
Owner
Read Only:true
Identifier of the person who owns the deliverable. -
TaskDeliverableAssociationId: integer
(int64)
Title:
Deliverable Association ID
Unique identifier of the association between task and deliverable. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
Identifier of the task associated with the deliverable.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource is used to view a deliverable attachment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskDeliverables-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Name of the person who originally created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the attachment was originally created. It is automatically populated as the date attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Type of attachment. Values are FILE, WEB_PAGE, or TEXT. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path to the folder where the uploaded file is stored. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error code, if the operation returns an error. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if the operation returns an error. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the file on the file content server. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file if the attachment type is File, or the text itself if the attachment type is File. -
FileUrl: string
Title:
File Url
Location on the file content server of the attached document or text. This is null if the attachment type is URL. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of file uploaded as attachment, such as text, or Excel document. -
UploadedFileLength: integer
Title:
File Size
Size of the file uploaded as attachment. This is null if the attachment type is URL. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment when uploaded. -
UploadedText: string
Title:
Uploaded Text
Type of content in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
Universal resource identifier, which is a unique identifier of the location on the Internet. -
Url: string
Title:
Url
Maximum Length:4000
Universal Resource Locator, if the attachment type is URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Code for the category of the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskDependencies-item-response
Type:
Show Source
object
-
DependencyId: integer
(int64)
Title:
Dependency ID
Read Only:true
Identifier of the dependency that exists between two tasks. Value is auto-generated when using POST and mandatory when using PATCH. -
DependencyType: string
Title:
Dependency Type
Maximum Length:30
Default Value:fs
The type of dependency that exists between project elements. Valid values are fs, if, sash, sf. Default value is fs if not provided when using POST. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
Lag: number
Title:
Lag
Default Value:0
Number of days that exist between project elements before the dependency is activated. Default value is 0 if not provided when using POST. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task ID
Unique identifier of the predecessor project element. Value is mandatory when using POST. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task ID
Unique identifier of the successor project element. Value is mandatory when using POST.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskExpenseResourceAssignments-item-response
Type:
Show Source
object
-
ActualAmount: number
Title:
Expense Resource Actual Amount
Default Value:0
The actual expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST. -
CurrentAmount: number
Title:
Expense Resource Current Amount
The current expense cost amount of a specific expense resource assigned to the task. It is auto-calculated as the sum of Expense Resource Actual Amount plus Expense Resource Remaining Amount. -
ExpenseResourceId: integer
(int64)
Title:
Expense Resource ID
Identifier of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlannedAmount: number
Title:
Expense Resource Planned Amount
Default Value:0
The planned expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST. -
RemainingAmount: number
Title:
Expense Resource Remaining Amount
Default Value:0
The remaining expense cost amount of a specific expense resource assigned to the task. Default value is 0 when using POST. -
ResourceName: string
Title:
Expense Resource Name
Maximum Length:240
Name of the expense resource assigned to the project task. You must enter either the Expense Resource Name or the Expense Resource ID when using POST or PATCH, but not both. -
TaskExpenseResourceAssignmentId: integer
(int64)
Title:
Expense Resource Assignment ID
Read Only:true
Unique identifier of the expense resource assignment to the project task. Value is auto-generated when using POST and mandatory when using PATCH. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the expense resource is assigned. Value is mandatory when using POST and must refer to a task that already exists in the project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskFinancialActuals-item-response
Type:
Show Source
object
-
ITDActualBurdenedCostInProjectCurrency: number
Read Only:
true
Actual burdended cost incurred for the project task in project currency from the start date of the task till the current date. -
ITDActualBurdenedCostInProjectLedgerCurrency: number
Read Only:
true
Actual burdended cost incurred for the project task in project ledger currency from the start date of the task till the current date. -
ITDActualEffort: number
Read Only:
true
Actual effort for the project task from the start of the task till the current date, expressed in hours. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaskId: integer
(int64)
Read Only:
true
The unique identifier of the task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskLaborResourceAssignments-item-response
Type:
Show Source
object
-
ActualBillAmount: number
Title:
Actual Labor Resource Bill Amount
The actual bill amount for the labor resource associated with the task. -
ActualCostAmount: number
Title:
Actual Labor Resource Cost Amount
The actual cost amount for the labor resource associated with the task. -
ActualEffortinHours: number
Title:
Actual Labor Resource Effort in Hours
Default Value:0
Actual effort in hours for the labor resource assigned to the task. -
CurrentBillAmount: number
Title:
Current Labor Resource Bill Amount
The current bill amount for the labor resource associated with the task. -
CurrentCostAmount: number
Title:
Current Labor Resource Cost Amount
The current cost amount for the labor resource associated with the task. -
CurrentEffortinHours: number
Title:
Current Labor Resource Effort in Hours
Estimated effort in hours on the task at completion for the labor resource. -
EffectiveBillRate: number
Title:
Effective Bill Rate
Indicates the rate derived from the rate schedule for calculating the bill amount. -
EffectiveCostRate: number
Title:
Effective Cost Rate
Indicates the rate derived from the rate schedule for calculating the burdened cost. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LaborResourceId: integer
(int64)
Title:
Labor Resource ID
Unique identifier of the labor resource assigned to the project task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PercentComplete: number
Title:
Labor Resource Percent Complete
Default Value:0
Indicates the percentage of work completed for the labor resource assigned to the task. -
PlannedBillAmount: number
Title:
Planned Labor Resource Bill Amount
The planned bill amount for the labor resource associated with the task. -
PlannedCostAmount: number
Title:
Planned Labor Resource Cost Amount
The planned cost amount for the labor resource associated with the task. -
PlannedEffortinHours: number
Title:
Planned Labor Resource Effort in Hours
Planned effort in hours of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary Resource
Indicates whether the resource is the primary labor resource for the project task. The resource is the primary labor resource when the value is True. The value is False when the resource is not the primary labor resource. Default value is False. -
ProgressStatus: string
Title:
Labor Resource Progress Status
Maximum Length:20
Indicates the status of the work for the labor resource assigned to the task. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment ID
Unique identifier of the assignment of the labor resource in a project. -
RemainingBillAmount: number
Title:
Remaining Labor Resource Bill Amount
The remaining bill amount for the labor resource associated with the task. -
RemainingCostAmount: number
Title:
Remaining Labor Resource Cost Amount
The remaining cost amount for the labor resource associated with the task. -
RemainingEffortinHours: number
Title:
Remaining Labor Resource Effort in Hours
Remaining effort in hours for the labor resource assigned to the task. -
ResourceAllocation: number
Title:
Labor Resource Allocation
Allocation percentage of the labor resource assigned to the task. Default value is the same as the resource allocation for the project. -
ResourceEmail: string
Title:
Labor Resource Email
Maximum Length:240
Email address of the labor resource assigned to the task. You must enter either the Labor Resource ID or the Labor Resource Email when using POST or PATCH, but not both. -
ResourceName: string
Title:
Labor Resource Name
Read Only:true
Maximum Length:240
Name of the labor resource assigned to the project task. -
TaskId: integer
(int64)
Title:
Task ID
Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST. -
TaskLaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment ID
Read Only:true
Unique identifier of the labor resource assignment for the project task. Value is auto-generated when using POST and mandatory when using PATCH.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-Tasks-item-response
Type:
Show Source
object
-
ActualCost: number
Title:
Total Actual Cost
The total actual cost amount for all the labor and expense resources associated with the task. -
ActualExpense: number
Title:
Actual Expense
Default Value:0
The actual expense amount for the task. -
ActualFinishDate: string
(date)
Title:
Actual Finish Date
The actual finish date for the task as opposed to a planned finish date for the task. It is recommended to use ActualFinishDateTime attribute. -
ActualFinishDateTime: string
(date-time)
Title:
Actual Finish Date and Time
The date and time when work finished on a task as opposed to the planned finish date and time for the task. -
ActualHours: number
Title:
Actual Hours
Default Value:0
Actual effort spent on the project task. Value is 0 if not provided when using POST. -
ActualLaborBillAmount: number
Title:
Actual Labor Bill Amount
The actual bill amount for all the labor resources associated with the task. -
ActualLaborCost: number
Title:
Actual Labor Cost
The actual cost amount for all the labor resources associated with the task. -
ActualStartDate: string
(date)
Title:
Actual Start Date
The date that work commenced on a task as opposed to the planned start date for the task. It is recommended to use ActualStartDateTime attribute. -
ActualStartDateTime: string
(date-time)
Title:
Actual Start Date and Time
The date and time when work started on a task as opposed to the planned start date and time for the task. -
BaselineAllocation: number
Title:
Primary Baseline Allocation
Original planned allocation of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineDuration: number
Title:
Primary Baseline Duration
Original planned duration of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineEffortinHours: number
Title:
Primary Baseline Effort in Hours
Original planned hours of effort of the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineExpense: number
Title:
Baseline Expense
Read Only:true
Original expense amount for the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineFinishDate: string
(date)
Title:
Primary Baseline Finish Date
Original planned finish date of the task in the primary work plan baseline. It is recommended to use BaselineFinishDateTime attribute. -
BaselineFinishDateTime: string
(date-time)
Title:
Baseline Finish Date and Time
Read Only:true
The planned finish date and time of the task in the primary work plan baseline. This value is available only if a primary baseline is set. -
BaselineLaborBillAmount: number
Title:
Baseline Labor Bill Amount
Read Only:true
Original bill amount for all the labor resources associated with the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineLaborCost: number
Title:
Baseline Labor Cost
Read Only:true
Original labor cost or all the labor resources associated with the task in the primary work plan baseline. The Baseline value will only be set when a primary baseline is created. -
BaselineStartDate: string
(date)
Title:
Primary Baseline Start Date
Original planned start date of the task in the primary work plan baseline. It is recommended to use BaselineStartDateTime attribute. -
BaselineStartDateTime: string
(date-time)
Title:
Baseline Start Date and Time
Read Only:true
The planned start date and time of the task in the primary work plan baseline. This value is available only if a primary baseline is set. -
BillableFlag: boolean
Maximum Length:
1
Indicates that transactions charged to that task can be billed to customers. The transactions are billable when the value is True. The value is False when the transactions are not billable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ChargeableFlag: boolean
Maximum Length:
1
Indicates that something is eligible to be charged to a task. The task is chargeable when the value is True. The value is False when the task is not chargeable. Value is True only when the task is a financial task. Value is False if not provided when using POST. -
ConstraintDate: string
(date)
Title:
Constraint Date
The date when a task must start or complete based on the constraint type for the task. It is recommended to use ConstraintDateTime attribute. -
ConstraintDateTime: string
(date-time)
Title:
Constraint Date and Time
The date and time when a task must start or finish 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. Valid values are MUST_START_BY, MUST_START_ON, START_ON_OR_AFTER, MUST_FINISH_BY, MUST_FINISH_ON, and FINISH_ON_OR_AFTER. -
CostPercentComplete: number
Title:
Cost Percent Complete
The percentage of the cost consumed in the task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Identifier of the user that created the task. Value is auto-generated on POST. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
Default Value:false
A task that must be completed on schedule or it will impact the finish date of the entire project. This attribute is not currently used. -
CurrentCost: number
Title:
Total Current Cost
The total current cost amount for all the labor and expense resources associated with the task. -
CurrentDuration: number
Title:
Current Duration
Length of time within which the project task is estimated to be completed. Duration is displayed in days. -
CurrentEffort: number
Title:
Current Effort in Hours
Total estimated effort on the task at completion. Value is auto-calculated as the sum of Remaining Hours and Actual Hours. -
CurrentExpense: number
Title:
Current Expense
The estimated expense amount for the task at completion. -
CurrentFinishDate: string
(date)
Title:
Current Finish Date
The date when the task is estimated to finish. It is recommended to use CurrentFinishDateTime attribute. -
CurrentFinishDateTime: string
(date-time)
Title:
Current Finish Date and Time
The date and time when the task is estimated to finish. -
CurrentLaborBillAmount: number
Title:
Current Labor Bill Amount
The current bill amount for all the labor resources associated with the task. -
CurrentLaborCost: number
Title:
Current Labor Cost
The current cost amount for all the labor resources associated with the task. -
CurrentStartDate: string
(date)
Title:
Current Start Date
The date when the task is estimated to start. It is recommended to use CurrentStartDateTime attribute. -
CurrentStartDateTime: string
(date-time)
Title:
Current Start Date and Time
The date and time when the task is estimated to start. -
Deadline: string
(date)
Title:
Task Deadline
The target date for the project manager when the task needs to be done. This attribute is not currently used. -
DeadlineDateTime: string
(date-time)
Title:
Deadline Date and Time
The target date and time by which the task should be completed. -
Description: string
Title:
Task Description
Maximum Length:2000
Text description of the project task. -
DisplayInTimelineFlag: boolean
Title:
Display in Timeline
Maximum Length:1
Indicates whether a task is visible in timeline when available. Values are True if task will be displayed in Timeline and False if task will not be displayed in Timeline. Default value is False if not provided when using POST. This attribute is not currently used. -
DisplaySequence: integer
(int64)
The order in which the task is displayed in the project plan. Default value is auto-calculated if not provided when using POST.
-
EarlyFinishDate: string
(date)
Title:
Early Finish Date
Date that is the earliest that a task can finish on. It is recommended to use EarlyFinishDateTime attribute. -
EarlyFinishDateTime: string
(date-time)
Title:
Early Finish Date and Time
The earliest date and time that a task can finish on. -
EarlyStartDate: string
(date)
Title:
Early Start Date
Date that is the earliest that a task can start on. It is recommended to use EarlyStartDateTime attribute. -
EarlyStartDateTime: string
(date-time)
Title:
Early Start Date and Time
The earliest date and time that a task can start on. -
ElementType: string
Title:
Task Element Type
Maximum Length:30
Default Value:EXECUTION
Indicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL. Default value is EXECUTION if not provided when using POST or when invalid value is provided. -
FreeFloat: number
Title:
Free Float
The free float or free slack is the amount of time in days that this task can be delayed without causing a delay to any of its successors. This attribute is not currently used. -
GateApprovers: array
Gate Approvers
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate. -
GateFlag: boolean
Title:
Gate
Maximum Length:1
Default Value:false
Indicates whether the task is a gate within the project. The task is a gate when the value is True. The task is not a gate when the value is False or Null. Default value is False if not provided when using POST. -
GateStatusCode: string
Title:
Gate Status Code
Maximum Length:50
The code for the status of the gate. Valid values are IN_REVIEW, OPEN, CLOSED, and TERMINATED. Value is NULL when the task is not a gate. -
Integrated: string
Title:
Is Integrated Indicator
Read Only:true
Maximum Length:1
Indicates the task was created in a third-party application. The task was integrated by a third-party application when the value is Y. The value is N when the task is not integrated. Default value is N if not provided when using POST. -
IntegrationSource: string
Title:
Integration Source
Indicates the task was created in a third-party application. -
LateFinishDate: string
(date)
Title:
Late Finish Date
Date that is the latest that a task can finish on that won't impact the finish date of the project. It is recommended to use LateFinishDateTime attribute. -
LateFinishDateTime: string
(date-time)
Title:
Late Finish Date and Time
The date and time by when a task must finish to avoid a delay in project completion. -
LateStartDate: string
(date)
Title:
Late Start Date
Date that is the latest that a task can start on that won't impact the finish date of the project. It is recommended to use LateStartDateTime attribute. -
LateStartDateTime: string
(date-time)
Title:
Late Start Date and Time
The date and time by when a task must start to avoid a delay in project completion. -
LeafIndicator: string
Title:
Leaf Indicator
Maximum Length:1
Default Value:Y
Indicates whether a task is a leaf task. Value is Y if a task is a leaf and N if a task is not a leaf. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualScheduleFlag: boolean
Title:
Manual Schedule
Maximum Length:1
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. The schedule mode of the task is Manual when the value is True. The value is False when the schedule mode of the task is Automatic. Default value is False if not provided when using POST or if task is a summary or financial task. -
MilestoneFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the task is a project milestone. The task is a milestone when the value is True. The value is False when the task is not a milestone. Default value is False if not provided when using POST. -
Name: string
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. Default value is new task when using POST and Element Type is Execution. Default value is new financial task if Element Type is Financial. -
NumberAttr01: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr02: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr03: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr04: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr05: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr06: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr07: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr08: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr09: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
NumberAttr10: number
Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
-
ParentTaskId: integer
(int64)
Identifier of the parent task of the task. Default value is the project plan task at level 0 if neither Parent Task ID nor Peer Reference Task ID is provided when using POST.
-
PeerReferenceTaskId: integer
Title:
Peer Reference Task ID
The task ID of the previous peer task in the project plan at the time of the creation of the task. If Peer Reference Task ID and Parent Task ID are not provided in POST, then task is created as the last task of the project. -
PendingRollupFlag: boolean
Title:
Pending Rollup Indicator
Maximum Length:1
Indicates that changes done at tasks need to be rolled up at the project level. -
PercentComplete: number
Title:
Task Percent Complete
Default Value:0
Indicates the percentage of work completed for a task. -
PhysicalPercentComplete: number
Title:
Task Physical Percent Complete
Default Value:0
The amount of physical work achieved on a task. Default values is 0 if not provided when using POST. -
PlanLineId: integer
(int64)
Unique identifier of the task planline.
-
PlannedAllocation: number
Title:
Planned Allocation Percentage
Percentage of hours that resources are allocated to the project task for a specified duration. -
PlannedCost: number
Title:
Total Planned Cost
The total planned cost amount for all the labor and expense resources associated with the task. -
PlannedDuration: number
Title:
Planned Duration
Length of time within which the project task is scheduled to be completed. Duration is displayed in days. -
PlannedEffort: number
Title:
Planned Effort in Hours
Measure of the effort required to complete the project task. -
PlannedExpense: number
Title:
Planned Expense
Default Value:0
The planned expense amount for the task. -
PlannedFinishDate: string
(date)
Title:
Planned Finish Date
The date when work is scheduled to end for a project task. It is recommended to use PlannedFinishDateTime attribute. -
PlannedFinishDateTime: string
(date-time)
Title:
Planned Finish Date and Time
The date and time when work is scheduled to finish for a project task. -
PlannedLaborBillAmount: number
Title:
Planned Labor Bill Amount
The planned bill amount for all the labor resources associated with the task. -
PlannedLaborCost: number
Title:
Planned Labor Cost
The planned cost amount for all the labor resources associated with the task. -
PlannedStartDate: string
(date)
Title:
Planned Start Date
The date when work is scheduled to start for a project task. It is recommended to use PlannedStartDateTime attribute. -
PlannedStartDateTime: string
(date-time)
Title:
Planned Start Date and Time
The date and time when work is scheduled to start for a project task. -
PrimaryResourceEmail: string
Title:
Primary Resource Email
Read Only:true
Maximum Length:240
Email of the person who leads the task. -
PrimaryResourceName: string
Title:
Primary Resource Name
Read Only:true
Maximum Length:240
Name of the resource who leads the task. -
Priority: number
Title:
Priority
Priority of the task. -
ProposedEffort: number
Title:
Proposed Effort in Hours
Read Only:true
Amount of effort to complete the project task proposed by the team member. Value is defaulted on POST and overwritten on PATCH to Planned Effort. -
ProposedFinishDate: string
(date)
Title:
Proposed Finish Date
Read Only:true
Date proposed by the team member to finish the project task. It is recommended to use ProposedFinishDateTime attribute. -
ProposedFinishDateTime: string
(date-time)
Title:
Proposed Finish Date and Time
Read Only:true
The date and time proposed by the team member to finish the project task. Value is defaulted on POST and overwritten on PATCH to Planned Finish Date and Time. -
ProposedStartDate: string
(date)
Title:
Proposed Start Date
Read Only:true
Date proposed by the team member to start the project task. It is recommended to use ProposedStartDateTime attribute. -
ProposedStartDateTime: string
(date-time)
Title:
Proposed Start Date and Time
Read Only:true
The date and time proposed by the team member to start the project task. Value is defaulted on POST and overwritten on PATCH to Planned Start Date and Time. -
RemainingCost: number
Title:
Total Remaining Cost
The total remaining cost amount for all the labor and expense resources associated with the task. -
RemainingExpense: number
Title:
Remaining Expense
Default Value:0
The remaining expense amount for the task. -
RemainingHours: number
Title:
Remaining Hours
Effort in hours that is remaining to be completed on the project task. -
RemainingLaborBillAmount: number
Title:
Remaining Labor Bill Amount
The remaining bill amount for all the labor resources associated with the task. -
RemainingLaborCost: number
Title:
Remaining Labor Cost
The remaining cost amount for all the labor resources associated with the task. -
RequirementId: integer
(int64)
Title:
Requirement ID
Unique identifier of the requirement associated to the task. -
ScheduleTypeCode: string
Title:
Task Schedule Type Code
Maximum Length:30
The schedule type of the task. Valid values are FIXED_EFFORT and FIXED_DURATION. Default value is the Project Schedule Type Code if not entered when using POST. -
SprintId: integer
(int64)
Title:
Sprint ID
Unique identifier of the sprint associated to the task. -
TaskCode01Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode02Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode03Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode04Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode05Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode06Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode07Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode08Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode09Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode10Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode11Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode12Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode13Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode14Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode15Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode16Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode17Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode18Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode19Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode20Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode21Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode22Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode23Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode24Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode25Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode26Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode27Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode28Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode29Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode30Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode31Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode32Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode33Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode34Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode35Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode36Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode37Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode38Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode39Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskCode40Id: integer
(int64)
Task code defined during implementation that provides a list of values to capture additional information for a project task.
-
TaskDFF: array
Tasks Descriptive Flexfields
Title:
Tasks Descriptive Flexfields
The Tasks Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a task. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the project task. Value is auto-generated when using POST and mandatory when using PATCH. -
TaskLevel: integer
(int32)
Indicates level of the task. Level 0 is reserved for the task that holds the rollup values of the project. Value is auto-calculated.
-
TaskNumber: string
Maximum Length:
100
The number of a task that needs to be unique within the project. Value will be auto-generated if not added in POST. -
TaskNumberPrefix: string
A value prefixed to the task number while creating tasks from the work plan template. This attribute is applicable only for PATCH operation and you must enter a different prefix each time you create tasks from the same work plan template in the same project.
-
TaskStatusCode: string
Title:
Task Status Code
Maximum Length:20
The code for the status of work completed on the task. Valid values are NOT_STARTED, IN_PROGRESS, and COMPLETED. Value is NOT_STARTED if not provided when using POST and it is neither a task nor a gate. -
TextAttr01: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr02: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr03: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr04: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr05: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr06: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr07: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr08: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr09: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr10: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr11: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr12: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr13: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr14: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr15: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr16: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr17: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr18: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr19: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TextAttr20: string
Maximum Length:
200
Task code defined during implementation that provides free-form text entry to capture additional information for a project task. -
TopTaskId: integer
(int64)
Title:
Top Task ID
Identifier of the top task to which a task rolls up. If the task is a top task, then identifier of the top task is same as the identifier of the task. -
TotalFloat: number
Title:
Total Float
The total float or total slack is the amount of time in days that the task can be delayed without causing a delay to the project. This attribute is not currently used. -
UpdateSource: string
Maximum Length:
30
For internal use. The source from which the task was last updated. -
WorkPlanTemplateId: integer
Unique identifier of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkPlanTemplateName: string
Name of the work plan template. You must enter either the Work Plan Template ID or the Work Plan Template Name when using the PATCH operation to create tasks in a project from a work plan template, but not both.
-
WorkType: string
Title:
Work Type
Maximum Length:240
Name of the work type associated to a task -
WorkTypeId: integer
(int64)
Title:
Work Type ID
Unique identifier of the work type
Nested Schema : Gate Approvers
Type:
array
Title:
Gate Approvers
The Gate Approvers resource is used to create a gate approver and to view and update approver details for a gate.
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 modify and view a list of all the descriptive flexfields available for a task.
Show Source
Nested Schema : projectPlans-Tasks-GateApprovers-item-response
Type:
Show Source
object
-
ApprovalId: integer
(int64)
Title:
Approval ID
Read Only:true
Unique identifier of the Gate Approver. Value is auto-generated when using POST and mandatory when using PATCH. -
GateApproverComments: string
Title:
Gate Approver Comments
Maximum Length:1000
Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver Email
Maximum Length:240
Email address of the gate approver. -
GateApproverName: string
Title:
Gate Approver Name
Read Only:true
Maximum Length:240
Name of the user who is to approve the gate. -
GateApproverStatus: string
Title:
Gate Approver Status
Maximum Length:16
Status set for a gate by the approver. -
GateApproverUpdatedBy: string
Title:
Gate Approver Updated By
Read Only:true
Maximum Length:240
The name of the user who updated the gate approval status. Nearly always the approver identified in the row, but could be the project manager. -
GateApproverUpdatedDate: string
(date)
Title:
Gate Approver Updated Date
Date when the Approval Status was last changed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-Tasks-TaskDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Unique identifier of the task. The values is the same as Task ID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPlans-TaskWorkItems-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectAssociationId: integer
(int64)
Title:
Object Association ID
Read Only:true
The unique identifier of the association of two business objects. For example, an identifier of the association between a work item and a project task. -
SourceWorkItemId: integer
(int64)
Title:
Source Work Item ID
The unique identifier of the associated work item in the source application. -
TaskCompletionEvent: string
Title:
Task Completion Event
The associated work item event or status change required in the source application to automatically mark the project task as complete. For example, approved, production, and suppliers invited. A list of values is defined in the lookup type for each work item type. -
TaskCompletionEventCode: string
Title:
Task Completion Event Code
Maximum Length:30
The code that represents the associated work item event or status change in the source application required to automatically mark the project task as complete. -
TaskCompletionEventStatus: string
Title:
Task Completion Event Status
Read Only:true
Maximum Length:80
The status that indicates whether the task completion event is pending, completed, or not set. The list of values is defined in the lookup ORA_PJE_COMPLETION_RULE_STATUS. The list of values can be accessed using the Setup and Maintenance work area and the Manage Standard Lookups task. -
TaskCompletionEventStatusCode: string
Title:
Task Completion Event Status Code
Read Only:true
Maximum Length:30
The code that represents whether the task completion event is pending, completed, or that no completion rule is set. Valid values are ORA_PENDING, ORA_COMPLETE, and ORA_NOT_SET. The list of values is defined in the lookup ORA_PJE_COMPLETION_RULE_STATUS. The list of values can be accessed using the Setup and Maintenance work area and the Manage Standard Lookups task. -
TaskId: integer
(int64)
Title:
Task ID
The unique identifier of the task. -
TaskName: string
Title:
Task Name
The name of the task. -
TaskNumber: string
The number of a task that is unique within the project.
-
Type: string
Title:
Type
The name of the work item type. -
TypeId: integer
(int64)
Title:
Type ID
The unique identifier of the work item type. -
WorkItemCurrentStatus: string
Title:
Work Item Current Status
Read Only:true
The current status of the associated work item in the source application. For example, draft, prototype, or design. -
WorkItemCurrentStatusCode: string
Title:
Work Item Current Status Code
Read Only:true
The code that represents the current status of the associated work item in the source application. -
WorkItemName: string
Title:
Work Item Name
The name or unique identifier of the associated work item in the source application. When using POST, you must enter the document number for Negotiation and the name for all other work item types. -
WorkItemRevision: string
Title:
Work Item Revision
The revision of the associated work item in the source application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all projects that I manage by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "CalendarId": 300100010293735, "CurrencyCode": "USD", "Description": null, "EndDate": null, "FinanciallyEnabledFlag": false, "Name": "TAP_PJT_Draft_Project ", "OrganizationId": -1, "PercentComplete": 0, "PrimaryProjectManagerName": "Connor Horton", "ProjectId": 300100038328105, "ProjectNumber": "300100038328105", "ScheduleTypeCode": "FIXED_EFFORT", "StartDate": "2014-07-01", "Status": "Submitted", "StatusCode": "SUBMITTED", "ViewAccessCode": "ORA_PJT_PRJ_PLAN_VIEW_TEAM", "ProjectCode01": null, "ProjectCode02": null, "ProjectCode03": null, "ProjectCode04": null, "ProjectCode05": null, "ProjectCode06": null, "ProjectCode07": null, "ProjectCode08": null, "ProjectCode09": null, "ProjectCode10": null, "ProjectCode11": null, "ProjectCode12": null, "ProjectCode13": null, "ProjectCode14": null, "ProjectCode15": null, "ProjectCode16": null, "ProjectCode17": null, "ProjectCode18": null, "ProjectCode19": null, "ProjectCode20": null, "ProjectCode21": null, "ProjectCode22": null, "ProjectCode23": null, "ProjectCode24": null, "ProjectCode25": null, "ProjectCode26": null, "ProjectCode27": null, "ProjectCode28": null, "ProjectCode29": null, "ProjectCode30": null, "ProjectCode31": null, "ProjectCode32": null, "ProjectCode33": null, "ProjectCode34": null, "ProjectCode35": null, "ProjectCode36": null, "ProjectCode37": null, "ProjectCode38": null, "ProjectCode39": null, "ProjectCode40": 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, "NumberAttr01": null, "NumberAttr02": null, "NumberAttr03": null, "NumberAttr04": null, "NumberAttr05": null, "NumberAttr06": null, "NumberAttr07": null, "NumberAttr08": null, "NumberAttr09": null, "NumberAttr10": null }