Get insights for all projects
get
/fscmRestApi/resources/11.13.18.05/projectInsights
Request
Query Parameters
- expand: string When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
- fields: string This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 - finder: string Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the project insights with the specified primary key.
Finder Variables- ProjectId; integer; The unique identifier of the project.
- findByProjectId Finds the project insights with the specified primary key.
Finder Variables- ProjectId; integer; The unique identifier of the project.
- PrimaryKey Finds the project insights with the specified primary key.
- limit: integer This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
- links: string This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical - offset: integer Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
- onlyData: boolean The resource item payload will be filtered in order to contain only data (no links section, for example).
- orderBy: string This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
- q: string This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActualPercentComplete; number; The percentage of reported work completed on the project.
- ActualPlannedCost; number; The amount in the cost breakdown for a project that's attributed to planned costs.
- ActualUnplannedCost; number; The amount in the cost breakdown for a project that's attributed to unplanned costs.
- AssignmentsEndingSoon; number; The number of resources with assignments to the project that are scheduled to end within the next two weeks.
- AssignmentsReserved; number; The number of resources with reserved assignments to the project.
- BudgetSpentAmount; number; The budgeted amount spent for the project.
- BudgetToDateAmount; number; The amount of budget that's available to spend at that point in time for a project.
- CommittedCost; number; The amount in the cost breakdown for a project that's attributed to committed costs. Commitments include purchase orders, purchase requisitions, and supplier invoices.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CurrencyCode; string; The currency code for the project currency.
- CurrentBaselineBudget; number; The total planned cost that's associated to the project tasks or task assignments in the current baseline budget.
- ExpectedPercentComplete; number; The percentage of work that should be complete as of today if the project is on schedule. The value is a calculation of expected duration multiplied by planned hours and then divided by the planned duration.
- InvoicesAwaitingApproval; number; The number of invoices submitted for the project that are pending approval.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- MilestonesAtRisk; number; The number of milestones that are at risk of being delayed.
- MilestonesDueSoon; number; The number of milestones that are due in the near future.
- MilestonesPastDue; number; The number of milestones that aren't completed by the finish date.
- MissingTimeCardsFiveWeeksOld; number; The number of time cards that are missing or incomplete for a project and due five weeks ago. Only resources that are enabled to track time are considered.
- MissingTimeCardsFourWeeksOld; number; The number of time cards that are missing or incomplete for a project and due four weeks ago. Only resources that are enabled to track time are considered.
- MissingTimeCardsOneWeekOld; number; The number of time cards that are missing or incomplete for a project and due one week ago. Only resources that are enabled to track time are considered.
- MissingTimeCardsThreeWeeksOld; number; The number of time cards that are missing or incomplete for a project and due three weeks ago. Only resources that are enabled to track time are considered.
- MissingTimeCardsTwoWeeksOld; number; The number of time cards that are missing or incomplete for a project and due two weeks ago. Only resources that are enabled to track time are considered.
- PerformanceHealthStatus; string; The value representing the overall performance health of the project, such as at risk and on track. The list of values is defined in the lookup PJS_PERF_INDICATORS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
- PerformanceHealthStatusCode; string; The code representing the overall performance health of the project, such as at risk and on track. A list of values is defined in the lookup type PJS_PERF_INDICATORS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
- PlannedEffort; number; The amount of effort planned for the project.
- ProjectId; integer; The unique identifier of the project.
- ProjectName; string; The display name of the project.
- TaskExceptionsCount; number; The number of task exceptions for a project. Task exceptions occur when the team member changes the task dates or effort outside of the threshold values that were set during implementation or when the tasks are overdue.
- WeekFiveToEightOverAllocated; number; The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours during the next five to eight weeks of the project.
- WeekFiveToEightUnderAllocated; number; The number of labor resources who are assigned to tasks for less than their allocated hours during the next five to eight weeks of the project.
- WeekNineToTwelveOverAllocated; number; The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours during the next nine to twelve weeks of the project.
- WeekNineToTwelveUnderAllocated; number; The number of labor resources who are assigned to tasks for less than their allocated hours during the next nine to twelve weeks of the project.
- WeekOneToFourOverAllocated; number; The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours for the four weeks of the project that start with the current week.
- WeekOneToFourUnderAllocated; number; The number of labor resources who are assigned to tasks for less than their allocated hours for the four weeks of the project that start with the current week.
- totalResults: boolean The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
- Metadata-Context: string 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: string 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 : projectInsights
Type:
Show Source object
- count(required): integer The number of resource instances returned in the current range.
- hasMore(required): boolean Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
- items: array Items Title:
Items
The items in the collection. - limit(required): integer The actual paging size used by the server.
- links(required): array Links Title:
Links
The link relations associated with the resource instance. - offset(required): integer The offset value used in the current page.
- totalResults: integer The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectInsights-item-response
Type:
Show Source object
- ActualPercentComplete: number Title:
Actual Percentage Complete
Read Only:true
The percentage of reported work completed on the project. - ActualPlannedCost: number Title:
Actual Planned Cost
Read Only:true
The amount in the cost breakdown for a project that's attributed to planned costs. - ActualUnplannedCost: number Title:
Actual Unplanned Cost
Read Only:true
The amount in the cost breakdown for a project that's attributed to unplanned costs. - Assignments: array Assignments Title:
Assignments
The Assignments resource is used to view details for the assignments ending soon and reserved assignments for a project. - AssignmentsEndingSoon: number Title:
Assignments Ending
Read Only:true
The number of resources with assignments to the project that are scheduled to end within the next two weeks. - AssignmentsReserved: number Title:
Assignments Reserved Count
Read Only:true
The number of resources with reserved assignments to the project. - BudgetSpentAmount: number Title:
Budget Spent
Read Only:true
The budgeted amount spent for the project. - BudgetToDateAmount: number Title:
Budget to Date
Read Only:true
The amount of budget that's available to spend at that point in time for a project. - CommittedCost: number Title:
Committed Cost
Read Only:true
The amount in the cost breakdown for a project that's attributed to committed costs. Commitments include purchase orders, purchase requisitions, and supplier invoices. - CreatedBy: string Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
Read Only:true
The date when the record was created. - CurrencyCode: string Title:
Currency
Read Only:true
Maximum Length:15
The currency code for the project currency. - CurrentBaselineBudget: number Title:
Budget
Read Only:true
The total planned cost that's associated to the project tasks or task assignments in the current baseline budget. - ExpectedPercentComplete: number Title:
Expected Percentage Complete
Read Only:true
The percentage of work that should be complete as of today if the project is on schedule. The value is a calculation of expected duration multiplied by planned hours and then divided by the planned duration. - InvoicesAwaitingApproval: number Title:
Invoices Awaiting Approval
Read Only:true
The number of invoices submitted for the project that are pending approval. - LastUpdateDate: string (date-time) Title:
Last Update Date
Read Only:true
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - MilestonesAtRisk: number Title:
Milestones at Risk
Read Only:true
The number of milestones that are at risk of being delayed. - MilestonesDueSoon: number Title:
Milestones Due Soon
Read Only:true
The number of milestones that are due in the near future. - MilestonesPastDue: number Title:
Milestones Past Due
Read Only:true
The number of milestones that aren't completed by the finish date. - MissingTimeCards: array Missing Time Cards Title:
Missing Time Cards
The Missing Time Card resource is used to view the details of the missing or incomplete time card count for a project. It includes the resources and their expected hours for time cards that are missing or partially reported. - MissingTimeCardsFiveWeeksOld: number Title:
Missing Time Cards Five Weeks Old
Read Only:true
The number of time cards that are missing or incomplete for a project and due five weeks ago. Only resources that are enabled to track time are considered. - MissingTimeCardsFourWeeksOld: number Title:
Missing Time Cards Four Weeks Old
Read Only:true
The number of time cards that are missing or incomplete for a project and due four weeks ago. Only resources that are enabled to track time are considered. - MissingTimeCardsOneWeekOld: number Title:
Missing Time Cards One Week Old
Read Only:true
The number of time cards that are missing or incomplete for a project and due one week ago. Only resources that are enabled to track time are considered. - MissingTimeCardsThreeWeeksOld: number Title:
Missing Time Cards Three Weeks Old
Read Only:true
The number of time cards that are missing or incomplete for a project and due three weeks ago. Only resources that are enabled to track time are considered. - MissingTimeCardsTwoWeeksOld: number Title:
Missing Time Cards Two Weeks Old
Read Only:true
The number of time cards that are missing or incomplete for a project and due two weeks ago. Only resources that are enabled to track time are considered. - PendingInvoices: array Pending Invoices Title:
Pending Invoices
The Pending Invoices resource is used to view the details of the invoices pending approval count for a project. - PerformanceHealthStatus: string Title:
Performance Health Status
Read Only:true
Maximum Length:80
The value representing the overall performance health of the project, such as at risk and on track. The list of values is defined in the lookup PJS_PERF_INDICATORS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - PerformanceHealthStatusCode: string Title:
Performance Health Status Code
Read Only:true
Maximum Length:30
The code representing the overall performance health of the project, such as at risk and on track. A list of values is defined in the lookup type PJS_PERF_INDICATORS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - PlannedEffort: number Title:
Planned
Read Only:true
The amount of effort planned for the project. - ProjectId: integer (int64) Title:
Project ID
The unique identifier of the project. - ProjectName: string Title:
Project Name
Read Only:true
Maximum Length:240
The display name of the project. - TaskExceptions: array Task Exceptions Title:
Task Exceptions
The Task Exceptions resource is used to view the details of the task exceptions, milestones past due, and milestones due soon counts for a project. It includes what qualified the task or milestone as an exception. - TaskExceptionsCount: number Title:
Task Exceptions Count
Read Only:true
The number of task exceptions for a project. Task exceptions occur when the team member changes the task dates or effort outside of the threshold values that were set during implementation or when the tasks are overdue. - TeamAllocations: array Team Allocations Title:
Team Allocations
The Team Allocations resource is used to view the over and under allocated labor resource details for a project. It includes the weekly assignment, allocation, and variance hours per team member for the twelve weeks that start with the current week. - WeekFiveToEightOverAllocated: number Title:
Weeks Five to Eight Overallocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours during the next five to eight weeks of the project. - WeekFiveToEightUnderAllocated: number Title:
Weeks Five to Eight Under Allocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for less than their allocated hours during the next five to eight weeks of the project. - WeekNineToTwelveOverAllocated: number Title:
Weeks Nine to Twelve Overallocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours during the next nine to twelve weeks of the project. - WeekNineToTwelveUnderAllocated: number Title:
Weeks Nine to Twelve Under Allocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for less than their allocated hours during the next nine to twelve weeks of the project. - WeekOneToFourOverAllocated: number Title:
Weeks One to Four Overallocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for more than one hundred percent of their allocated hours for the four weeks of the project that start with the current week. - WeekOneToFourUnderAllocated: number Title:
Weeks One to Four Under Allocated Resources
Read Only:true
The number of labor resources who are assigned to tasks for less than their allocated hours for the four weeks of the project that start with the current week.
Nested Schema : Assignments
Type:
array
Title:
Assignments
The Assignments resource is used to view details for the assignments ending soon and reserved assignments for a project.
Show Source Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : Missing Time Cards
Type:
array
Title:
Missing Time Cards
The Missing Time Card resource is used to view the details of the missing or incomplete time card count for a project. It includes the resources and their expected hours for time cards that are missing or partially reported.
Show Source Nested Schema : Pending Invoices
Type:
array
Title:
Pending Invoices
The Pending Invoices resource is used to view the details of the invoices pending approval count for a project.
Show Source Nested Schema : Task Exceptions
Type:
array
Title:
Task Exceptions
The Task Exceptions resource is used to view the details of the task exceptions, milestones past due, and milestones due soon counts for a project. It includes what qualified the task or milestone as an exception.
Show Source Nested Schema : Team Allocations
Type:
array
Title:
Team Allocations
The Team Allocations resource is used to view the over and under allocated labor resource details for a project. It includes the weekly assignment, allocation, and variance hours per team member for the twelve weeks that start with the current week.
Show Source Nested Schema : projectInsights-Assignments-item-response
Type:
Show Source object
- AssignmentEndDate: string (date) Title:
Assignment End Date
The date when the resource assignment to the project is scheduled to end. - AssignmentId: integer (int64) Title:
Assignment ID
The unique identifier of the project resource assignment. - AssignmentStartDate: string (date) Title:
Start Date
The date when the resource assignment to the project is scheduled to start. - AssignmentStatus: string Title:
Assignment Status
Read Only:true
Maximum Length:80
The project assignment status for a resource, such as reserved or pending adjustment. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - AssignmentStatusCode: string Title:
Assignment Status Code
Maximum Length:30
The code representing the project assignment status for a resource, such as RESERVED and PENDING_ADJUSTMENT. A list of values is defined in the lookup type PJR_ASSIGN_STATUS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CreatedBy: string Title:
Created By
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
The date when the record was created. - EarliestTaskDate: string (date) Title:
Earliest Task Start Date
The earliest start date for the set of tasks that are assigned to the labor resource for the project. - LastUpdateDate: string (date-time) Title:
Last Update Date
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Maximum Length:64
The user who last updated the record. - LatestTaskDate: string (date) Title:
Latest Task Finish Date
The latest finish date for the set of tasks that are assigned to the labor resource. - links: array Links Title:
Links
The link relations associated with the resource instance. - ResourceId: integer (int64) Title:
Resource ID
The unique identifier of the project enterprise labor resource. - ResourceName: string Title:
Resource
Read Only:true
Maximum Length:240
The name of the project enterprise labor resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object
- href: string Title:
hyperlink reference
The URI to the related resource. - kind: string Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. - name: string Title:
name
The name of the link to the related resource. - properties: object properties
- rel: string Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object
- changeIndicator: string Change indicator or the ETag value of the resource instance.
Nested Schema : projectInsights-MissingTimeCards-item-response
Type:
Show Source object
- CategoryCodeForFiveWeeksAgo: string Title:
Category Code for Five Weeks Old Missing Time Card
Maximum Length:30
The code that represents the categorization of the missing time card for the week ending five weeks ago. Values include ORA_PJS_MISSING_TIMECARD, ORA_PJS_MISSING_HOURS, and ORA_PJS_IN_PROCESS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryCodeForFourWeeksAgo: string Title:
Category Code for Four Weeks Old Missing Time Card
Maximum Length:30
The code that represents the categorization of the missing time card for the week ending four weeks ago. Values include ORA_PJS_MISSING_TIMECARD, ORA_PJS_MISSING_HOURS, and ORA_PJS_IN_PROCESS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryCodeForOneWeekAgo: string Title:
Category Code for One Week Old Missing Time Card
Maximum Length:30
The code that represents the categorization of the missing time card for the week ending one week ago. Values include ORA_PJS_MISSING_TIMECARD, ORA_PJS_MISSING_HOURS, and ORA_PJS_IN_PROCESS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryCodeForThreeWeeksAgo: string Title:
Category Code for Three Weeks Old Missing Time Card
Maximum Length:30
The code that represents the categorization of the missing time card for the week ending three weeks ago. Values include ORA_PJS_MISSING_TIMECARD, ORA_PJS_MISSING_HOURS, and ORA_PJS_IN_PROCESS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryCodeForTwoWeeksAgo: string Title:
Category Code for Two Weeks Old Missing Time Card
Maximum Length:30
The code that represents the categorization of the missing time card for the week ending two weeks ago. Values include ORA_PJS_MISSING_TIMECARD, ORA_PJS_MISSING_HOURS, and ORA_PJS_IN_PROCESS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryForFiveWeeksAgo: string Title:
Category for Five Weeks Old Missing Time Card
The categorization of the missing time card for the week ending five weeks ago. Values include missing, partially reported, and in progress. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryForFourWeeksAgo: string Title:
Category for Four Weeks Old Missing Time Card
The categorization of the missing time card for the week ending four weeks ago. Values include missing, partially reported, and in progress. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryForOneWeekAgo: string Title:
Category for One Week Old Missing Time Card
The categorization of the missing time card for the week ending one week ago. Values include missing, partially reported, and in progress. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryForThreeWeeksAgo: string Title:
Category for Three Weeks Old Missing Time Card
The categorization of the missing time card for the week ending three weeks ago. Values include missing, partially reported, and in progress. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CategoryForTwoWeeksAgo: string Title:
Category for Two Weeks Old Missing Time Card
The categorization of the missing time card for the week ending two weeks ago. Values include missing, partially reported, and in progress. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_CATEGORY. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentCodeForFiveWeeksAgo: string Title:
Commentary Code for Five Weeks Old Time Card
Maximum Length:30
The code that represents the additional commentary for the time card for the week ending five weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are ORA_PJS_SAVED, ORA_PJS_AWAITING_APPROVAL, ORA_PJS_AWAITING_PROCESSING, ORA_PJS_REJECTED, and ORA_PJS_HOURS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentCodeForFourWeeksAgo: string Title:
Commentary Code for Four Weeks Old Time Card
Maximum Length:30
The code that represents the additional commentary for the time card for the week ending four weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are ORA_PJS_SAVED, ORA_PJS_AWAITING_APPROVAL, ORA_PJS_AWAITING_PROCESSING, ORA_PJS_REJECTED, and ORA_PJS_HOURS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentCodeForOneWeekAgo: string Title:
Commentary Code for One Week Old Time Card
Maximum Length:30
The code that represents the additional commentary for the time card for the week ending one week ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are ORA_PJS_SAVED, ORA_PJS_AWAITING_APPROVAL, ORA_PJS_AWAITING_PROCESSING, ORA_PJS_REJECTED, and ORA_PJS_HOURS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentCodeForThreeWeeksAgo: string Title:
Commentary Code for Three Weeks Old Time Card
Maximum Length:30
The code that represents the additional commentary for the time card for the week ending three weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are ORA_PJS_SAVED, ORA_PJS_AWAITING_APPROVAL, ORA_PJS_AWAITING_PROCESSING, ORA_PJS_REJECTED, and ORA_PJS_HOURS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentCodeForTwoWeeksAgo: string Title:
Commentary Code for Two Weeks Old Time Card
Maximum Length:30
The code that represents the additional commentary for the time card for the week ending two weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are ORA_PJS_SAVED, ORA_PJS_AWAITING_APPROVAL, ORA_PJS_AWAITING_PROCESSING, ORA_PJS_REJECTED, and ORA_PJS_HOURS. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentForFiveWeeksAgo: string Title:
Commentary for Five Weeks Old Time Card
Additional commentary for the time card for the week ending five weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are saved, awaiting approval, awaiting processing, rejected, and hours less than scheduled. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentForFourWeeksAgo: string Title:
Commentary for Four Weeks Old Time Card
Additional commentary for the time card for the week ending four weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are saved, awaiting approval, awaiting processing, rejected, and hours less than scheduled. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentForOneWeekAgo: string Title:
Commentary for One Week Old Time Card
Additional commentary for the time card for the week ending one week ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are saved, awaiting approval, awaiting processing, rejected, and hours less than scheduled. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentForThreeWeeksAgo: string Title:
Commentary for Three Weeks Old Time Card
Additional commentary for the time card for the week ending three weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are saved, awaiting approval, awaiting processing, rejected, and hours less than scheduled. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CommentForTwoWeeksAgo: string Title:
Commentary for Two Weeks Old Time Card
Additional commentary for the time card for the week ending two weeks ago. The commentary is for a time card that exists but isn't yet approved and successfully transferred. Values are saved, awaiting approval, awaiting processing, rejected, and hours less than scheduled. A list of values is defined in the lookup type ORA_PJS_UDB_TIMECARD_COMMENTS. Review the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. - CreatedBy: string Title:
Created By
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
The date when the record was created. - DefaultHoursFiveWeeksAgo: number Title:
Default Hours Five Weeks Ago
The default hours for the week ending five weeks ago for the resource and project. - DefaultHoursFourWeeksAgo: number Title:
Default Hours Four Weeks Ago
The default hours for the week ending four weeks ago for the resource and project. - DefaultHoursOneWeekAgo: number Title:
Default Hours One Week Ago
The default hours for the week ending one week ago for the resource and project. - DefaultHoursThreeWeeksAgo: number Title:
Default Hours Three Weeks Ago
The default hours for the week ending three weeks ago for the resource and project. - DefaultHoursTwoWeeksAgo: number Title:
Default Hours Two Weeks Ago
The default hours for the week ending two weeks ago for the resource and project. - LastUpdateDate: string (date-time) Title:
Last Update Date
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Maximum Length:64
The user who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - ResourceId: integer (int64) Title:
Resource ID
Read Only:true
The unique identifier of the project enterprise labor resource. - ResourceName: string Title:
Resource Name
Read Only:true
Maximum Length:240
The name of the project enterprise labor resource. - ScheduledHoursFiveWeeksAgo: number Title:
Scheduled Hours Five Weeks Ago
The effort in hours for the week ending five weeks ago for the resource and project. - ScheduledHoursFourWeeksAgo: number Title:
Scheduled Hours Four Weeks Ago
The effort in hours for the week ending four weeks ago for the resource and project. - ScheduledHoursOneWeekAgo: number Title:
Scheduled Hours One Week Ago
The effort in hours for the week ending one week ago for the resource and project. - ScheduledHoursThreeWeeksAgo: number Title:
Scheduled Hours Three Weeks Ago
The effort in hours for the week ending three weeks ago for the resource and project. - ScheduledHoursTwoWeeksAgo: number Title:
Scheduled Hours Two Weeks Ago
The effort in hours for the week ending two weeks ago for the resource and project. - TimeCardHoursFiveWeeksAgo: number Title:
Time Card Hours Five Weeks Ago
The effort in hours reported on a time card for the week ending five weeks ago for the resource and project. - TimeCardHoursFourWeeksAgo: number Title:
Time Card Hours Four Weeks Ago
The effort in hours reported on a time card for the week ending four weeks ago for the resource and project. - TimeCardHoursOneWeekAgo: number Title:
Time Card Hours One Week Ago
The effort in hours reported on a time card for the week ending one week ago for the resource and project. - TimeCardHoursThreeWeeksAgo: number Title:
Time Card Hours Three Weeks Ago
The effort in hours reported on a time card for the week ending three weeks ago for the resource and project. - TimeCardHoursTwoWeeksAgo: number Title:
Time Card Hours Two Weeks Ago
The effort in hours reported on a time card for the week ending two weeks ago for the resource and project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectInsights-PendingInvoices-item-response
Type:
Show Source object
- CreatedBy: string Title:
Created By
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
The date when the record was created. - InvoiceAmount: number Title:
Invoice Amount in Invoice Currency
The amount in the invoice currency. - InvoiceCreationDate: string (date) Title:
Invoice Creation Date
The date when the invoice was created. - InvoiceCurrencyCode: string Title:
Invoice Currency Code
Maximum Length:15
The currency code for the invoice that's transferred to Receivables. - InvoiceDate: string (date) Title:
Invoice Date
The invoice date that's passed to Receivables to calculate the invoice due date. - InvoiceId: integer (int64) Title:
Invoice ID
The unique identifier of the invoice. - LastUpdateDate: string (date-time) Title:
Last Update Date
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Maximum Length:64
The user who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - ProjectId: integer (int64) The unique identifier of the project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectInsights-TaskExceptions-item-response
Type:
Show Source object
- ActualHours: number Title:
Actual Hours
The actual effort spent on the project task. - CreatedBy: string Title:
Created By
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
The date when the record was created. - FinishDelayedFlag: boolean Title:
Finish Delayed Indicator
Maximum Length:1
Indicates whether the task finish date was updated to a later date and is beyond the threshold that was set during implementation. If true, then the finish date change is beyond the threshold. - FinishPastDueFlag: boolean Title:
Finish Past Due Indicator
Maximum Length:1
Indicates whether the project task finished on time. If true, then the task didn't finish on time. - LastUpdateDate: string (date-time) Title:
Last Update Date
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Maximum Length:64
The user who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - MilestoneFlag: boolean Title:
Milestone
Maximum Length:1
Indicates whether the task is a project milestone. If true, then the task is a milestone. - NumberOfExceptions: number Title:
Number of Exceptions
The number of exceptions for a task. Task exceptions occur when the team member changes the task dates or effort outside of the threshold values that were set during implementation or when the tasks are overdue. - PercentComplete: number Title:
Percent Complete
The percentage of work completed for a task. - PlannedEffort: number Title:
Planned
The planned effort required to complete the project task. - PlannedFinishDate: string (date) Title:
Planned Finish Date
The date when work is scheduled to end for a project task. - PlannedHoursIncreasedFlag: boolean Title:
Planned Hours Increased Indicator
Maximum Length:1
Indicates whether the number of hours planned for a project task has increased more than the threshold that was set during implementation. If true, then the planned hours change is over the threshold. - PlannedStartDate: string (date) Title:
Planned Start Date
The date when work is scheduled to start for a project task. - StartDelayedFlag: boolean Title:
Start Delayed Indicator
Maximum Length:1
Indicates whether the task start date was updated to a later date and is beyond the threshold that was set during implementation. If true, then the start date change is beyond the threshold. - StartPastDueFlag: boolean Title:
Start Past Due Indicator
Maximum Length:1
Indicates whether the project task started on time. If true, then the task didn't start on time. - TaskId: integer (int64) The unique identifier of the project task.
- TaskName: string Title:
Task Name
Read Only:true
Maximum Length:255
The name of the project task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : projectInsights-TeamAllocations-item-response
Type:
Show Source object
- CreatedBy: string Title:
Created By
Maximum Length:64
The user who created the record. - CreationDate: string (date-time) Title:
Creation Date
The date when the record was created. - LastUpdateDate: string (date-time) Title:
Last Updated By
The date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated By
Maximum Length:64
The user who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - ResourceId: integer (int64) Title:
Resource ID
The unique identifier of the project enterprise labor resource. - ResourceName: string Title:
Resource
Read Only:true
Maximum Length:240
The name of the project enterprise labor resource. - WeekEightAllocatedHours: number Title:
Week Eight Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in seven weeks. - WeekEightAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in seven weeks.
- WeekEightVariance: number Title:
Week Eight Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in seven weeks. - WeekElevenAllocatedHours: number The number of hours allocated to the resource for the week of the project that starts in ten weeks.
- WeekElevenAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in ten weeks.
- WeekElevenVariance: number Title:
Week Eleven Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in ten weeks. - WeekFiveAllocatedHours: number Title:
Week Five Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in four weeks. - WeekFiveAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in four weeks.
- WeekFiveToEightAllocatedHours: number Title:
Weeks Five to Eight Allocated Hours
Read Only:true
The number of hours allocated to the resource for the four weeks of the project that start in four weeks. - WeekFiveToEightAssignedHours: number Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start in four weeks. - WeekFiveToEightVariance: number Title:
Weeks Five to Eight Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start in four weeks. - WeekFiveVariance: number Title:
Week Five Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in four weeks. - WeekFourAllocatedHours: number Title:
Week Four Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in three weeks. - WeekFourAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in three weeks.
- WeekFourVariance: number Title:
Week Four Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in three weeks. - WeekNineAllocatedHours: number Title:
Week Nine Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in eight weeks. - WeekNineAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in eight weeks.
- WeekNineToTwelveAllocatedHours: number Read Only:
true
The number of hours allocated to the resource for the four weeks of the project that start in eight weeks. - WeekNineToTwelveAssignedHours: number Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start in eight weeks. - WeekNineToTwelveVariance: number Title:
Weeks Nine to Twelve Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start in eight weeks. - WeekNineVariance: number Title:
Week Nine Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in eight weeks. - WeekOneAllocatedHours: number Title:
Week One Allocated Hours
The number of hours allocated to the resource for the current week of the project. - WeekOneAssignedHours: number The number of hours assigned to the resource for the current week of the project.
- WeekOneToFourAllocatedHours: number Title:
Weeks One to Four Allocated Hours
Read Only:true
The number of hours allocated to the resource for the four weeks of the project that start with the current week. - WeekOneToFourAssignedHours: number Read Only:
true
The number of hours assigned to the resource for the four weeks of the project that start with the current week. - WeekOneToFourVariance: number Title:
Weeks One to Four Allocation Variance
The variance between the allocated and assigned hours for the four weeks of the project that start with the current week. - WeekOneVariance: number Title:
Week One Allocation Variance
The variance between the allocated and assigned hours for the current week of the project. - WeekSevenAllocatedHours: number Title:
Week Seven Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in six weeks. - WeekSevenAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in six weeks.
- WeekSevenVariance: number Title:
Week Seven Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in six weeks. - WeekSixAllocatedHours: number Title:
Week Six Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in five weeks. - WeekSixAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in five weeks.
- WeekSixVariance: number Title:
Week Six Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in five weeks. - WeekTenAllocatedHours: number Title:
Week Ten Allocated Hours
The number of hours allocated to the resource for the week of the project that starts in nine weeks. - WeekTenAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in nine weeks.
- WeekTenVariance: number Title:
Week Ten Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in nine weeks. - WeekThreeAllocatedHours: number Title:
Week Three Assigned Hours
The number of hours allocated to the resource for the week of the project that starts in two weeks. - WeekThreeAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in two weeks.
- WeekThreeVariance: number Title:
Week Three Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in two weeks. - WeekTwelveAllocatedHours: number The number of hours allocated to the resource for the week of the project that starts in eleven weeks.
- WeekTwelveAssignedHours: number The number of hours assigned to the resource for the week of the project that starts in eleven weeks.
- WeekTwelveVariance: number Title:
Week Twelve Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts in eleven weeks. - WeekTwoAllocatedHours: number Title:
Week Two Allocated Hours
The number of hours allocated to the resource for the week of the project that starts next Sunday. - WeekTwoAssignedHours: number The number of hours assigned to the resource for the week of the project that starts next Sunday.
- WeekTwoVariance: number Title:
Week Two Allocation Variance
The variance between the allocated and assigned hours for the week of the project that starts next Sunday.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Examples
The following example shows how to get insights for all projects 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/projectInsights
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "items": [ { "ProjectId": 300100061807448, "ProjectName": "Fox Stores", "ActualPercentComplete": 42, "ExpectedPercentComplete": 45, "PlannedEffort": 1600, "TaskExceptionsCount": 4, "WeekOneToFourUnderAllocated": 1, "WeekFiveToEightUnderAllocated": 0, "WeekNineToTwelveUnderAllocated": 0, "WeekOneToFourOverAllocated": 1, "WeekFiveToEightOverAllocated": 0, "WeekNineToTwelveOverAllocated": 0, "AssignmentsEndingSoon": 1, "AssignmentsReserved": 2, "MilestonesAtRisk": 0, "MilestonesDueSoon": 1, "MilestonesPastDue": 0, "MissingTimeCardsFiveWeeksOld": null, "MissingTimeCardsFourWeeksOld": null, "MissingTimeCardsThreeWeeksOld": 1, "MissingTimeCardsTwoWeeksOld": 0, "MissingTimeCardsOneWeekOld": 1, "CurrentBaselineBudget": 2560000, "CurrencyCode": "USD", "BudgetSpentAmount": 453000, "BudgetToDateAmount": 471000, "ActualUnplannedCost": 20800, "ActualPlannedCost": 431200, "CommittedCost": 504000, "InvoicesAwaitingApproval": 1, "PerformanceHealthStatusCode": "INDICATOR_4", "PerformanceHealthStatus": "On track", "CreatedBy": "Lisa.Williams", "CreationDate": "2019-09-07T05:42:39+00:00", "LastUpdateDate": "2019-10-28T09:14:32+00:00", "LastUpdatedBy": "Lisa.Williams", "links": [ .... ] } ... ] }