Jump to

• Request
• Response

Create task impact details for a change impact

post

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

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

• 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.
• 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
        },
        "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
            }
        },
        "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-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"
    }
}

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