1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Change Orders
  4. Change Impacts

Get all impacts for a change order

get

/fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts

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 an impact for the change order with the specified primary key.
      Finder Variables:
      • ImpactId; integer; The unique identifier of impact for the change order.
    • findByImpactId: Finds all change impacts with the specified impact ID.
      Finder Variables:
      • ImpactId; string; The unique identifier of impact for the change order.
    • findImpactByArea: Finds all impacts for the change order with the specified impact area.
      Finder Variables:
      • Bind_ImpactArea; string; The unique identifier of the impact area for the change order.
    • findImpactByParticipant: Finds all impacts for the change order with the specified participant ID.
      Finder Variables:
      • Bind_ParticipantId; string; The unique identifier of the owner of the impact for the change order.
  • 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:
    • Area; string; The code of the impact area of a change order. Valid values are BUDGET_AND_FORECAST, CONTRACTS, OTHERS, PROJECT_PLAN, REQUIREMENTS, and RESOURCES. The default value is PROJECT_PLAN.
    • ContractAmount; number; Contract amount of the impact of a change order.
    • Currency; string; Currency code for the amounts impacted by the change. If project is specified for the change order, currency is defaulted to project currency. Otherwise, default value for currency is USD.
    • Description; string; Description of the impact of a change order.
    • EffortsInHours; number; Effort required in hours to implement the change requested.
    • EstimatedCost; number; Estimated cost to implement the change requested.
    • EstimatedRevenue; number; Estimated revenue to implement the change requested.
    • ImpactId; integer; Unique identifier of the impact to the change order.
    • ImpactOwnerEmail; string; Email of the impact owner.
    • ImpactOwnerId; integer; Resource identifier of the impact owner.
    • ImpactOwnerName; string; Name of the impact owner.
    • ImpactTo; string; The detail of the impacted object type such as a cost budget or revenue budget.
    • ImpactedObjectId; integer; Identifier of the impacted object such as a budget version or a forecast version.
    • Summary; string; Summary of the impact of a change order.
  • 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 : changeOrders-ChangeImpacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : changeOrders-ChangeImpacts-item-response
Type: object
Show Source
  • Title: Impact Area Code
    Maximum Length: 30
    The code of the impact area of a change order. Valid values are BUDGET_AND_FORECAST, CONTRACTS, OTHERS, PROJECT_PLAN, REQUIREMENTS, and RESOURCES. The default value is PROJECT_PLAN.
  • Change Impact Details
    Title: Change Impact Details
    The Change Impact Details resource is used to view, create, update or delete the impact details for a change order. Change Impact Details can be created only for the impacts where the impact area is defined as Budget and Forecast.
  • Title: Contract Amount
    Contract amount of the impact of a change order.
  • Title: Impact Currency Code
    Maximum Length: 15
    Currency code for the amounts impacted by the change. If project is specified for the change order, currency is defaulted to project currency. Otherwise, default value for currency is USD.
  • Title: Impact Description
    Maximum Length: 2000
    Description of the impact of a change order.
  • Title: Effort in Hours
    Effort required in hours to implement the change requested.
  • Title: Estimated Cost
    Estimated cost to implement the change requested.
  • Title: Estimated Revenue
    Estimated revenue to implement the change requested.
  • Title: Impacted Object ID
    Identifier of the impacted object such as a budget version or a forecast version.
  • Title: Impact Id
    Read Only: true
    Unique identifier of the impact to the change order.
  • Title: Impact Owner Email
    Email of the impact owner.
  • Title: Impact Owner Id
    Resource identifier of the impact owner.
  • Title: Impact Owner Name
    Name of the impact owner.
  • Title: Impact To
    Maximum Length: 30
    The detail of the impacted object type such as a cost budget or revenue budget.
  • Links
  • Title: Impact Name
    Maximum Length: 100
    Summary of the impact of a change order.
Nested Schema : Change Impact Details
Type: array
Title: Change Impact Details
The Change Impact Details resource is used to view, create, update or delete the impact details for a change order. Change Impact Details can be created only for the impacts where the impact area is defined as Budget and Forecast.
Show Source
Nested Schema : changeOrders-ChangeImpacts-ChangeImpactDetails-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all the change impacts for a change orders 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.18.05/changeOrders/300100124745706/child/ChangeImpacts

Example of Response Body

The following example shows the contents of the response body in JSON format which includes all the change impacts for the changer order with change document ID 300100124745706.

{
"items": [
  {
"ImpactId": 300100124745940,
"ChangeDocumentId": 300100124745706,
"ImpactOwnerId": 300100023180814,
"Area": "REQUIREMENTS",
"EffortsInHours": 14.567,
"EstimatedCost": 19.456,
"EstimatedRevenue": 45.98,
"Currency": "AED",
"Summary": "Summary for impacts area",
"Description": "Test",
"ContractAmount": null,
"ImpactOwnerName": "Mary Smith",
"ImpactOwnerEmail": "prj_mary_smith_in_grp@oracle.com",
}
],
}
Back to Top