Procore.Api.QualitySafetyInspectionsChecklists (procore_sdk v0.3.0)
API calls for all endpoints tagged QualitySafetyInspectionsChecklists
.
Summary
Functions
List Checklists Lists Checklist (Inspections) in a specified Project grouped by a specified attribute. By default the Checklists are grouped by template. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete Checklist Deletes Inspection Checklist in a specified Project.
Show Checklist Retrieves Inspection Checklist in a specified Project.
Update Checklist Updates Inspection Checklist in a specified Project.
Create Checklist Creates Inspection Checklist in a specified Project.
List Checklists (Inspections) Lists Checklist (Inspections) in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
List Grouped Checklists (Inspections) Lists Grouped Checklist (Inspections) in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Delete Checklist (Inspection) Deletes specified Checklist (Inspection)
Show Checklist (Inspection) Returns the specified Checklist (Inspection)
Update Checklist (Inspection) Updates a specified Checklist (Inspection)
Send Checklist (Inspection) Email Send an email for a Checklist (Inspection) in a Project.
Create Checklist (Inspection) Creates an instance of Inspection in a given Project
List Recycled Checklists (Inspections) Lists Recycled Checklist (Inspections) in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
List Grouped Recycled Checklists (Inspections) Lists Recycled Checklist (Inspections) in a specified Project grouped by a specified attribute. By default the Checklists are grouped by template. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Show Recycled Checklist (Inspection) Returns the specified Recycled Checklist (Inspection)
Restore Deleted Checklist (Inspection) Restores a specified deleted Checklist (Inspection)
Delete Checklist (Inspection) Deletes specified Checklist (Inspection)
Update Checklist (Inspection) Updates a specified Checklist (Inspection)
Create Checklist (Inspection) Creates an instance of Inspection in a given Project
Restore Deleted Checklist (Inspection) Restores a specified deleted Checklist (Inspection)
Create Checklists (Inspection) in Bulk Creates multiple instances of an Inspection in a given Project
Functions
rest_v10_checklist_lists_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_checklist_lists_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV10ChecklistListsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Checklists Lists Checklist (Inspections) in a specified Project grouped by a specified attribute. By default the Checklists are grouped by template. 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:"filters[view]"
(String.t): If 'recycle', return deleted Checklists.:"filters[inspection_type_id]"
([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.:"filters[point_of_contact_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are the point of contact.:"filters[inspector_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are inspectors.:"filters[list_template_id]"
([integer()]): Array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs.:"filters[location_id]"
(integer()): Filters by specific location (Note: Use either this or location_id_with_sublocations, but not both):"filters[spec_section_id]"
([integer()]): Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.:"filters[responsible_contractor_id]"
([integer()]): Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.:"filters[status]"
([String.t]): Returns item(s) matching the specified status value.:"filters[trade_id]"
(integer()): Trade ID:"filters[search]"
(String.t): Returns item(s) matching the specified search query string.:"filters[due_at]"
(DateTime.t): Return item(s) due within the specified date range.:"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_checklist_lists_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_checklist_lists_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Checklist Deletes Inspection Checklist in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_checklist_lists_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_checklist_lists_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist3.t()} | {:error, Tesla.Env.t()}
Show Checklist Retrieves Inspection Checklist in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Checklist3.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_checklist_lists_id_patch(connection, procore_company_id, id, checklist_body1, opts \\ [])
@spec rest_v10_checklist_lists_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.ChecklistBody1.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist3.t()} | {:error, Tesla.Env.t()}
Update Checklist Updates Inspection Checklist in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDchecklist_body1
(ChecklistBody1):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist3.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_checklist_lists_post(connection, procore_company_id, checklist_body, opts \\ [])
@spec rest_v10_checklist_lists_post( Tesla.Env.client(), integer(), Procore.Model.ChecklistBody.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist3.t()} | {:error, Tesla.Env.t()}
Create Checklist Creates Inspection Checklist in a specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.checklist_body
(ChecklistBody):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist3.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_checklist_lists_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.Checklist5.t()]} | {:error, Tesla.Env.t()}
List Checklists (Inspections) Lists Checklist (Inspections) 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[inspection_date]"
(Date.t): Return item(s) with inspection date within the specified ISO 8601 date range.:"filters[inspection_type_id]"
([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.:"filters[inspector_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are inspectors.:"filters[template_id]"
([String.t]): Array of Checklist Template IDs. Return item(s) associated to the specified Checklist Template IDs.:"filters[location_id]"
([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.:"filters[managed_equipment_id]"
(integer()): Return item(s) with the specified Managed Equipment ID.:"filters[point_of_contact_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are the point of contact.:"filters[spec_section_id]"
([integer()]): Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.:"filters[responsible_contractor_id]"
([integer()]): Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.:"filters[closed_by_id]"
([integer()]): Array of User IDs. Return item(s) closed by the specified User ID.:"filters[status]"
(integer()): Return item(s) with the specified statuses:"filters[trade_id]"
(integer()): Trade ID:"filters[query]"
(String.t): Return item(s) containing search query:"filters[due_at]"
(DateTime.t): Return item(s) due within the specified date range.:"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 -
:"filters[closed_at]"(Date.t): Returns item(s) closed within the specified ISO 8601 datetime range. -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_checklist_lists_grouped_index_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_grouped_index_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ChecklistListGroup.t()]} | {:error, Tesla.Env.t()}
List Grouped Checklists (Inspections) Lists Grouped Checklist (Inspections) 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[inspection_date]"
(Date.t): Return item(s) with inspection date within the specified ISO 8601 date range.:"filters[inspection_type_id]"
([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.:"filters[inspector_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are inspectors.:"filters[list_template_id]"
([integer()]): Array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs.:"filters[location_id]"
([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.:"filters[managed_equipment_id]"
(integer()): Return item(s) with the specified Managed Equipment ID.:"filters[point_of_contact_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are the point of contact.:"filters[spec_section_id]"
([integer()]): Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.:"filters[responsible_contractor_id]"
([integer()]): Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.:"filters[closed_by_id]"
([integer()]): Array of User IDs. Return item(s) closed by the specified User ID.:"filters[status]"
(integer()): Return item(s) with the specified statuses:"filters[trade_id]"
(integer()): Trade ID:"filters[query]"
(String.t): Return item(s) containing search query:"filters[due_at]"
(DateTime.t): Return item(s) due within the specified date range.:"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 -
:"filters[closed_at]"(Date.t): Returns item(s) closed within the specified ISO 8601 datetime range. -
:sort(String.t): -
:group_by(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_checklist_lists_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Checklist (Inspection) Deletes specified Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_checklist_lists_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist5.t()} | {:error, Tesla.Env.t()}
Show Checklist (Inspection) Returns the specified Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Checklist5.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_checklist_lists_id_patch(connection, procore_company_id, id, project_id, rest_v10_projects_project_id_checklist_lists_id_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdChecklistListsIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist5.t()} | {:error, Tesla.Env.t()}
Update Checklist (Inspection) Updates a specified Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.rest_v10_projects_project_id_checklist_lists_id_patch_request
(RestV10ProjectsProjectIdChecklistListsIdPatchRequest):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist5.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_checklist_lists_id_send_email_post(connection, procore_company_id, id, project_id, body114, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_id_send_email_post( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.Body114.t(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Send Checklist (Inspection) Email Send an email for a Checklist (Inspection) in a Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.body114
(Body114):opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_checklist_lists_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_lists_post_request, opts \\ [])
@spec rest_v10_projects_project_id_checklist_lists_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdChecklistListsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist5.t()} | {:error, Tesla.Env.t()}
Create Checklist (Inspection) Creates an instance of Inspection in a given 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.rest_v10_projects_project_id_checklist_lists_post_request
(RestV10ProjectsProjectIdChecklistListsPostRequest):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist5.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_checklist_lists_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_checklist_lists_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.Checklist5.t()]} | {:error, Tesla.Env.t()}
List Recycled Checklists (Inspections) Lists Recycled Checklist (Inspections) 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[inspection_date]"
(Date.t): Return item(s) with inspection date within the specified ISO 8601 date range.:"filters[inspection_type_id]"
([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.:"filters[inspector_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are inspectors.:"filters[template_id]"
([String.t]): Array of Checklist Template IDs. Return item(s) associated to the specified Checklist Template IDs.:"filters[location_id]"
([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.:"filters[managed_equipment_id]"
(integer()): Return item(s) with the specified Managed Equipment ID.:"filters[point_of_contact_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are the point of contact.:"filters[spec_section_id]"
([integer()]): Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.:"filters[responsible_contractor_id]"
([integer()]): Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.:"filters[closed_by_id]"
([integer()]): Array of User IDs. Return item(s) closed by the specified User ID.:"filters[status]"
(integer()): Return item(s) with the specified statuses:"filters[trade_id]"
(integer()): Trade ID:"filters[query]"
(String.t): Return item(s) containing search query:"filters[due_at]"
(DateTime.t): Return item(s) due within the specified date range.:"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 -
:"filters[closed_at]"(Date.t): Returns item(s) closed within the specified ISO 8601 datetime range. -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_recycle_bin_checklist_lists_grouped_index_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_checklist_lists_grouped_index_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ChecklistListGroup.t()]} | {:error, Tesla.Env.t()}
List Grouped Recycled Checklists (Inspections) Lists Recycled Checklist (Inspections) in a specified Project grouped by a specified attribute. By default the Checklists are grouped by template. 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[inspection_date]"
(Date.t): Return item(s) with inspection date within the specified ISO 8601 date range.:"filters[inspection_type_id]"
([integer()]): Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.:"filters[inspector_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are inspectors.:"filters[list_template_id]"
([integer()]): Array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs.:"filters[location_id]"
([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.:"filters[managed_equipment_id]"
(integer()): Return item(s) with the specified Managed Equipment ID.:"filters[point_of_contact_id]"
([integer()]): Array of User IDs. Return item(s) where the specified User IDs are the point of contact.:"filters[spec_section_id]"
([integer()]): Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.:"filters[responsible_contractor_id]"
([integer()]): Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.:"filters[closed_by_id]"
([integer()]): Array of User IDs. Return item(s) closed by the specified User ID.:"filters[status]"
(integer()): Return item(s) with the specified statuses:"filters[trade_id]"
(integer()): Trade ID:"filters[query]"
(String.t): Return item(s) containing search query:"filters[due_at]"
(DateTime.t): Return item(s) due within the specified date range.:"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 -
:"filters[closed_at]"(Date.t): Returns item(s) closed within the specified ISO 8601 datetime range. -
:sort(String.t): -
:group_by(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_recycle_bin_checklist_lists_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_checklist_lists_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist5.t()} | {:error, Tesla.Env.t()}
Show Recycled Checklist (Inspection) Returns the specified Recycled Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.Checklist5.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_checklist_lists_id_restore_patch(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_checklist_lists_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Restore Deleted Checklist (Inspection) Restores a specified deleted Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_checklist_lists_id_delete(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_checklist_lists_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Checklist (Inspection) Deletes specified Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_checklist_lists_id_patch(connection, procore_company_id, id, project_id, rest_v11_projects_project_id_checklist_lists_id_patch_request, opts \\ [])
@spec rest_v11_projects_project_id_checklist_lists_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdChecklistListsIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist.t()} | {:error, Tesla.Env.t()}
Update Checklist (Inspection) Updates a specified Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.rest_v11_projects_project_id_checklist_lists_id_patch_request
(RestV11ProjectsProjectIdChecklistListsIdPatchRequest):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_checklist_lists_post(connection, procore_company_id, project_id, rest_v11_projects_project_id_checklist_lists_post_request, opts \\ [])
@spec rest_v11_projects_project_id_checklist_lists_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdChecklistListsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Checklist.t()} | {:error, Tesla.Env.t()}
Create Checklist (Inspection) Creates an instance of Inspection in a given 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.rest_v11_projects_project_id_checklist_lists_post_request
(RestV11ProjectsProjectIdChecklistListsPostRequest):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): If true, validations are run for the corresponding Configurable Field Set.
Returns
{:ok, Procore.Model.Checklist.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_recycle_bin_checklist_lists_id_restore_patch(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_recycle_bin_checklist_lists_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Restore Deleted Checklist (Inspection) Restores a specified deleted Checklist (Inspection)
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Checklist IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v20_companies_company_id_projects_project_id_checklist_lists_bulk_create_post(connection, procore_company_id, company_id, project_id, opts \\ [])
@spec rest_v20_companies_company_id_projects_project_id_checklist_lists_bulk_create_post( Tesla.Env.client(), integer(), String.t(), String.t(), keyword() ) :: {:ok, Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdChecklistListsBulkCreatePost200Response.t()} | {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()} | {:error, Tesla.Env.t()}
Create Checklists (Inspection) in Bulk Creates multiple instances of an Inspection in a given Project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(String.t): Unique identifier for the company.project_id
(String.t): Unique identifier for the project.opts
(keyword): Optional parameters:body
(RestV20CompaniesCompanyIdProjectsProjectIdChecklistListsBulkCreatePostRequest):
Returns
{:ok, Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdChecklistListsBulkCreatePost200Response.t}
on success{:error, Tesla.Env.t}
on failure