Update a task impact detail for a change impact
patch
/fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeImpacts/{ImpactId}/child/ChangeImpactTaskDetails/{ImpactTaskDetailsId}
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.
-
ImpactTaskDetailsId(required): integer(int64)
Unique identifier of the task impact details of 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
Root Schema : schema
Type:
Show Source
object
-
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 Flag
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : changeOrders-ChangeImpacts-ChangeImpactTaskDetails-item-response
Type:
Show Source
object
-
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 Flag
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.