Procore.Api.ConstructionFinancialsWorkBreakdownStructureCodes (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsWorkBreakdownStructureCodes.

Summary

Functions

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_bulk_create_patch(connection, procore_company_id, project_id, wbs_code_bulk_create, opts \\ [])

Bulk Create WBS codes Bulk Create WBS codes using the specified segments. If the combination of segments matches an existing WBS Code, the existing code will be updated with the description provided.

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

List Project WBS codes All Work Breakdown Structure codes for a given project

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch_request, opts \\ [])

Update a WBS code Update a WBS Code with new custom description or status.

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_post_request, opts \\ [])

Create a WBS Code Create a new WBS code using the specified segments. If the combination of segments matches an existing WBS Code, the existing code will be updated with the description provided.

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_update_all_patch(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_update_all_patch_request, opts \\ [])

Bulk update WBS codes Bulk update WBS Codes with the same status.

Functions

Link to this function

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_bulk_create_patch(connection, procore_company_id, project_id, wbs_code_bulk_create, opts \\ [])

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

Bulk Create WBS codes Bulk Create WBS codes using the specified segments. If the combination of segments matches an existing WBS Code, the existing code will be updated with the description provided.

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

Returns

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

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

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

List Project WBS codes All Work Breakdown Structure codes for a given 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
    • :can_select_divisions (boolean()): If true, will include WBS Codes with division segment items. Default is true.
    • :required_segments ([String.t]):
    • :"filters[status][]" ([String.t]): Filter results to only return codes with the included statuses. Options are 'active' or 'inactive'. Defaults to returning all results.
    • :"filters[updated_at]" (String.t): Filter results to only return codes that were updated within the range of the two specified ISO 8601 timestamps separated by the ... delimiter.
    • :scope (String.t): Filter results to only return codes that match the specified WBS scope.
    • :query (String.t): Searches the WBS code and description values and returns results sorted in descending order of relevance to the search query.
    • :group_type (String.t): Along with 'group_id', groups WBS codes by the specified group type and group ID. Only supported option is 'contract'.
    • :group_id (integer()): Along with 'group_type', groups WBS codes by the specified group type and group ID. Only supported option is a contract ID.
    • :hide_not_in_group (boolean()): If true, will hide WBS codes that are not in the specified 'group_type' and 'group_id'. Default is true. If false, WBS codes in the specified group will be returned first followed by WBS codes not in the group.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch_request, opts \\ [])

@spec rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdWorkBreakdownStructureWbsCodesIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdWorkBreakdownStructureWbsCodesGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()}
  | {:error, Tesla.Env.t()}

Update a WBS code Update a WBS Code with new custom description or status.

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()): WBS Code ID
  • rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_id_patch_request (RestV10ProjectsProjectIdWorkBreakdownStructureWbsCodesIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_post_request, opts \\ [])

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

Create a WBS Code Create a new WBS code using the specified segments. If the combination of segments matches an existing WBS Code, the existing code will be updated with the description provided.

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

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_update_all_patch(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_update_all_patch_request, opts \\ [])

@spec rest_v10_projects_project_id_work_breakdown_structure_wbs_codes_update_all_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdWorkBreakdownStructureWbsCodesUpdateAllPatchRequest.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10CompanyConfigurationGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()}
  | {:error, Tesla.Env.t()}

Bulk update WBS codes Bulk update WBS Codes with the same status.

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

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure