Update the progress of a resource
patch
/fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}/child/TaskProgress/{TaskId}/child/ResourceProgress/{ResourceId}
Request
Path Parameters
-
ProjectId(required): integer(int64)
Unique identifier of the project.
-
ResourceId(required): integer(int64)
Identifier of the resource breakdown structure element used to create the financial plan resource assignment.
-
TaskId(required): integer(int64)
Unique identifier of the task.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActualFinishDate: string
(date)
Title:
Actual Finish DateActual finish date collected during progress entry. -
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. -
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. -
Notes: array
Notes
Title:
NotesThe Note resource is used to view, create, update, and delete notes for resource progress. -
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.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachment resource is used to view, create, update, and delete attachments for resource progress.
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-patch-request
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
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. -
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.
Nested Schema : projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request
Type:
Show Source
object-
NoteTxt: string
(byte)
Title:
Note TextThe text for the progress note.
Nested Schema : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request
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.
Response
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-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 : 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-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
Links
- Attachments
-
Parameters:
- ProjectId:
$request.path.ProjectId - ResourceId:
$request.path.ResourceId - TaskId:
$request.path.TaskId
The Attachment resource is used to view, create, update, and delete attachments for resource progress. - ProjectId:
- Notes
-
Parameters:
- ProjectId:
$request.path.ProjectId - ResourceId:
$request.path.ResourceId - TaskId:
$request.path.TaskId
The Note resource is used to view, create, update, and delete notes for resource progress. - ProjectId:
- ResourceProgressDFF
-
Parameters:
- ProjectId:
$request.path.ProjectId - ResourceId:
$request.path.ResourceId - TaskId:
$request.path.TaskId
The Resource Progress Descriptive Flexfields resource is used to view, create, and update additional information for resource progress. - ProjectId: