Sign in

v1

latestOpenAPI 3.0.32026-07-246304082.0 MB
rfis

Transition an rfi

patch/api/v3/projects/{project_id}/rfis/{id}/transition

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

to_state'draft' | 'open' | 'pending' | 'closed' | 'void' required

The status the user is trying to transitions the RFI to.

assignee_user_idinteger nullable

ID of whom this RFI will be assigned to.

assignee_user_emailstring nullable

User email that this RFI will be assigned to.

messagestring nullable

Message to be emailed when the RFI is transitioned or updated.

answerstring nullable

Answer to the question of the RFI.

due_datestring date nullable

RFI transition due date

on_behalfboolean nullable

True if user is transitioning on behalf of the assignee

enable_email_remindersboolean nullable

True if email reminders need to be sent

watcher_idsinteger[] nullable

A list of user IDs to be added as watchers

add_reviewer_user_idsinteger[] nullable

List of User ids that will become reviewers

add_watcher_user_idsinteger[] nullable

List of User ids that will become watchers

remove_watcher_user_idsinteger[] nullable

List of User ids that will be removed as watchers

Response

Successful response

idstring uuid required

ID of 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

namestring required

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

location_idstring uuid nullable

ID of the location associated with this RFI.

created_atstring date-time required

Time when the server created the entity

deleted_atstring date-time nullable

Time the server deleted the entity

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

updated_atstring date-time required

Time when the server last updated the entity

answerstring nullable

The answer to the Rfi

questionstring nullable

The question of the Rfi

suggestionstring nullable

The suggestion for the question of the Rfi

impact_notesstring nullable

The impact notes of the Rfi

due_datestring date nullable

When the Rfi is due by

reference_numberstring nullable

The reference number of the Rfi

rfi_numberinteger nullable

The number extracted from consolidated number associated with the Rfi

consolidated_numberstring

The consolidated number associated with the Rfi

assignee_idinteger nullable required

The id of the user assigned to the Rfi

voided_by_user_idinteger nullable

The id of the user who voided the Rfi

voided_atstring date-time nullable

Time the server voided the entity

submitted_by_user_idinteger nullable

The id of the user submitted the Rfi

last_answered_by_user_idinteger nullable

The id of the user who last answered the Rfi

original_assignee_idinteger nullable

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

to_pm_group_idstring uuid nullable

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

creator_pm_group_idstring uuid nullable

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

status'draft' | 'submitted' | 'answered' | 'closed' | 'void' | 'null' nullable

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

previous_status'draft' | 'open' | 'pending' | 'closed' | 'void' | 'null' nullable

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

mapped_status'draft' | 'open' | 'pending' | 'closed' | 'void' | 'null' nullable

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

impact'no_impact' | 'cost' | 'schedule' | 'cost_and_schedule' | 'null' nullable

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

resolved_conflictboolean

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

return_to_lead_companyboolean

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

company_codestring

Code of the PmGroup that created this Rfi

watchersinteger[]

Array containing rfi watchers user ids

date_askedstring date nullable

When the Rfi was first asked

date_answeredstring date nullable

When the Rfi was last answered

response_timeinteger nullable

Difference between date_asked and date_answered in days

closed_atstring date-time nullable

Time the server last closed the entity