v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
change orders

Update an existing change_order by ID

patch/api/v3/projects/{project_id}/change_orders/{id}

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

idstring uuid required

ID of the entity

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

namestring

Name of the Change Order.

descriptionstring nullable

Description of the Change Order.

reason_type_idstring uuid nullable

The ID of the ReasonTypes indicating why change order was created.

reference_numberstring nullable

Reference number of the Change Order.

schedule_impact'yes' | 'no' | 'maybe' nullable

Specifies how the schedule is impacted by this Change Order. Valid values are: none, maybe, yes.

schedule_impact_daysinteger nullable

Number of days the schedule is impacted by this Change Order.

last_editor_user_idinteger required

ID of the user who most recently edited this entity

device_updated_atstring date-time nullable

Time when the device last updated the entity

Response

Successful response

idstring uuid required

Unique identifier for the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

project_idstring uuid required

ID of the project this entity belongs to

resolved_conflictboolean required

Specifies if PUT/PATCH request was rejected - do not store this field!

created_atstring date required

Time when the entity was created

updated_atstring date required

Time when the entity was last updated

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

deleted_atstring date nullable required

Time when the entity was deleted

reference_numberstring nullable required

Reference number to document outside of Fieldwire.

namestring required

Name of the change order.

due_datestring date-time nullable required

The due date for the change order.

pm_group_numberinteger nullable required

The project management group number associated with the change order.

total_coststring nullable required

The total cost associated with the change order.

revision_idstring uuid required

ID of the current revision entity.

status_name'Draft' | 'Requested' | 'Pending Revision' | 'Pending Approval' | 'Approved' | 'Rejected' | 'Void' required

The name of the current status of the change order.

descriptionstring nullable required

Description of the change order.

assignee_user_idinteger nullable required

ID of the user who is assigned to this change order.

external_assignee_user_idinteger nullable required

ID of the external user who is assigned to this change order.

schedule_impact'yes' | 'no' | 'maybe' nullable required

Description of the schedule impact of the change order.

schedule_impact_daysinteger nullable required

Impact on schedule, measured in days.

current_revision_idstring uuid required

ID of the current revision entity.

reason_type_idstring uuid nullable required

The ID of the ReasonTypes indicating why change order was created.