Create impacts for a change order
post
/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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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. -
Summary: string
Title:
Impact Name
Maximum Length:100
Summary of the impact of a change order.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-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. -
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. -
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. -
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 : 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 create impacts for a change order by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/changeOrders/300100124745706/child/ChangeImpacts
Example of Request Body
The following example shows the request body to create a new impact for a change order that is associated to the project with project ID 300100125163003.
{ "ImpactOwnerId":"300100124678720", "ImpactOwnerName": "Mary Smith", "ImpactOwnerEmail": "prj_mary_smith_in_grp@oracle.com", "Area": "REQUIREMENTS", "Summary" : "Summary for impacts area", "Description" : "Test" , "EffortsInHours" : "14.567", "EstimatedCost" : "19.456", "EstimatedRevenue": "45.98", "Currency" : "AED", "ContractAmount" : 100 }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "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", }