Procore.Api.FieldProductivityManagedEquipmentManagedEquipmentCompanyLevel (procore_sdk v0.3.0)

API calls for all endpoints tagged FieldProductivityManagedEquipmentManagedEquipmentCompanyLevel.

Summary

Functions

rest_v10_companies_company_id_managed_equipment_bulk_destroy_delete(connection, procore_company_id, company_id, rest_v10_companies_company_id_managed_equipment_bulk_destroy_delete_request, opts \\ [])

Bulk Delete Managed Equipment Delete multiple Managed Equipment with one request.

rest_v10_companies_company_id_managed_equipment_bulk_restore_patch(connection, procore_company_id, company_id, rest_v10_companies_company_id_managed_equipment_bulk_restore_patch_request, opts \\ [])

Bulk Retrieve Managed Equipment Restore multiple Managed Equipment with one request.

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

List all Equipment Return a list of all Equipment with details for a specified company.

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

Show Equipment Change History Return Equipment change history detailed information.

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

Delete Equipment Deleting a piece of Equipment

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

Show Equipment Return Equipment detailed information.

rest_v10_companies_company_id_managed_equipment_id_patch(connection, procore_company_id, company_id, id, managed_equipment_body, opts \\ [])

Update Equipment Updating a piece of Equipment

rest_v10_companies_company_id_managed_equipment_id_restore_patch(connection, procore_company_id, company_id, id, managed_equipment_body, opts \\ [])

Retrieve Equipment Restore a piece of Equipment

rest_v10_companies_company_id_managed_equipment_id_update_deleted_equipment_serial_number_patch(connection, procore_company_id, company_id, id, managed_equipment_serial_number_update_body, opts \\ [])

Update Deleted Equipment Serial Number Update a serial number for a deleted piece of Equipment

rest_v10_companies_company_id_managed_equipment_post(connection, procore_company_id, company_id, managed_equipment_body, opts \\ [])

Create Equipment Create a new Equipment associated with the specified company.

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

Search all equipment Return a list of all searched equipment with details for a specified company.

rest_v10_companies_company_id_managed_equipment_setup_managed_equipment_dependents_post(connection, procore_company_id, company_id, managed_equipment_dependent_body, opts \\ [])

Setup Managed Equipment Taxonomy Setup Managed Equipment Taxonomy with the specified company.

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

List all Company Managed Equipment User Permissions Return a list of allCompany Managed Equipment User Permissions for a specified company.

rest_v10_companies_company_id_managed_equipment_user_permissions_patch(connection, procore_company_id, company_id, managed_equipment_permission_update_body, opts \\ [])

Update User Permission Updating a Company Managed Equipment User Permission

Functions

Link to this function

rest_v10_companies_company_id_managed_equipment_bulk_destroy_delete(connection, procore_company_id, company_id, rest_v10_companies_company_id_managed_equipment_bulk_destroy_delete_request, opts \\ [])

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

Bulk Delete Managed Equipment Delete multiple Managed Equipment with one request.

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.
  • rest_v10_companies_company_id_managed_equipment_bulk_destroy_delete_request (RestV10CompaniesCompanyIdManagedEquipmentBulkDestroyDeleteRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_managed_equipment_bulk_restore_patch(connection, procore_company_id, company_id, rest_v10_companies_company_id_managed_equipment_bulk_restore_patch_request, opts \\ [])

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

Bulk Retrieve Managed Equipment Restore multiple Managed Equipment with one request.

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.
  • rest_v10_companies_company_id_managed_equipment_bulk_restore_patch_request (RestV10CompaniesCompanyIdManagedEquipmentBulkRestorePatchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

List all Equipment Return a list of all Equipment with details 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[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[managed_equipment_id]" (integer()): Return item(s) with the specified Managed Equipment ID.
    • :"filters[managed_equipment_category_id]" (integer()): Return item(s) with the specified Managed Equipment Category ID.
    • :"filters[managed_equipment_type_id]" (integer()): Return item(s) with the specified Managed Equipment Type ID.
    • :"filters[managed_equipment_make_id]" (integer()): Return item(s) with the specified Managed Equipment Make ID.
    • :"filters[managed_equipment_model_id]" (integer()): Return item(s) with the specified Managed Equipment Model ID.
    • :"filters[company_visible]" (boolean()): If true, return item(s) with 'company visible' status.
    • :"filters[current_project_id]" (integer()): Return item(s) with the specified current project ID.
    • :"filters[year]" (integer()): Return item(s) with the specified year.
    • :"filters[status]" ([String.t]): Returns item(s) matching the specified status value.
    • :"filters[last_service_date]" (String.t): Return item(s) with a last service date within the specified ISO 8601 datetime range.
    • :"filters[next_service_date]" (String.t): Return item(s) with a next service date within the specified ISO 8601 datetime range.

Returns

  • {:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Show Equipment Change History Return Equipment change history detailed information.

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.
  • id (integer()): ID
  • opts (keyword): Optional parameters

Returns

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

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

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

Delete Equipment Deleting a piece of Equipment

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.
  • id (integer()): Id of the Equipment
  • opts (keyword): Optional parameters

Returns

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

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

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

Show Equipment Return Equipment detailed information.

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.
  • id (integer()): ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_managed_equipment_id_patch(connection, procore_company_id, company_id, id, managed_equipment_body, opts \\ [])

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

Update Equipment Updating a piece of Equipment

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.
  • id (integer()): Id of the Equipment
  • managed_equipment_body (ManagedEquipmentBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_managed_equipment_id_restore_patch(connection, procore_company_id, company_id, id, managed_equipment_body, opts \\ [])

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

Retrieve Equipment Restore a piece of Equipment

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.
  • id (integer()): Id of the Equipment
  • managed_equipment_body (ManagedEquipmentBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_managed_equipment_id_update_deleted_equipment_serial_number_patch(connection, procore_company_id, company_id, id, managed_equipment_serial_number_update_body, opts \\ [])

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

Update Deleted Equipment Serial Number Update a serial number for a deleted piece of Equipment

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.
  • id (integer()): Id of the Equipment
  • managed_equipment_serial_number_update_body (ManagedEquipmentSerialNumberUpdateBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_managed_equipment_post(connection, procore_company_id, company_id, managed_equipment_body, opts \\ [])

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

Create Equipment Create a new Equipment associated with the 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.
  • managed_equipment_body (ManagedEquipmentBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

Search all equipment Return a list of all searched equipment with details 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[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[managed_equipment_id]" (integer()): Return item(s) with the specified Managed Equipment ID.
    • :"filters[managed_equipment_category_id]" (integer()): Return item(s) with the specified Managed Equipment Category ID.
    • :"filters[managed_equipment_type_id]" (integer()): Return item(s) with the specified Managed Equipment Type ID.
    • :"filters[managed_equipment_make_id]" (integer()): Return item(s) with the specified Managed Equipment Make ID.
    • :"filters[managed_equipment_model_id]" (integer()): Return item(s) with the specified Managed Equipment Model ID.
    • :"filters[company_visible]" (boolean()): If true, return item(s) with 'company visible' status.
    • :"filters[current_project_id]" (integer()): Return item(s) with the specified current project ID.
    • :"filters[year]" (integer()): Return item(s) with the specified year.
    • :"filters[status]" ([String.t]): Returns item(s) matching the specified status value.
    • :"filters[last_service_date]" (String.t): Return item(s) with a last service date within the specified ISO 8601 datetime range.
    • :"filters[next_service_date]" (String.t): Return item(s) with a next service date within the specified ISO 8601 datetime range.
    • :search_keyword (String.t): Search keyword to search Project Managed Equipment.

Returns

  • {:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_managed_equipment_setup_managed_equipment_dependents_post(connection, procore_company_id, company_id, managed_equipment_dependent_body, opts \\ [])

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

Setup Managed Equipment Taxonomy Setup Managed Equipment Taxonomy with the 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.
  • managed_equipment_dependent_body (ManagedEquipmentDependentBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

List all Company Managed Equipment User Permissions Return a list of allCompany Managed Equipment User Permissions 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

Returns

  • {:ok, [%CompanyManagedEquipmentUserPermission{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_managed_equipment_user_permissions_patch(connection, procore_company_id, company_id, managed_equipment_permission_update_body, opts \\ [])

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

Update User Permission Updating a Company Managed Equipment User Permission

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.
  • managed_equipment_permission_update_body (ManagedEquipmentPermissionUpdateBody):
  • opts (keyword): Optional parameters

Returns

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