Procore.Api.ConstructionFinancialsWorkBreakdownStructureSegmentItems (procore_sdk v0.3.0)
API calls for all endpoints tagged ConstructionFinancialsWorkBreakdownStructureSegmentItems
.
Summary
Functions
Bulk Delete Company Segment Items Bulk Delete Company Segment Items
List Company Segment Items List Segment Items for a specific segment
Delete Company Segment Item Delete a specific Company Segment Item.
Show Company Segment Item Return details on a specific Company Segment Item.
Update Company Segment Item Update a specific Company Segment Item.
Create Company Segment Item Create a Company Segment Item.
Update All Company Segment Items Update All Segment Items with the same attributes. The endpoint currently handles updating status (deactivating or reactivating) for segment items and their children.
Bulk Delete Project Segment Items Bulk Delete Project Segment Items
List Project Segment Items List Segment Items for a specific segment
Delete Project Segment Item Delete a specific Project Segment Item.
Update Project Segment Item Update a specific Project Segment Item. The ID of the record is subject to change under certain conditions, please store the response accordingly.
Create Project Segment Item Create a Project Segment Item
Update All Project Segment Items Update All Segment Items with the same attributes. The endpoint currently handles updating status (deactivating or reactivating) for segment items and their children.
Functions
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete(connection, procore_company_id, company_id, segment_id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete_request, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDeleteRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDelete207Response.t()} | {:error, Tesla.Env.t()}
Bulk Delete Company Segment Items Bulk Delete Company Segment Items
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDeleteRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDelete207Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_get(connection, procore_company_id, company_id, segment_id, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t() ]} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
List Company Segment Items List Segment Items for a specific segment
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDopts
(keyword): Optional parameters:segment_item_list_id
(integer()): Used to filter legacy segment items by list. Required for Cost Codes.:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_delete(connection, procore_company_id, company_id, segment_id, id, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_delete( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Delete Company Segment Item Delete a specific Company Segment Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDid
(integer()): Segment Item IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_get(connection, procore_company_id, company_id, segment_id, id, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_get( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Show Company Segment Item Return details on a specific Company Segment Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDid
(integer()): Segment Item IDopts
(keyword): Optional parameters:standard_cost_code_list_id
(integer()): Standard Cost Code List ID (required for cost codes only)
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch(connection, procore_company_id, company_id, segment_id, id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch_request, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch( Tesla.Env.client(), integer(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Update Company Segment Item Update a specific Company Segment Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDid
(integer()): Segment Item IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsIdPatchRequest):opts
(keyword): Optional parameters:standard_cost_code_list_id
(integer()): Standard Cost Code List ID (required for cost codes only)
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_post(connection, procore_company_id, company_id, segment_id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_post_request, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_post( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Create Company Segment Item Create a Company Segment Item.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_post_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch(connection, procore_company_id, company_id, segment_id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch_request, opts \\ [])
@spec rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsUpdateAllPatchRequest.t(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Update All Company Segment Items Update All Segment Items with the same attributes. The endpoint currently handles updating status (deactivating or reactivating) for segment items and their children.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.company_id
(integer()): Unique identifier for the company.segment_id
(integer()): Segment IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsUpdateAllPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete(connection, procore_company_id, project_id, segment_id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete_request, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDeleteRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDelete207Response.t()} | {:error, Tesla.Env.t()}
Bulk Delete Project Segment Items Bulk Delete Project Segment Items
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.segment_id
(integer()): Segment IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_bulk_destroy_delete_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDeleteRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsBulkDestroyDelete207Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_get(connection, procore_company_id, project_id, segment_id, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t() ]} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
List Project Segment Items List Segment Items for a specific segment
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.segment_id
(integer()): Segment IDopts
(keyword): Optional parameters:legacy_sub_job_id
(integer()): Used to filter legacy cost codes by sub job. Default will filter by project.:legacy_cost_code_id
(integer())::include_action_policy
(boolean())::only_active_items
(boolean())::with_descendant_counts
(boolean())::include_sub_job_cost_codes
(boolean())::page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_delete(connection, procore_company_id, project_id, segment_id, id, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_delete( Tesla.Env.client(), integer(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Delete Project Segment Item Delete a specific Project Segment Item.
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.segment_id
(integer()): Segment IDid
(integer()): Segment Item IDopts
(keyword): Optional parameters:sub_job_id
(integer()): Sub Job ID (required for a sub job's cost codes only)
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch(connection, procore_company_id, project_id, segment_id, id, rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch( Tesla.Env.client(), integer(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsIdPatchRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Update Project Segment Item Update a specific Project Segment Item. The ID of the record is subject to change under certain conditions, please store the response accordingly.
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.segment_id
(integer()): Segment IDid
(integer()): Segment Item IDrest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_id_patch_request
(RestV10ProjectsProjectIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsIdPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_post(connection, procore_company_id, project_id, segment_id, rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_post_request, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_post( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10ProjectsProjectIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Create Project Segment Item Create a Project Segment Item
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.segment_id
(integer()): Segment IDrest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_post_request
(RestV10ProjectsProjectIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsPostRequest):opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10ProjectsProjectIdTaskCodesGet200ResponseInnerSegmentItemsInner.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch(connection, procore_company_id, project_id, segment_id, rest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch_request, opts \\ [])
@spec rest_v10_projects_project_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsUpdateAllPatchRequest.t(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()} | {:error, Tesla.Env.t()}
Update All Project Segment Items Update All Segment Items with the same attributes. The endpoint currently handles updating status (deactivating or reactivating) for segment items and their children.
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.segment_id
(integer()): Segment IDrest_v10_companies_company_id_work_breakdown_structure_segments_segment_id_segment_items_update_all_patch_request
(RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsSegmentIdSegmentItemsUpdateAllPatchRequest):opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure