Update rfi by ID

patch https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/rfis/{id}

Path Params

project_id

uuid

required

ID of the project this entity belongs to

uuid

required

ID of the entity

Body Params

last_editor_user_id

int32

ID of the user who most recently edited this entity

name

string

Name of the Rfi. Must be unique between Rfis under the same parent.

location_id

uuid | null

ID of the location associated with this RFI.

device_updated_at

date-time

Time when the device last updated the entity

answer

string | null

The answer to the Rfi

question

string | null

The question of the Rfi

suggestion

string | null

The suggestion for the question of the Rfi

impact_notes

string | null

The impact notes of the Rfi

due_date

date | null

When the Rfi is due by

reference_number

string | null

The reference number of the Rfi

assignee_id

int32 | null

The id of the user assigned to the Rfi

impact

string | null

The impact of the Rfi as an enum, e.g. cost, schedule, both

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Response

Response body

object

uuid

required

ID of the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

project_id

uuid

required

ID of the project this entity belongs to

name

string

required

Name of the Rfi. Must be unique between Rfis under the same parent.

location_id

uuid | null

ID of the location associated with this RFI.

created_at

date-time

required

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

required

Time when the device created the entity

device_updated_at

date-time

required

Time when the device last updated the entity

updated_at

date-time

required

Time when the server last updated the entity

answer

string | null

The answer to the Rfi

question

string | null

The question of the Rfi

suggestion

string | null

The suggestion for the question of the Rfi

impact_notes

string | null

The impact notes of the Rfi

due_date

date | null

When the Rfi is due by

reference_number

string | null

The reference number of the Rfi

rfi_number

int32 | null

The number associated with the Rfi

assignee_id

int32 | null

required

The id of the user assigned to the Rfi

rfi_assignee

object | null

Entity that represents a RfiUser document

uuid

required

ID of the entity

project_id

uuid

required

ID of the project this entity belongs to

rfi_id

uuid

required

ID of the Rfi this entity belongs to

project_userable_id

int32

ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind.

project_userable_type

string

ProjectUser or ExternalProjectUser, i.e non-user or user kind

user_id

int32 | null

ID of the User. Belongs to User entity.

is_assignee

boolean | null

indication for whether this RfiUser is an assignee on the Rfi

is_watcher

boolean | null

indication for whether this RfiUser is a watcher on the Rfi

is_reviewer

boolean | null

indication for whether this RfiUser is a reviewer on the Rfi

kind

string

kind of user

string | null

users email, if non_user

language

string | null

users language, if non_user

user

object | null

the associated project-user attributes

device_created_at

date-time

Time when the device created the entity

device_updated_at

date-time

Time when the device last updated the entity

deleted_at

date-time | null

Time the server deleted the entity

created_at

date-time

required

Time when the server created the entity

updated_at

date-time

required

Time when the server last updated the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

resolved_conflict

boolean

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

submitted_by_user_id

int32 | null

The id of the user submitted the Rfi

last_answered_by_user_id

int32 | null

The id of the user who last answered the Rfi

original_assignee_id

int32 | null

The id of the user who was last assigned the Rfi before the Rfi was open to answering on behalf

original_rfi_assignee

object | null

Entity that represents a RfiUser document

uuid

required

ID of the entity

project_id

uuid

required

ID of the project this entity belongs to

rfi_id

uuid

required

ID of the Rfi this entity belongs to

project_userable_id

int32

ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind.

project_userable_type

string

ProjectUser or ExternalProjectUser, i.e non-user or user kind

user_id

int32 | null

ID of the User. Belongs to User entity.

is_assignee

boolean | null

indication for whether this RfiUser is an assignee on the Rfi

is_watcher

boolean | null

indication for whether this RfiUser is a watcher on the Rfi

is_reviewer

boolean | null

indication for whether this RfiUser is a reviewer on the Rfi

kind

string

kind of user

string | null

users email, if non_user

language

string | null

users language, if non_user

user

object | null

the associated project-user attributes

device_created_at

date-time

Time when the device created the entity

device_updated_at

date-time

Time when the device last updated the entity

deleted_at

date-time | null

Time the server deleted the entity

created_at

date-time

required

Time when the server created the entity

updated_at

date-time

required

Time when the server last updated the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

resolved_conflict

boolean

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

to_pm_group_id

uuid | null

The id of the PmGroup receiving the Rfi. Only set when Rfi is submitted.

creator_pm_group_id

uuid | null

The id of the PmGroup that the Rfi creator was in when the Rfi was created

status

string | null

The status of the Rfi as an enum, e.g. draft, submitted

draft submitted answered closed void

mapped_status

string | null

The status of the Rfi as an enum, e.g. draft, submitted

draft open pending closed void

impact

string | null

The impact of the Rfi as an enum, e.g. cost, schedule, both

no_impact cost schedule cost_and_schedule

resolved_conflict

boolean

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

return_to_lead_company

boolean

Specifies whether a reassigned RFI is to be returned back to the lead/creator company

company_code

string

Code of the PmGroup that created this Rfi

watchers

array of int32s

Array containing rfi watchers user ids

watchers

rfi_plan_relations

array of objects

Array containing related plan ids

rfi_plan_relations

object

uuid

ID of rfi plan relation object

rfi_id

uuid

required

ID of related rfi

floorplan_id

uuid

required

ID of related plan

sheet_id

uuid

required

ID of related sheet

data

object

required

JSON information about relationship, such as markup placement

Has additional fields

creator_user_id

int32

ID of the user who created this entity

last_editor_user_id

int32

ID of the user who most recently edited this entity

created_at

date-time

Time when the server created the entity

deleted_at

date-time | null

Time the server deleted the entity

device_created_at

date-time

Time when the device created the entity

device_updated_at

date-time

Time when the device last updated the entity

updated_at

date-time

Time when the server last updated the entity

project_id

uuid

ID of the project this entity belongs to

resolved_conflict

boolean

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

related_tasks

array of objects

Array containing related tasks

related_tasks

object

name

string | null

required

Name of the task

uuid

required

ID of related task

number

int32 | null

required

Number of the task

assignee

string

required

Initials of the assignee

bubbles

int32

required

Amount of bubbles attached to task

checklist

object

required

Object containing checklist information

category

string | null

required

Short form name of the team of the task

status_color

string | null

required

Color of the task status

relation_creator_user_id

int32

required

ID of user that created the relationship

related_rfis

array of objects

Array containing related rfis

related_rfis

object

uuid

ID of the entity

name

string

Name of the Rfi. Must be unique between Rfis under the same parent.

status

string | null

The status of the Rfi as an enum, e.g. draft, submitted

draft submitted answered closed void

company_code

string

Code of the PmGroup that created this Rfi

number

int32 | null

The number associated with the Rfi

attachments

array of objects

Array containing attachment objects

attachments

object

uuid

required

ID of the RFI Attachment object.

name

string | null

Name of the file if there is one.

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

ID of the user who last interacted modified this entity

project_id

uuid

required

ID of the project this entity belongs to

rfi_id

uuid

required

The RFI on which these attachments will exist.

rfi_response_id

uuid | null

The RFI response on which these attachments will exist.

attached_to

string

required

Where under the RFI this attachment was added: question, or answer.

question answer

kind

string

required

Allowable kinds of RFI Attachments.

new_file existing_file over_limit_file cropped_plan new_photo existing_photo

fw_object_id

uuid | null

The ID of the FW object which this RFIAttachment comes from.

original_url

string | null

URL of the file originally uploaded by the user

file_url

string | null

URL of the potentially processed file

thumb_url

string | null

Thumb URL of the file if there is one

file_size

int32 | null

Size of file if there is one

created_at

date-time

required

Time when the server created the entity

device_created_at

date-time

required

Time when the device created the entity

resolved_conflict

boolean | null

required

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

device_updated_at

date-time

required

Time when the device last updated the entity

updated_at

date-time

required

Time when the server last updated the entity

deleted_at

date-time | null

Time the server deleted the entity

flattened_file_url

string | null

URL of the file that has the markups flattened too

voided_at

date-time | null

Time the server voided the entity

closed_at

date-time | null

Time the server last closed the entity

closed_by

object | null

Entity that represents a RfiUser document

uuid

required

ID of the entity

project_id

uuid

required

ID of the project this entity belongs to

rfi_id

uuid

required

ID of the Rfi this entity belongs to

project_userable_id

int32

ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind.

project_userable_type

string

ProjectUser or ExternalProjectUser, i.e non-user or user kind

user_id

int32 | null

ID of the User. Belongs to User entity.

is_assignee

boolean | null

indication for whether this RfiUser is an assignee on the Rfi

is_watcher

boolean | null

indication for whether this RfiUser is a watcher on the Rfi

is_reviewer

boolean | null

indication for whether this RfiUser is a reviewer on the Rfi

kind

string

kind of user

string | null

users email, if non_user

language

string | null

users language, if non_user

user

object | null

the associated project-user attributes

device_created_at

date-time

Time when the device created the entity

device_updated_at

date-time

Time when the device last updated the entity

deleted_at

date-time | null

Time the server deleted the entity

created_at

date-time

required

Time when the server created the entity

updated_at

date-time

required

Time when the server last updated the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

resolved_conflict

boolean

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

voided_by

object | null

Entity that represents a RfiUser document

uuid

required

ID of the entity

project_id

uuid

required

ID of the project this entity belongs to

rfi_id

uuid

required

ID of the Rfi this entity belongs to

project_userable_id

int32

ID of the ProjectUser if user kind, ExternalProjectUser if non-user kind.

project_userable_type

string

ProjectUser or ExternalProjectUser, i.e non-user or user kind

user_id

int32 | null

ID of the User. Belongs to User entity.

is_assignee

boolean | null

indication for whether this RfiUser is an assignee on the Rfi

is_watcher

boolean | null

indication for whether this RfiUser is a watcher on the Rfi

is_reviewer

boolean | null

indication for whether this RfiUser is a reviewer on the Rfi

kind

string

kind of user

string | null

users email, if non_user

language

string | null

users language, if non_user

user

object | null

the associated project-user attributes

device_created_at

date-time

Time when the device created the entity

device_updated_at

date-time

Time when the device last updated the entity

deleted_at

date-time | null

Time the server deleted the entity

created_at

date-time

required

Time when the server created the entity

updated_at

date-time

required

Time when the server last updated the entity

creator_user_id

int32

required

ID of the user who created this entity

last_editor_user_id

int32

required

ID of the user who most recently edited this entity

resolved_conflict

boolean

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

Headers

object

X-Current-User-Id

integer

Current user's id

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://client-api.us.fieldwire.com/api/v3/projects/project_id/rfis/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response