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

Create a change order

post

/fscmRestApi/resources/11.13.18.05/changeOrders

Request

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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Change Order Cancellation Date
    Date when the change order was canceled. Application calculated field.
  • Title: Change Order Cancellation Comments
    Maximum Length: 2000
    User comments for cancelling the change order. Mandatory for cancelling the change order.
  • Title: Reason Code for Canceling
    Maximum Length: 30
    The code of the reason for canceling the change order. Mandatory for cancelling the change order. Valid values are DUPLICATE, INSUFFICIENT_INFORMATION, NO_LONGER_REQUIRED, OTHER, and REJECTED.
  • Change Impacts
    Title: Change Impacts
    The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
  • Change Participants
    Title: Change Participants
    The Change Participants resource is used to view, create, update, or delete the participants for a change order.
  • Title: Comments
    Maximum Length: 2000
    User comments for the change order.
  • Title: Creator Email
    Email of the creator of a change order.
  • Title: Creator ID
    Identifier of the creator for a change order. Mandatory for POST operation if Creator Name or Creator Email is not provided.
  • Title: Creator Name
    Name of the creator of a change order.
  • Title: Description
    Maximum Length: 2000
    Description of the change order.
  • Title: Impact if Not Implemented
    Maximum Length: 2000
    Impact if the change is not implemented.
  • Title: Justification
    Maximum Length: 2000
    Justification for a change order.
  • Title: Change Order Name
    Maximum Length: 80
    Name of the change order.
  • Title: Change Order Owner Email
    Email of the owner of a change order. The default value is the creator email of the change order.
  • Title: Change Order Owner Id
    Unique identifier of the owner of change order. The default value is creator of the change order.
  • Title: Change Order Owner Name
    Name of the owner of a change order. The default value is the creator name of the change order.
  • Title: Priority Code
    Maximum Length: 30
    The code of the priority of a change order. Valid values are HIGH, LOW, and MEDIUM. The default value is MEDIUM.
  • Title: Project Id
    Unique identifier of the project for which change document is created.
  • Title: Project Name
    Name of the project for which change order is created.
  • Title: Reason Code
    Maximum Length: 30
    The code of the reason for which the change order is created, rejected, and canceled. Valid values are BUDGET_REVISION, CLIENT_SCOPE_CHANGES, CONTRACT_MODIFICATION, DESIGN_CHANGES, GENERAL, OTHER, SCHEDULE_MODIFICATION, and SCOPE_REVISION. The default value is GENERAL.
  • Title: Stage Code
    Maximum Length: 30
    The code of the current stage of a change order. Valid values are CREATE, IMPACT_ANALYSIS, APPROVAL, CLOSE, REVIEW, IMPLEMENTATION. The default value is CREATE.
  • Title: Status Code
    Maximum Length: 30
    The code of the current status of a change order. Status is derived from stage of the change order. You need to mention status only when you want to cancel the change order. Valid value is CANCELED.
  • Title: Task ID
    Unique identifier of the task for which change document is created.
  • Title: Task Name
    Name of the task for which change order is created.
  • Title: Task Number
    Unique number of the task associated with a specific project for which change order is created.
Nested Schema : Change Impacts
Type: array
Title: Change Impacts
The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
Show Source
Nested Schema : Change Participants
Type: array
Title: Change Participants
The Change Participants resource is used to view, create, update, or delete the participants for a change order.
Show Source
Nested Schema : schema
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 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.
  • 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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Approval or Rejection Comments
    Maximum Length: 2000
    Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
  • Title: Approver Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.
  • Title: Approver Status
    Maximum Length: 30
    Default Value: N
    Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.
  • Title: Assessment Comments
    Maximum Length: 2000
    Assessment comments by participant for a change order.
  • Title: Assessor Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.
  • Title: Assessor Status
    Maximum Length: 30
    Default Value: N
    Assessment status of assessor for a change order. Valid values are In Progress and Completed.
  • Title: Implementation Comments
    Maximum Length: 2000
    Implementation comments by participant for a change order.
  • Title: Implementor Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.
  • Title: Implementor Status
    Maximum Length: 30
    Default Value: N
    Implementation status of participant for a change order. Valid values are In Progress and Completed.
  • Title: Participant Email
    Email of the change order participant.
  • Title: Participant Name
    Name of the change order participant.
  • Title: Participant Resource Id
    Resource identifier of the change order participant.
  • Title: Rejection Date
    Date when change order was rejected. Calculated by application.
  • Title: Rejection Reason Code
    Maximum Length: 30
    The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.
  • Title: Review Comments
    Maximum Length: 2000
    Review comments by participant for a change order.
  • Title: Reviewer Indicator
    Maximum Length: 2
    Default Value: true
    Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.
  • Title: Reviewer Status
    Maximum Length: 30
    Default Value: N
    Review status of participant for a change order. Valid values are In Progress and Completed.
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-item-response
Type: object
Show Source
  • Title: Change Order Cancellation Date
    Date when the change order was canceled. Application calculated field.
  • Title: Change Order Cancellation Comments
    Maximum Length: 2000
    User comments for cancelling the change order. Mandatory for cancelling the change order.
  • Title: Reason Code for Canceling
    Maximum Length: 30
    The code of the reason for canceling the change order. Mandatory for cancelling the change order. Valid values are DUPLICATE, INSUFFICIENT_INFORMATION, NO_LONGER_REQUIRED, OTHER, and REJECTED.
  • Title: Change Order ID
    Read Only: true
    Unique identifier of a project change order. Mandatory for PATCH operation.
  • Title: Change Order Number
    Read Only: true
    Unique number of the change order. Application calculated field.
  • Change Impacts
    Title: Change Impacts
    The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
  • Change Participants
    Title: Change Participants
    The Change Participants resource is used to view, create, update, or delete the participants for a change order.
  • Title: Comments
    Maximum Length: 2000
    User comments for the change order.
  • Title: Creation Date
    Read Only: true
    Date when the change order was created. Application calculated.
  • Title: Creator Email
    Email of the creator of a change order.
  • Title: Creator ID
    Identifier of the creator for a change order. Mandatory for POST operation if Creator Name or Creator Email is not provided.
  • Title: Creator Name
    Name of the creator of a change order.
  • Title: Customer
    Read Only: true
    Customer of the project for which change order is created. If project is specified for the change order, customer is defaulted to project customer.
  • Title: Description
    Maximum Length: 2000
    Description of the change order.
  • Title: Impact if Not Implemented
    Maximum Length: 2000
    Impact if the change is not implemented.
  • Title: Justification
    Maximum Length: 2000
    Justification for a change order.
  • Links
  • Title: Change Order Name
    Maximum Length: 80
    Name of the change order.
  • Title: Change Order Owner Email
    Email of the owner of a change order. The default value is the creator email of the change order.
  • Title: Change Order Owner Id
    Unique identifier of the owner of change order. The default value is creator of the change order.
  • Title: Change Order Owner Name
    Name of the owner of a change order. The default value is the creator name of the change order.
  • Title: Priority Code
    Maximum Length: 30
    The code of the priority of a change order. Valid values are HIGH, LOW, and MEDIUM. The default value is MEDIUM.
  • Title: Project Id
    Unique identifier of the project for which change document is created.
  • Title: Project Name
    Name of the project for which change order is created.
  • Title: Reason Code
    Maximum Length: 30
    The code of the reason for which the change order is created, rejected, and canceled. Valid values are BUDGET_REVISION, CLIENT_SCOPE_CHANGES, CONTRACT_MODIFICATION, DESIGN_CHANGES, GENERAL, OTHER, SCHEDULE_MODIFICATION, and SCOPE_REVISION. The default value is GENERAL.
  • Title: Stage Code
    Maximum Length: 30
    The code of the current stage of a change order. Valid values are CREATE, IMPACT_ANALYSIS, APPROVAL, CLOSE, REVIEW, IMPLEMENTATION. The default value is CREATE.
  • Title: Status Code
    Maximum Length: 30
    The code of the current status of a change order. Status is derived from stage of the change order. You need to mention status only when you want to cancel the change order. Valid value is CANCELED.
  • Title: Task ID
    Unique identifier of the task for which change document is created.
  • Title: Task Name
    Name of the task for which change order is created.
  • Title: Task Number
    Unique number of the task associated with a specific project for which change order is created.
Nested Schema : Change Impacts
Type: array
Title: Change Impacts
The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
Show Source
Nested Schema : Change Participants
Type: array
Title: Change Participants
The Change Participants resource is used to view, create, update, or delete the participants for a change order.
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
Nested Schema : changeOrders-ChangeParticipants-item-response
Type: object
Show Source
  • Title: Approval or Rejection Comments
    Maximum Length: 2000
    Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
  • Title: Approver Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.
  • Title: Approver Status
    Maximum Length: 30
    Default Value: N
    Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.
  • Title: Assessment Comments
    Maximum Length: 2000
    Assessment comments by participant for a change order.
  • Title: Assessor Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.
  • Title: Assessor Status
    Maximum Length: 30
    Default Value: N
    Assessment status of assessor for a change order. Valid values are In Progress and Completed.
  • Title: Implementation Comments
    Maximum Length: 2000
    Implementation comments by participant for a change order.
  • Title: Implementor Indicator
    Maximum Length: 2
    Default Value: false
    Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.
  • Title: Implementor Status
    Maximum Length: 30
    Default Value: N
    Implementation status of participant for a change order. Valid values are In Progress and Completed.
  • Links
  • Title: Participant Email
    Email of the change order participant.
  • Title: Participant Id
    Read Only: true
    Unique identifier of the change order participant.
  • Title: Participant Name
    Name of the change order participant.
  • Title: Participant Resource Id
    Resource identifier of the change order participant.
  • Title: Rejection Date
    Date when change order was rejected. Calculated by application.
  • Title: Rejection Reason Code
    Maximum Length: 30
    The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.
  • Title: Review Comments
    Maximum Length: 2000
    Review comments by participant for a change order.
  • Title: Reviewer Indicator
    Maximum Length: 2
    Default Value: true
    Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.
  • Title: Reviewer Status
    Maximum Length: 30
    Default Value: N
    Review status of participant for a change order. Valid values are In Progress and Completed.
Links
ChangeImpacts
Parameters:
  • ChangeDocumentId: $request.path.ChangeDocumentId
The Change Impacts resource is used to create, view, update, or delete the impacts due to the respective change order.
ChangeParticipants
Parameters:
  • ChangeDocumentId: $request.path.ChangeDocumentId
The Change Participants resource is used to view, create, update, or delete the participants for a change order.
Back to Top

Examples

The following example shows how to create 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

Example of Request Body

The following example shows the request body to create a new change order that is associated to the project with project ID 300100125163003.

{
  "Name": " TESTMSRESTCO ",
  "CreatorName" : "Mary Aberdeen",
  "OwnerName": "Mary Aberdeen",
  "ProjectName": "Project Jellyfish4",
  "Stage": "Create",
  "Priority": "Medium",
  "Description": "Trimble SR Impact to Project Plan Scope",
  "Justification": "Trimble SR Impact to Project Plan Scope",
  "ImpactIfNotImpl": "Trimble SR Impact to Project Plan Scope",
  "Comments": "Trimble SR Impact to Project Plan Scope"

}

Example of Response Body

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

{
"CancelDate": null,
"ChangeDocumentId": 300100124745706,
"CancelReason": null,
"CancelType": null,
"Comments": "Trimble SR Impact to Project Plan Scope",
"CreatorId": 300100038328481,
"Description": "Trimble SR Impact to Project Plan Scope",
"ImpactIfNotImpl": "Trimble SR Impact to Project Plan Scope",
"Justification": "Trimble SR Impact to Project Plan Scope",
"Name": "TESTMSRESTCO",
"OwnerId": 300100038328481,
"Priority": "MEDIUM",
"ProjectId": null,
"Reason": "GENERAL",
"Stage": "CREATE",
"Status": "DRAFT",
"OwnerName": "Mary Aberdeen",
"OwnerEmail": "prj_mary_aberdeen_grp@oracle.com",
"ProjectName": null,
"ChangeDocumentNumber": 87,
"CreatorName": "Mary Aberdeen",
"CreatorEmail": "prj_mary_aberdeen_grp@oracle.com",
"CreationDate": "2018-03-21T10:33:06+00:00",
"Customer": null,
}
Back to Top