Get the progress of all financial tasks in the project
get
/fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds task progress of the specified project task ID.
Finder Variables: - findProgressByTaskId: Finds task progress of the specified task ID.
Finder Variables:- TaskId; integer; The unique identifier of the project task.
- findProgressByTaskNumber: Finds task progress of the specified task number.
Finder Variables:- TaskNumber; string; Number of the project task that is being queried.
- PrimaryKey: Finds task progress of the specified project task ID.
-
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:- ActualAmountsDate; string; Date on which actual amounts are most recently summarized.
- ActualAmountsThroughPeriod; string; Period through which actual amounts are summarized for project progress.
- ActualFinishDate; string; Date on which work completed on the task as opposed to the planned end date of the task.
- ActualStartDate; string; Date on which work commenced on the task as opposed to the planned start date of the task.
- BaselineFinishDate; string; Planned end date of the task in baseline project plan. Used to compare the deviation of the current task end from the original planned end date.
- BaselineStartDate; string; Planned start date of the task in baseline project plan. Used to compare the deviation of the current task start from the original planned start date.
- CurrentActualAmountsDate; string; Date on which actual amounts are most recently summarized.
- CurrentActualAmountsPeriod; string; Period through which actual amounts are most recently summarized.
- EstimatedFinishDate; string; Projected end date of the task.
- EstimatedStartDate; string; Projected start date of the task.
- PercentComplete; number; The amount of physical work achieved on the task.
- PlannedFinishDate; string; Scheduled end date of the task.
- PlannedStartDate; string; Scheduled start date of the task.
- PreviousPercentComplete; number; The amount of physical work achieved on the task in the most recently captured progress.
- ProgressAsOfDate; string; Date through which progress is captured for the project.
- ProgressAsOfPeriod; string; Period through which progress is captured for the project.
- ProgressStatus; string; Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
- ProgressStatusCode; string; Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task.
- ProjectBurdenedActualCost; number; Cost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead.
- ProjectCurrency; string; The currency code for the project. The currency code is a three-letter ISO code associated with a currency.
- ProjectId; integer; Unique identifier of the project.
- ProjectLedgerBurdenedActualCost; number; Cost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead.
- ProjectLedgerCurrency; string; The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency.
- ProjectLedgerRawActualCost; number; Actual amount paid or actual amount incurred for the task in project ledger currency.
- ProjectName; string; Name assigned to the project.
- ProjectNumber; string; Alphanumeric identifier of the project.
- ProjectRawActualCost; number; Actual amount paid or actual amount incurred for the task in project currency.
- PublicationStatus; string; Status of current project progress. The status can either be Draft or Published.
- SourceApplicationCode; string; The third-party application from which the project originated.
- SourceProjectReference; string; The identifier of the project in the external application where it was originally created.
- TaskId; integer; Unique identifier of the task.
- TaskName; string; Name assigned to the task.
- TaskNumber; string; Alphanumeric identifier of the task.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectProgress-TaskProgress
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectProgress-TaskProgress-item-response
Type:
Show Source
object-
ActualAmountsDate: string
(date)
Title:
Progress Actual Amounts Summarization DateRead Only:trueDate on which actual amounts are most recently summarized. -
ActualAmountsThroughPeriod: string
Title:
Actual Amounts Through PeriodRead Only:trueMaximum Length:30Period through which actual amounts are summarized for project progress. -
ActualFinishDate: string
(date)
Title:
Actual Finish DateDate on which work completed on the task as opposed to the planned end date of the task. -
ActualStartDate: string
(date)
Title:
Actual Start DateDate on which work commenced on the task as opposed to the planned start date of the task. -
Attachments: array
Attachments
Title:
AttachmentsThe Attachment resource is used to view, create, update, and delete attachments for task progress. -
BaselineFinishDate: string
(date)
Title:
Baseline Finish DateRead Only:truePlanned end date of the task in baseline project plan. Used to compare the deviation of the current task end from the original planned end date. -
BaselineStartDate: string
(date)
Title:
Baseline Start DateRead Only:truePlanned start date of the task in baseline project plan. Used to compare the deviation of the current task start from the original planned start date. -
CurrentActualAmountsDate: string
(date)
Title:
Current Actual Amounts Summarization DateRead Only:trueDate on which actual amounts are most recently summarized. -
CurrentActualAmountsPeriod: string
Title:
Current Actual Amount PeriodRead Only:trueMaximum Length:255Period through which actual amounts are most recently summarized. -
EstimatedFinishDate: string
(date)
Title:
Estimated Finish DateProjected end date of the task. -
EstimatedStartDate: string
(date)
Title:
Estimated Start DateProjected start date of the task. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Notes: array
Notes
Title:
NotesThe Note resource is used to view, create, update, and delete notes for task progress. -
PercentComplete: number
Title:
Physical Percent CompleteThe amount of physical work achieved on the task. -
PlannedFinishDate: string
(date)
Title:
Planned Finish DateRead Only:trueScheduled end date of the task. -
PlannedStartDate: string
(date)
Title:
Planned Start DateRead Only:trueScheduled start date of the task. -
PreviousPercentComplete: number
Title:
Previous Physical Percent CompleteRead Only:trueThe amount of physical work achieved on the task in the most recently captured progress. -
ProgressAsOfDate: string
(date)
Title:
Progress As-of DateRead Only:trueDate through which progress is captured for the project. -
ProgressAsOfPeriod: string
Title:
Progress As-of PeriodRead Only:trueMaximum Length:30Period through which progress is captured for the project. -
ProgressStatus: string
Title:
Progress StatusStatus, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task. -
ProgressStatusCode: string
Title:
Progress Status CodeMaximum Length:30Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the task. -
ProjectBurdenedActualCost: number
Title:
Actual Burdened Cost in Project CurrencyRead Only:trueCost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead. -
ProjectCurrency: string
Title:
Project CurrencyRead Only:trueMaximum Length:15The currency code for the project. The currency code is a three-letter ISO code associated with a currency. -
ProjectId: integer
(int64)
Title:
Project IDRead Only:trueUnique identifier of the project. -
ProjectLedgerBurdenedActualCost: number
Title:
Actual Burdened Cost in Ledger CurrencyRead Only:trueCost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead. -
ProjectLedgerCurrency: string
Title:
Project Ledger CurrencyRead Only:trueMaximum Length:15The currency code used for accounting and reporting in the project ledger. The currency code is a three-letter ISO code associated with a currency. -
ProjectLedgerRawActualCost: number
Title:
Actual Raw Cost in Ledger CurrencyRead Only:trueActual amount paid or actual amount incurred for the task in project ledger currency. -
ProjectName: string
Title:
Project NameRead Only:trueMaximum Length:240Name assigned to the project. -
ProjectNumber: string
Title:
Project NumberRead Only:trueMaximum Length:25Alphanumeric identifier of the project. -
ProjectRawActualCost: number
Title:
Actual Raw Cost in Project CurrencyRead Only:trueActual amount paid or actual amount incurred for the task in project currency. -
PublicationStatus: string
Title:
Progress Publication StatusRead Only:trueMaximum Length:255Status of current project progress. The status can either be Draft or Published. -
ResourceProgress: array
Resource Progress
Title:
Resource ProgressThe Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management. -
SourceApplicationCode: string
Title:
Source ApplicationRead Only:trueMaximum Length:30The third-party application from which the project originated. -
SourceProjectReference: string
Title:
Source ReferenceRead Only:trueMaximum Length:25The identifier of the project in the external application where it was originally created. -
TaskId: integer
(int64)
Title:
Task IDRead Only:trueUnique identifier of the task. -
TaskName: string
Title:
Task NameRead Only:trueMaximum Length:255Name assigned to the task. -
TaskNumber: string
Title:
Task NumberRead Only:trueMaximum Length:100Alphanumeric identifier of the task. -
TaskProgressDFF: array
Task Progress Descriptive Flexfields
Title:
Task Progress Descriptive FlexfieldsThe Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachment resource is used to view, create, update, and delete attachments for task progress.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe Note resource is used to view, create, update, and delete notes for task progress.
Show Source
Nested Schema : Resource Progress
Type:
arrayTitle:
Resource ProgressThe Project Progress resource is used to capture draft progress, view draft and published progress, update draft progress, and publish progress for a project enabled for financial management.
Show Source
Nested Schema : Task Progress Descriptive Flexfields
Type:
arrayTitle:
Task Progress Descriptive FlexfieldsThe Task Progress Descriptive Flexfields resource is used to view, create, and update additional information for task progress.
Show Source
Nested Schema : projectProgress-TaskProgress-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 : 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 : projectProgress-TaskProgress-Notes-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 Update 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. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the progress note. -
NoteTxt: string
(byte)
Title:
Note TextThe text for the progress note.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-item-response
Type:
Show Source
object-
ActualAmountsDate: string
(date)
Title:
Progress Actual Amounts Summarization DateRead Only:trueDate on which actual amounts are most recently summarized. -
ActualFinishDate: string
(date)
Title:
Actual Finish DateActual finish date collected during progress entry. -
ActualsAmountsThroughPeriod: string
Title:
Actual Amounts Through PeriodRead Only:trueMaximum Length:30Period through which actual amounts are summarized for project progress. -
ActualStartDate: string
(date)
Title:
Actual Start DateActual start date collected during progress entry. -
Attachments: array
Attachments
Title:
AttachmentsThe Attachment resource is used to view, create, update, and delete attachments for resource progress. -
BaselinedPlannedCost: number
Title:
Baseline Planned CostRead Only:trueBaseline planned burdened cost from the project plan. -
BaselinedPlannedEffort: number
Title:
Baseline Planned EffortRead Only:trueBaselined planned effort from the financial project plan. -
BaselinedPlannedQuantity: number
Title:
Baseline Planned QuantityRead Only:trueBaselined planned quantity from the financial project plan. -
BaselineFinishDate: string
(date)
Title:
Baseline Finish DateRead Only:truePlanned end date of the task in the baseline project plan. Used to compare the deviation of the current task end from the original planned end date. -
BaselineStartDate: string
(date)
Title:
Baseline Start DateRead Only:truePlanned start date of the task in the baseline project plan. Used to compare the deviation of the current task start from the original planned start date. -
CurrentActualAmountsDate: string
(date)
Title:
Current Actual Amounts Summarization DateRead Only:trueDate on which actual amounts are most recently summarized. -
CurrentActualAmountsPeriod: string
Title:
Current Actual Amount PeriodRead Only:trueMaximum Length:255Period through which actual amounts are most recently summarized. -
CurrentPlannedCost: number
Title:
Current Planned CostRead Only:trueCurrent planned burdened cost from the project plan. -
CurrentPlannedEffort: number
Title:
Current Planned EffortRead Only:trueCurrent planned effort from the financial project plan. -
CurrentPlannedQuantity: number
Title:
Current Planned QuantityRead Only:trueCurrent planned quantity from the financial project plan. -
EstimateatCompletionCostinProjectCurrency: number
Title:
EACRead Only:trueEstimate at completion burdened cost in project currency. -
EstimateatCompletionQuantity: number
Title:
EACRead Only:trueEstimate at completion quantity. -
EstimatedFinishDate: string
(date)
Title:
Estimated Finish DateAn estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date. -
EstimatedStartDate: string
(date)
Title:
Estimated Start DateAn estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date. -
EstimatetoCompleteCostinProjectCurrency: number
Title:
ETCEstimate to complete burdened cost in project currency. -
EstimatetoCompleteQuantity: number
Title:
ETCEstimate to complete in quantity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Notes: array
Notes
Title:
NotesThe Note resource is used to view, create, update, and delete notes for resource progress. -
PlanningEndDate: string
(date)
Title:
Planned Finish DateRead Only:trueScheduled end date of the task. -
PlanningStartDate: string
(date)
Title:
Planned Start DateRead Only:trueScheduled start date of the task. -
ProgressAsOfDate: string
(date)
Title:
Progress As-of DateRead Only:trueDate through which progress is captured for the project. -
ProgressAsOfPeriod: string
Title:
Progress As-of PeriodRead Only:trueMaximum Length:30Period through which progress is captured for the project. -
ProjectBurdenedActualCost: number
Title:
Actual Burdened Cost in Project CurrencyRead Only:trueCost that is actually charged to the task in project currency. Burdened cost is the sum of raw cost and the overhead. -
ProjectCurrency: string
Title:
Project CurrencyRead Only:trueMaximum Length:15The currency code for the project. It is a three-letter ISO code associated with a currency. -
ProjectId: integer
(int64)
Title:
Project IDRead Only:trueUnique identifier of the project. -
ProjectLedgerBurdenedActualCost: number
Title:
Actual Burdened Cost in Ledger CurrencyRead Only:trueCost that is actually charged to the task in project ledger currency. Burdened cost is the sum of raw cost and the overhead. -
ProjectLedgerCurrency: string
Title:
Project Ledger CurrencyRead Only:trueMaximum Length:15The currency code used for accounting and reporting in the project ledger. It is a three-letter ISO code associated with a currency. -
ProjectLedgerRawActualCost: number
Title:
Actual Raw Cost in Ledger CurrencyRead Only:trueActual amount paid or actual amount incurred for the task in project ledger currency. -
ProjectName: string
Title:
Project NameRead Only:trueMaximum Length:240Name assigned to the project. -
ProjectNumber: string
Title:
Project NumberRead Only:trueMaximum Length:25Alphanumeric identifier of the project. -
ProjectRawActualCost: number
Title:
Actual Raw Cost in Project CurrencyRead Only:trueActual amount paid or actual amount incurred for the task in project currency. -
PublicationStatus: string
Title:
Progress Publication StatusRead Only:trueMaximum Length:255Status of the current project progress. The status can either be Draft or Published. -
ResourceAssignmentFromDate: string
(date)
Title:
Resource Assignment From DateRead Only:trueThe date that is planned on the financial plan for a resource to begin their assignment on a project task. -
ResourceAssignmentToDate: string
(date)
Title:
Resource Assignment To DateRead Only:trueThe date that is planned on the financial plan for a resource to finish their assignment on a project task. -
ResourceClass: string
Title:
Resource ClassRead Only:trueMaximum Length:30Grouping of predefined resource types to which the resource in the financial plan resource assignment belongs. A list of valid values are Labor, Equipment, Material Items, and Financial Resources. -
ResourceId: integer
(int64)
Title:
Resource IDRead Only:trueIdentifier of the resource breakdown structure element used to create the financial plan resource assignment. -
ResourceName: string
Title:
ResourceRead Only:trueMaximum Length:240Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment. -
ResourceProgressDFF: array
Resource Progress Descriptive Flexfields
Title:
Resource Progress Descriptive FlexfieldsThe Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress. -
SourceApplicationCode: string
Title:
Source ApplicationRead Only:trueMaximum Length:30The third-party application from which the project originated. -
SourceApplicationReference: string
Title:
Source ReferenceRead Only:trueMaximum Length:25The identifier of the project in the external application where it was originally created. -
TaskId: integer
(int64)
Title:
Task IDRead Only:trueUnique identifier of the task. -
TaskName: string
Title:
Task NameRead Only:trueMaximum Length:255Name assigned to the task. -
TaskNumber: string
Title:
Task NumberRead Only:trueMaximum Length:100Alphanumeric identifier of the task. -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:30Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment. -
Unplanned: string
Title:
Unplanned ResourceRead Only:trueMaximum Length:1Default Value:NUnplanned project cost included on the project.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachment resource is used to view, create, update, and delete attachments for resource progress.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe Note resource is used to view, create, update, and delete notes for resource progress.
Show Source
Nested Schema : Resource Progress Descriptive Flexfields
Type:
arrayTitle:
Resource Progress Descriptive FlexfieldsThe Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress.
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-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 : projectProgress-TaskProgress-ResourceProgress-Notes-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 Update 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. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the progress note. -
NoteTxt: string
(byte)
Title:
Note TextThe text for the progress note.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext display value of the descriptive flexfield. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjectProgressId: integer
(int64)
Unique identifier of the project progress.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectProgress-TaskProgress-TaskProgressDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext display value of the descriptive flexfield. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjectProgressId: integer
(int64)
Unique identifier of the project progress.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get the progress of all tasks of 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.0.0/projectProgress/PRJ7909228/child/taskProgress/
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"ProjectId" : PRJ7909228,
"ProjectName" : "Fusion_SCM_Implementation",
"ProjectNumber" : "Fusion_SCM_Implementation",
"SourceApplicationCode" : null,
"SourceProjectReference" : null,
"ProgressAsOfDate" : "2015-03-25",
"ProgressAsOfPeriod" : "Mar-15",
"ActualAmountsThroughPeriod" : "Mar-15",
"ActualAmountsDate" : "2015-03-25",
"PublicationStatus" : "LATEST_PUBLISHED",
"CurrentActualAmountsPeriod" : null,
"CurrentActualAmountsDate" : null,
"PlannedStartDate" : "2016-01-01",
"PlannedFinishDate" : "2016-06-02",
"BaselineStartDate" : "2016-01-01",
"BaselineFinishDate" : "2016-06-02",
"EstimatedStartDate" : "2016-01-01",
"EstimatedFinishDate" : "2016-06-02",
"ActualStartDate" : "2016-02-01",
"ActualFinishDate" : null,
"PercentComplete" : 39.6633163387,
"PreviousPercentComplete" : null,
"ProjectCurrency" : "USD",
"ProjectRawActualCost" : 2750,
"ProjectBurdenedActualCost" : 3760.188,
"ProjectLedgerCurrency" : "USD",
"ProjectLedgerRawActualCost" : 2750,
"ProjectLedgerBurdenedActualCost" : 3760.188,
"ProgressStatusCode" : "PROGRESS_STAT_IN_TROUBLE",
"ProgressStatus" : "In Trouble",
"ProgressStatusCodeLOV" : [ {
"ProgressStatusCode" : "300100039542390",
"ProgressStatus" : "UE_At Risk",
"StartDateActive" : "2001-01-01",
"EndDateActive" : null,
...
"TaskProgress" : [ {
"ProjectId" : PRJ7909228,
"ProjectName" : "Fusion_SCM_Implementation",
"ProjectNumber" : "Fusion_SCM_Implementation",
"SourceApplicationCode" : null,
"SourceProjectReference" : null,
"TaskId" : Implementation_Analysis,
"TaskName" : "Schematic Design Phase",
"TaskNumber" : "1.0",
"ProgressAsOfDate" : "2015-03-25",
"ProgressAsOfPeriod" : "Mar-15",
"ActualAmountsThroughPeriod" : "Mar-15",
"ActualAmountsDate" : "2015-03-25",
"PublicationStatus" : "LATEST_PUBLISHED",
"CurrentActualAmountsPeriod" : null,
"CurrentActualAmountsDate" : null,
"PlannedStartDate" : "2015-01-01",
"PlannedFinishDate" : "2015-03-17",
"BaselineStartDate" : "2015-01-01",
"BaselineFinishDate" : "2015-03-17",
"EstimatedStartDate" : "2015-01-01",
"EstimatedFinishDate" : "2015-03-17",
"ActualStartDate" : "2015-02-01",
"ActualFinishDate" : null,
"PercentComplete" : 17.9693957493,
"PreviousPercentComplete" : null,
"ProjectCurrency" : "USD",
"ProjectRawActualCost" : 2170.4,
"ProjectBurdenedActualCost" : 3000.012,
"ProjectLedgerCurrency" : "USD",
"ProjectLedgerRawActualCost" : 2170.4,
"ProjectLedgerBurdenedActualCost" : 3000.012,
"ProgressStatusCode" : "PROGRESS_STAT_IN_TROUBLE",
"ProgressStatus" : "In Trouble",
...
}]
}]
}