Get all impacts for a change order
get
/fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts
Request
Path Parameters
-
ChangeDocumentId(required): integer(int64)
Unique identifier of a project change order. Mandatory for PATCH operation.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
finder: string
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.
- PrimaryKey: Finds an impact for the change order with the specified primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
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 : changeOrders-ChangeImpacts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : changeOrders-ChangeImpacts-item-response
Type:
Show Source
object
-
Area: string
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. -
ChangeImpactDetails: array
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. -
ContractAmount: number
Title:
Contract Amount
Contract amount of the impact of a change order. -
Currency: string
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. -
Description: string
Title:
Impact Description
Maximum Length:2000
Description of the impact of a change order. -
EffortsInHours: number
Title:
Effort in Hours
Effort required in hours to implement the change requested. -
EstimatedCost: number
Title:
Estimated Cost
Estimated cost to implement the change requested. -
EstimatedRevenue: number
Title:
Estimated Revenue
Estimated revenue to implement the change requested. -
ImpactedObjectId: integer
(int64)
Title:
Impacted Object ID
Identifier of the impacted object such as a budget version or a forecast version. -
ImpactId: integer
(int64)
Title:
Impact Id
Read Only:true
Unique identifier of the impact to the change order. -
ImpactOwnerEmail: string
Title:
Impact Owner Email
Email of the impact owner. -
ImpactOwnerId: integer
(int64)
Title:
Impact Owner Id
Resource identifier of the impact owner. -
ImpactOwnerName: string
Title:
Impact Owner Name
Name of the impact owner. -
ImpactTo: string
Title:
Impact To
Maximum Length:30
The detail of the impacted object type such as a cost budget or revenue budget. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Summary: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : changeOrders-ChangeImpacts-ChangeImpactDetails-item-response
Type:
Show Source
object
-
ChangeDocumentId: integer
(int64)
Title:
Change Order ID
External identifier of a project change order. Updatable only at creation time. -
ChangeImpactId: integer
(int64)
Title:
Impact ID
Unique identifier of the impact to the change order. Updatable only at creation time. -
FinishDate: string
(date)
Title:
Finish Date
The finish date of the change impact detail. -
ImpactDetailsId: integer
(int64)
Title:
Impact Details ID
Unique identifier of the impact detail of the change order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PCBurdenedCost: number
Title:
Burdened Cost in Project Currency
The amount of change to the burdened cost in project currency. -
PCRawCost: number
Title:
Raw Cost in Project Currency
The amount of change to the raw cost in project currency. -
PCRevenue: number
Title:
Revenue in Project Currency
The amount of change to the revenue in project currency. -
PfcBurdenedCost: number
Title:
Burdened Cost in Project Ledger Currency
The amount of change to the burdened cost in project ledger currency. -
PfcRawCost: number
Title:
Raw Cost in Project Ledger Currency
The amount of change to the raw cost in project ledger currency. -
PfcRevenue: number
Title:
Revenue in Project Ledger Currency
The amount of change to the revenue in project ledger currency. -
ProjectOrTaskName: string
Title:
Project or Task
Maximum Length:255
Name of the task or the project for which change order impact detail is created. Updatable only at creation time. -
ProjElementId: integer
(int64)
Title:
Task Number
Identifier of the task or the project that is impacted by the change. Updatable only at creation time. -
Quantity: number
Title:
Quantity
The amount of change to the quantity. -
RbsElementId: integer
(int64)
Title:
Resource ID
Identifier of the resource that is impacted by the change. Updatable only at creation time. -
ResourceName: string
Title:
Resource Name
Maximum Length:255
Name of the resource that's impacted by the change. Updatable only at creation time. -
StartDate: string
(date)
Title:
Start Date
The start date of the change impact detail. -
TCBurdenedCost: number
Title:
Burdened Cost
The amount of change to the burdened cost in transaction currency. -
TCRawCost: number
Title:
Raw Cost
The amount of change to the raw cost in transaction currency. -
TCRevenue: number
Title:
Revenue
The amount of change to the revenue in transaction currency. -
TransactionCurrency: string
Title:
Transaction Currency Code
Maximum Length:15
The currency code for the change impact in transaction currency. -
UnitOfMeasure: string
Title:
Unit of Measure
Maximum Length:30
The unit to measure the quantity such as hours or tons.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.
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", } ], }