Procore.Api.QualitySafetyObservationsObservations (procore_sdk v0.3.0)
API calls for all endpoints tagged QualitySafetyObservationsObservations
.
Summary
Functions
List Observation Category Configurable Field Sets Returns a collection of Observation Category Configurable Field Sets from the Project
List Observation Default Distribution Members Returns a collection of Users that are of the Observations Default Distribution list
List Observation Items Returns a collection of Observation Items. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Show Observation Item Returns an Observation Item.
Update Observation Item Updates an Observation Item.
Get Observation Item PDF url Return the PDF url for a specified Observation Item
Send Observation Item Email Sends an email for an Observation Item in a Project.
List Observation Item Response Logs Returns a collection of Response Logs for a given Observation Item.
Create Observation Item Response Log Creates a new Response Log for a given Observation Item.
Show Next Available Number for Observation Items Returns the next available number for an observation item in the current Project.
Create Observation Item Creates an Observation Item.
Send unsent Observation Items Sends email notifications for unsent Observation Items.
List Observation Potential Distribution Members Returns a collection of Potential Users for the Observations Distribution List
List Observation Types Returns a collection of Observation Types from the Project's Company or from the Company, depending on which query parameter is used. NOTE: Though both query parameters are marked as required below, only one of the two needs to be passed in (i.e., if you pass in a project_id then you do not need to also pass in a company_id, and vice versa).
Delete Observation Item Sends the specified Observation Item to the recycle bin.
List available Observation Item statuses with localized labels Returns a collection of available statuses.
List Observations Response Logs Returns a collection of Response Logs scoped to viewable Observations See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
List Recycled Observation Items Returns a collection of Recycled Observation Items. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Show Recycled Observation Returns the specified Recycled Observation.
Retrieve Recycled Observation Retrieves the specified Observation from Recycle Bin.
Functions
rest_v10_observations_category_configurable_field_sets_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_observations_category_configurable_field_sets_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationCategoryConfigurableFieldSets.t()]} | {:error, Tesla.Env.t()}
List Observation Category Configurable Field Sets Returns a collection of Observation Category Configurable Field Sets from the 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
Returns
{:ok, [%ObservationCategoryConfigurableFieldSets{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_default_distribution_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_observations_default_distribution_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItemDefaultDistribution.t()]} | {:error, Tesla.Env.t()}
List Observation Default Distribution Members Returns a collection of Users that are of the Observations Default Distribution list
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
Returns
{:ok, [%ObservationItemDefaultDistribution{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_observations_items_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItem.t()]} | {:error, Tesla.Env.t()}
List Observation Items Returns a collection of Observation Items. 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[assignee_company_id]"
([integer()]): Array of Vendor IDs. Returns item(s) where the assignee is associated to the specified Vendor ID.:"filters[checklist_list_id]"
([String.t]): Array of Checklist List IDs. Return item(s) associated with the specified Checklist List IDs.:"filters[created_by_id]"
([integer()]): Returns item(s) created by the specified User IDs.:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[location_id]"
([integer()]): Return item(s) with the specified Location IDs.:"filters[assignee_id]"
([integer()]): Return item(s) assigned to the specified User ID.:"filters[checklist_item_id]"
(integer()): Return Observations(s) originating from the specified Checklist Item(s).:"filters[priority]"
([String.t]): Return item(s) with the specified priorities.:"filters[search]"
(String.t): Return item(s) matching the specified Search query.:"filters[status]"
([integer()]): Return item(s) with the specified status values. The mapping is as follows:0: Initiated 1: Ready For reviewed 2: Not Accepted 3: Closed
:"filters[type_id]"
([integer()]): Return item(s) with the specified Observation Type ID.:"filters[trade_ids]"
([integer()]): Array of Trade IDs. Returns item(s) with the specified Trade 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
- 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:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%ObservationItem{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_id_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_observations_items_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.ObservationItem1.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Show Observation Item Returns an Observation Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Observation Item IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ObservationItem1.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_id_patch(connection, procore_company_id, id, body57, opts \\ [])
@spec rest_v10_observations_items_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.Body57.t(), keyword() ) :: {:ok, Procore.Model.ObservationItem1.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Update Observation Item Updates an Observation Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Observation Item IDbody57
(Body57):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ObservationItem1.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_id_pdf_get(connection, procore_company_id, id, project_id, opts \\ [])
@spec rest_v10_observations_items_id_pdf_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.ObservationItemPdf.t()} | {:error, Tesla.Env.t()}
Get Observation Item PDF url Return the PDF url for a specified Observation Item
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Observation Item IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ObservationItemPdf.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_id_send_email_post(connection, procore_company_id, id, project_id, body59, opts \\ [])
@spec rest_v10_observations_items_id_send_email_post( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.Body59.t(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Send Observation Item Email Sends an email for an Observation Item in a Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.id
(integer()): Observation Item IDproject_id
(integer()): Project IDbody59
(Body59):opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_item_id_response_logs_get(connection, procore_company_id, item_id, project_id, opts \\ [])
@spec rest_v10_observations_items_item_id_response_logs_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItemResponseLog.t()]} | {:error, Tesla.Env.t()}
List Observation Item Response Logs Returns a collection of Response Logs for a given Observation Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.item_id
(integer()): Observation Item IDproject_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%ObservationItemResponseLog{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_item_id_response_logs_post(connection, procore_company_id, item_id, observation_item_response_log_body, opts \\ [])
@spec rest_v10_observations_items_item_id_response_logs_post( Tesla.Env.client(), integer(), integer(), Procore.Model.ObservationItemResponseLogBody.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.ObservationItemResponseLog.t()} | {:error, Tesla.Env.t()}
Create Observation Item Response Log Creates a new Response Log for a given Observation Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.item_id
(integer()): Observation Item IDobservation_item_response_log_body
(ObservationItemResponseLogBody):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): Whether or not Configurable validations from the Observation Items Category Configurable Field Set should be run (default: false). See (https://developers.procore.com/reference/observations#list-observation-category-configurable-field-sets) for a list of Observation Category configurable validations enabled on this project.
Returns
{:ok, Procore.Model.ObservationItemResponseLog.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_next_available_number_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_observations_items_next_available_number_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10ObservationsItemsNextAvailableNumberGet200Response.t()} | {:error, Tesla.Env.t()}
Show Next Available Number for Observation Items Returns the next available number for an observation item in the current 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
Returns
{:ok, Procore.Model.RestV10ObservationsItemsNextAvailableNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_post(connection, procore_company_id, body55, opts \\ [])
@spec rest_v10_observations_items_post( Tesla.Env.client(), integer(), Procore.Model.Body55.t(), keyword() ) :: {:ok, Procore.Model.ObservationItem1.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Create Observation Item Creates an Observation Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.body55
(Body55):opts
(keyword): Optional parameters:run_configurable_validations
(boolean()): Whether or not Configurable validations from the Observation Items Category Configurable Field Set should be run (default: false). See (https://developers.procore.com/reference/observations#list-observation-category-configurable-field-sets) for a list of Observation Category configurable validations enabled on this project.
Returns
{:ok, Procore.Model.ObservationItem1.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_items_send_unsent_post(connection, procore_company_id, rest_v10_observations_items_send_unsent_post_request, opts \\ [])
@spec rest_v10_observations_items_send_unsent_post( Tesla.Env.client(), integer(), Procore.Model.RestV10ObservationsItemsSendUnsentPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItem.t()]} | {:error, Tesla.Env.t()}
Send unsent Observation Items Sends email notifications for unsent Observation Items.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.rest_v10_observations_items_send_unsent_post_request
(RestV10ObservationsItemsSendUnsentPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, [%ObservationItem{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_potential_distribution_members_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_observations_potential_distribution_members_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItemDefaultDistribution.t()]} | {:error, Tesla.Env.t()}
List Observation Potential Distribution Members Returns a collection of Potential Users for the Observations Distribution List
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
Returns
{:ok, [%ObservationItemDefaultDistribution{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_observations_types_get(connection, procore_company_id, project_id, company_id, opts \\ [])
@spec rest_v10_observations_types_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, [Procore.Model.ObservationType.t()]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List Observation Types Returns a collection of Observation Types from the Project's Company or from the Company, depending on which query parameter is used. NOTE: Though both query parameters are marked as required below, only one of the two needs to be passed in (i.e., if you pass in a project_id then you do not need to also pass in a company_id, and vice versa).
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.company_id
(integer()): Unique identifier for the company.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%ObservationType{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_observations_items_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_observations_items_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Observation Item Sends the specified Observation Item 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()): Observation IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_observations_items_statuses_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_observations_items_statuses_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ArrayOfAvailableStatusesInner.t()]} | {:error, Tesla.Env.t()}
List available Observation Item statuses with localized labels Returns a collection of available statuses.
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
Returns
{:ok, [%ArrayOfAvailableStatusesInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_observations_response_logs_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_observations_response_logs_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItemResponseLog.t()]} | {:error, Tesla.Env.t()}
List Observations Response Logs Returns a collection of Response Logs scoped to viewable Observations 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[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, [%ObservationItemResponseLog{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_observations_items_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_observations_items_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.ObservationItem.t()]} | {:error, Tesla.Env.t()}
List Recycled Observation Items Returns a collection of Recycled Observation Items. 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[type_id]"
([integer()]): Return item(s) with the specified Observation Type ID.:"filters[trade_ids]"
([integer()]): Array of Trade IDs. Returns item(s) with the specified Trade IDs.:"filters[assignee_id]"
([integer()]): Return item(s) assigned to the specified User ID.:"filters[status]"
([integer()]): Return item(s) with the specified status values. The mapping is as follows:0: Initiated 1: Ready For reviewed 2: Not Accepted 3: Closed
:"filters[priority]"
([String.t]): Return item(s) with the specified priorities.:"filters[location_id]"
([integer()]): Return item(s) with the specified Location IDs.:"filters[created_by_id]"
([integer()]): Returns item(s) created by the specified User IDs.:"filters[assignee_company_id]"
([integer()]): Array of Vendor IDs. Returns item(s) where the assignee is associated to the specified Vendor ID.:"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, [%ObservationItem{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_observations_items_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_observations_items_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.ObservationItem1.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Show Recycled Observation Returns the specified Recycled Observation.
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()): Observation IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ObservationItem1.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_recycle_bin_observations_items_id_restore_patch(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_recycle_bin_observations_items_id_restore_patch( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.ObservationItem1.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Retrieve Recycled Observation Retrieves the specified Observation from 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()): Observation IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.ObservationItem1.t}
on success{:error, Tesla.Env.t}
on failure