Get a project that I can view
get
/fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}
Request
Path Parameters
-
ProjectId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPlanDetails-item-response
Type:
Show Source
object-
CalendarId: integer
(int64)
Read Only:
trueUnique identifier of the calendar associated to the project. -
CurrencyCode: string
Title:
Project Currency CodeRead Only:trueMaximum Length:15Default Value:USDThe code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency. -
Description: string
Read Only:
trueMaximum Length:2000A description about the project. This might include high-level information about the work being performed. -
EndDate: string
(date)
Title:
Project Finish DateRead Only:trueThe date that work or information tracking completes for a project. -
FinanciallyEnabledFlag: boolean
Title:
Enabled for Financial ManagementRead Only:trueIndicates 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 isn't enabled for financial management. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
Project NameRead Only:trueMaximum Length:240Name of the project. -
NumberAttr01: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 01 as additional information for a project. -
NumberAttr02: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 02 as additional information for a project. -
NumberAttr03: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 03 as additional information for a project. -
NumberAttr04: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 04 as additional information for a project. -
NumberAttr05: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 05 as additional information for a project. -
NumberAttr06: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 06 as additional information for a project. -
NumberAttr07: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 07 as additional information for a project. -
NumberAttr08: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 08 as additional information for a project. -
NumberAttr09: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 09 as additional information for a project. -
NumberAttr10: number
Read Only:
trueProject code defined during implementation that provides the ability to capture a numeric value 10 as additional information for a project. -
OrganizationId: integer
(int64)
Read Only:
trueDefault Value:-1Unique identifier of the organization that owns the project. -
PercentComplete: number
Title:
Project Percent CompleteRead Only:trueDefault Value:0Indicates the percentage of work completed for the project. -
PrimaryProjectManagerName: string
Title:
Primary Project Manager NameRead Only:trueMaximum Length:240Name 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 CalendarsThe 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)
Read Only:
trueProject code defined during implementation that provides a list of values 01 to capture additional information for a project. -
ProjectCode02: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 02 to capture additional information for a project. -
ProjectCode03: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 03 to capture additional information for a project. -
ProjectCode04: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 04 to capture additional information for a project. -
ProjectCode05: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 05 to capture additional information for a project. -
ProjectCode06: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 06 to capture additional information for a project. -
ProjectCode07: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 07 to capture additional information for a project. -
ProjectCode08: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 08 to capture additional information for a project. -
ProjectCode09: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 09 to capture additional information for a project. -
ProjectCode10: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 10 to capture additional information for a project. -
ProjectCode11: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 11 to capture additional information for a project. -
ProjectCode12: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 12 to capture additional information for a project. -
ProjectCode13: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 13 to capture additional information for a project. -
ProjectCode14: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 14 to capture additional information for a project. -
ProjectCode15: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 15 to capture additional information for a project. -
ProjectCode16: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 16 to capture additional information for a project. -
ProjectCode17: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 17 to capture additional information for a project. -
ProjectCode18: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 18 to capture additional information for a project. -
ProjectCode19: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 19 to capture additional information for a project. -
ProjectCode20: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 20 to capture additional information for a project. -
ProjectCode21: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 21 to capture additional information for a project. -
ProjectCode22: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 22 to capture additional information for a project. -
ProjectCode23: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 23 to capture additional information for a project. -
ProjectCode24: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 24 to capture additional information for a project. -
ProjectCode25: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 25 to capture additional information for a project. -
ProjectCode26: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 26 to capture additional information for a project. -
ProjectCode27: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 27 to capture additional information for a project. -
ProjectCode28: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 28 to capture additional information for a project. -
ProjectCode29: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 29 to capture additional information for a project. -
ProjectCode30: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 30 to capture additional information for a project. -
ProjectCode31: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 31 to capture additional information for a project. -
ProjectCode32: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 32 to capture additional information for a project. -
ProjectCode33: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 33 to capture additional information for a project. -
ProjectCode34: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 34 to capture additional information for a project. -
ProjectCode35: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 35 to capture additional information for a project. -
ProjectCode36: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 36 to capture additional information for a project. -
ProjectCode37: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 37 to capture additional information for a project. -
ProjectCode38: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 38 to capture additional information for a project. -
ProjectCode39: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 39 to capture additional information for a project. -
ProjectCode40: integer
(int64)
Read Only:
trueProject code defined during implementation that provides a list of values 40 to capture additional information for a project. -
ProjectId: integer
(int64)
Read Only:
trueUnique identifier of the project. -
ProjectNumber: string
Title:
Project NumberRead Only:trueMaximum Length:25Number of a project. -
ScheduleTypeCode: string
Title:
Project Schedule Type CodeRead Only:trueMaximum Length:30The schedule type of the project. Valid values are FIXED_EFFORT and FIXED_DURATION. -
StartDate: string
(date)
Title:
Project Start DateRead Only:trueThe date that work or information tracking begins on a project. -
Status: string
Title:
Project StatusRead Only:trueMaximum Length:80An implementation-defined classification of the status of a project. -
StatusCode: string
Read Only:
trueMaximum Length:30Default Value:ACTIVEThe 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 CodeRead Only:trueMaximum Length:30The underlying system project status code associated with the implementation-defined project status. Valid values are ACTIVE, CLOSED, DRAFT, PENDING_CLOSE, and SUBMITTED. -
TaskDeliverables: array
Task Deliverables
Title:
Task DeliverablesThe 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 DependenciesThe Task Dependency resource is used to view 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 AssignmentsThe Task Expenses resource assignment resource is used to view 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. -
TaskLaborResourceAssignments: array
Task Labor Resource Assignments
Title:
Task Labor Resource AssignmentsThe Task Labor resource assignments resource is used to view 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:
TasksThe Tasks resource is used to 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 ItemsThe 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
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 01 to capture additional information for a project. -
TextAttr02: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 02 to capture additional information for a project. -
TextAttr03: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 03 to capture additional information for a project. -
TextAttr04: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 04 to capture additional information for a project. -
TextAttr05: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 05 to capture additional information for a project. -
TextAttr06: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 06 to capture additional information for a project. -
TextAttr07: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 07 to capture additional information for a project. -
TextAttr08: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 08 to capture additional information for a project. -
TextAttr09: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 09 to capture additional information for a project. -
TextAttr10: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 10 to capture additional information for a project. -
TextAttr11: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 11 to capture additional information for a project. -
TextAttr12: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 12 to capture additional information for a project. -
TextAttr13: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 13 to capture additional information for a project. -
TextAttr14: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 14 to capture additional information for a project. -
TextAttr15: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 15 to capture additional information for a project. -
TextAttr16: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 16 to capture additional information for a project. -
TextAttr17: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 17 to capture additional information for a project. -
TextAttr18: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 18 to capture additional information for a project. -
TextAttr19: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 19 to capture additional information for a project. -
TextAttr20: string
Read Only:
trueMaximum Length:200Project code defined during implementation that provides free-form text entry 20 to capture additional information for a project. -
ViewAccessCode: string
Read Only:
trueMaximum Length:30Default Value:ORA_PJT_PRJ_PLAN_VIEW_TEAMCode 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Project Calendars
Type:
arrayTitle:
Project CalendarsThe 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 : Task Deliverables
Type:
arrayTitle:
Task DeliverablesThe 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:
arrayTitle:
Task DependenciesThe Task Dependency resource is used to view 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:
arrayTitle:
Task Expense Resource AssignmentsThe Task Expenses resource assignment resource is used to view 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 Labor Resource Assignments
Type:
arrayTitle:
Task Labor Resource AssignmentsThe Task Labor resource assignments resource is used to view 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:
arrayTitle:
TasksThe Tasks resource is used to 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:
arrayTitle:
Task Work ItemsThe 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 : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectPlanDetails-ProjectCalendars-item-response
Type:
Show Source
object-
ActiveFlag: boolean
Title:
Active IndicatorRead Only:trueIndicates if the calendar is active. -
CalendarExceptions: array
Calendar Exceptions
Title:
Calendar ExceptionsThe 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 IDRead Only:trueUnique identifier of the calendar. -
CalendarName: string
Title:
NameRead Only:trueMaximum Length:240Name of the calendar. -
CategoryCode: string
Title:
Calendar Category CodeRead Only:trueMaximum Length:30The category of the use of the calendar. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Indicates the resource who created the row of data. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the row of data was created. -
Description: string
Title:
Calendar DescriptionRead Only:trueMaximum Length:2000Description of the calendar. -
EffectiveFromDate: string
(date)
Title:
Effective from DateRead Only:trueThe date for which the calendar starts to be effective. -
EffectiveToDate: string
(date)
Title:
Effective to DateRead Only:trueThe inclusive last date of the effectivity of the calendar. -
FirstDayOfWeek: integer
Title:
First Day of Week for CalendarRead Only:trueThe index of the first day in the week, 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. -
FridayWorkFlag: boolean
Title:
Friday Work IndicatorRead Only:trueIndicates if Fridays are workable. True if it's workable, False if it isn't. -
HoursPerDay: number
Title:
Hours per DayRead Only:trueNumber 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 DateRead Only:trueDate when the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Indicates who last edited the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MondayWorkFlag: boolean
Title:
Monday Work IndicatorRead Only:trueIndicates if Mondays are workable. True if it's workable, False if it's not. -
QuaterlyTypeCode: string
Title:
Quarterly Type CodeRead Only:trueMaximum Length:30Indicates the quarter type used for the calendar. -
SaturdayWorkFlag: boolean
Title:
Saturday Work IndicatorRead Only:trueIndicates if Saturdays are workable. True if it's workable, False if it's not. -
SundayWorkFlag: boolean
Title:
Sunday Work IndicatorRead Only:trueIndicates if Sundays are workable. True if it's workable, False if it's not. -
ThursdayWorkFlag: boolean
Title:
Thursday Work IndicatorRead Only:trueIndicates if Thursdays are workable. True if it's workable, False if it's not. -
TuesdayWorkFlag: boolean
Title:
Tuesday Work IndicatorRead Only:trueIndicates if Tuesdays are workable. True if it's workable, False if it's not. -
WednesdayWorkFlag: boolean
Title:
Wednesday Work IndicatorRead Only:trueIndicates if Wednesdays are workable. True if it's workable, False if it's not.
Nested Schema : Calendar Exceptions
Type:
arrayTitle:
Calendar ExceptionsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-ProjectCalendars-CalendarExceptions-item-response
Type:
Show Source
object-
AllDayFlag: boolean
Title:
All Day Exception IndicatorRead Only:trueMaximum Length:1Default Value:trueIndicates if the calendar exception is for the whole day. -
CategoryCode: string
Title:
Calendar Exception Category CodeRead Only:trueMaximum Length:30Category code in which the exception falls. -
Code: string
Title:
Calendar Exception CodeRead Only:trueMaximum Length:3Code to identify the exception. -
Description: string
Title:
Calendar Exception DescriptionRead Only:trueMaximum Length:2000Description of the exception. -
EndDate: string
(date-time)
Title:
Calendar Exception End DateRead Only:trueThe inclusive end date of the calendar exception. Value contains a time component if the exception isn't for all day long. -
ExceptionId: integer
(int64)
Title:
Calendar Exception IDRead Only:trueUnique identifier of the exception in the calendar. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
Calendar Exception NameRead Only:trueMaximum Length:240Name of the exception. -
PeriodType: string
Title:
Calendar Exception Period TypeRead Only:trueMaximum Length:30Indicates 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 DateRead Only:trueThe date on which the calendar exception begins. Value contains a time component if the exception isn't for all day long.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskDeliverables-item-response
Type:
Show Source
object-
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
DeliverableDescription: string
Title:
Deliverable DescriptionRead Only:trueMaximum Length:1000The description of the deliverable. -
DeliverableId: integer
(int64)
Title:
Deliverable IDRead Only:trueIdentifier of the deliverable associated with the task. -
DeliverableName: string
Title:
Deliverable NameRead Only:trueMaximum Length:150Name of the deliverable associated with the task. -
DeliverablePriorityCode: string
Title:
Deliverable Priority CodeRead Only:trueMaximum Length:30Internal code for the priority assigned to the deliverable. -
DeliverableShortName: string
Title:
Deliverable Short NameRead Only:trueMaximum Length:30Short name of the deliverable. -
DeliverableStatusCode: string
Title:
Deliverable Status CodeRead Only:trueMaximum Length:30Internal code for the status of the deliverable. -
DeliverableTypeId: integer
(int64)
Title:
Deliverable Type CodeRead Only:trueIdentifier of the type of the deliverable. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NeedByDate: string
(date)
Title:
Need-by DateRead Only:trueDate by which the deliverable is expected. -
Owner: integer
(int64)
Title:
OwnerRead Only:trueIdentifier of the person who owns the deliverable. -
TaskDeliverableAssociationId: integer
(int64)
Title:
Deliverable Association IDRead Only:trueUnique identifier of the association between task and deliverable. -
TaskId: integer
(int64)
Title:
Task IDRead Only:trueIdentifier of the task associated with the deliverable.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskDeliverables-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskDependencies-item-response
Type:
Show Source
object-
DependencyId: integer
(int64)
Title:
Dependency IDRead Only:trueIdentifier of the dependency that exists between two tasks. -
DependencyType: string
Title:
Dependency TypeRead Only:trueMaximum Length:30Default Value:fsThe type of dependency that exists between project elements. Valid values are fs, ff, ss, and sf. -
IntegrationSource: string
Title:
Integration SourceRead Only:trueIndicates the task was created in a third-party application. -
Lag: number
Title:
LagRead Only:trueDefault Value:0Number of days that exist between project elements before the dependency is activated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PredecessorTaskId: integer
(int64)
Title:
Predecessor Task IDRead Only:trueUnique identifier of the predecessor project element. -
SuccessorTaskId: integer
(int64)
Title:
Successor Task IDRead Only:trueUnique identifier of the successor project element.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskExpenseResourceAssignments-item-response
Type:
Show Source
object-
ExpenseResourceId: integer
(int64)
Title:
Expense Resource IDRead Only:trueIdentifier of the expense resource assigned to the project task. -
IntegrationSource: string
Title:
Integration SourceRead Only:trueIndicates the task was created in a third-party application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceName: string
Title:
Expense Resource NameRead Only:trueMaximum Length:240Name of the expense resource assigned to the project task. -
TaskExpenseResourceAssignmentId: integer
(int64)
Title:
Expense Resource Assignment IDRead Only:trueUnique identifier of the expense resource assignment to the project task. -
TaskId: integer
(int64)
Title:
Task IDRead Only:trueIdentifier of the task to which the expense resource is assigned.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskLaborResourceAssignments-item-response
Type:
Show Source
object-
ActualCostAmount: number
Title:
Actual Labor Resource Cost AmountRead Only:trueThe actual cost amount for the labor resource associated with the task. -
ActualEffortinHours: number
Title:
Actual Labor Resource Effort in HoursRead Only:trueDefault Value:0Actual effort in hours for the labor resource assigned to the task. -
CurrentEffortinHours: number
Title:
Current Labor Resource Effort in HoursRead Only:trueEstimated effort in hours on the task at completion for the labor resource. -
IntegrationSource: string
Title:
Integration SourceRead Only:trueIndicates the task was created in a third-party application. -
LaborResourceId: integer
(int64)
Title:
Labor Resource IDRead Only:trueUnique identifier of the labor resource assigned to the project task. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PercentComplete: number
Title:
Labor Resource Percent CompleteRead Only:trueDefault Value:0Indicates the percentage of work completed for the labor resource assigned to the task. -
PlannedEffortinHours: number
Title:
Planned Labor Resource Effort in HoursRead Only:truePlanned effort in hours of the labor resource assigned to the task. -
PrimaryResourceFlag: boolean
Title:
Primary ResourceRead Only:trueIndicates 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 isn't the primary labor resource. -
ProgressStatus: string
Title:
Labor Resource Progress StatusRead Only:trueMaximum Length:20Indicates the status of the work for the labor resource assigned to the task. -
ProjectResourceAssignId: integer
Title:
Project Resource Assignment IDRead Only:trueUnique identifier of the assignment of the labor resource in a project. -
RemainingEffortinHours: number
Title:
Remaining Labor Resource Effort in HoursRead Only:trueRemaining effort in hours for the labor resource assigned to the task. -
ResourceAllocation: number
Title:
Labor Resource AllocationRead Only:trueAllocation percentage of the labor resource assigned to the task. -
ResourceEmail: string
Title:
Labor Resource EmailRead Only:trueMaximum Length:240Email address of the labor resource assigned to the task. -
ResourceName: string
Title:
Labor Resource NameRead Only:trueMaximum Length:240Name of the labor resource assigned to the project task. -
TaskId: integer
(int64)
Title:
Task IDRead Only:trueIdentifier of the task to which the labor resource is assigned. -
TaskLaborResourceAssignmentId: integer
(int64)
Title:
Labor Resource Assignment IDRead Only:trueUnique identifier of the labor resource assignment for the project task.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-Tasks-item-response
Type:
Show Source
object-
ActualFinishDate: string
(date)
Title:
Actual Finish DateRead Only:trueThe actual finish date for the task as opposed to a planned finish date for the task. -
ActualFinishDateTime: string
(date-time)
Title:
Actual Finish Date and TimeThe date and time when work finished on a task as opposed to the planned finish date and time for the task. This attribute isn't currently used. -
ActualHours: number
Title:
Actual HoursRead Only:trueDefault Value:0Actual effort spent on the project task. -
ActualStartDate: string
(date)
Title:
Actual Start DateRead Only:trueThe date that work commenced on a task as opposed to the planned start date for the task. -
ActualStartDateTime: string
(date-time)
Title:
Actual Start Date and TimeThe date and time when work started on a task as opposed to the planned start date and time for the task. This attribute isn't currently used. -
BaselineAllocation: number
Title:
Primary Baseline AllocationRead Only:trueOriginal planned allocation of the task in the primary work plan baseline. -
BaselineDuration: number
Title:
Primary Baseline DurationRead Only:trueOriginal planned duration of the task in the primary work plan baseline. -
BaselineEffortinHours: number
Title:
Primary Baseline Effort in HoursRead Only:trueOriginal planned hours of effort of the task in the primary work plan baseline. -
BaselineFinishDate: string
(date)
Title:
Primary Baseline Finish DateRead Only:trueOriginal planned finish date of the task in the primary work plan baseline. -
BaselineFinishDateTime: string
(date-time)
Title:
Baseline Finish Date and TimeThe 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. -
BaselineStartDate: string
(date)
Title:
Primary Baseline Start DateRead Only:trueOriginal planned start date of the task in the primary work plan baseline. -
BaselineStartDateTime: string
(date-time)
Title:
Baseline Start Date and TimeThe 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. -
ConstraintDate: string
(date)
Title:
Constraint DateRead Only:trueThe date when a task must start or complete based on the constraint type for the task. -
ConstraintDateTime: string
(date-time)
Title:
Constraint Date and TimeThe date and time when a task must start or finish based on the constraint type for the task. This attribute isn't currently used. -
ConstraintType: string
Title:
Constraint TypeRead Only:trueMaximum Length:30The 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. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Identifier of the user that created the task. -
CriticalFlag: boolean
Title:
CriticalRead Only:trueMaximum Length:1Default Value:falseA task that must be completed on schedule or it will impact the finish date of the entire project. This attribute is currently not supported. -
CurrentDuration: number
Title:
Current DurationRead Only:trueLength of time within which the project task is estimated to be completed. Duration is displayed in days. -
CurrentEffort: number
Title:
Current Effort in HoursRead Only:trueTotal estimated effort on the task at completion. -
CurrentFinishDate: string
(date)
Title:
Current Finish DateRead Only:trueThe date when the task is estimated to finish. -
CurrentFinishDateTime: string
(date-time)
Title:
Current Finish Date and TimeRead Only:trueThe date and time when the task is estimated to finish. This attribute is currently not supported. -
CurrentStartDate: string
(date)
Title:
Current Start DateRead Only:trueThe date when the task is estimated to start. -
CurrentStartDateTime: string
(date-time)
Title:
Current Start Date and TimeRead Only:trueThe date and time when the task is estimated to start. This attribute is currently not supported. -
Deadline: string
(date)
Title:
Task DeadlineRead Only:trueThe target date for the project manager when the task needs to be done. This attribute is currently not supported. -
DeadlineDateTime: string
(date-time)
Title:
Deadline Date and TimeThe target date and time by which the task should be completed. This attribute isn't currently used. -
Description: string
Title:
Task DescriptionRead Only:trueMaximum Length:2000Text description of the project task. -
DisplayInTimelineFlag: boolean
Title:
Display in TimelineRead Only:trueMaximum Length:1Indicates whether a task is visible in the timeline when available. Values are True if a task will be displayed in Timeline and False if task won't be displayed in the Timeline. This attribute is currently not supported. -
DisplaySequence: integer
(int64)
Title:
Display SequenceThe order in which the task is displayed in the project plan. -
EarlyFinishDate: string
(date)
Title:
Early Finish DateRead Only:trueDate that's the earliest that a task can finish on. This attribute is currently not supported. -
EarlyFinishDateTime: string
(date-time)
Title:
Early Finish Date and TimeThe earliest date and time that a task can finish on. This attribute isn't currently used. -
EarlyStartDate: string
(date)
Title:
Early Start DateRead Only:trueDate that's the earliest that a task can start on. This attribute is currently not supported. -
EarlyStartDateTime: string
(date-time)
Title:
Early Start Date and TimeThe earliest date and time that a task can start on. This attribute isn't currently used. -
ElementType: string
Title:
Task Element TypeRead Only:trueMaximum Length:30Default Value:EXECUTIONIndicates if the task is financially tracked or tracked for execution only. Valid values are EXECUTION and FINANCIAL. -
FreeFloat: number
Title:
Free FloatRead Only:trueThe 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 currently not supported. -
GateApprovers: array
Gate Approvers
Title:
Gate ApproversThe Gate Approvers resource is used to view the approver details for a gate. -
GateFlag: boolean
Title:
GateRead Only:trueMaximum Length:1Default Value:falseIndicates whether the task is a gate within the project. The task is a gate when the value is True. The task isn't a gate when the value is False or Null. -
GateStatusCode: string
Title:
Gate Status CodeRead Only:trueMaximum Length:50The code for the status of the gate. Valid values are IN_REVIEW, OPEN, CLOSED, and TERMINATED. Value is NULL when the task isn't a gate. -
Integrated: string
Title:
Is Integrated IndicatorRead Only:trueMaximum Length:1Indicates 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 isn't integrated. -
IntegrationSource: string
Title:
Integration SourceRead Only:trueIndicates the task was created in a third-party application. -
LateFinishDate: string
(date)
Title:
Late Finish DateRead Only:trueDate that's the latest that a task can finish on that won't impact the finish date of the project. This attribute is currently not supported. -
LateFinishDateTime: string
(date-time)
Title:
Late Finish Date and TimeThe date and time by which a task must finish to avoid a delay in project completion. This attribute isn't currently used. -
LateStartDate: string
(date)
Title:
Late Start DateRead Only:trueDate that's the latest that a task can start on that won't impact the finish date of the project. This attribute is currently not supported. -
LateStartDateTime: string
(date-time)
Title:
Late Start Date and TimeThe date and time by which a task must start to avoid a delay in project completion. This attribute isn't currently used. -
LeafIndicator: string
Title:
Leaf IndicatorRead Only:trueMaximum Length:1Default Value:YIndicates whether a task is a leaf task. Value is Y if a task is a leaf and N if a task isn't a leaf. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualScheduleFlag: boolean
Title:
Manual ScheduleRead Only:trueMaximum Length:1Indicates whether the schedule mode of a task is manual. If the schedule mode is manual, the task can't be updated automatically using the scheduling process. 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. -
MilestoneFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates whether the task is a project milestone. The task is a milestone when the value is True. The value is False when the task isn't a milestone. -
Name: string
Read Only:
trueMaximum Length:255The 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. -
NumberAttr01: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 01 as additional information for a project task. -
NumberAttr02: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 02 as additional information for a project task. -
NumberAttr03: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 03 as additional information for a project task. -
NumberAttr04: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 04 as additional information for a project task. -
NumberAttr05: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 05 as additional information for a project task. -
NumberAttr06: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 06 as additional information for a project task. -
NumberAttr07: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 07 as additional information for a project task. -
NumberAttr08: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 08 as additional information for a project task. -
NumberAttr09: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 09 as additional information for a project task. -
NumberAttr10: number
Read Only:
trueTask code defined during implementation that provides the ability to capture a numeric value 10 as additional information for a project task. -
ParentTaskId: integer
(int64)
Read Only:
trueIdentifier of the parent task of the task. -
PendingRollupFlag: boolean
Title:
Pending Rollup IndicatorRead Only:trueMaximum Length:1Indicates that changes done at tasks need to be rolled up at the project level. -
PercentComplete: number
Title:
Task Percent CompleteRead Only:trueDefault Value:0Indicates the percentage of work completed for a task. -
PhysicalPercentComplete: number
Title:
Task Physical Percent CompleteRead Only:trueDefault Value:0The amount of physical work achieved on a task. -
PlannedAllocation: number
Title:
Planned Allocation PercentageRead Only:truePercentage of hours that resources are allocated to the project task for a specified duration. -
PlannedDuration: number
Title:
Planned DurationRead Only:trueLength of time within which the project task is scheduled to be completed. Duration is displayed in days. -
PlannedEffort: number
Title:
Planned Effort in HoursRead Only:trueMeasure of the effort required to complete the project task. -
PlannedFinishDate: string
(date)
Title:
Planned Finish DateRead Only:trueThe date when work is scheduled to end for a project task. -
PlannedFinishDateTime: string
(date-time)
Title:
Planned Finish Date and TimeThe date and time when work is scheduled to finish for a project task. This attribute isn't currently used. -
PlannedStartDate: string
(date)
Title:
Planned Start DateRead Only:trueThe date when work is scheduled to start for a project task. -
PlannedStartDateTime: string
(date-time)
Title:
Planned Start Date and TimeThe date and time when work is scheduled to start for a project task. This attribute isn't currently used. -
PrimaryResourceEmail: string
Title:
Primary Resource EmailRead Only:trueMaximum Length:240Email of the person who leads the task. -
PrimaryResourceName: string
Title:
Primary Resource NameRead Only:trueMaximum Length:240Name of the resource who leads the task. -
ProposedEffort: number
Title:
Proposed Effort in HoursRead Only:trueAmount of effort to complete the project task proposed by the team member. -
ProposedFinishDate: string
(date)
Title:
Proposed Finish DateRead Only:trueDate proposed by the team member to finish the project task. -
ProposedFinishDateTime: string
(date-time)
Title:
Proposed Finish Date and TimeThe date and time proposed by the team member to finish the project task. This attribute isn't currently used. -
ProposedStartDate: string
(date)
Title:
Proposed Start DateRead Only:trueDate proposed by the team member to start the project task. -
ProposedStartDateTime: string
(date-time)
Title:
Proposed Start Date and TimeThe date and time proposed by the team member to start the project task. This attribute isn't currently used. -
RemainingHours: number
Title:
Remaining HoursRead Only:trueEffort in hours that's remaining to be completed on the project task. -
ScheduleTypeCode: string
Title:
Task Schedule Type CodeRead Only:trueMaximum Length:30The schedule type of the task. Valid values are FIXED_EFFORT and FIXED_DURATION. -
TaskCode01Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 01 to capture additional information for a project task. -
TaskCode02Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 02 to capture additional information for a project task. -
TaskCode03Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 03 to capture additional information for a project task. -
TaskCode04Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 04 to capture additional information for a project task. -
TaskCode05Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 05 to capture additional information for a project task. -
TaskCode06Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 06 to capture additional information for a project task. -
TaskCode07Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 07 to capture additional information for a project task. -
TaskCode08Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 08 to capture additional information for a project task. -
TaskCode09Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 09 to capture additional information for a project task. -
TaskCode10Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 10 to capture additional information for a project task. -
TaskCode11Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 11 to capture additional information for a project task. -
TaskCode12Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 12 to capture additional information for a project task. -
TaskCode13Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 13 to capture additional information for a project task. -
TaskCode14Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 14 to capture additional information for a project task. -
TaskCode15Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 15 to capture additional information for a project task. -
TaskCode16Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 16 to capture additional information for a project task. -
TaskCode17Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 17 to capture additional information for a project task. -
TaskCode18Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 18 to capture additional information for a project task. -
TaskCode19Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 19 to capture additional information for a project task. -
TaskCode20Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 20 to capture additional information for a project task. -
TaskCode21Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 21 to capture additional information for a project task. -
TaskCode22Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 22 to capture additional information for a project task. -
TaskCode23Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 23 to capture additional information for a project task. -
TaskCode24Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 24 to capture additional information for a project task. -
TaskCode25Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 25 to capture additional information for a project task. -
TaskCode26Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 26 to capture additional information for a project task. -
TaskCode27Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 27 to capture additional information for a project task. -
TaskCode28Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 28 to capture additional information for a project task. -
TaskCode29Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 29 to capture additional information for a project task. -
TaskCode30Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 30 to capture additional information for a project task. -
TaskCode31Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 31 to capture additional information for a project task. -
TaskCode32Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 32 to capture additional information for a project task. -
TaskCode33Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 33 to capture additional information for a project task. -
TaskCode34Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 34 to capture additional information for a project task. -
TaskCode35Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 35 to capture additional information for a project task. -
TaskCode36Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 36 to capture additional information for a project task. -
TaskCode37Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 37 to capture additional information for a project task. -
TaskCode38Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 38 to capture additional information for a project task. -
TaskCode39Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 39 to capture additional information for a project task. -
TaskCode40Id: integer
(int64)
Read Only:
trueTask code defined during implementation that provides a list of values 40 to capture additional information for a project task. -
TaskDFF: array
TaskDFF
-
TaskId: integer
(int64)
Title:
Task IDRead Only:trueUnique identifier of the project task. -
TaskLevel: integer
(int32)
Read Only:
trueIndicates level of the task. Level 0 is reserved for the task that holds the rollup values of the project. -
TaskNumber: string
Read Only:
trueMaximum Length:100The number of a task that needs to be unique within the project. -
TaskStatusCode: string
Title:
Task Status CodeRead Only:trueMaximum Length:20The code for the status of work completed on the task. Valid values are NOT_STARTED, IN_PROGRESS, and COMPLETED. -
TextAttr01: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 01 to capture additional information for a project task. -
TextAttr02: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 02 to capture additional information for a project task. -
TextAttr03: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 03 to capture additional information for a project task. -
TextAttr04: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 04 to capture additional information for a project task. -
TextAttr05: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 05 to capture additional information for a project task. -
TextAttr06: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 06 to capture additional information for a project task. -
TextAttr07: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 07 to capture additional information for a project task. -
TextAttr08: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 08 to capture additional information for a project task. -
TextAttr09: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 09 to capture additional information for a project task. -
TextAttr10: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 10 to capture additional information for a project task. -
TextAttr11: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 11 to capture additional information for a project task. -
TextAttr12: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 12 to capture additional information for a project task. -
TextAttr13: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 13 to capture additional information for a project task. -
TextAttr14: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 14 to capture additional information for a project task. -
TextAttr15: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 15 to capture additional information for a project task. -
TextAttr16: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 16 to capture additional information for a project task. -
TextAttr17: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 17 to capture additional information for a project task. -
TextAttr18: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 18 to capture additional information for a project task. -
TextAttr19: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 19 to capture additional information for a project task. -
TextAttr20: string
Read Only:
trueMaximum Length:200Task code defined during implementation that provides free-form text entry 20 to capture additional information for a project task. -
TopTaskId: integer
(int64)
Title:
Top Task IDRead Only:trueIdentifier 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 FloatRead Only:trueThe 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 currently not supported. -
UpdateSource: string
Read Only:
trueMaximum Length:30For internal use. The source from which the task was last updated. -
WorkType: string
Title:
Work TypeRead Only:trueMaximum Length:240Name of the classification of the work associated with the project task. Use work types to categorize and group tasks for processing purposes. The work type must be active as of the current system date. -
WorkTypeId: integer
(int64)
Title:
Work Type IDUnique identifier of the work type. Work type is used to classify the work associated with the project task. The work type must be active as of the current system date.
Nested Schema : Gate Approvers
Type:
arrayTitle:
Gate ApproversThe Gate Approvers resource is used to view the approver details for a gate.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-Tasks-GateApprovers-item-response
Type:
Show Source
object-
ApprovalId: integer
(int64)
Title:
Approval IDRead Only:trueUnique identifier of the Gate Approver. -
GateApproverComments: string
Title:
Gate Approver CommentsRead Only:trueMaximum Length:1000Optional text for comments by the approver. -
GateApproverEmail: string
Title:
Gate Approver EmailMaximum Length:240Email address of the gate approver. -
GateApproverName: string
Title:
Gate Approver NameRead Only:trueMaximum Length:240Name of the user who's to approve the gate. -
GateApproverStatus: string
Title:
Gate Approver StatusRead Only:trueMaximum Length:16Status set for a gate by the approver. -
GateApproverUpdatedBy: string
Title:
Gate Approver Updated ByRead Only:trueMaximum Length:240The 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 DateRead Only:trueDate when the Approval Status was last changed. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-Tasks-TaskDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjElementId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanDetails-TaskWorkItems-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectAssociationId: integer
(int64)
Title:
Object Association IDRead Only:trueThe 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 IDRead Only:trueThe unique identifier of the associated work item in the source application. -
TaskCompletionEvent: string
Title:
Task Completion EventRead Only:trueThe 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. -
TaskCompletionEventCode: string
Title:
Task Completion Event CodeRead Only:trueMaximum Length:30The 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 StatusRead Only:trueMaximum Length:80The 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 CodeRead Only:trueMaximum Length:30The code that represents whether the task completion event is pending, completed, or not 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 IDRead Only:trueUnique identifier of the project task. -
TaskName: string
Title:
Task NameRead Only:trueMaximum Length:255The name of the task. -
TaskNumber: string
Read Only:
trueMaximum Length:100The number of a task that's unique within the project. -
Type: string
Title:
TypeRead Only:trueMaximum Length:80The name of the work item type. -
TypeId: integer
(int64)
Title:
Type IDRead Only:trueThe unique identifier of the work item type. -
WorkItemCurrentStatus: string
Title:
Work Item Current StatusRead Only:trueThe current status of the associated work item in the source application. For example, draft, prototype, or design. -
WorkItemCurrentStatusCode: string
Title:
Work Item Current Status CodeRead Only:trueThe code that represents the current status of the associated work item in the source application. -
WorkItemName: string
Title:
Work Item NameRead Only:trueThe name of the associated work item in the source application. -
WorkItemRevision: string
Title:
Work Item RevisionRead Only:trueThe revision of the associated work item in the source application.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- 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. - ProjectId:
- 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. - ProjectId:
- TaskDependencies
-
Parameters:
- ProjectId:
$request.path.ProjectId
The Task Dependency resource is used to view 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. - ProjectId:
- TaskExpenseResourceAssignments
-
Parameters:
- ProjectId:
$request.path.ProjectId
The Task Expenses resource assignment resource is used to view 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. - ProjectId:
- TaskLaborResourceAssignments
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPlanDetails/{ProjectId}/child/TaskLaborResourceAssignmentsParameters:
- ProjectId:
$request.path.ProjectId
The Task Labor resource assignments resource is used to view 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. - ProjectId:
- 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. - ProjectId:
- Tasks
-
Parameters:
- ProjectId:
$request.path.ProjectId
The Tasks resource is used to 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. - ProjectId:
Examples
The following example shows how to get a project 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/projectPlanDetails/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,
"SystemStatusCode": "ACTIVE",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495",
"name": "projectPlanDetails",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000027704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000378"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495",
"name": "projectPlanDetails",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/ProjectCalendars",
"name": "ProjectCalendars",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/TaskDeliverables",
"name": "TaskDeliverables",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/TaskDependencies",
"name": "TaskDependencies",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/TaskExpenseResourceAssignments",
"name": "TaskExpenseResourceAssignments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/TaskLaborResourceAssignments",
"name": "TaskLaborResourceAssignments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/TaskWorkItems",
"name": "TaskWorkItems",
"kind": "collection"
},
{
"rel": "child",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanDetails/300100185844495/child/Tasks",
"name": "Tasks",
"kind": "collection"
}
]
}