Update the draft progress of the project

patch

/fscmRestApi/resources/11.13.18.05/projectProgress/{ProjectId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachment resource is used to view, create, update, and delete attachments for project progress.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Note resource is used to view, create, update, and delete notes for project progress.
Show Source
Nested Schema : Project Progress Descriptive Flexfields
Type: array
Title: Project Progress Descriptive Flexfields
The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress.
Show Source
Nested Schema : Task Progress
Type: array
Title: Task Progress
The Task Progress resource is used to capture, view, and update draft progress for the tasks of a project enabled for financial management.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : projectProgress-Notes-item-patch-request
Type: object
Show Source
Nested Schema : projectProgress-ProjectProgressDFF-item-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-item-patch-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachment resource is used to view, create, update, and delete attachments for task progress.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Note resource is used to view, create, update, and delete notes for task progress.
Show Source
Nested Schema : Resource Progress
Type: array
Title: Resource Progress
The 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: array
Title: Task Progress Descriptive Flexfields
The 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-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-Notes-item-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-item-patch-request
Type: object
Show Source
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 : 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-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-Notes-item-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-patch-request
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-TaskProgressDFF-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : projectProgress-item-response
Type: object
Show Source
  • Title: Progress Actual Amounts Summarization Date
    Read Only: true
    Date on which actual amounts are summarized for project progress.
  • Title: Actual Amounts Through Period
    Read Only: true
    Maximum Length: 30
    Period through which actual amounts are summarized for project progress.
  • Title: Actual Finish Date
    Date on which work completed on the project as opposed to the planned end date of the project.
  • Title: Actual Start Date
    Date on which work commenced on the project as opposed to the planned start date of the project.
  • Attachments
    Title: Attachments
    The Attachment resource is used to view, create, update, and delete attachments for project progress.
  • Title: Baseline Finish Date
    Read Only: true
    Planned end date of the project in baseline project plan. Used to compare the deviation of the current project end from the original planned end date.
  • Title: Baseline Start Date
    Read Only: true
    Planned start date of the project in baseline project plan. Used to compare the deviation of the current project start from the original planned start date.
  • Title: Current Actual Amounts Summarization Date
    Read Only: true
    Date on which actual amounts are most recently summarized.
  • Title: Current Actual Amount Period
    Read Only: true
    Maximum Length: 255
    Period through which actual amounts are most recently summarized.
  • Title: Estimated Finish Date
    Projected end date of the project.
  • Title: Estimated Start Date
    Projected start date of the project.
  • Links
  • Notes
    Title: Notes
    The Note resource is used to view, create, update, and delete notes for project progress.
  • Title: Physical Percent Complete
    The amount of physical work achieved on the project.
  • Title: Planned Finish Date
    Read Only: true
    Scheduled end date of the project.
  • Title: Planned Start Date
    Read Only: true
    Scheduled start date of the project.
  • Title: Previous Physical Percent Complete
    Read Only: true
    The amount of physical work achieved on the project in the most recently captured progress.
  • Title: Progress As-of Date
    Read Only: true
    Date through which progress is captured for the project.
  • Title: Progress As-of Period
    Read Only: true
    Maximum Length: 30
    Period through which progress is captured for the project.
  • Title: Progress Status
    Status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the project.
  • Title: Progress Status Code
    Maximum Length: 30
    Code of the status, such as In Trouble, On Track or At Risk, that indicates the overall progress of the project.
  • Title: Actual Burdened Cost in Project Currency
    Read Only: true
    Cost that is actually charged to the project in project currency. Burdened cost is the sum of raw cost and the overhead.
  • Title: Project Currency
    Read Only: true
    Maximum Length: 15
    The currency code for the project. The currency code is a three-letter ISO code associated with a currency.
  • Title: Project ID
    Read Only: true
    Unique identifier of the project.
  • Title: Actual Burdened Cost in Ledger Currency
    Read Only: true
    Cost that is actually charged to the project in project ledger currency. Burdened cost is the sum of raw cost and the overhead.
  • Title: Project Ledger Currency
    Read Only: true
    Maximum Length: 15
    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.
  • Title: Actual Raw Cost in Ledger Currency
    Read Only: true
    Actual amount paid or actual amount incurred for the project in project ledger currency.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    Name assigned to the project.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    Alphanumeric identifier of the project.
  • Project Progress Descriptive Flexfields
    Title: Project Progress Descriptive Flexfields
    The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress.
  • Title: Actual Raw Cost in Project Currency
    Read Only: true
    Actual amount paid or actual amount incurred for the project in project currency.
  • Title: Progress Publication Status
    Read Only: true
    Maximum Length: 255
    Status of current project progress. The status can either be Draft or Published.
  • Title: Source Application
    Read Only: true
    Maximum Length: 30
    The third-party application from which the project originated.
  • Title: Source Reference
    Read Only: true
    Maximum Length: 25
    The identifier of the project in the external application where it was originally created.
  • Task Progress
    Title: Task Progress
    The Task Progress resource is used to capture, view, and update draft progress for the tasks of a project enabled for financial management.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachment resource is used to view, create, update, and delete attachments for project progress.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Note resource is used to view, create, update, and delete notes for project progress.
Show Source
Nested Schema : Project Progress Descriptive Flexfields
Type: array
Title: Project Progress Descriptive Flexfields
The Project Progress Descriptive Flexfields resource is used to view, create, and update additional information for project progress.
Show Source
Nested Schema : Task Progress
Type: array
Title: Task Progress
The Task Progress resource is used to capture, view, and update draft progress for the tasks of a project enabled for financial management.
Show Source
Nested Schema : projectProgress-Attachments-item-response
Type: object
Show Source
Nested Schema : projectProgress-Notes-item-response
Type: object
Show Source
Nested Schema : projectProgress-ProjectProgressDFF-item-response
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachment resource is used to view, create, update, and delete attachments for task progress.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Note resource is used to view, create, update, and delete notes for task progress.
Show Source
Nested Schema : Resource Progress
Type: array
Title: Resource Progress
The 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: array
Title: Task Progress Descriptive Flexfields
The 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: object
Show Source
Nested Schema : projectProgress-TaskProgress-Notes-item-response
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-Notes-item-response
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-ResourceProgress-ResourceProgressDFF-item-response
Type: object
Show Source
Nested Schema : projectProgress-TaskProgress-TaskProgressDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update the progress of a project by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projectProgress/300100084467245

Example of Request Body

The following example shows the request body to update the project progress of the project with the project id 300100084467245.

{ 
      "PercentComplete": "30"
      }

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
        "ProjectId": 300100084467245,
        "ProjectName": "PJO_PROGRESS_OTBI1",
        "ProjectNumber": "PJO_PROGRESS_OTBI1",
        "SourceApplicationCode": null,
        "SourceProjectReference": null,
        "ProgressAsOfDate": "2015-05-21",
        "ProgressAsOfPeriod": "May-15",
        "ActualAmountsThroughPeriod": "May-16",
        "ActualAmountsDate": null,
        "PublicationStatus": "DRAFT",
        "CurrentActualAmountsPeriod": null,
        "CurrentActualAmountsDate": null,
        "PlannedStartDate": "2015-01-01",
        "PlannedFinishDate": "2015-06-02",
        "BaselineStartDate": "2015-01-01",
        "BaselineFinishDate": "2015-06-02",
        "EstimatedStartDate": "2015-01-01",
        "EstimatedFinishDate": "2015-06-02",
        "ActualStartDate": "2015-01-01",
        "ActualFinishDate": null,
        "PercentComplete": 30,
        "PreviousPercentComplete": 1.9866278279,
        "ProjectCurrency": "USD",
        "ProjectRawActualCost": null,
        "ProjectBurdenedActualCost": null,
        "ProjectLedgerCurrency": "USD",
        "ProjectLedgerRawActualCost": null,
        "ProjectLedgerBurdenedActualCost": null,
        "ProgressStatusCode": null,
        "ProgressStatus": null,
         ...
		}
Back to Top