Jump to

• Request
• Response
• Examples

Update an impact for a change order

patch

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

Request

Path Parameters

• ChangeDocumentId(required): integer(int64)
  Unique identifier of a project change order. Mandatory for PATCH operation.
• ImpactId(required): integer(int64)
  Unique identifier of the impact to the change order.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 or Project Plan.
• ChangeImpactTaskDetails: array Change Impact Task Details
  Title: Change Impact Task Details

  The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.
• 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.
• Summary: string
  Title: Impact Name

  Maximum Length: 100

  Summary of the impact of a change order.

{
    "type":"object",
    "properties":{
        "Area":{
            "title":"Impact Area Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ChangeImpactDetails":{
            "title":"Change Impact Details",
            "type":"array",
            "description":"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 or Project Plan.",
            "items":{
                "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactDetails-item-patch-request"
            }
        },
        "ChangeImpactTaskDetails":{
            "title":"Change Impact Task Details",
            "type":"array",
            "description":"The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.",
            "items":{
                "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-patch-request"
            }
        },
        "ContractAmount":{
            "title":"Contract Amount",
            "type":"number",
            "description":"Contract amount of the impact of a change order.",
            "nullable":true
        },
        "Currency":{
            "title":"Impact Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Description":{
            "title":"Impact Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the impact of a change order.",
            "nullable":true
        },
        "EffortsInHours":{
            "title":"Effort in Hours",
            "type":"number",
            "description":"Effort required in hours to implement the change requested.",
            "nullable":true
        },
        "EstimatedCost":{
            "title":"Estimated Cost",
            "type":"number",
            "description":"Estimated cost to implement the change requested.",
            "nullable":true
        },
        "EstimatedRevenue":{
            "title":"Estimated Revenue",
            "type":"number",
            "description":"Estimated revenue to implement the change requested.",
            "nullable":true
        },
        "ImpactedObjectId":{
            "title":"Impacted Object ID",
            "type":"integer",
            "description":"Identifier of the impacted object such as a budget version or a forecast version.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Summary":{
            "title":"Impact Name",
            "maxLength":100,
            "type":"string",
            "description":"Summary of the impact of a change order.",
            "nullable":false
        }
    }
}

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 or Project Plan.

Show Source

• Array of: object changeOrders-ChangeImpacts-ChangeImpactDetails-item-patch-request

{
    "title":"Change Impact Details",
    "type":"array",
    "description":"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 or Project Plan.",
    "items":{
        "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactDetails-item-patch-request"
    }
}

Nested Schema : Change Impact Task Details

Type: array

Title: Change Impact Task Details

The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.

Show Source

• Array of: object changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-patch-request

{
    "title":"Change Impact Task Details",
    "type":"array",
    "description":"The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.",
    "items":{
        "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-patch-request"
    }
}

Nested Schema : changeOrders-ChangeImpacts-ChangeImpactDetails-item-patch-request

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ChangeDocumentId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"External identifier of a project change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeImpactId":{
            "title":"Impact ID",
            "type":"integer",
            "description":"Unique identifier of the impact to the change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The finish date of the change impact detail.",
            "format":"date",
            "nullable":true
        },
        "PCBurdenedCost":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"The amount of change to the burdened cost in project currency.",
            "nullable":true
        },
        "PCRawCost":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"The amount of change to the raw cost in project currency.",
            "nullable":true
        },
        "PCRevenue":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"The amount of change to the revenue in project currency.",
            "nullable":true
        },
        "PfcBurdenedCost":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the burdened cost in project ledger currency.",
            "nullable":true
        },
        "PfcRawCost":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the raw cost in project ledger currency.",
            "nullable":true
        },
        "PfcRevenue":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the revenue in project ledger currency.",
            "nullable":true
        },
        "ProjElementId":{
            "title":"Task Number",
            "type":"integer",
            "description":"Identifier of the task or the project that is impacted by the change. Updatable only at creation time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectOrTaskName":{
            "title":"Project or Task",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task or the project for which change order impact detail is created. Updatable only at creation time.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The amount of change to the quantity.",
            "nullable":true
        },
        "RbsElementId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the resource that is impacted by the change.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the resource that's impacted by the change. Updatable only at creation time.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the change impact detail.",
            "format":"date",
            "nullable":true
        },
        "TCBurdenedCost":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"The amount of change to the burdened cost in transaction currency.",
            "nullable":true
        },
        "TCRawCost":{
            "title":"Raw Cost",
            "type":"number",
            "description":"The amount of change to the raw cost in transaction currency.",
            "nullable":true
        },
        "TCRevenue":{
            "title":"Revenue",
            "type":"number",
            "description":"The amount of change to the revenue in transaction currency.",
            "nullable":true
        },
        "TransactionCurrency":{
            "title":"Transaction Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for the change impact in transaction currency.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The unit to measure the quantity such as hours or tons.",
            "nullable":true
        }
    }
}

Nested Schema : changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-patch-request

Type: object

Show Source

• Action: string
  Title: Action

  Maximum Length: 10

  Specifies the type of task impact. A value of CREATE denotes the creation of a new task, while a value of UPDATE indicates modifications to an existing task using the change order.
• ChangeDocumentId: integer (int64)
  Title: Change Order ID

  Identifier of a project change order. Updatable only at creation time.
• ChangeImpactId: integer (int64)
  Title: Impact ID

  Identifier of the impact to the change order. Updatable only at creation time.
• FinishDate: string (date)
  Title: Finish Date

  The proposed finish date of a task created or existing task impacted with the change order.
• MilestoneFlag: boolean
  Title: Milestone

  Maximum Length: 1

  Indicates whether the impacted task is a milestone. Value of True indicates that the task is a milestone. The default value is False.
• ParentTaskId: integer (int64)
  Title: Parent Task ID

  Unique Identifier of the parent task of a new task that's proposed or impacted with the change order.
• ParentTaskName: string
  Title: Parent Task Name

  Maximum Length: 255

  Name of the parent task of a new task proposed or impacted with the change order.
• ParentTaskNumber: string
  Title: Parent Task Number

  Maximum Length: 255

  Unique number of the parent task of a new task that's proposed or impacted with the change order.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project that's impacted. Updateable only at the time of creation.
• StartDate: string (date)
  Title: Start Date

  The proposed start date of a task created or existing task impacted with the change order.
• TaskId: integer (int64)
  Title: Task ID

  Unique identifier of the task that's impacted due to the change order.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task that's impacted due to the change order.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task that's impacted due to the change order.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action",
            "maxLength":10,
            "type":"string",
            "description":"Specifies the type of task impact. A value of CREATE denotes the creation of a new task, while a value of UPDATE indicates modifications to an existing task using the change order.",
            "nullable":true
        },
        "ChangeDocumentId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"Identifier of a project change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeImpactId":{
            "title":"Impact ID",
            "type":"integer",
            "description":"Identifier of the impact to the change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The proposed finish date of a task created or existing task impacted with the change order.",
            "format":"date",
            "nullable":true
        },
        "MilestoneFlag":{
            "title":"Milestone",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the impacted task is a milestone. Value of True indicates that the task is a milestone. The default value is False.",
            "nullable":true
        },
        "ParentTaskId":{
            "title":"Parent Task ID",
            "type":"integer",
            "description":"Unique Identifier of the parent task of a new task that's proposed or impacted with the change order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ParentTaskName":{
            "title":"Parent Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent task of a new task proposed or impacted with the change order.",
            "nullable":true
        },
        "ParentTaskNumber":{
            "title":"Parent Task Number",
            "maxLength":255,
            "type":"string",
            "description":"Unique number of the parent task of a new task that's proposed or impacted with the change order.",
            "nullable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project that's impacted. Updateable only at the time of creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The proposed start date of a task created or existing task impacted with the change order.",
            "format":"date",
            "nullable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task that's impacted due to the change order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task that's impacted due to the change order.",
            "nullable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Number of the task that's impacted due to the change order.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : changeOrders-ChangeImpacts-item-response

Type: object

Show Source

• 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 or Project Plan.
• ChangeImpactTaskDetails: array Change Impact Task Details
  Title: Change Impact Task Details

  The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.
• 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.

{
    "type":"object",
    "properties":{
        "Area":{
            "title":"Impact Area Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeImpactDetails":{
            "title":"Change Impact Details",
            "type":"array",
            "description":"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 or Project Plan.",
            "items":{
                "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactDetails-item-response"
            }
        },
        "ChangeImpactTaskDetails":{
            "title":"Change Impact Task Details",
            "type":"array",
            "description":"The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.",
            "items":{
                "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-response"
            }
        },
        "ContractAmount":{
            "title":"Contract Amount",
            "type":"number",
            "description":"Contract amount of the impact of a change order.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Impact Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Impact Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the impact of a change order.",
            "nullable":true,
            "x-queryable":true
        },
        "EffortsInHours":{
            "title":"Effort in Hours",
            "type":"number",
            "description":"Effort required in hours to implement the change requested.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedCost":{
            "title":"Estimated Cost",
            "type":"number",
            "description":"Estimated cost to implement the change requested.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedRevenue":{
            "title":"Estimated Revenue",
            "type":"number",
            "description":"Estimated revenue to implement the change requested.",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactId":{
            "title":"Impact Id",
            "type":"integer",
            "description":"Unique identifier of the impact to the change order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImpactOwnerEmail":{
            "title":"Impact Owner Email",
            "type":"string",
            "description":"Email of the impact owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactOwnerId":{
            "title":"Impact Owner ID",
            "type":"integer",
            "description":"Resource identifier of the impact owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImpactOwnerName":{
            "title":"Impact Owner Name",
            "type":"string",
            "description":"Name of the impact owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactTo":{
            "title":"Impact To",
            "maxLength":30,
            "type":"string",
            "description":"The detail of the impacted object type such as a cost budget or revenue budget.",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactedObjectId":{
            "title":"Impacted Object ID",
            "type":"integer",
            "description":"Identifier of the impacted object such as a budget version or a forecast version.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Summary":{
            "title":"Impact Name",
            "maxLength":100,
            "type":"string",
            "description":"Summary of the impact of a change order.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 or Project Plan.

Show Source

• Array of: object changeOrders-ChangeImpacts-ChangeImpactDetails-item-response

{
    "title":"Change Impact Details",
    "type":"array",
    "description":"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 or Project Plan.",
    "items":{
        "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactDetails-item-response"
    }
}

Nested Schema : Change Impact Task Details

Type: array

Title: Change Impact Task Details

The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.

Show Source

• Array of: object changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-response

{
    "title":"Change Impact Task Details",
    "type":"array",
    "description":"The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.",
    "items":{
        "$ref":"#/components/schemas/changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : changeOrders-ChangeImpacts-ChangeImpactDetails-item-response

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ChangeDocumentId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"External identifier of a project change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeImpactId":{
            "title":"Impact ID",
            "type":"integer",
            "description":"Unique identifier of the impact to the change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The finish date of the change impact detail.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactDetailsId":{
            "title":"Impact Details ID",
            "type":"integer",
            "description":"Unique identifier of the impact detail of the change order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PCBurdenedCost":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "description":"The amount of change to the burdened cost in project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PCRawCost":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "description":"The amount of change to the raw cost in project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PCRevenue":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "description":"The amount of change to the revenue in project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PfcBurdenedCost":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the burdened cost in project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PfcRawCost":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the raw cost in project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "PfcRevenue":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "description":"The amount of change to the revenue in project ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjElementId":{
            "title":"Task Number",
            "type":"integer",
            "description":"Identifier of the task or the project that is impacted by the change. Updatable only at creation time.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectOrTaskName":{
            "title":"Project or Task",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task or the project for which change order impact detail is created. Updatable only at creation time.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The amount of change to the quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "RbsElementId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the resource that is impacted by the change.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the resource that's impacted by the change. Updatable only at creation time.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the change impact detail.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TCBurdenedCost":{
            "title":"Burdened Cost",
            "type":"number",
            "description":"The amount of change to the burdened cost in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "TCRawCost":{
            "title":"Raw Cost",
            "type":"number",
            "description":"The amount of change to the raw cost in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "TCRevenue":{
            "title":"Revenue",
            "type":"number",
            "description":"The amount of change to the revenue in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCurrency":{
            "title":"Transaction Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for the change impact in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The unit to measure the quantity such as hours or tons.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-response

Type: object

Show Source

• Action: string
  Title: Action

  Maximum Length: 10

  Specifies the type of task impact. A value of CREATE denotes the creation of a new task, while a value of UPDATE indicates modifications to an existing task using the change order.
• ChangeDocumentId: integer (int64)
  Title: Change Order ID

  Identifier of a project change order. Updatable only at creation time.
• ChangeImpactId: integer (int64)
  Title: Impact ID

  Identifier of the impact to the change order. Updatable only at creation time.
• FinishDate: string (date)
  Title: Finish Date

  The proposed finish date of a task created or existing task impacted with the change order.
• ImpactTaskDetailsId: integer (int64)
  Title: Impact Task Details ID

  Unique identifier of the task impact details of the change order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneFlag: boolean
  Title: Milestone

  Maximum Length: 1

  Indicates whether the impacted task is a milestone. Value of True indicates that the task is a milestone. The default value is False.
• ParentTaskId: integer (int64)
  Title: Parent Task ID

  Unique Identifier of the parent task of a new task that's proposed or impacted with the change order.
• ParentTaskName: string
  Title: Parent Task Name

  Maximum Length: 255

  Name of the parent task of a new task proposed or impacted with the change order.
• ParentTaskNumber: string
  Title: Parent Task Number

  Maximum Length: 255

  Unique number of the parent task of a new task that's proposed or impacted with the change order.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project that's impacted. Updateable only at the time of creation.
• StartDate: string (date)
  Title: Start Date

  The proposed start date of a task created or existing task impacted with the change order.
• TaskId: integer (int64)
  Title: Task ID

  Unique identifier of the task that's impacted due to the change order.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task that's impacted due to the change order.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Number of the task that's impacted due to the change order.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action",
            "maxLength":10,
            "type":"string",
            "description":"Specifies the type of task impact. A value of CREATE denotes the creation of a new task, while a value of UPDATE indicates modifications to an existing task using the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeDocumentId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"Identifier of a project change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeImpactId":{
            "title":"Impact ID",
            "type":"integer",
            "description":"Identifier of the impact to the change order. Updatable only at creation time.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The proposed finish date of a task created or existing task impacted with the change order.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactTaskDetailsId":{
            "title":"Impact Task Details ID",
            "type":"integer",
            "description":"Unique identifier of the task impact details of the change order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneFlag":{
            "title":"Milestone",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the impacted task is a milestone. Value of True indicates that the task is a milestone. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTaskId":{
            "title":"Parent Task ID",
            "type":"integer",
            "description":"Unique Identifier of the parent task of a new task that's proposed or impacted with the change order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTaskName":{
            "title":"Parent Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent task of a new task proposed or impacted with the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTaskNumber":{
            "title":"Parent Task Number",
            "maxLength":255,
            "type":"string",
            "description":"Unique number of the parent task of a new task that's proposed or impacted with the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project that's impacted. Updateable only at the time of creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The proposed start date of a task created or existing task impacted with the change order.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Unique identifier of the task that's impacted due to the change order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task that's impacted due to the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Number of the task that's impacted due to the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ChangeImpactDetails

Operation: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactDetails

Parameters:

• ChangeDocumentId: $request.path.ChangeDocumentId
• ImpactId: $request.path.ImpactId

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 or Project Plan.

ChangeImpactTaskDetails

Operation: /fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactTaskDetails

Parameters:

• ChangeDocumentId: $request.path.ChangeDocumentId
• ImpactId: $request.path.ImpactId

The Change Impact Task Details resource is used to view, create, update, or delete the task impact details for a change order. This allows for creation of tasks and updates to task dates through a change order.

Back to Top

Examples

The following example shows how to update an impact for a change order by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/changeOrders/300100152034699/child/ChangeImpacts/300100152034700

Note:

You cannot add, update, or delete participants or impacts to a change order that is approved or in implementation stage.

Request Body Example

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

 {
"Area":"OTHERS"
}

Response Body Example

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

{
    "ImpactId": 300100125631301,
    "ChangeDocumentId": 300100125631297,
    "ImpactOwnerId": 300100024326751,
    "Area": "OTHERS",
    "EffortsInHours": 14.567,
    "EstimatedCost": 2,
    "EstimatedRevenue": 45.98,
    "Currency": "USD",
    "Summary": "Summary for impacts area",
    "Description": "Description for impacts area",
    "ContractAmount": 2,
    "ImpactOwnerName": "Abraham Mason",
    "ImpactOwnerEmail": "[e-mail]"
}

Back to Top