Get the progress of all resources in the project
get
/fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
TaskId(required): integer(int64)
Unique identifier of the task.
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: The unique identifier of the project resource.
Finder Variables: - findProgressByResourceId: Finds resource progress of the specified resource ID.
Finder Variables:- ResourceId; integer; The unique identifier of the project resource.
- PrimaryKey: The unique identifier of the project resource.
-
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.
- ActualFinishDate; string; Actual finish date collected during progress entry.
- ActualStartDate; string; Actual start date collected during progress entry.
- ActualsAmountsThroughPeriod; string; Period through which actual amounts are summarized for project progress.
- BaselineFinishDate; string; Planned 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; Planned 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.
- BaselinedPlannedCost; number; Baseline planned burdened cost from the project plan.
- BaselinedPlannedEffort; number; Baselined planned effort from the financial project plan.
- BaselinedPlannedQuantity; number; Baselined planned quantity from the financial project plan.
- CurrentActualAmountsDate; string; Date on which actual amounts are most recently summarized.
- CurrentActualAmountsPeriod; string; Period through which actual amounts are most recently summarized.
- CurrentPlannedCost; number; Current planned burdened cost from the project plan.
- CurrentPlannedEffort; number; Current planned effort from the financial project plan.
- CurrentPlannedQuantity; number; Current planned quantity from the financial project plan.
- EstimateatCompletionCostinProjectCurrency; number; Estimate at completion burdened cost in project currency.
- EstimateatCompletionQuantity; number; Estimate at completion quantity.
- EstimatedFinishDate; string; An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date.
- EstimatedStartDate; string; An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date.
- EstimatetoCompleteCostinProjectCurrency; number; Estimate to complete burdened cost in project currency.
- EstimatetoCompleteQuantity; number; Estimate to complete in quantity.
- PlanningEndDate; string; Scheduled end date of the task.
- PlanningStartDate; string; Scheduled start date of the task.
- ProgressAsOfDate; string; Date through which progress is captured for the project.
- ProgressAsOfPeriod; string; Period through which progress is captured for the project.
- 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. It 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. It 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 the current project progress. The status can either be Draft or Published.
- ResourceAssignmentFromDate; string; The date that is planned on the financial plan for a resource to begin their assignment on a project task.
- ResourceAssignmentToDate; string; The date that is planned on the financial plan for a resource to finish their assignment on a project task.
- ResourceClass; string; Grouping 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; Identifier of the resource breakdown structure element used to create the financial plan resource assignment.
- ResourceName; string; Name or alias of the resource included in the planning resource breakdown structure that is used to create the financial plan resource assignment.
- SourceApplicationCode; string; The third-party application from which the project originated.
- SourceApplicationReference; 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.
- UnitOfMeasure; string; Unit of work that measures the quantity of effort for which the resource is planned for on the financial plan resource assignment.
- Unplanned; string; Unplanned project cost included on the project.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectProgress-TaskProgress-ResourceProgress
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 : projectProgress-TaskProgress-ResourceProgress-item-response
Type:
Show Source
object
-
ActualAmountsDate: string
(date)
Title:
Progress Actual Amounts Summarization Date
Read Only:true
Date on which actual amounts are most recently summarized. -
ActualFinishDate: string
(date)
Title:
Actual Finish Date
Actual finish date collected during progress entry. -
ActualsAmountsThroughPeriod: string
Title:
Actual Amounts Through Period
Read Only:true
Maximum Length:30
Period through which actual amounts are summarized for project progress. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Actual start date collected during progress entry. -
Attachments: array
Attachments
Title:
Attachments
The Attachment resource is used to view, create, update, and delete attachments for resource progress. -
BaselinedPlannedCost: number
Title:
Baseline Planned Cost
Read Only:true
Baseline planned burdened cost from the project plan. -
BaselinedPlannedEffort: number
Title:
Baseline Planned Effort
Read Only:true
Baselined planned effort from the financial project plan. -
BaselinedPlannedQuantity: number
Title:
Baseline Planned Quantity
Read Only:true
Baselined planned quantity from the financial project plan. -
BaselineFinishDate: string
(date)
Title:
Baseline Finish Date
Read Only:true
Planned 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 Date
Read Only:true
Planned 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 Date
Read Only:true
Date on which actual amounts are most recently summarized. -
CurrentActualAmountsPeriod: string
Title:
Current Actual Amount Period
Read Only:true
Maximum Length:255
Period through which actual amounts are most recently summarized. -
CurrentPlannedCost: number
Title:
Current Planned Cost
Read Only:true
Current planned burdened cost from the project plan. -
CurrentPlannedEffort: number
Title:
Current Planned Effort
Read Only:true
Current planned effort from the financial project plan. -
CurrentPlannedQuantity: number
Title:
Current Planned Quantity
Read Only:true
Current planned quantity from the financial project plan. -
EstimateatCompletionCostinProjectCurrency: number
Title:
EAC
Read Only:true
Estimate at completion burdened cost in project currency. -
EstimateatCompletionQuantity: number
Title:
EAC
Read Only:true
Estimate at completion quantity. -
EstimatedFinishDate: string
(date)
Title:
Estimated Finish Date
An estimated finish date collected during progress entry and usually defaulted to the resource assignments planned to date. -
EstimatedStartDate: string
(date)
Title:
Estimated Start Date
An estimated start date collected during progress entry and usually defaulted to the resource assignments planned start date. -
EstimatetoCompleteCostinProjectCurrency: number
Title:
ETC
Estimate to complete burdened cost in project currency. -
EstimatetoCompleteQuantity: number
Title:
ETC
Estimate to complete in quantity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: array
Notes
Title:
Notes
The Note resource is used to view, create, update, and delete notes for resource progress. -
PlanningEndDate: string
(date)
Title:
Planned Finish Date
Read Only:true
Scheduled end date of the task. -
PlanningStartDate: string
(date)
Title:
Planned Start Date
Read Only:true
Scheduled start date of the task. -
ProgressAsOfDate: string
(date)
Title:
Progress As-of Date
Read Only:true
Date through which progress is captured for the project. -
ProgressAsOfPeriod: string
Title:
Progress As-of Period
Read Only:true
Maximum Length:30
Period through which progress is captured for the project. -
ProjectBurdenedActualCost: number
Title:
Actual Burdened Cost in Project Currency
Read Only:true
Cost 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 Currency
Read Only:true
Maximum Length:15
The currency code for the project. It is a three-letter ISO code associated with a currency. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Unique identifier of the project. -
ProjectLedgerBurdenedActualCost: number
Title:
Actual Burdened Cost in Ledger Currency
Read Only:true
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
Title:
Project Ledger Currency
Read Only:true
Maximum Length:15
The 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 Currency
Read Only:true
Actual amount paid or actual amount incurred for the task in project ledger currency. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name assigned to the project. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Alphanumeric identifier of the project. -
ProjectRawActualCost: number
Title:
Actual Raw Cost in Project Currency
Read Only:true
Actual amount paid or actual amount incurred for the task in project currency. -
PublicationStatus: string
Title:
Progress Publication Status
Read Only:true
Maximum Length:255
Status of the current project progress. The status can either be Draft or Published. -
ResourceAssignmentFromDate: string
(date)
Title:
Resource Assignment From Date
Read Only:true
The 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 Date
Read Only:true
The date that is planned on the financial plan for a resource to finish their assignment on a project task. -
ResourceClass: string
Title:
Resource Class
Read Only:true
Maximum Length:30
Grouping 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 ID
Read Only:true
Identifier of the resource breakdown structure element used to create the financial plan resource assignment. -
ResourceName: string
Title:
Resource
Read Only:true
Maximum Length:240
Name 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 Flexfields
The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress. -
SourceApplicationCode: string
Title:
Source Application
Read Only:true
Maximum Length:30
The third-party application from which the project originated. -
SourceApplicationReference: string
Title:
Source Reference
Read Only:true
Maximum Length:25
The identifier of the project in the external application where it was originally created. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
Unique identifier of the task. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name assigned to the task. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Alphanumeric identifier of the task. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
Unit 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 Resource
Read Only:true
Maximum Length:1
Default Value:N
Unplanned project cost included on the project.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachment resource is used to view, create, update, and delete attachments for resource progress.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Note resource is used to view, create, update, and delete notes for resource progress.
Show Source
Nested Schema : Resource Progress Descriptive Flexfields
Type:
array
Title:
Resource Progress Descriptive Flexfields
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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 : projectProgress-TaskProgress-ResourceProgress-Notes-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last 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. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the progress note. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the progress note.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Segment
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context display value of the descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectProgressId: integer
(int64)
Unique identifier of the project progress.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source