Create a change order
post
/fscmRestApi/resources/11.13.18.05/changeOrders
Request
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
-
CancelDate: string
(date)
Title:
Change Order Cancellation Date
Date when the change order was canceled. Application calculated field. -
CancelReason: string
Title:
Change Order Cancellation Comments
Maximum Length:2000
User comments for cancelling the change order. Mandatory for cancelling the change order. -
CancelType: string
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. -
ChangeImpacts: array
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. -
ChangeParticipants: array
Change Participants
Title:
Change Participants
The Change Participants resource is used to view, create, update, or delete the participants for a change order. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the change order. -
CreatorEmail: string
Title:
Creator Email
Email of the creator of a change order. -
CreatorId(required): integer
(int64)
Title:
Creator ID
Identifier of the creator for a change order. Mandatory for POST operation if Creator Name or Creator Email is not provided. -
CreatorName: string
Title:
Creator Name
Name of the creator of a change order. -
Description: string
Title:
Description
Maximum Length:2000
Description of the change order. -
ImpactIfNotImpl: string
Title:
Impact if Not Implemented
Maximum Length:2000
Impact if the change is not implemented. -
Justification: string
Title:
Justification
Maximum Length:2000
Justification for a change order. -
Name(required): string
Title:
Change Order Name
Maximum Length:80
Name of the change order. -
OwnerEmail: string
Title:
Change Order Owner Email
Email of the owner of a change order. The default value is the creator email of the change order. -
OwnerId(required): integer
(int64)
Title:
Change Order Owner Id
Unique identifier of the owner of change order. The default value is creator of the change order. -
OwnerName: string
Title:
Change Order Owner Name
Name of the owner of a change order. The default value is the creator name of the change order. -
Priority(required): string
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. -
ProjectId: integer
(int64)
Title:
Project Id
Unique identifier of the project for which change document is created. -
ProjectName: string
Title:
Project Name
Name of the project for which change order is created. -
Reason(required): string
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. -
Stage(required): string
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. -
Status(required): string
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. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task for which change document is created. -
TaskName: string
Title:
Task Name
Name of the task for which change order is created. -
TaskNumber: string
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:
Show Source
object
-
Area(required): 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. -
ImpactOwnerEmail: string
Title:
Impact Owner Email
Email of the impact owner. -
ImpactOwnerId(required): 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. -
Summary(required): 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 : schema
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. -
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 : schema
Type:
Show Source
object
-
ApproveComments: string
Title:
Approval or Rejection Comments
Maximum Length:2000
Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order. -
ApproveFlag: boolean
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. -
ApproveStatus: string
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. -
AssessmentComments: string
Title:
Assessment Comments
Maximum Length:2000
Assessment comments by participant for a change order. -
AssessmentFlag: boolean
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. -
AssessmentStatus: string
Title:
Assessor Status
Maximum Length:30
Default Value:N
Assessment status of assessor for a change order. Valid values are In Progress and Completed. -
ImplementationComments: string
Title:
Implementation Comments
Maximum Length:2000
Implementation comments by participant for a change order. -
ImplementationFlag: boolean
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. -
ImplementationStatus: string
Title:
Implementor Status
Maximum Length:30
Default Value:N
Implementation status of participant for a change order. Valid values are In Progress and Completed. -
ParticipantEmail: string
Title:
Participant Email
Email of the change order participant. -
ParticipantName: string
Title:
Participant Name
Name of the change order participant. -
ParticipantResourceId: integer
(int64)
Title:
Participant Resource Id
Resource identifier of the change order participant. -
RejectDate: string
(date)
Title:
Rejection Date
Date when change order was rejected. Calculated by application. -
RejectType: string
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. -
ReviewComments: string
Title:
Review Comments
Maximum Length:2000
Review comments by participant for a change order. -
ReviewFlag: boolean
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. -
ReviewStatus: string
Title:
Reviewer Status
Maximum Length:30
Default Value:N
Review status of participant for a change order. Valid values are In Progress and Completed.
Response
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-item-response
Type:
Show Source
object
-
CancelDate: string
(date)
Title:
Change Order Cancellation Date
Date when the change order was canceled. Application calculated field. -
CancelReason: string
Title:
Change Order Cancellation Comments
Maximum Length:2000
User comments for cancelling the change order. Mandatory for cancelling the change order. -
CancelType: string
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. -
ChangeDocumentId: integer
(int64)
Title:
Change Order ID
Read Only:true
Unique identifier of a project change order. Mandatory for PATCH operation. -
ChangeDocumentNumber: integer
Title:
Change Order Number
Read Only:true
Unique number of the change order. Application calculated field. -
ChangeImpacts: array
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. -
ChangeParticipants: array
Change Participants
Title:
Change Participants
The Change Participants resource is used to view, create, update, or delete the participants for a change order. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the change order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the change order was created. Application calculated. -
CreatorEmail: string
Title:
Creator Email
Email of the creator of a change order. -
CreatorId: integer
(int64)
Title:
Creator ID
Identifier of the creator for a change order. Mandatory for POST operation if Creator Name or Creator Email is not provided. -
CreatorName: string
Title:
Creator Name
Name of the creator of a change order. -
Customer: string
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. -
Description: string
Title:
Description
Maximum Length:2000
Description of the change order. -
ImpactIfNotImpl: string
Title:
Impact if Not Implemented
Maximum Length:2000
Impact if the change is not implemented. -
Justification: string
Title:
Justification
Maximum Length:2000
Justification for a change order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Change Order Name
Maximum Length:80
Name of the change order. -
OwnerEmail: string
Title:
Change Order Owner Email
Email of the owner of a change order. The default value is the creator email of the change order. -
OwnerId: integer
(int64)
Title:
Change Order Owner Id
Unique identifier of the owner of change order. The default value is creator of the change order. -
OwnerName: string
Title:
Change Order Owner Name
Name of the owner of a change order. The default value is the creator name of the change order. -
Priority: string
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. -
ProjectId: integer
(int64)
Title:
Project Id
Unique identifier of the project for which change document is created. -
ProjectName: string
Title:
Project Name
Name of the project for which change order is created. -
Reason: string
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. -
Stage: string
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. -
Status: string
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. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task for which change document is created. -
TaskName: string
Title:
Task Name
Name of the task for which change order is created. -
TaskNumber: string
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 : 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.
Nested Schema : changeOrders-ChangeParticipants-item-response
Type:
Show Source
object
-
ApproveComments: string
Title:
Approval or Rejection Comments
Maximum Length:2000
Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order. -
ApproveFlag: boolean
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. -
ApproveStatus: string
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. -
AssessmentComments: string
Title:
Assessment Comments
Maximum Length:2000
Assessment comments by participant for a change order. -
AssessmentFlag: boolean
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. -
AssessmentStatus: string
Title:
Assessor Status
Maximum Length:30
Default Value:N
Assessment status of assessor for a change order. Valid values are In Progress and Completed. -
ImplementationComments: string
Title:
Implementation Comments
Maximum Length:2000
Implementation comments by participant for a change order. -
ImplementationFlag: boolean
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. -
ImplementationStatus: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantEmail: string
Title:
Participant Email
Email of the change order participant. -
ParticipantId: integer
(int64)
Title:
Participant Id
Read Only:true
Unique identifier of the change order participant. -
ParticipantName: string
Title:
Participant Name
Name of the change order participant. -
ParticipantResourceId: integer
(int64)
Title:
Participant Resource Id
Resource identifier of the change order participant. -
RejectDate: string
(date)
Title:
Rejection Date
Date when change order was rejected. Calculated by application. -
RejectType: string
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. -
ReviewComments: string
Title:
Review Comments
Maximum Length:2000
Review comments by participant for a change order. -
ReviewFlag: boolean
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. -
ReviewStatus: string
Title:
Reviewer Status
Maximum Length:30
Default Value:N
Review status of participant for a change order. Valid values are In Progress and Completed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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. - ChangeDocumentId:
- ChangeParticipants
-
Operation: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipantsParameters:
- ChangeDocumentId:
$request.path.ChangeDocumentId
The Change Participants resource is used to view, create, update, or delete the participants for a change order. - ChangeDocumentId:
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, }