Procore.Api.QualitySafetyIncidentsWitnessStatements (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsWitnessStatements.

Summary

Functions

rest_v10_projects_project_id_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

List Witness Statements Returns a list of Witness Statements for a given project.

rest_v10_projects_project_id_incidents_witness_statements_id_delete(connection, procore_company_id, project_id, id, opts \\ [])

Destroy Witness Statement Sends the specified Witness Statement to the Recycle Bin

rest_v10_projects_project_id_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

Show Witness Statement Returns the specified Witness Statement

rest_v10_projects_project_id_incidents_witness_statements_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_witness_statements_id_patch_request, opts \\ [])

Update Witness Statement Updates the specified Witness Statement

rest_v10_projects_project_id_incidents_witness_statements_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_witness_statements_post_request, opts \\ [])

Create Witness Statement Creates a Witness Statement.

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

List Recycled Witness Statements Returns a list of Recycled Witness Statements for a given project (or Incident, if incident_id is present).

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

Show Recycled Witness Statement Returns a specific Recycled Witness Statement

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])

Retrieve Recycled Witness Statement Retrieves a specific Recycled Witness Statement from the recycle bin

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

List Recycled Witness Statements Returns a list of Recycled Witness Statements for a given project (or Incident, if incident_id is present).

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

Show Recycled Witness Statement Returns a specific Recycled Witness Statement

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])

Retrieve Recycled Witness Statement Retrieves a specific Recycled Witness Statement from the recycle bin

Functions

rest_v10_projects_project_id_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_incidents_witness_statements_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

List Witness Statements Returns a list of Witness Statements for a given project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Witness Statements for a given Incident.
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[created_at]" (Date.t): Return item(s) created 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[date_received]"(Date.t): Return item(s) within the specified date received date range. This assumes the dates provided are in the project time zone. -:"filters[witness_id]"([integer()]): Return item(s) with the specified Witness (Party) ID. -:"filters[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure

rest_v10_projects_project_id_incidents_witness_statements_id_delete(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_incidents_witness_statements_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Destroy Witness Statement Sends the specified Witness Statement to the Recycle Bin

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_incidents_witness_statements_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Show Witness Statement Returns the specified Witness Statement

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_witness_statements_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_witness_statements_id_patch_request, opts \\ [])

@spec rest_v10_projects_project_id_incidents_witness_statements_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdIncidentsWitnessStatementsIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Update Witness Statement Updates the specified Witness Statement

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
rest_v10_projects_project_id_incidents_witness_statements_id_patch_request (RestV10ProjectsProjectIdIncidentsWitnessStatementsIdPatchRequest):
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_incidents_witness_statements_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_witness_statements_post_request, opts \\ [])

@spec rest_v10_projects_project_id_incidents_witness_statements_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdIncidentsWitnessStatementsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Create Witness Statement Creates a Witness Statement.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
rest_v10_projects_project_id_incidents_witness_statements_post_request (RestV10ProjectsProjectIdIncidentsWitnessStatementsPostRequest):
opts (keyword): Optional parameters

Returns

{:ok, Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

List Recycled Witness Statements Returns a list of Recycled Witness Statements for a given project (or Incident, if incident_id is present).

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Recycled Witness Statements for a given Incident.
- :"filters[created_at]" (Date.t): Return item(s) created 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[date_received]"(Date.t): Return item(s) within the specified date received date range. This assumes the dates provided are in the project time zone. -:"filters[witness_id]"([integer()]): Return item(s) with the specified Witness (Party) ID. -:"filters[query]"(String.t): Return item(s) containing query -:sort(String.t): -:page(integer()): Page -:per_page(integer()): Elements per page ### Returns -, ...]}on success -` on failure

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Show Recycled Witness Statement Returns a specific Recycled Witness Statement

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Retrieve Recycled Witness Statement Retrieves a specific Recycled Witness Statement from the recycle bin

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

List Recycled Witness Statements Returns a list of Recycled Witness Statements for a given project (or Incident, if incident_id is present).

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Recycled Witness Statements for a given Incident.
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[created_at]" (Date.t): Return item(s) created 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[date_received]"(Date.t): Return item(s) within the specified date received date range. This assumes the dates provided are in the project time zone. -:"filters[witness_id]"([integer()]): Return item(s) with the specified Witness (Party) ID. -:"filters[query]"(String.t): Return item(s) containing query -:sort(String.t): ### Returns -, ...]}on success -` on failure

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Show Recycled Witness Statement Returns a specific Recycled Witness Statement

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, Procore.Model.RestV11ProjectsProjectIdRecycleBinIncidentsWitnessStatementsGet200ResponseInner.t} on success
{:error, Tesla.Env.t} on failure

rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v11_projects_project_id_recycle_bin_incidents_witness_statements_id_restore_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Retrieve Recycled Witness Statement Retrieves a specific Recycled Witness Statement from the recycle bin

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Witness Statement ID
opts (keyword): Optional parameters
- :incident_id (integer()): Incident ID

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure