Procore.Api.ConstructionFinancialsWorkBreakdownStructurePatterns (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsWorkBreakdownStructurePatterns.

Summary

Functions

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

List Company WBS Patterns All patterns for a given company

rest_v10_companies_company_id_work_breakdown_structure_patterns_update_segment_order_put(connection, procore_company_id, company_id, update_segment_order_body, opts \\ [])

Update Company Pattern's Segment Order Updates the segment order on a company pattern

rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put_request, opts \\ [])

Add segment to the project pattern Add segment to the project pattern

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

List Project WBS Patterns All patterns for a given project

rest_v10_projects_project_id_work_breakdown_structure_patterns_remove_segment_put(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put_request, opts \\ [])

Remove segment from the project pattern Remove segment from the project pattern

rest_v10_projects_project_id_work_breakdown_structure_patterns_update_segment_order_put(connection, procore_company_id, project_id, update_segment_order_body, opts \\ [])

Update Project Pattern's Segment Order Updates the segment order on a project pattern

Functions

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

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

List Company WBS Patterns All patterns for a given 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

Returns

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

rest_v10_companies_company_id_work_breakdown_structure_patterns_update_segment_order_put(connection, procore_company_id, company_id, update_segment_order_body, opts \\ [])

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

Update Company Pattern's Segment Order Updates the segment order on a company pattern

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.
update_segment_order_body (UpdateSegmentOrderBody):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put_request, opts \\ [])

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

Add segment to the project pattern Add segment to the project pattern

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_patterns_add_segment_put_request (RestV10ProjectsProjectIdWorkBreakdownStructurePatternsAddSegmentPutRequest):
opts (keyword): Optional parameters

Returns

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

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

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

List Project WBS Patterns All patterns 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

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_patterns_remove_segment_put(connection, procore_company_id, project_id, rest_v10_projects_project_id_work_breakdown_structure_patterns_add_segment_put_request, opts \\ [])

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

Remove segment from the project pattern Remove segment from the project pattern

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_patterns_add_segment_put_request (RestV10ProjectsProjectIdWorkBreakdownStructurePatternsAddSegmentPutRequest):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_work_breakdown_structure_patterns_update_segment_order_put(connection, procore_company_id, project_id, update_segment_order_body, opts \\ [])

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

Update Project Pattern's Segment Order Updates the segment order on a project pattern

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.
update_segment_order_body (UpdateSegmentOrderBody):
opts (keyword): Optional parameters

Returns

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