Procore.Api.QualitySafetyFormsFormTemplates (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyFormsFormTemplates.

Summary

Functions

rest_v10_companies_company_id_form_templates_get(connection, procore_company_id, company_id, opts \\ [])

List Company Form Templates Returns a collection of Form Templates for a specified Company.

rest_v10_companies_company_id_form_templates_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

Delete Company Form Template Delete a Company Form Template

rest_v10_companies_company_id_form_templates_id_get(connection, procore_company_id, id, company_id, opts \\ [])

Show Company Form Template Returns the details for a specified Company Form Template

rest_v10_companies_company_id_form_templates_id_patch(connection, procore_company_id, id, company_id, body87, opts \\ [])

Update Company Form Template Update a Company Form Template

rest_v10_companies_company_id_form_templates_post(connection, procore_company_id, company_id, form_template, fillable_pdf, opts \\ [])

Create Company Form Template Create a new Company Form Template

rest_v10_companies_company_id_recycle_bin_form_templates_get(connection, procore_company_id, company_id, opts \\ [])

List Recycled Company Form Templates Returns a collection of Recycled Form Templates for a specified Company.

rest_v10_companies_company_id_recycle_bin_form_templates_id_get(connection, procore_company_id, id, company_id, opts \\ [])

Show Recycled Company Form Template Returns the details for a specified recycled Company Form Template

rest_v10_companies_company_id_recycle_bin_form_templates_id_restore_patch(connection, procore_company_id, id, company_id, opts \\ [])

Restore Company Form Template Restores the specified Form Template from Recycle Bin.

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

List Company Form Templates from Project Returns a collection of Company Form Templates for a specified Project.

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

Show Company Form Template from Project Returns the details for a specified Company Form Template

Functions

Link to this function

rest_v10_companies_company_id_form_templates_get(connection, procore_company_id, company_id, opts \\ [])

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

List Company Form Templates Returns a collection of Form Templates for a specified Company.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"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[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 -, ...]}on success -` on failure
Link to this function

rest_v10_companies_company_id_form_templates_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

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

Delete Company Form Template Delete a Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_form_templates_id_get(connection, procore_company_id, id, company_id, opts \\ [])

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

Show Company Form Template Returns the details for a specified Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdFormTemplatesGet200ResponseInner.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_form_templates_id_patch(connection, procore_company_id, id, company_id, body87, opts \\ [])

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

Update Company Form Template Update a Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • company_id (integer()): Unique identifier for the company.
  • body87 (Body87):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdFormTemplatesGet200ResponseInner.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_form_templates_post(connection, procore_company_id, company_id, form_template, fillable_pdf, opts \\ [])

@spec rest_v10_companies_company_id_form_templates_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.FormTemplate.t(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdFormTemplatesGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Create Company Form Template Create a new Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • form_template (Procore.Model.FormTemplate.t):
  • fillable_pdf (String.t): Form Template's Fillable PDF. To upload a fillable PDF you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with fillable_pdf as files.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdFormTemplatesGet200ResponseInner.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_recycle_bin_form_templates_get(connection, procore_company_id, company_id, opts \\ [])

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

List Recycled Company Form Templates Returns a collection of Recycled Form Templates for a specified Company.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"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[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 -, ...]}on success -` on failure
Link to this function

rest_v10_companies_company_id_recycle_bin_form_templates_id_get(connection, procore_company_id, id, company_id, opts \\ [])

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

Show Recycled Company Form Template Returns the details for a specified recycled Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdFormTemplatesGet200ResponseInner.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_recycle_bin_form_templates_id_restore_patch(connection, procore_company_id, id, company_id, opts \\ [])

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

Restore Company Form Template Restores the specified Form Template from Recycle Bin.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

List Company Form Templates from Project Returns a collection of Company Form Templates for a specified 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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"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[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 -, ...]}on success -` on failure
Link to this function

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

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

Show Company Form Template from Project Returns the details for a specified Company Form Template

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Company Form Template ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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