1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Plans

Get a project that I manage

get

/fscmRestApi/resources/11.13.18.05/projectPlans/{ProjectId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectPlans-item-response
Type: object
Show Source
  • 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.
  • Unique identifier of the calendar associated to the project.
  • Title: Creation Date
    Read Only: true
    Date when the row of data was created.
  • 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.
  • Maximum Length: 2000
    A description about the project. This might include high-level information about the work being performed.
  • Title: Project Finish Date
    The date that work or information tracking completes for a project.
  • 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
  • Title: Project Name
    Maximum Length: 240
    Name of the project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Project code defined during implementation that provides the ability to capture a numeric value as additional information for a project.
  • Default Value: -1
    Unique identifier of the organization that owns the project.
  • Title: Project Percent Complete
    Read Only: true
    Default Value: 0
    Indicates the percentage of work completed for the project.
  • 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.
  • 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.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • Project code defined during implementation that provides a list of values to capture additional information for a project.
  • 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.
  • Unique identifier of the project.
  • Read Only: true
    Maximum Length: 15
    Code that identifies the ledger currency of the business unit that owns the project.
  • Title: Project Number
    Maximum Length: 25
    Number of a project.
  • Title: Project Schedule Type Code
    Maximum Length: 30
    The schedule type of the project. Valid values are FIXED_EFFORT and FIXED_DURATION.
  • Title: Project Start Date
    The date that work or information tracking begins on a project.
  • Title: Project Status
    Read Only: true
    Maximum Length: 80
    An implementation-defined classification of the status of a project.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
    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.
  • 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.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • Maximum Length: 200
    Project code defined during implementation that provides free-form text entry to capture additional information for a project.
  • 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 : 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: object
Show Source
Nested Schema : projectPlans-ProjectCalendars-item-response
Type: object
Show Source
  • Title: Active Indicator
    Read Only: true
    Indicates if the calendar is active.
  • 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.
  • Title: Calendar ID
    Read Only: true
    Unique identifier of the calendar.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the calendar.
  • Title: Calendar Category Code
    Read Only: true
    Maximum Length: 30
    The category of the use of the calendar.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Indicates the resource who created the row of data.
  • Title: Creation Date
    Read Only: true
    Date when the row of data was created.
  • Title: Calendar Description
    Read Only: true
    Maximum Length: 2000
    Description of the calendar.
  • Title: Effective from Date
    Read Only: true
    The date for which the calendar starts to be effective.
  • Title: Effective to Date
    Read Only: true
    The inclusive last date of the effectivity of the calendar.
  • 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.
  • Title: Friday Work Indicator
    Read Only: true
    Indicates if Fridays workable. True if it is workable, False if it is not.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    Date when the record was last edited.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Indicates who last edited the record.
  • Links
  • Title: Monday Work Indicator
    Read Only: true
    Indicates if Mondays are workable. True if it is workable, False if it is not.
  • Title: Quarterly Type Code
    Read Only: true
    Maximum Length: 30
    Indicates the quarter type used for the calendar.
  • Title: Saturday Work Indicator
    Read Only: true
    Indicates if Saturdays are workable. True if it is workable, False if it is not.
  • Title: Sunday Work Indicator
    Read Only: true
    Indicates if Sundays are workable. True if it is workable, False if it is not.
  • Title: Thursday Work Indicator
    Read Only: true
    Indicates if Thursdays are workable. True if it is workable, False if it is not.
  • Title: Tuesday Work Indicator
    Read Only: true
    Indicates if Tuesdays are workable. True if it is workable, False if it is not.
  • 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 : projectPlans-ProjectCalendars-CalendarExceptions-item-response
Type: object
Show Source
  • Title: All Day Exception Indicator
    Read Only: true
    Maximum Length: 1
    Default Value: true
    Indicates if the calendar exception is for the whole day.
  • Title: Calendar Exception Category Code
    Read Only: true
    Maximum Length: 30
    Category code in which the exception falls.
  • Title: Calendar Exception Code
    Read Only: true
    Maximum Length: 3
    Code to identify the exception.
  • Title: Calendar Exception Description
    Read Only: true
    Maximum Length: 2000
    Description of the exception.
  • 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.
  • Title: Calendar Exception ID
    Read Only: true
    Unique identifier of the exception in the calendar.
  • Links
  • Title: Calendar Exception Name
    Read Only: true
    Maximum Length: 240
    Name of the exception.
  • 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'.
  • 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 : projectPlans-ProjectDFF-item-response
Type: object
Show Source
Nested Schema : projectPlans-TaskDeliverables-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource is used to view a deliverable attachment.
Show Source
Nested Schema : projectPlans-TaskDeliverables-Attachments-item-response
Type: object
Show Source
Nested Schema : projectPlans-TaskDependencies-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Title: Integration Source
    Indicates the task was created in a third-party application.
  • 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
  • Title: Predecessor Task ID
    Unique identifier of the predecessor project element. Value is mandatory when using POST.
  • Title: Successor Task ID
    Unique identifier of the successor project element. Value is mandatory when using POST.
Nested Schema : projectPlans-TaskExpenseResourceAssignments-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Integration Source
    Indicates the task was created in a third-party application.
  • Links
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : projectPlans-TaskFinancialActuals-item-response
Type: object
Show Source
Nested Schema : projectPlans-TaskLaborResourceAssignments-item-response
Type: object
Show Source
  • Title: Actual Labor Resource Bill Amount
    The actual bill amount for the labor resource associated with the task.
  • Title: Actual Labor Resource Cost Amount
    The actual cost amount for the labor resource associated with the task.
  • Title: Actual Labor Resource Effort in Hours
    Default Value: 0
    Actual effort in hours for the labor resource assigned to the task.
  • Title: Current Labor Resource Bill Amount
    The current bill amount for the labor resource associated with the task.
  • Title: Current Labor Resource Cost Amount
    The current cost amount for the labor resource associated with the task.
  • Title: Current Labor Resource Effort in Hours
    Estimated effort in hours on the task at completion for the labor resource.
  • Title: Effective Bill Rate
    Indicates the bill rate derived from the rate schedule for calculating the bill amount.
  • Title: Effective Cost Rate
    Indicates the cost rate derived from the rate schedule for calculating the burdened cost.
  • Title: Integration Source
    Indicates the task was created in a third-party application.
  • 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
  • Title: Labor Resource Percent Complete
    Default Value: 0
    Indicates the percentage of work completed for the labor resource assigned to the task.
  • Title: Planned Labor Resource Bill Amount
    The planned bill amount for the labor resource associated with the task.
  • Title: Planned Labor Resource Cost Amount
    The planned cost amount for the labor resource associated with the task.
  • Title: Planned Labor Resource Effort in Hours
    Planned effort in hours of the labor resource assigned to the task.
  • 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.
  • Title: Labor Resource Progress Status
    Maximum Length: 20
    Indicates the status of the work for the labor resource assigned to the task.
  • Title: Project Resource Assignment ID
    Unique identifier of the assignment of the labor resource in a project.
  • Title: Remaining Labor Resource Bill Amount
    The remaining bill amount for the labor resource associated with the task.
  • Title: Remaining Labor Resource Cost Amount
    The remaining cost amount for the labor resource associated with the task.
  • Title: Remaining Labor Resource Effort in Hours
    Remaining effort in hours for the labor resource assigned to the task.
  • 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.
  • 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.
  • Title: Labor Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the labor resource assigned to the project task.
  • Title: Task ID
    Identifier of the task to which the labor resource is assigned. Value is mandatory when using POST.
  • 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 : projectPlans-Tasks-item-response
Type: object
Show Source
  • Title: Total Actual Cost
    The total actual cost amount for all the labor and expense resources associated with the task.
  • Title: Actual Expense
    Default Value: 0
    The actual expense amount for the task.
  • 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.
  • 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.
  • Title: Actual Hours
    Default Value: 0
    Actual effort spent on the project task. Value is 0 if not provided when using POST.
  • Title: Actual Labor Bill Amount
    The actual bill amount for all the labor resources associated with the task.
  • Title: Actual Labor Cost
    The actual cost amount for all the labor resources associated with the task.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Constraint Date and Time
    The date and time when a task must start or finish based on the constraint type for the task.
  • 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.
  • Read Only: true
    The unique identifier of the milestone on the contract line.
  • Title: Cost Percent Complete
    The percentage of the cost consumed in the task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Identifier of the user that created the task. Value is auto-generated on POST.
  • 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.
  • Title: Allow milestone date changes in the project plan
    Read Only: true
    Maximum Length: 1
    Indicates whether milestone date changes are allowed in the project plan. Possible values are Y and N. Y indicates that the milestone dates can be modified in the project plan.
  • Title: Total Current Cost
    The total current cost amount for all the labor and expense resources associated with the task.
  • Title: Current Duration
    Length of time within which the project task is estimated to be completed. Duration is displayed in days.
  • 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.
  • Title: Current Expense
    The estimated expense amount for the task at completion.
  • Title: Current Finish Date
    The date when the task is estimated to finish. It is recommended to use CurrentFinishDateTime attribute.
  • Title: Current Finish Date and Time
    The date and time when the task is estimated to finish.
  • Title: Current Labor Bill Amount
    The current bill amount for all the labor resources associated with the task.
  • Title: Current Labor Cost
    The current cost amount for all the labor resources associated with the task.
  • Title: Current Start Date
    The date when the task is estimated to start. It is recommended to use CurrentStartDateTime attribute.
  • Title: Current Start Date and Time
    The date and time when the task is estimated to start.
  • Title: Task Deadline
    The target date for the project manager when the task needs to be done. This attribute is not currently used.
  • Title: Deadline Date and Time
    The target date and time by which the task should be completed.
  • Title: Task Description
    Maximum Length: 2000
    Text description of the project task.
  • 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.
  • The order in which the task is displayed in the project plan. Default value is auto-calculated if not provided when using POST.
  • Title: Early Finish Date
    Date that is the earliest that a task can finish on. It is recommended to use EarlyFinishDateTime attribute.
  • Title: Early Finish Date and Time
    The earliest date and time that a task can finish on.
  • Title: Early Start Date
    Date that is the earliest that a task can start on. It is recommended to use EarlyStartDateTime attribute.
  • Title: Early Start Date and Time
    The earliest date and time that a task can start on.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Integration Source
    Indicates the task was created in a third-party application.
  • 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.
  • Title: Late Finish Date and Time
    The date and time by when a task must finish to avoid a delay in project completion.
  • 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.
  • Title: Late Start Date and Time
    The date and time by when a task must start to avoid a delay in project completion.
  • 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
  • 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.
  • 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.
  • 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.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • Task code defined during implementation that provides the ability to capture a numeric value as additional information for a project task.
  • 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.
  • 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.
  • Title: Pending Rollup Indicator
    Maximum Length: 1
    Indicates that changes done at tasks need to be rolled up at the project level.
  • Title: Task Percent Complete
    Default Value: 0
    Indicates the percentage of work completed for a task.
  • 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.
  • Unique identifier of the task planline.
  • Title: Planned Allocation Percentage
    Percentage of hours that resources are allocated to the project task for a specified duration.
  • Title: Total Planned Cost
    The total planned cost amount for all the labor and expense resources associated with the task.
  • Title: Planned Duration
    Length of time within which the project task is scheduled to be completed. Duration is displayed in days.
  • Title: Planned Effort in Hours
    Measure of the effort required to complete the project task.
  • Title: Planned Expense
    Default Value: 0
    The planned expense amount for the task.
  • Title: Planned Finish Date
    The date when work is scheduled to end for a project task. It is recommended to use PlannedFinishDateTime attribute.
  • Title: Planned Finish Date and Time
    The date and time when work is scheduled to finish for a project task.
  • Title: Planned Labor Bill Amount
    The planned bill amount for all the labor resources associated with the task.
  • Title: Planned Labor Cost
    The planned cost amount for all the labor resources associated with the task.
  • Title: Planned Start Date
    The date when work is scheduled to start for a project task. It is recommended to use PlannedStartDateTime attribute.
  • Title: Planned Start Date and Time
    The date and time when work is scheduled to start for a project task.
  • Title: Primary Resource Email
    Read Only: true
    Maximum Length: 240
    Email of the person who leads the task.
  • Title: Primary Resource Name
    Read Only: true
    Maximum Length: 240
    Name of the resource who leads the task.
  • Title: Priority
    Priority of the task.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Total Remaining Cost
    The total remaining cost amount for all the labor and expense resources associated with the task.
  • Title: Remaining Expense
    Default Value: 0
    The remaining expense amount for the task.
  • Title: Remaining Hours
    Effort in hours that is remaining to be completed on the project task.
  • Title: Remaining Labor Bill Amount
    The remaining bill amount for all the labor resources associated with the task.
  • Title: Remaining Labor Cost
    The remaining cost amount for all the labor resources associated with the task.
  • Title: Requirement ID
    Unique identifier of the requirement associated to the task.
  • 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.
  • Title: Sprint ID
    Unique identifier of the sprint associated to the task.
  • Title: Status Change Comments
    Maximum Length: 4000
    The comments entered when the status of the milestone is changed.
  • Status History
    Title: Status History
    The Status History is used to track the history of the status changes for objects such as milestones, bill transactions, and projects.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • Task code defined during implementation that provides a list of values to capture additional information for a project task.
  • 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.
  • Title: Task ID
    Unique identifier of the project task. Value is auto-generated when using POST and mandatory when using PATCH.
  • Indicates level of the task. Level 0 is reserved for the task that holds the rollup values of the project. Value is auto-calculated.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • Maximum Length: 200
    Task code defined during implementation that provides free-form text entry to capture additional information for a project task.
  • 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.
  • 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.
  • Maximum Length: 30
    For internal use. The source from which the task was last updated.
  • 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.
  • 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.
  • Title: Work Type
    Maximum Length: 240
    Name of the work type associated to a task
  • 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 : Status History
Type: array
Title: Status History
The Status History is used to track the history of the status changes for objects such as milestones, bill transactions, and projects.
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: object
Show Source
Nested Schema : projectPlans-Tasks-StatusHistory-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: New Status
    Read Only: true
    Maximum Length: 80
    The new status of the object, such as milestone or project.
  • Title: New Status Classification
    Read Only: true
    Maximum Length: 240
    The new internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
  • Title: New Status Classification Code
    Read Only: true
    Maximum Length: 30
    The new internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
  • Title: New Status Code
    Read Only: true
    Maximum Length: 30
    The new status code of the object, such as milestone or project.
  • Title: Object ID
    Read Only: true
    The unique identifier of the object, such as Milestone ID or Project ID.
  • Title: Old Status
    Read Only: true
    Maximum Length: 80
    The old status of the object, such as milestone or project.
  • Title: Old Status Classification
    Read Only: true
    Maximum Length: 240
    The old internal status classification of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
  • Title: Old Status Classification Code
    Read Only: true
    Maximum Length: 30
    The old internal status classification code of the object, such as milestone or project. Status classifications are predefined groupings of statuses for each status object which typically govern delivered application behavior. Status classification attributes also control extensibility.
  • Title: Old Status Code
    Read Only: true
    Maximum Length: 30
    The old status code of the object, such as milestone or project.
  • Title: Status Change Comments
    Read Only: true
    Maximum Length: 4000
    The comments entered when the status of the object, such as milestone or project, is changed.
  • Title: Status History ID
    Read Only: true
    Unique identifier of the status change record.
  • Title: Status Object
    Read Only: true
    Maximum Length: 30
    Type of the object that's undergoing the status change. For example, project or milestone.
Nested Schema : projectPlans-Tasks-TaskDFF-item-response
Type: object
Show Source
Nested Schema : projectPlans-TaskWorkItems-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • 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.
  • Title: Source Work Item ID
    The unique identifier of the associated work item in the source application.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Task ID
    The unique identifier of the task.
  • Title: Task Name
    The name of the task.
  • The number of a task that is unique within the project.
  • Title: Type
    The name of the work item type.
  • Title: Type ID
    The unique identifier of the work item type.
  • 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.
  • 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.
  • 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.
  • Title: Work Item Revision
    The revision of the associated work item in the source application.
Links
Baselines
Parameters:
  • ProjectId: $request.path.ProjectId
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.
ProjectCalendars
Parameters:
  • ProjectId: $request.path.ProjectId
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.
ProjectDFF
Parameters:
  • ProjectId: $request.path.ProjectId
The Project Descriptive Flexfields resource is used to modify and view a list of all the descriptive flexfields available for a project.
TaskDeliverables
Parameters:
  • ProjectId: $request.path.ProjectId
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
Parameters:
  • ProjectId: $request.path.ProjectId
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
Parameters:
  • ProjectId: $request.path.ProjectId
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
Parameters:
  • ProjectId: $request.path.ProjectId
The Task Financial Actuals resource is used to view the ITD actual effort and actual burdened cost for a project task.
TaskLaborResourceAssignments
Parameters:
  • ProjectId: $request.path.ProjectId
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.
TaskWorkItems
Parameters:
  • ProjectId: $request.path.ProjectId
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.
Tasks
Parameters:
  • ProjectId: $request.path.ProjectId
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.
Back to Top

Examples

The following example shows how to get a project plan 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/300100185844495

Response Body Example

The following shows an example of the response body in JSON format.

{ "CalendarId": 300100010293735, "CurrencyCode": "USD", "Description": null, "EndDate": null, "FinanciallyEnabledFlag": false, "Name": "Proj-1609", "OrganizationId": -1, "PercentComplete": 0, "PrimaryProjectManagerName": "Connor Horton", "ProjectId": 300100185844495, "ProjectNumber": "300100185844495", "ScheduleTypeCode": "FIXED_EFFORT", "StartDate": "2020-09-16", "Status": "Active_1", "StatusCode": "ACTIVE", "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, "CreationDate": "2020-09-16T05:49:36.001+00:00", "SystemStatusCode": "ACTIVE", "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495", "name": "projectPlans", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000027704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000378" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495", "name": "projectPlans", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/Baselines", "name": "Baselines", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/ProjectCalendars", "name": "ProjectCalendars", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/ProjectDFF", "name": "ProjectDFF", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/TaskDeliverables", "name": "TaskDeliverables", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/TaskDependencies", "name": "TaskDependencies", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/TaskExpenseResourceAssignments", "name": "TaskExpenseResourceAssignments", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/TaskLaborResourceAssignments", "name": "TaskLaborResourceAssignments", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/TaskWorkItems", "name": "TaskWorkItems", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlans/300100185844495/child/Tasks", "name": "Tasks", "kind": "collection" } ] }
Back to Top