Get the progress of the project

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 get progress for a particular project by submitting a GET request on the REST resource using cURL.

Note:

You can use this operation to get progress of projects whose PublicationStatus is DRAFT. If you need to get progress of projects whose PublicationStatus is LATEST_PUBLISHED, then use the Get the progress of all projects operation with the required finder.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projectProgress/300100072419098

Response Body Example

The following shows an example of the response body in JSON format.

{
      "ProjectId" : 300100072419098,
      "ProjectName" : "KNU_ExtSysControl Proj",
      "ProjectNumber" : "KNU_ExtSysControl Proj",
      "SourceApplicationCode" : null,
      "SourceProjectReference" : null,
      "TaskId" : 300100072419119,
      "TaskName" : "Complete Rough Framing",
      "TaskNumber" : "4.1",
      "ProgressAsOfDate" : "2015-12-05",
      "ProgressAsOfPeriod" : "Dec-15",
      "ActualAmountsThroughPeriod" : "Nov-15",
      "ActualAmountsDate" : "2015-11-05",
      "PublicationStatus" : "DRAFT",
      "CurrentActualAmountsPeriod" : null,
      "CurrentActualAmountsDate" : "2015-11-05",
      "PlannedStartDate" : "2015-08-01",
      "PlannedFinishDate" : "2015-12-30",
      "BaselineStartDate" : "2015-08-01",
      "BaselineFinishDate" : "2015-12-30",
      "EstimatedStartDate" : "2015-08-01",
      "EstimatedFinishDate" : "2015-12-30",
      "ActualStartDate" : null,
      "ActualFinishDate" : null,
      "PercentComplete" : 0,
      "PreviousPercentComplete" : null,
      "ProjectCurrency" : "USD",
      "ProjectRawActualCost" : null,
      "ProjectBurdenedActualCost" : null,
      "ProjectLedgerCurrency" : "USD",
      "ProjectLedgerRawActualCost" : null,
      "ProjectLedgerBurdenedActualCost" : null,
      "ProgressStatusCode" : null,
      "ProgressStatus" : null,
      ...
			 }
Back to Top