Procore.Api.QualitySafetyFormsForms (procore_sdk v0.3.0)
API calls for all endpoints tagged QualitySafetyFormsForms
.
Summary
Functions
List Forms on a project Return a list of all Forms from a specified Project.
Delete Form Delete the specified Form.
Show Form Return detailed information on the specified Form.
Update Form Update the specified Form.
Create Form Create a new Form associated with the specified Project.
List Recycled Project Forms Returns a collection of Recycled Forms for a specified Project.
Show Recycled Project Form Returns the details for a specified recycled Project Form
Restore Project Form Restores the specified Form from Recycle Bin.
List Forms on a project Return a list of all Forms from a specified Project.
Functions
rest_v10_projects_project_id_forms_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_forms_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Forms on a project Return a list of all Forms from 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[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[created_by_id]"
([integer()]): Returns item(s) created by the specified User IDs.:"filters[form_template_id]"
([integer()]): Array of Form Template IDs. Return item(s) associated with the specified Form Template IDs.:"filters[search]"
(String.t): Returns item(s) matching the specified search query string.:"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[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 -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_forms_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_forms_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Form Delete the specified Form.
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()): Form IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_forms_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_forms_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Form Return detailed information on the specified Form.
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()): Form IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_forms_id_patch(connection, procore_company_id, project_id, id, body84, opts \\ [])
@spec rest_v10_projects_project_id_forms_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.Body84.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Update Form Update the specified Form.
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()): Form IDbody84
(Body84):opts
(keyword): Optional parameters:send_emails
(boolean()): Designates whether or not emails will be sent (default false)
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_forms_post(connection, procore_company_id, project_id, body82, opts \\ [])
@spec rest_v10_projects_project_id_forms_post( Tesla.Env.client(), integer(), integer(), Procore.Model.Body82.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Create Form Create a new Form associated with the 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.body82
(Body82):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_forms_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_forms_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Recycled Project Forms Returns a collection of Recycled Forms for 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[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
- 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[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 ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_recycle_bin_forms_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_forms_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Show Recycled Project Form Returns the details for a specified recycled Project Form
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Project Form IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_forms_id_restore_patch(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_forms_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()} | {:error, Tesla.Env.t()}
Restore Project Form Restores the specified Form from Recycle Bin.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Project Form IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_forms_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_forms_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV11ProjectsProjectIdFormsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Forms on a project Return a list of all Forms from 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[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[private]"
(boolean()): If true, returns only item(s) with aprivate
status.:"filters[created_by_id]"
([integer()]): Returns item(s) created by the specified User IDs.:"filters[form_template_id]"
([integer()]): Array of Form Template IDs. Return item(s) associated with the specified Form Template IDs.:"filters[search]"
(String.t): Returns item(s) matching the specified search query string.:"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[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 -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure