Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

RFIs

37 endpoints11 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/rfisList RFIs
  2. POST /rest/v1.0/projects/{project_id}/rfisCreate RFI
  3. PATCH /rest/v1.0/projects/{project_id}/rfisBatch Update RFIs
  4. GET /rest/v1.0/projects/{project_id}/rfis/{id}Show RFI
  5. PATCH /rest/v1.0/projects/{project_id}/rfis/{id}Update RFI
  6. GET /rest/v1.0/projects/{project_id}/rfis/{id}.pdfShow RFI in PDF format
  7. PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/advance_ball_in_courtUpdate Advance Ball in Court
  8. GET /rest/v1.0/projects/{project_id}/rfis/{id}/advanced_exportsGet Export Options for Existing RFI
  9. POST /rest/v1.0/projects/{project_id}/rfis/{id}/advanced_exportsCreate Advanced Export for Existing RFI
  10. PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/forward_for_reviewUpdate Forward For Review
  11. PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/recycleRecycle RFI
  12. PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/retrieveRetrieve Recycled RFI
  13. GET /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/repliesList RFI Replies
  14. POST /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/repliesCreate RFI Reply
  15. GET /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}Show RFI Reply
  16. PATCH /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}Update RFI Reply
  17. DELETE /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}Delete an RFI Response
  18. GET /rest/v1.0/projects/{project_id}/rfis/default_distributionList RFI Default Distribution
  19. GET /rest/v1.0/projects/{project_id}/rfis/exportDownload RFIs List
  20. GET /rest/v1.0/projects/{project_id}/rfis/filter_optionsList available RFI filters
  21. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/assigned_idList available RFI assigned_id filter options
  22. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/ball_in_court_idList available RFI ball in court filter options
  23. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/cost_code_idList available RFI cost code options
  24. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/location_idList available RFIs locations
  25. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/prefix_stage_idList available RFI Prefix Stage filter options
  26. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/priorityList available RFI Priority filter options
  27. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/received_from_login_information_idList available RFI received from filter options
  28. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/responsible_contractor_idList available RFI responsible contractor filter options
  29. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/rfi_manager_idList available RFI RFI Manager filter options
  30. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/statusList available RFI status filter options
  31. GET /rest/v1.0/projects/{project_id}/rfis/filter_options/sub_job_idList available RFI Sub Job filter options
  32. GET /rest/v1.0/projects/{project_id}/rfis/potential_assigneesGet a list of possible assignees for an RFI
  33. GET /rest/v1.0/projects/{project_id}/rfis/potential_rfi_managersGet a list of possible RFI Managers for an RFI
  34. GET /rest/v1.0/projects/{project_id}/rfis/recycle_binList Recycled RFIs
  35. PATCH /rest/v1.1/projects/{project_id}/rfis/{id}/advance_ball_in_courtUpdate Advance Ball in Court
  36. PATCH /rest/v1.1/projects/{project_id}/rfis/{id}/forward_for_reviewUpdate Forward For Review
  37. GET /rest/v1.1/projects/{project_id}/rfis/exportDownload RFIs List
GET /rest/v1.0/projects/{project_id}/rfis

List RFIs

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[status]
    string | string[]query
  • filters[assigned_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[created_at]
    string (date)query
  • filters[responsible_contractor_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[cost_code_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[received_from_login_information_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[ball_in_court_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[location_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[for_location_id_with_sublocations]
    integer | string (integer) | integer | string (integer)[]query
  • filters[updated_at]
    string (date)query
  • filters[initiated_at]
    stringquery
  • filters[rfi_manager_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[number]
    string | string[]query
  • filters[prefix_stage_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[current_revision]
    boolean | boolean[]query
  • filters[sub_job_id]
    integer | string (integer) | integer | string (integer)[]query
  • filters[priority]
    string | integer | string | integer[]query
  • filters[linked_to_connected_rfis]
    booleanquery
  • filters[linked_to_external_rfis]
    booleanquery
  • filters[overdue]
    boolean | boolean[]query
  • serializer_view
    stringquery
  • as_datetimes
    booleanquery
  • search
    stringquery
  • q
    stringquery
  • sort[attribute]
    stringquery
  • sort[direction]
    stringquery

Response · 200 · integer[] | object[]

No documented fields.

POST /rest/v1.0/projects/{project_id}/rfis

Create RFI

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • rfi
    objectrequired

Response · 201 · object

  • accepted
    boolean
  • ball_in_court_role
    string
  • created_by
    object
  • custom_textfield_1
    object
  • custom_textfield_2
    object
  • distribution_list
    object[]
  • draft
    boolean
  • drawing_ids
    integer[]
  • drawing_number
    string
  • questions
    object[]
  • specification_section
    object
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • subject
    string
  • revision
    string
  • source_rfi_header_id
    integer
  • current_revision
    boolean
  • has_revisions
    boolean
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
  • connect_exported_project_ids
    integer[]
PATCH /rest/v1.0/projects/{project_id}/rfis

Batch Update RFIs

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • data
    object[]required

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/rfis/{id}

Show RFI

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • accepted
    boolean
  • ball_in_court_role
    string
  • created_by
    object
  • custom_textfield_1
    object
  • custom_textfield_2
    object
  • distribution_list
    object[]
  • draft
    boolean
  • drawing_ids
    integer[]
  • drawing_number
    string
  • questions
    object[]
  • specification_section
    object
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • subject
    string
  • revision
    string
  • source_rfi_header_id
    integer
  • current_revision
    boolean
  • has_revisions
    boolean
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
  • connect_exported_project_ids
    integer[]
PATCH /rest/v1.0/projects/{project_id}/rfis/{id}

Update RFI

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • run_configurable_validations
    booleanquery

Request body

  • rfi
    objectrequired

Response · 200 · object

  • accepted
    boolean
  • ball_in_court_role
    string
  • created_by
    object
  • custom_textfield_1
    object
  • custom_textfield_2
    object
  • distribution_list
    object[]
  • draft
    boolean
  • drawing_ids
    integer[]
  • drawing_number
    string
  • questions
    object[]
  • specification_section
    object
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • subject
    string
  • revision
    string
  • source_rfi_header_id
    integer
  • current_revision
    boolean
  • has_revisions
    boolean
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
  • connect_exported_project_ids
    integer[]
GET /rest/v1.0/projects/{project_id}/rfis/{id}.pdf

Show RFI in PDF format

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • only_official
    booleanquery

Response

No response body.

PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/advance_ball_in_court

Update Advance Ball in Court

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • accepted
    boolean
  • ball_in_court_role
    string
  • created_by
    object
  • custom_textfield_1
    object
  • custom_textfield_2
    object
  • distribution_list
    object[]
  • draft
    boolean
  • drawing_ids
    integer[]
  • drawing_number
    string
  • questions
    object[]
  • specification_section
    object
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • subject
    string
  • revision
    string
  • source_rfi_header_id
    integer
  • current_revision
    boolean
  • has_revisions
    boolean
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
  • connect_exported_project_ids
    integer[]
GET /rest/v1.0/projects/{project_id}/rfis/{id}/advanced_exports

Get Export Options for Existing RFI

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object[]

  • slug
    string
  • name
    string
  • type
    string
  • options
    object[]
POST /rest/v1.0/projects/{project_id}/rfis/{id}/advanced_exports

Create Advanced Export for Existing RFI

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • format
    stringqueryrequired

Request body

  • options
    objectrequired

Response · 200 · object

  • message
    string
PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/forward_for_review

Update Forward For Review

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • rfi
    objectrequired

Response · 200 · object

  • accepted
    boolean
  • ball_in_court_role
    string
  • created_by
    object
  • custom_textfield_1
    object
  • custom_textfield_2
    object
  • distribution_list
    object[]
  • draft
    boolean
  • drawing_ids
    integer[]
  • drawing_number
    string
  • questions
    object[]
  • specification_section
    object
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • subject
    string
  • revision
    string
  • source_rfi_header_id
    integer
  • current_revision
    boolean
  • has_revisions
    boolean
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
  • connect_exported_project_ids
    integer[]
PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/recycle

Recycle RFI

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

PATCH /rest/v1.0/projects/{project_id}/rfis/{id}/retrieve

Retrieve Recycled RFI

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies

List RFI Replies

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • rfi_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • official
    boolean
  • answer_date
    string (date-time)
  • plain_text_body
    string
  • rich_text_body
    string
  • created_by
    string
  • created_by_id
    integer
  • attachments
    object[]
POST /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies

Create RFI Reply

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • rfi_id
    integerpathrequired

Request body

  • reply
    objectrequired
  • attachments
    string[]

Response · 201 · object

  • id
    integer
  • official
    boolean
  • answer_date
    string (date-time)
  • plain_text_body
    string
  • rich_text_body
    string
  • created_by
    string
  • created_by_id
    integer
  • attachments
    object[]
GET /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}

Show RFI Reply

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • rfi_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • official
    boolean
  • answer_date
    string (date-time)
  • plain_text_body
    string
  • rich_text_body
    string
  • created_by
    string
  • created_by_id
    integer
  • attachments
    object[]
PATCH /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}

Update RFI Reply

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • rfi_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reply
    objectrequired

Response · 200 · object

  • id
    integer
  • official
    boolean
  • answer_date
    string (date-time)
  • plain_text_body
    string
  • rich_text_body
    string
  • created_by
    string
  • created_by_id
    integer
  • attachments
    object[]
DELETE /rest/v1.0/projects/{project_id}/rfis/{rfi_id}/replies/{id}

Delete an RFI Response

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • rfi_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/projects/{project_id}/rfis/default_distribution

List RFI Default Distribution

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • login
    string
  • name
    string
  • locale
    string
  • company_name
    string
GET /rest/v1.0/projects/{project_id}/rfis/export

Download RFIs List

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • filters[query]
    stringquery
  • export_format
    stringquery
  • table_configuration_for_export
    objectquery

Response · 200 · string

No documented fields.

GET /rest/v1.0/projects/{project_id}/rfis/filter_options

List available RFI filters

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object

  • key
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/assigned_id

List available RFI assigned_id filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/ball_in_court_id

List available RFI ball in court filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/cost_code_id

List available RFI cost code options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/location_id

List available RFIs locations

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/prefix_stage_id

List available RFI Prefix Stage filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/priority

List available RFI Priority filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/received_from_login_information_id

List available RFI received from filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/responsible_contractor_id

List available RFI responsible contractor filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/rfi_manager_id

List available RFI RFI Manager filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/status

List available RFI status filter options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    string
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/filter_options/sub_job_id

List available RFI Sub Job filter options

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Response · 200 · object[]

  • key
    integer
  • value
    string
GET /rest/v1.0/projects/{project_id}/rfis/potential_assignees

Get a list of possible assignees for an RFI

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • login
    string
  • id
    integer
  • name
    string
  • locale
    string
GET /rest/v1.0/projects/{project_id}/rfis/potential_rfi_managers

Get a list of possible RFI Managers for an RFI

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • login
    string
  • id
    integer
  • name
    string
  • locale
    string
GET /rest/v1.0/projects/{project_id}/rfis/recycle_bin

List Recycled RFIs

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[updated_at]
    string (date)query

Response · 200 · object[]

  • created_by
    object
  • link
    string (url)
  • location_id
    integer
  • specification_section_id
    integer
  • questions
    object[]
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object
  • cost_impact
    object
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date) | string (date-time)
  • initiated_at
    string (date-time)
  • location
    object
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • project_stage
    object
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object
  • rfi_manager
    object
  • schedule_impact
    object
  • status
    string
  • translated_status
    string
  • sub_job
    object
  • subject
    string
  • revision
    string
  • current_revision
    boolean
  • has_revisions
    boolean
  • source_rfi_header_id
    integer
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
PATCH /rest/v1.1/projects/{project_id}/rfis/{id}/advance_ball_in_court

Update Advance Ball in Court

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • created_by
    object
  • link
    string (url)
  • location_id
    integer
  • specification_section_id
    integer
  • questions
    object[]
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object | null
  • cost_impact
    object | null
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date) | string (date-time)
  • initiated_at
    string (date-time)
  • location
    object | null
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • project_stage
    object | null
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object | null
  • rfi_manager
    object
  • schedule_impact
    object | null
  • status
    string
  • translated_status
    string
  • sub_job
    object | null
  • subject
    string
  • revision
    string
  • current_revision
    boolean
  • has_revisions
    boolean
  • source_rfi_header_id
    integer
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
PATCH /rest/v1.1/projects/{project_id}/rfis/{id}/forward_for_review

Update Forward For Review

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • rfi
    objectrequired

Response · 200 · object

  • created_by
    object
  • link
    string (url)
  • location_id
    integer
  • specification_section_id
    integer
  • questions
    object[]
  • custom_fields
    object
  • id
    integer
  • assignee
    object
  • assignees
    object[]
  • ball_in_court
    object
  • ball_in_courts
    object[]
  • cost_code
    object | null
  • cost_impact
    object | null
  • created_at
    string (date-time)
  • deleted
    boolean
  • deleted_at
    string (date-time)
  • due_date
    string (date) | string (date-time)
  • initiated_at
    string (date-time)
  • location
    object | null
  • full_number
    string
  • number
    string
  • prefix
    string
  • private
    boolean
  • project_stage
    object | null
  • received_from
    object
  • reference
    string
  • responsible_contractor
    object | null
  • rfi_manager
    object
  • schedule_impact
    object | null
  • status
    string
  • translated_status
    string
  • sub_job
    object | null
  • subject
    string
  • revision
    string
  • current_revision
    boolean
  • has_revisions
    boolean
  • source_rfi_header_id
    integer
  • time_resolved
    string (date-time)
  • updated_at
    string (date-time)
  • connect_export_origin
    object
GET /rest/v1.1/projects/{project_id}/rfis/export

Download RFIs List

v1.1Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • filters[query]
    stringquery
  • export_format
    stringquery
  • table_configuration_for_export
    objectquery

Response · 200 · string

No documented fields.

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file