Procore.Api.FieldProductivityManagedEquipmentManagedEquipmentProjectLevel (procore_sdk v0.3.0)

API calls for all endpoints tagged FieldProductivityManagedEquipmentManagedEquipmentProjectLevel.

Summary

Functions

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

List all equipment Return a list of all equipment with details for a specified project.

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

Delete an equipment Deleting an equipment associated with the specified project.

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

Show equipment Return equipment detailed information.

rest_v10_projects_project_id_managed_equipment_id_patch(connection, procore_company_id, project_id, id, managed_equipment_body, opts \\ [])

Update an equipment Updating an equipment associated with the specified project.

rest_v10_projects_project_id_managed_equipment_id_restore_patch(connection, procore_company_id, project_id, id, managed_equipment_body, opts \\ [])

Restoring an equipment Restoring an equipment associated with the specified project.

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

List all project equipment IDs Return a list of all equipment IDs with details for a specified project.

rest_v10_projects_project_id_managed_equipment_post(connection, procore_company_id, project_id, managed_equipment_body, opts \\ [])

Create a new equipment Create a new equipment associated with the specified project.

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

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

Functions

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

@spec rest_v10_projects_project_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 project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[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.
- :"filters[onsite]" ([String.t]): Onsite Dates. Returns item(s) with the specified range of onsite dates.
- :"filters[offsite]" ([String.t]): Offsite Dates. Returns item(s) with the specified range of offsite dates.
- :"filters[ownership]" (String.t): Returns only item(s) with the specified ownership value. Must be one of Owned, Rented, or Sub.
- :"filters[vendor_id]" (integer()): Return item(s) with the specified Vendor ID.
- :"filters[induction_status]" (boolean()): Returns item(s) with the specified inudction status.

Returns

{:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

@spec rest_v10_projects_project_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 an equipment Deleting an equipment associated with the specified project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
id (integer()): Id of the equipment
opts (keyword): Optional parameters

Returns

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

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

@spec rest_v10_projects_project_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.
project_id (integer()): Unique identifier for the project.
id (integer()): ID
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_managed_equipment_id_patch(connection, procore_company_id, project_id, id, managed_equipment_body, opts \\ [])

@spec rest_v10_projects_project_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 an equipment Updating an equipment associated with the specified project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
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

rest_v10_projects_project_id_managed_equipment_id_restore_patch(connection, procore_company_id, project_id, id, managed_equipment_body, opts \\ [])

@spec rest_v10_projects_project_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()}

Restoring an equipment Restoring an equipment associated with the specified project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
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

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

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

List all project equipment IDs Return a list of all equipment IDs with details for a specified project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[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

{:ok, [%Integer{}, ...]} on success
{:error, Tesla.Env.t} on failure

rest_v10_projects_project_id_managed_equipment_post(connection, procore_company_id, project_id, managed_equipment_body, opts \\ [])

@spec rest_v10_projects_project_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 a new equipment Create a new equipment associated with the specified project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
managed_equipment_body (ManagedEquipmentBody):
opts (keyword): Optional parameters

Returns

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

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

@spec rest_v10_projects_project_id_managed_equipment_search_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 project.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[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.
- :"filters[onsite]" ([String.t]): Onsite Dates. Returns item(s) with the specified range of onsite dates.
- :"filters[offsite]" ([String.t]): Offsite Dates. Returns item(s) with the specified range of offsite dates.
- :"filters[ownership]" (String.t): Returns only item(s) with the specified ownership value. Must be one of Owned, Rented, or Sub.
- :"filters[vendor_id]" (integer()): Return item(s) with the specified Vendor ID.
- :"filters[induction_status]" (boolean()): Returns item(s) with the specified inudction status.

Returns

{:ok, [%RestV10ProjectsProjectIdManagedEquipmentGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure