Jump to

• Request
• Response

Update a task impact detail

patch

/fscmRestApi/resources/11.13.18.05/projectChangeRequests/{ChangeRequestId}/child/TaskImpactDetails/{TaskImpactDetailsId}

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=
• TaskImpactDetailsId(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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Action: string
  Title: Action

  Maximum Length: 10

  Specifies the type of task impact. A value of CREATE denotes the proposal for a new task, while a value of UPDATE indicates modifications to an existing task using the change request.
• ApprovalComments: string
  Title: Approval Comments

  Maximum Length: 2000

  The justification for either approving or rejecting the change request impact detail.
• ApprovalDate: string (date)
  Title: Approval Date

  The date when the approval decision of the change request impact detail was made.
• ApproverId: integer (int64)
  Title: Approver ID

  The identifier of the project person who made the approval decision for the change request impact detail.
• ApproverName: string
  Title: Approver Name

  Maximum Length: 255

  The name of the project person who made the approval decision on the change request impact detail.
• AreaCode: string
  Title: Area Code

  Maximum Length: 30

  Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA.
• ChangeOrderId: integer (int64)
  Title: Change Order ID

  Identifier of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderImpactDetailsId: integer (int64)
  Title: Change Order Impact Detail ID

  Identifier of the change order impact detail, if any, that the change request impact detail is associated with.
• ChangeOrderImpactId: integer (int64)
  Title: Change Order Impact ID

  Identifier of the change order impact, if any, that the change request impact detail is associated with.
• ChangeOrderName: string
  Maximum Length: 255

  The name of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderNumber: integer (int64)
  The number of the change order, if any, that the change request impact detail is associated with.
• ChangeRequestId: integer (int64)
  Title: Change Request ID

  The identifier of the change request.
• 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

  The identifier of the parent task of a new task proposed or a task impacted with the change request.
• ParentTaskName: string
  Title: Parent Task Name

  Maximum Length: 255

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

  Maximum Length: 255

  The number of the parent task of a new task proposed or a task impacted with the change request.
• ProjectId: integer (int64)
  Title: Project ID

  The identifier of the project associated with the change request.
• ProposedFinishDate: string (date)
  Title: Proposed Finish Date

  The proposed finish date of the task in change impact task details.
• ProposedStartDate: string (date)
  Title: Proposed Start Date

  The proposed start date of the task in the change impact task details.
• Status: string
  Title: Status

  Maximum Length: 255

  The status of the change request impact detail such as approved or rejected.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code that represents the status of the change impact detail such as approved or rejected.
• TaskId: integer (int64)
  Title: Task ID

  The identifier of the task that's impacted due to the change request.
• TaskImpactDetailsId: integer (int64)
  Title: Task Impact Detail ID

  The unique identifier of the change request task impact assessment.
• TaskName: string
  Title: Task Name

  Maximum Length: 100

  The name of the task that's impacted due to the change request.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  The number of the task that's impacted due to the change request.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action",
            "maxLength":10,
            "type":"string",
            "description":"Specifies the type of task impact. A value of CREATE denotes the proposal for a new task, while a value of UPDATE indicates modifications to an existing task using the change request.",
            "nullable":true
        },
        "ApprovalComments":{
            "title":"Approval Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The justification for either approving or rejecting the change request impact detail.",
            "nullable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The date when the approval decision of the change request impact detail was made.",
            "format":"date",
            "nullable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "description":"The identifier of the project person who made the approval decision for the change request impact detail.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApproverName":{
            "title":"Approver Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the project person who made the approval decision on the change request impact detail.",
            "nullable":true
        },
        "AreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA.",
            "nullable":false
        },
        "ChangeOrderId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"Identifier of the change order, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderImpactDetailsId":{
            "title":"Change Order Impact Detail ID",
            "type":"integer",
            "description":"Identifier of the change order impact detail, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderImpactId":{
            "title":"Change Order Impact ID",
            "type":"integer",
            "description":"Identifier of the change order impact, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeOrderName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the change order, if any, that the change request impact detail is associated with.",
            "nullable":true
        },
        "ChangeOrderNumber":{
            "type":"integer",
            "description":"The number of the change order, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "ChangeRequestId":{
            "title":"Change Request ID",
            "type":"integer",
            "description":"The identifier of the change request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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":"The identifier of the parent task of a new task proposed or a task impacted with the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ParentTaskName":{
            "title":"Parent Task Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the parent task of a new task proposed or a task impacted with the change request.",
            "nullable":true
        },
        "ParentTaskNumber":{
            "title":"Parent Task Number",
            "maxLength":255,
            "type":"string",
            "description":"The number of the parent task of a new task proposed or a task impacted with the change request.",
            "nullable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"The identifier of the project associated with the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProposedFinishDate":{
            "title":"Proposed Finish Date",
            "type":"string",
            "description":"The proposed finish date of the task in change impact task details.",
            "format":"date",
            "nullable":true
        },
        "ProposedStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "description":"The proposed start date of the task in the change impact task details.",
            "format":"date",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the change request impact detail such as approved or rejected.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the status of the change impact detail such as approved or rejected.",
            "nullable":false
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"The identifier of the task that's impacted due to the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskImpactDetailsId":{
            "title":"Task Impact Detail ID",
            "type":"integer",
            "description":"The unique identifier of the change request task impact assessment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the task that's impacted due to the change request.",
            "nullable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number of the task that's impacted due to the change request.",
            "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-TaskImpactDetails-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 proposal for a new task, while a value of UPDATE indicates modifications to an existing task using the change request.
• ApprovalComments: string
  Title: Approval Comments

  Maximum Length: 2000

  The justification for either approving or rejecting the change request impact detail.
• ApprovalDate: string (date)
  Title: Approval Date

  The date when the approval decision of the change request impact detail was made.
• ApproverId: integer (int64)
  Title: Approver ID

  The identifier of the project person who made the approval decision for the change request impact detail.
• ApproverName: string
  Title: Approver Name

  Maximum Length: 255

  The name of the project person who made the approval decision on the change request impact detail.
• AreaCode: string
  Title: Area Code

  Maximum Length: 30

  Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA.
• ChangeOrderId: integer (int64)
  Title: Change Order ID

  Identifier of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderImpactDetailsId: integer (int64)
  Title: Change Order Impact Detail ID

  Identifier of the change order impact detail, if any, that the change request impact detail is associated with.
• ChangeOrderImpactId: integer (int64)
  Title: Change Order Impact ID

  Identifier of the change order impact, if any, that the change request impact detail is associated with.
• ChangeOrderName: string
  Maximum Length: 255

  The name of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderNumber: integer (int64)
  The number of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderStatus: string
  Title: Change Order Status

  Read Only: true

  Maximum Length: 255

  The status of the change order, if any, that the change request impact detail is associated with.
• ChangeOrderStatusCode: string
  Title: Change Order Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the change order, if any, that the change request impact detail is associated with.
• ChangeRequestId: integer (int64)
  Title: Change Request ID

  The identifier of the change request.
• 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

  The identifier of the parent task of a new task proposed or a task impacted with the change request.
• ParentTaskName: string
  Title: Parent Task Name

  Maximum Length: 255

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

  Maximum Length: 255

  The number of the parent task of a new task proposed or a task impacted with the change request.
• ProjectId: integer (int64)
  Title: Project ID

  The identifier of the project associated with the change request.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project associated with the change request.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The number of the project associated with the change request.
• ProposedFinishDate: string (date)
  Title: Proposed Finish Date

  The proposed finish date of the task in change impact task details.
• ProposedStartDate: string (date)
  Title: Proposed Start Date

  The proposed start date of the task in the change impact task details.
• Status: string
  Title: Status

  Maximum Length: 255

  The status of the change request impact detail such as approved or rejected.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code that represents the status of the change impact detail such as approved or rejected.
• TaskId: integer (int64)
  Title: Task ID

  The identifier of the task that's impacted due to the change request.
• TaskImpactDetailsId: integer (int64)
  Title: Task Impact Detail ID

  The unique identifier of the change request task impact assessment.
• TaskName: string
  Title: Task Name

  Maximum Length: 100

  The name of the task that's impacted due to the change request.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  The number of the task that's impacted due to the change request.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action",
            "maxLength":10,
            "type":"string",
            "description":"Specifies the type of task impact. A value of CREATE denotes the proposal for a new task, while a value of UPDATE indicates modifications to an existing task using the change request.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalComments":{
            "title":"Approval Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The justification for either approving or rejecting the change request impact detail.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The date when the approval decision of the change request impact detail was made.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "description":"The identifier of the project person who made the approval decision for the change request impact detail.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApproverName":{
            "title":"Approver Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the project person who made the approval decision on the change request impact detail.",
            "nullable":true,
            "x-queryable":true
        },
        "AreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeOrderId":{
            "title":"Change Order ID",
            "type":"integer",
            "description":"Identifier of the change order, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderImpactDetailsId":{
            "title":"Change Order Impact Detail ID",
            "type":"integer",
            "description":"Identifier of the change order impact detail, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderImpactId":{
            "title":"Change Order Impact ID",
            "type":"integer",
            "description":"Identifier of the change order impact, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeOrderName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the change order, if any, that the change request impact detail is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeOrderNumber":{
            "type":"integer",
            "description":"The number of the change order, if any, that the change request impact detail is associated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ChangeOrderStatus":{
            "title":"Change Order Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the change order, if any, that the change request impact detail is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeOrderStatusCode":{
            "title":"Change Order Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the change order, if any, that the change request impact detail is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeRequestId":{
            "title":"Change Request ID",
            "type":"integer",
            "description":"The identifier of the change request.",
            "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":"The identifier of the parent task of a new task proposed or a task impacted with the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentTaskName":{
            "title":"Parent Task Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the parent task of a new task proposed or a task impacted with the change request.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTaskNumber":{
            "title":"Parent Task Number",
            "maxLength":255,
            "type":"string",
            "description":"The number of the parent task of a new task proposed or a task impacted with the change request.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"The identifier of the project associated with the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the project associated with the change request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"The number of the project associated with the change request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ProjectId1"
                ]
            },
            "x-queryable":true
        },
        "ProposedFinishDate":{
            "title":"Proposed Finish Date",
            "type":"string",
            "description":"The proposed finish date of the task in change impact task details.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProposedStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "description":"The proposed start date of the task in the change impact task details.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the change request impact detail such as approved or rejected.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the status of the change impact detail such as approved or rejected.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"The identifier of the task that's impacted due to the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskImpactDetailsId":{
            "title":"Task Impact Detail ID",
            "type":"integer",
            "description":"The unique identifier of the change request task impact assessment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the task that's impacted due to the change request.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number of the task that's impacted due to the change request.",
            "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