Jump to

• Request
• Response

Create a financial impact detail

post

/fscmRestApi/resources/11.13.18.05/projectChangeRequests/{ChangeRequestId}/child/FinancialImpactDetails

Request

Path Parameters

• ChangeRequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.
• Upsert-Mode: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApprovalComments: string
  Title: Approval Comments

  Maximum Length: 2000
• ApprovalDate: string (date)
  Title: Approval Date
• ApproverId: integer (int64)
  Title: Approver ID
• ApproverName: string
  Title: Approver Name

  Maximum Length: 255
• AreaCode: string
  Title: Area Code

  Maximum Length: 30
• BurdenedCost: number
  Title: Burdened Cost
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency
• ChangeOrderId: integer (int64)
  Title: Change Order ID
• ChangeOrderImpactDetailsId: integer (int64)
  Title: Change Order Impact Detail ID
• ChangeOrderImpactId: integer (int64)
  Title: Change Order Impact ID
• ChangeOrderName: string
  Title: Change Order Name

  Maximum Length: 255
• ChangeOrderNumber: integer (int64)
  Title: Change Order Name
• ChangeRequestId: integer (int64)
  Title: Change Request ID
• ImpactDetailsId: integer (int64)
  Title: Impact Details ID
• ImpactTo: string
  Title: Impact To

  Maximum Length: 30
• PlanningCurrencyCode: string
  Title: Planning Currency Code

  Maximum Length: 15
• ProjectId: integer (int64)
  Title: Project ID
• ProjectName: string
  Title: Project Name
• ProposedFinishDate: string (date)
  Title: Proposed Finish Date
• ProposedStartDate: string (date)
  Title: Proposed Start Date
• Quantity: number
  Title: Quantity
• RawCost: number
  Title: Raw Cost
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency
• ResourceId: integer (int64)
  Title: Resource ID
• ResourceName: string
  Title: Resource Name

  Maximum Length: 255
• Revenue: number
  Title: Revenue
• RevenueCostInProjectCurrency: number
  Title: Revenue in Project Currency
• RevenueCostInProjectLedgerCurrency: number
  Title: Revenue in Project Ledger Currency
• Status: string
  Title: Status

  Maximum Length: 255
• StatusCode: string
  Title: Status Code

  Maximum Length: 30
• TaskId: integer (int64)
  Title: Task ID
• TaskName: string
  Title: Task Name

  Maximum Length: 255
• TaskNumber: string
  Title: Task Number

  Maximum Length: 255
• UnitOfMeasureCode: string
  Title: Unit of Measure

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "ApprovalComments":{
            "title":"Approval Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApproverName":{
            "title":"Approver Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "AreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "BurdenedCost":{
            "title":"Burdened Cost",
            "type":"number",
            "nullable":true
        },
        "BurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "nullable":true
        },
        "BurdenedCostInProjectLedgerCurrency":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "nullable":true
        },
        "ChangeOrderId":{
            "title":"Change Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderImpactDetailsId":{
            "title":"Change Order Impact Detail ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderImpactId":{
            "title":"Change Order Impact ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderName":{
            "title":"Change Order Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "ChangeOrderNumber":{
            "title":"Change Order Name",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "ChangeRequestId":{
            "title":"Change Request ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ImpactDetailsId":{
            "title":"Impact Details ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ImpactTo":{
            "title":"Impact To",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "PlanningCurrencyCode":{
            "title":"Planning Currency Code",
            "maxLength":15,
            "type":"string",
            "nullable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectName":{
            "title":"Project Name",
            "type":"string",
            "nullable":true
        },
        "ProposedFinishDate":{
            "title":"Proposed Finish Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "ProposedStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "nullable":true
        },
        "RawCost":{
            "title":"Raw Cost",
            "type":"number",
            "nullable":true
        },
        "RawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "nullable":true
        },
        "RawCostInProjectLedgerCurrency":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "nullable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "Revenue":{
            "title":"Revenue",
            "type":"number",
            "nullable":true
        },
        "RevenueCostInProjectCurrency":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "nullable":true
        },
        "RevenueCostInProjectLedgerCurrency":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "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 : projectChangeRequests-FinancialImpactDetails-item-response

Type: object

Show Source

• ApprovalComments: string
  Title: Approval Comments

  Maximum Length: 2000
• ApprovalDate: string (date)
  Title: Approval Date
• ApproverId: integer (int64)
  Title: Approver ID
• ApproverName: string
  Title: Approver Name

  Maximum Length: 255
• AreaCode: string
  Title: Area Code

  Maximum Length: 30
• BurdenedCost: number
  Title: Burdened Cost
• BurdenedCostInProjectCurrency: number
  Title: Burdened Cost in Project Currency
• BurdenedCostInProjectLedgerCurrency: number
  Title: Burdened Cost in Project Ledger Currency
• ChangeOrderId: integer (int64)
  Title: Change Order ID
• ChangeOrderImpactDetailsId: integer (int64)
  Title: Change Order Impact Detail ID
• ChangeOrderImpactId: integer (int64)
  Title: Change Order Impact ID
• ChangeOrderName: string
  Title: Change Order Name

  Maximum Length: 255
• ChangeOrderNumber: integer (int64)
  Title: Change Order Name
• ChangeOrderStatus: string
  Title: Change Order Status

  Read Only: true

  Maximum Length: 255
• ChangeRequestId: integer (int64)
  Title: Change Request ID
• ImpactDetailsId: integer (int64)
  Title: Impact Details ID
• ImpactTo: string
  Title: Impact To

  Maximum Length: 30
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCurrencyCode: string
  Title: Planning Currency Code

  Maximum Length: 15
• ProjectId: integer (int64)
  Title: Project ID
• ProjectName: string
  Title: Project Name
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25
• ProposedFinishDate: string (date)
  Title: Proposed Finish Date
• ProposedStartDate: string (date)
  Title: Proposed Start Date
• Quantity: number
  Title: Quantity
• RawCost: number
  Title: Raw Cost
• RawCostInProjectCurrency: number
  Title: Raw Cost in Project Currency
• RawCostInProjectLedgerCurrency: number
  Title: Raw Cost in Project Ledger Currency
• ResourceId: integer (int64)
  Title: Resource ID
• ResourceName: string
  Title: Resource Name

  Maximum Length: 255
• Revenue: number
  Title: Revenue
• RevenueCostInProjectCurrency: number
  Title: Revenue in Project Currency
• RevenueCostInProjectLedgerCurrency: number
  Title: Revenue in Project Ledger Currency
• Status: string
  Title: Status

  Maximum Length: 255
• StatusCode: string
  Title: Status Code

  Maximum Length: 30
• TaskId: integer (int64)
  Title: Task ID
• TaskName: string
  Title: Task Name

  Maximum Length: 255
• TaskNumber: string
  Title: Task Number

  Maximum Length: 255
• UnitOfMeasureCode: string
  Title: Unit of Measure

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "ApprovalComments":{
            "title":"Approval Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApproverName":{
            "title":"Approver Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "BurdenedCost":{
            "title":"Burdened Cost",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectCurrency":{
            "title":"Burdened Cost in Project Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenedCostInProjectLedgerCurrency":{
            "title":"Burdened Cost in Project Ledger Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeOrderId":{
            "title":"Change Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderImpactDetailsId":{
            "title":"Change Order Impact Detail ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderImpactId":{
            "title":"Change Order Impact ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderName":{
            "title":"Change Order Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeOrderNumber":{
            "title":"Change Order Name",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ChangeOrderStatus":{
            "title":"Change Order Status",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeRequestId":{
            "title":"Change Request ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImpactDetailsId":{
            "title":"Impact Details ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImpactTo":{
            "title":"Impact To",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCurrencyCode":{
            "title":"Planning Currency Code",
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ProjectId1"
                ]
            },
            "x-queryable":true
        },
        "ProposedFinishDate":{
            "title":"Proposed Finish Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProposedStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RawCost":{
            "title":"Raw Cost",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProjectCurrency":{
            "title":"Raw Cost in Project Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RawCostInProjectLedgerCurrency":{
            "title":"Raw Cost in Project Ledger Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Revenue":{
            "title":"Revenue",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueCostInProjectCurrency":{
            "title":"Revenue in Project Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueCostInProjectLedgerCurrency":{
            "title":"Revenue in Project Ledger Currency",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "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."
        }
    }
}

Back to Top