Procore.Api.ProjectManagementRFIRFIs (procore_sdk v0.3.0)
API calls for all endpoints tagged ProjectManagementRFIRFIs
.
Summary
Functions
List RFIs Returns all RFIs in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Show RFI Return detailed information about a specified RFI in a specified Project.
Update RFI Updates a specified RFI in a specified Project.
Recycle RFI Send a specified RFI to the Recycle Bin.
Retrieve Recycled RFI Retrieve a specified RFI from the Recycle Bin.
Show RFI in PDF format Return detailed information (as a PDF) about a specified RFI in a specified Project.
Batch Update RFIs Update specified RFIs in a specified project. Specify the RFIs by their IDs. Pass in the same values for each specified RFI for the action to succeed.
Create RFI Creates a new RFI in a specified Project.
List Recycled RFIs Returns all deleted RFIs in a specified Project
Functions
rest_v10_projects_project_id_rfis_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10ProjectsProjectIdRfisGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List RFIs Returns all RFIs in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[status]"
(String.t): Return item(s) with the specified RFI Status.:"filters[assigned_id]"
(String.t): Assigned ID:"filters[created_at]"
(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[responsible_contractor_id]"(integer()): Responsible Contractor ID -
:"filters[cost_code_id]"(String.t): Cost Code ID. Returns item(s) with the specified Cost Code ID or within the specified range of Cost Code IDs. -
:"filters[received_from_login_information_id]"(String.t): Received From Login Information ID. Returns item(s) with the specified Received From Login Information ID. -
:"filters[ball_in_court_id]"(integer()): User ID. Return item(s) where the specified User ID is the Ball in Court. -
:"filters[location_id]"([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs. -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[rfi_manager_id]"(integer()): Return item(s) with the specified RFI Manager ID. -
:"filters[number]"(integer()): Return item(s) with the specified RFI Number. -
:"filters[prefix_stage_id]"(String.t): Return item(s) with the specified RFI Prefix Stage. -
:search(String.t): Search for RFIs by subject or number. This parameter will return all RFIs that match the search term. -
:"sort[attribute]"(String.t): The attribute by which to sort the list of RFIs -
:"sort[direction]"(String.t): If passed a sort attribute, determines which direction to sort ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_rfis_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t()} | {:error, Tesla.Env.t()}
Show RFI Return detailed information about a specified RFI in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): RFI IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_id_patch(connection, procore_company_id, project_id, id, rfi_update_body, opts \\ [])
@spec rest_v10_projects_project_id_rfis_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RfiUpdateBody.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t()} | {:error, Tesla.Env.t()}
Update RFI Updates a specified RFI in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): RFI IDrfi_update_body
(RfiUpdateBody):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_id_recycle_patch(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_id_recycle_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Recycle RFI Send a specified RFI to the Recycle Bin.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): RFI IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_id_retrieve_patch(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_id_retrieve_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Retrieve Recycled RFI Retrieve a specified RFI from the Recycle Bin.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): RFI IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_idpdf_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_idpdf_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t()} | {:error, Tesla.Env.t()}
Show RFI in PDF format Return detailed information (as a PDF) about a specified RFI in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): RFI IDopts
(keyword): Optional parameters:only_official
(boolean()): If true, include only official responses; if false return all responses.
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_patch(connection, procore_company_id, project_id, rfi_body2, opts \\ [])
@spec rest_v10_projects_project_id_rfis_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.RfiBody2.t(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Batch Update RFIs Update specified RFIs in a specified project. Specify the RFIs by their IDs. Pass in the same values for each specified RFI for the action to succeed.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.rfi_body2
(RfiBody2):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_post(connection, procore_company_id, project_id, rfi_body, opts \\ [])
@spec rest_v10_projects_project_id_rfis_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RfiBody.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t()} | {:error, Tesla.Env.t()}
Create RFI Creates a new RFI in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.rfi_body
(RfiBody):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdRfisPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_rfis_recycle_bin_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_rfis_recycle_bin_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10ProjectsProjectIdRfisGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Recycled RFIs Returns all deleted RFIs in a specified Project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[updated_at]"
(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00
...YYYY-MM-DDTHH:MM:SS+XX:00
- Datetime with Custom Offset
Returns
{:ok, [%RestV10ProjectsProjectIdRfisGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure