Get the progress of all financial tasks in the project

get

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

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
  • 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.
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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.
    • 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
    • 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-TaskProgress
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    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 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",
            ...
        				}]
     						}]
    							}
    
    Back to Top