Overview
Configuration is provided for establishing connections with Procore service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Procore REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Procore. If you want to connect to the sandbox, you have to change the server host parameter to: https://sandbox.procore.com/rest/v1.0
Then click New in the Token File parameter to create a new token file.
Step 3. Select Edge browser option. Click on Next button.
Step 4: Provide Email and Password. Then press 'Log In button.
Step 5: Save generated access token to file. Specify token protection password. Click OK.
Step 6. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Procore instance.
In this guide, we will show how to read data from the Procore service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Procore connection from the combo. Select from available Procore resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Procore resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Procore service.
In this guide, we will show how to write data to the Procore service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Procore connection from the combo. Also, select resource action and Procore resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Procore resource.
Configuration
Base URL address: https://api.procore.com/rest/v1.0.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.procore.com/reference/rest/v1/authentication.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies.Documentation: https://developers.procore.com/reference/rest/v1/companies#list-companies.
- id
Template: Id.
- name
Template: ShortText.
- is_active
Data type: DT_BOOL
- logo_url
Template: ShortText.
- pcn_business_experience
Data type: DT_BOOL
- logo
Data type: DT_IMAGE The value is gathered from
{{=item.logo_url}}address. The value is sent to/companies/{{=item.id}}/settings/logoaddress.- change_order_change_reasons
The value is gathered from
/change_order_change_reasonsaddress. Field components:- An array.
- Contains the following components: id, company_id, change_reason, show_in_select.
- change_order_statuses
The value is gathered from
/change_order/statusesaddress. Field components:- An array.
-
Uses template:
ChangeStatusT.
- uom_categories
The value is gathered from
/companies/{{=item.id}}/uom_categoriesaddress. Field components:- An array.
-
Uses template:
RefT.
- wbs_patterns
The value is gathered from
/companies/{{=item.id}}/work_breakdown_structure/patternsaddress. Field components:- An array.
- Contains the following components: id, description, created_at, updated_at, is_project_level_ordered, segments.
- configuration
The value is gathered from
/company_configurationaddress. Field components:-
Uses template:
ShortText. - Contains the following components: strict_file_uploading, enable_image_real_time_as_builts, currency_symbol, currency_display, currency_iso_code, timecard_employees_see_all_projects, timesheet_enabled_cost_type, timesheet_type, enable_sd_storage, timesheets_custom_signature_text, timesheets_week_start_day, use_24_hour_mode, timesheets_tab_enabled, timecard_should_track_location, projects_timecard_in_out_enabled, rounding_configuration, time_and_materials_company_config, projects_timecard_default_lunch_time, projects_timecard_default_start_time, projects_timecard_default_stop_time, projects_timecard_lunch_time_tracking, task_codes_enabled, timecard_employees_can_select_non_budgeted_items, timecards_private, timesheet_default_cost_type_id, timesheet_erp_default_cost_type_id.
-
Uses template:
- projects
The value is gathered from
/companies/{{=item.id}}/projectsaddress. Field components:- An array.
-
Uses template:
RefT. - Contains the following components: address, stage_name, status_name, type_name, open_items.
- roles
The value is gathered from
/companies/{{=item.id}}/rolesaddress. Field components:- An array.
-
Uses template:
RefT.
- submittal_statuses
The value is gathered from
/companies/{{=item.id}}/submittal_statusesaddress. Field components:- An array.
-
Uses template:
RefT.
- submittal_types
The value is gathered from
/companies/{{=item.id}}/submittal_typesaddress. Field components:- An array.
-
Uses template:
RefT.
- project_templates
A read-only field. The value is gathered from
/project_templatesaddress. Field components:- An array.
-
Uses template:
RefT.
- filters
A read-only field. The value is gathered from
/companies/{{=item.id}}/filtersaddress. The gathered value is processed with{{=response.filters}}expression. Field components:- An array.
-
Uses template:
FilterT.
- schedule_resources
A read-only field. The value is gathered from
/companies/{{=item.id}}/schedule/resourcesaddress. Field components:- An array.
-
Uses template:
UserRefT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/projects#list-projects.
- [Create] action
-
Endpoint URL address:
/projects.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, project: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/projects#create-project.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, project: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/projects#update-project.
-
application/json:
- id
A key field. Template: Id.
- name
Template: ShortText.
- is_demo
Data type: DT_BOOL
- parent_job_id
Template: Id.
- display_name
Template: ShortText.
- project_number
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- state_code
Template: ShortText.
- code
Template: ShortText.
- country_code
Template: ShortText.
- description
Template: ShortText.
- zip
Template: ShortText.
- county
Template: ShortText.
- time_zone
Template: ShortText.
- latitude
Data type: DT_R8
- longitude
Data type: DT_R8
- stage
Template: ShortText.
- project_stage_id
Template: Id.
- project_stage
Template: RefT. A read-only field.
- project_template_id
Template: Id.
- project_template
Template: RefT. A read-only field.
- phone
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- active
Data type: DT_BOOL
- origin_id
Template: ShortText.
- origin_data
Template: ShortText.
- origin_code
Template: ShortText.
- owners_project_id
Template: Id.
- total_value
Data type: DT_R8
- store_number
Data type: DT_I4
- accounting_project_number
Data type: DT_I4
- designated_market_area
Template: ShortText.
- project_region_id
Template: Id.
- project_bid_type_id
Template: Id.
- project_owner_type_id
Template: Id.
- photo_id
Template: Id.
- start_date
Template: Date.
- completion_date
Template: Date.
- estimated_value
Data type: DT_R8
- estimated_start_date
Template: Date.
- estimated_completion_date
Template: Date.
- company_id
A key field. Template: Id.
- company
Template: RefT. A read-only field.
- warranty_start_date
Template: Date.
- warranty_end_date
Template: Date.
- flag
Template: ShortText.
- office_id
Template: Id.
- public_notes
Template: ShortText.
- square_feet
Data type: DT_I4
- program_id
Template: Id.
- project_type_id
Template: Id.
- department_ids
Template: LongText. A composite field.
- erp_integrated
Data type: DT_BOOL
- budget
The value is gathered from
/projects/{{=item.id}}/budgetaddress. Field components:- Contains the following components: locked.
- manual_forecast_line_items
A read-only field. The value is gathered from
/projects/{{=item.id}}/manual_forecast_line_itemsaddress. Field components:- An array.
-
Uses template:
ManualForecastLineItemT.
- monitoring_resources
A read-only field. The value is gathered from
/projects/{{=item.id}}/monitoring_resourcesaddress. Field components:- An array.
-
Uses template:
MonitoringResourceT.
- wbs_patterns
A read-only field. The value is gathered from
/projects/{{=item.id}}/work_breakdown_structure/patternsaddress. Field components:- An array.
- Contains the following components: id, description, created_at, updated_at, is_project_level_ordered, segments.
- open_items
A read-only field. The value is gathered from
/open_items/alladdress. Field components:-
Uses template:
DateTime. - Contains the following components: count, open_count, upcoming_count, overdue_count, last_activity.
-
Uses template:
- filters
A read-only field. The value is gathered from
/projects/{{=item.id}}/filtersaddress. The gathered value is processed with{{=response.filters}}expression. Field components:- An array.
-
Uses template:
FilterT.
- dates
A read-only field. The value is gathered from
/projects/{{=item.id}}/project_datesaddress. Field components:- An array.
-
Uses template:
RefT.
- tools
A read-only field. The value is gathered from
/projects/{{=item.id}}/toolsaddress. Field components:- An array.
- Contains the following components: id, engine_name, is_active, position, required, title.
- permission_templates
A read-only field. The value is gathered from
/projects/{{=item.id}}/permission_templatesaddress. Field components:- An array.
-
Uses template:
PermissionTemplateT.
- task_item_categories
A read-only field. The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/projects/{{=item.id}}/task_item_categoriesaddress. Field components:- An array.
-
Uses template:
RefT.
- coordination_issues_filter_options
A read-only field. The value is gathered from
/coordination_issues/filter_optionsaddress. Field components:- An array.
- Contains the following components: key, value, endpoint.
- correspondence_types
A read-only field. Field components:
- Contains the following components: users, defaults, permissions.
- daily_logs_counts
A read-only field. The value is gathered from
/projects/{{=item.id}}/daily_logs/countsaddress. Field components:- An array.
- Contains the following components: module_name, count, position.
- rfi
A read-only field. Field components:
- Contains the following components: potential_assignees, potential_managers, default_distribution.
- submittal_packages
A read-only field. The value is gathered from
/projects/{{=item.id}}/submittal_packagesaddress. Field components:- An array.
-
Uses template:
SubmittalPackageT.
- submittal_responses
A read-only field. The value is gathered from
/submittal_responsesaddress. Field components:- An array.
-
Uses template:
ResponseT.
- timecard_time_types
A read-only field. The value is gathered from
/timecard_time_typesaddress. Field components:- An array.
- Contains the following components: id, time_type, abbreviated_time_type, global.
- available_punch_item_managers
A read-only field. The value is gathered from
/projects/{{=item.id}}/available_punch_item_managersaddress. Field components:- An array.
-
Uses template:
UserRefT.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/budget_changes.
The result is extracted from:{{=response.data}}.Documentation: https://developers.procore.com/reference/rest/v1/budget-change#list-budget-change-summaries.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_changes.Documentation: https://developers.procore.com/reference/rest/v1/budget-change#create-a-budget-change.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_changes/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/budget-change#update-information-of-a-budget-change.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_changes/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/budget-change#delete-a-budget-change.
- id
Template: Id.
- number
Data type: DT_I4
- status
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- erp_status
Template: ShortText.
- change_event_line_item_count
Data type: DT_I4
- adjustment_total
Data type: DT_I4
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/budget_views/{{=Procore.UI.BudgetViewEditor.getValue(parameters)}}/budget_details.
The action uses POST method.The action has the following user-defined parameters:
- budget_view_id: Required. Specify budget view identifier.
- biller: Specify as JSON. Optional.
- cost_code: Specify comma (,) delimited list of codes. Optional.
- root_cost_code: Specify comma (,) delimited list of root cost codes. Optional.
- cost_type: Specify comma (,) delimited list of cost types. Optional.
- vendor: Specify comma (,) delimited list of vendors. Optional.
- detail_type: Specify comma (,) delimited list of detail types. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{={ filters: { biller: parameters.get('biller') && JSON.parse(parameters.biller), cost_code: Procore.getArrParameter(parameters.get('cost_code')), root_cost_code: Procore.getArrParameter(parameters.get('root_cost_code')), cost_type: Procore.getArrParameter(parameters.get('cost_type')), vendor: Procore.getArrParameter(parameters.get('vendor')), detail_type: Procore.getArrParameter(parameters.get('detail_type')) } } }}
Documentation: https://developers.procore.com/reference/rest/v1/budget-details#list-budget-details.
- id
Template: ShortText.
- biller
Template: RefT.
- contract
Template: RefT.
- cost_code
Template: RefT.
- cost_type
Template: RefT.
- description
Template: ShortText.
- detail_type
Template: RefT.
- item
Template: ShortText.
- link
Template: ShortText.
- root_cost_code
Template: RefT.
- vendor
Template: RefT.
- wbs_code
Template: WbsCodeT.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/budget_line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Requred. Specify line item identifier.
Documentation: https://developers.procore.com/reference/rest/v1/budget-line-items#show-budget-line-item.
- [Create] action
-
Endpoint URL address:
/budget_line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, budget_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budget-line-items#create-budget-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/budget_line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, budget_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budget-line-items#update-budget-line-item.
-
application/json:
- id
A key field. Template: Id.
- cost_code_id
Template: Id.
- line_item_type_id
Template: Id.
- original_budget_amount
Data type: DT_R8
- uom
Template: ShortText.
- quantity
Data type: DT_R8
- unit_cost
Data type: DT_R8
- calculation_strategy
Template: ShortText.
- direct_costs
Data type: DT_R8
- approved_budget_changes
Data type: DT_R8 A read-only field.
- revised_budget
Data type: DT_R8 A read-only field.
- pending_budget_changes
Data type: DT_R8 A read-only field.
- projected_budget
Data type: DT_R8 A read-only field.
- committed_costs
Data type: DT_R8 A read-only field.
- pending_cost_changes
Data type: DT_R8 A read-only field.
- projected_costs
Data type: DT_R8 A read-only field.
- budget_forecast
Data type: DT_R8 A read-only field.
- estimated_cost_at_completion
Data type: DT_R8 A read-only field.
- projected_over_under
Data type: DT_R8 A read-only field.
- cost_code
Template: CodeT. A read-only field.
- division
Template: CodeT. A read-only field.
- line_item_type
Template: RefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/budget_modifications.Documentation: https://developers.procore.com/reference/rest/v1/budget-modifications#list-budget-modifications.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/budget_modifications/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/budget-modifications#show-budget-modification.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_modifications.The following request parameters will be automatically processed:
-
application/json:
{{={ budget_modification: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budget-modifications#create-budget-modification.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_modifications/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ budget_modification: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budget-modifications#update-budget-modification.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budget_modifications/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/budget-modifications#delete-budget-modification.
- id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- from_budget_line_item_id
Template: Id.
- notes
Template: ShortText.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- to_budget_line_item_id
Template: Id.
- transfer_amount
Data type: DT_R8
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_views/{{=Procore.UI.BudgetViewEditor.getValue(parameters)}}/detail_rows.The action has the following user-defined parameters:
- budget_view_id: Required. Specify budget view identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}} -
biller:
{{=Procore.getArrParameter(parameters.get('biller'))}} -
cost_code_id:
{{=Procore.getArrParameter(parameters.get('cost_code_id'))}} -
root_cost_code_id:
{{=Procore.getArrParameter(parameters.get('root_cost_code_id'))}} -
root_cost_code_name:
{{=Procore.getArrParameter(parameters.get('root_cost_code_name'))}} -
category_id:
{{=Procore.getArrParameter(parameters.get('category_id'))}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-view-detail-rows#list-budget-view-detail-rows.
The resource includes the fields from the BudgetViewDetailRowT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_view_snapshots/{{=Procore.UI.BudgetViewSnapshotEditor.getValue(parameters)}}/detail_rows.The action has the following user-defined parameters:
- budget_view_snapshot_id: Required. Specify budget view snapshot identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}} -
cost_code_id:
{{=Procore.getArrParameter(parameters.get('cost_code_id'))}} -
cost_code_name:
{{=Procore.getArrParameter(parameters.get('cost_code_name'))}} -
root_cost_code_id:
{{=Procore.getArrParameter(parameters.get('root_cost_code_id'))}} -
category_id:
{{=Procore.getArrParameter(parameters.get('category_id'))}} -
budget_line_item_id:
{{=Procore.getArrParameter(parameters.get('budget_line_item_id'))}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-view-snapshot-detail-rows#list-budget-view-snapshot-detail-rows.
The resource includes the fields from the BudgetViewDetailRowT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_view_snapshots/{{=Procore.UI.BudgetViewSnapshotEditor.getValue(parameters)}}/summary_rows.The action has the following user-defined parameters:
- budget_view_snapshot_id: Required. Specify budget view snapshot identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}} -
cost_code_id:
{{=Procore.getArrParameter(parameters.get('cost_code_id'))}} -
cost_code_name:
{{=Procore.getArrParameter(parameters.get('cost_code_name'))}} -
root_cost_code_id:
{{=Procore.getArrParameter(parameters.get('root_cost_code_id'))}} -
category_id:
{{=Procore.getArrParameter(parameters.get('category_id'))}} -
budget_line_item_id:
{{=Procore.getArrParameter(parameters.get('budget_line_item_id'))}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-view-snapshot-summary-rows#list-budget-view-snapshot-summary-rows.
The resource includes the fields from the BudgetViewSnapshotSummaryRowT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_view_snapshots.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-view-snapshots#list-budget-view-snapshots.
-
project_id:
- id
Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- created_at
Template: DateTime.
- created_by
Template: UserRefT.
- budget_view
Field components:
-
Uses template:
Id. - Contains the following components: id.
-
Uses template:
- detail_rows
The gathered value is processed with
{{=connection.resourceManager['Budget View Snapshot Detail Row'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'budget_view_snapshot_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
BudgetViewDetailRowT.
- summary_rows
The gathered value is processed with
{{=connection.resourceManager['Budget View Snapshot Summary Row'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'budget_view_snapshot_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
BudgetViewSnapshotSummaryRowT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_views/{{=Procore.UI.BudgetViewEditor.getValue(parameters)}}/summary_rows.The action has the following user-defined parameters:
- budget_view_id: Required. Specify budget view identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}} -
biller:
{{=Procore.getArrParameter(parameters.get('biller'))}} -
cost_code_id:
{{=Procore.getArrParameter(parameters.get('cost_code_id'))}} -
cost_code_name:
{{=Procore.getArrParameter(parameters.get('cost_code_name'))}} -
root_cost_code_id:
{{=Procore.getArrParameter(parameters.get('root_cost_code_id'))}} -
root_cost_code_name:
{{=Procore.getArrParameter(parameters.get('root_cost_code_name'))}} -
category_id:
{{=Procore.getArrParameter(parameters.get('category_id'))}} -
budget_line_item_id:
{{=Procore.getArrParameter(parameters.get('budget_line_item_id'))}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-view-summary-rows#list-budget-view-summary-rows.
The resource includes the fields from the BudgetViewSummaryRowT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/budget_views.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/budget-views#list-budget-views.
-
project_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- role
Template: ShortText.
- detail_columns
The value is gathered from
/budget_views/{{=item.id}}/budget_detail_columnsaddress. Field components:- An array.
-
Uses template:
RefT. - Contains the following components: aggregatable, filterable, groupable, position, type.
- detail_rows
The gathered value is processed with
{{=connection.resourceManager['Budget View Detail Row'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'budget_view_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
BudgetViewDetailRowT.
- summary_rows
The gathered value is processed with
{{=connection.resourceManager['Budget View Summary Row'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'budget_view_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
BudgetViewSummaryRowT.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/manual_forecast_line_items.The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/manual-forecast-line-items#list-manual-forecast-line-items.
-
Procore-Company-Id:
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/manual_forecast_line_items.Documentation: https://developers.procore.com/reference/rest/v1/manual-forecast-line-items#create-a-manual-forecast-line-item.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/manual_forecast_line_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/manual-forecast-line-items#update-a-manual-forecast-line-item.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/manual_forecast_line_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/manual-forecast-line-items#delete-a-manual-forecast-line-item.
The resource includes the fields from the ManualForecastLineItemT template.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/monitoring_resources.Documentation: https://developers.procore.com/reference/rest/v1/monitoring-resources#list-monitoring-resources.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/monitoring_resources.The following request parameters will be automatically processed:
-
application/json:
{{={ monitoring_resource: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/monitoring-resources#create-monitoring-resource.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/monitoring_resources/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ monitoring_resource: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/monitoring-resources#update-monitoring-resource.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/monitoring_resources/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/monitoring-resources#delete-monitoring-resource.
The resource includes the fields from the MonitoringResourceT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/change_event/statuses.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-events#list-change-event-statuses.
-
project_id:
The resource includes the fields from the ChangeStatusT template.
- default_status
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/change_events.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-events#list-change-events.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/change_events/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-events#show-change-event.
-
project_id:
- [Create] action
-
Endpoint URL address:
/change_events.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ change_event: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-events#create-change-event.
-
project_id:
- [Update] action
-
Endpoint URL address:
/change_events/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, change_event: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-events#update-change-event.
-
application/json:
The resource includes the fields from the ChangeEventT template.
- rfi_id
Template: Id.
- change_event_line_items_attributes
Field components:
- An array.
- Contains the following components: id, budget_code, description, uom, estimated_cost_amount, estimated_cost_quantity, estimated_cost_unit_cost, estimated_cost_calculation_strategy, line_item_type_id, cost_code_id, proposed_vendor_id, proposed_contract_id, commitment_contract_line_item_id.
- change_order_change_reason_id
Template: Id.
- change_event_status_id
Template: Id.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/change_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-types#list-change-types.
- id
Template: Id.
- abbreviation
Template: ShortText.
- company_id
Template: Id.
- change_type
Template: ShortText.
- show_in_select
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/change_order_packages.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-packages#list-change-order-packages.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/change_order_packages/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-packages#show-change-order-package.
-
project_id:
- [Create] action
-
Endpoint URL address:
/change_order_packages.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-packages#create-change-order-package.
-
application/json:
- [Update] action
-
Endpoint URL address:
/change_order_packages/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-packages#update-change-order-package.
-
application/json:
The resource includes the fields from the ChangeOrderPackageT template.
- executed
Data type: DT_BOOL
- position
Data type: DT_I4 A read-only field.
- review_notes
Template: ShortText. A read-only field.
- revised_substantial_completion_date
Template: Date. A read-only field.
- schedule_impact_amount
Data type: DT_I4
- signed_change_order_received_date
Template: Date.
- revision
Data type: DT_I4 A read-only field.
- grand_total
Data type: DT_R8
- designated_reviewer
Template: UserRefT. A read-only field.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/change_order_requests.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-requests#list-change-order-requests.
- [Read single] action
-
Endpoint URL address:
/change_order_requests/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-requests#show-change-order-request.
- [Create] action
-
Endpoint URL address:
/change_order_requests.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-requests#create-change-order-request.
-
application/json:
- [Update] action
-
Endpoint URL address:
/change_order_requests/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/change-order-requests#update-change-order-request.
-
application/json:
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- created_by_id
Template: Id. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- due_date
Template: Date.
- invoiced_date
Template: Date.
- number
Template: ShortText.
- paid_date
Template: Date.
- status
Template: ShortText.
- title
Template: ShortText.
- change_order_package_id
Template: Id.
- updated_at
Template: DateTime. A read-only field.
- revision
Data type: DT_I4 A read-only field.
- grand_total
Data type: DT_R8
- schedule_impact_amount
Data type: DT_I4
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
- contract_id
A key field. Template: Id.
- description
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/potential_change_orders.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#list-potential-change-orders.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/potential_change_orders/{{=item.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#show-potential-change-orders.
- [Create] action
-
Endpoint URL address:
/potential_change_orders.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#create-potential-change-order.
-
application/json:
- [Update] action
-
Endpoint URL address:
/potential_change_orders/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, change_order: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#update-potential-change-order.
-
application/json:
The resource includes the fields from the ChangeOrderT template.
- contract_id
A key field. Template: Id.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
- commitment_change_event_id
Template: Id.
- description
Template: ShortText.
- prime_change_event_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/potential_change_orders/{{=parameters.potential_change_order_id}}/line_items.The action has the following user-defined parameters:
- potential_change_order_id: Required. Specify potential change order identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#list-potential-change-order-line-items.
- [Read single] action
-
Endpoint URL address:
/potential_change_orders/{{=parameters.potential_change_order_id}}/line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- potential_change_order_id: Required. Specify potential change order identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#show-potential-change-order-line-item.
- [Create] action
-
Endpoint URL address:
/potential_change_orders/{{=item.potential_change_order_id}}/line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#create-potential-change-order-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/potential_change_orders/{{=item.potential_change_order_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#update-potential-change-order-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/potential_change_orders/{{=item.potential_change_order_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/potential-change-orders#delete-potential-change-order-line-item.
-
project_id:
The resource includes the fields from the LineItemT template.
- potential_change_order_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/billing_periods.Documentation: https://developers.procore.com/reference/rest/v1/billing-periods#list-billing-periods.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/billing_periods/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/billing-periods#show-billing-period-for-project.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/billing_periods.The following request parameters will be automatically processed:
-
application/json:
{{={ billing_period: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/billing-periods#create-billing-period.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/billing_periods/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ billing_period: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/billing-periods#update-billing-period.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/billing_periods/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/billing-periods#delete-billing-period.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- due_date
Template: Date.
- end_date
Template: Date.
- position
Data type: DT_I4
- start_date
Template: Date.
- status
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/contract_payments.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/contract-payments#list-contract-payments.
- [Read single] action
-
Endpoint URL address:
/contract_payments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/contract-payments#show-contract-payment.
- [Create] action
-
Endpoint URL address:
/contract_payments.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, attachments: item.attachments, contract_payment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/contract-payments#create-contract-payment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contract_payments/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.contract_id, attachments: item.attachments, contract_payment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/contract-payments#update-contract-payment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contract_payments/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
contract_id:
{{=item.contract_id}}
Documentation: https://developers.procore.com/reference/rest/v1/contract-payments#delete-contract-payment.
-
project_id:
- id
A key field. Template: Id.
- amount
Data type: DT_R8
- check_number
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- date
Template: Date.
- date_payment_settled
Template: DateTime.
- date_payment_initiated
Template: DateTime.
- draw_request_number
Data type: DT_I4
- invoice_number
Template: ShortText.
- notes
Template: ShortText.
- payment_number
Data type: DT_I4
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- requisition_id
Template: Id.
- origin_id
Template: ShortText.
- origin_code
Template: ShortText.
- origin_data
Template: ShortText.
- status
Template: ShortText.
- contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/line_item_types.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/line-item-types-cost-types.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/line_item_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/line-item-types-cost-types#show-line-item-type.
-
project_id:
- [Create] action
-
Endpoint URL address:
/line_item_types.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, line_item_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/line-item-types-cost-types#create-line-item-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/line_item_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, line_item_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/line-item-types-cost-types#update-line-item-type.
-
application/json:
The resource includes the fields from the LineItemTypeT template.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/purchase_order_contracts/{{=Procore.UI.PurchaseOrderContractEditor.getValue(parameters)}}/line_item_contract_details.The action has the following user-defined parameters:
- purchase_order_contract_id: Required. Specify purchase order contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-detail-line-items#list-purchase-order-contract-detail-line-items.
- [Read single] action
-
Endpoint URL address:
/purchase_order_contracts/{{=Procore.UI.PurchaseOrderContractEditor.getValue(parameters)}}/line_item_contract_details/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- purchase_order_contract_id: Required. Specify purchase order contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-detail-line-items#show-purchase-order-contract-detail-line-item.
- [Create] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_item_contract_details.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_detail_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-detail-line-items#create-purchase-order-contract-detail-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_item_contract_details/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_detail_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-detail-line-items#update-purchase-order-contract-detail-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_item_contract_details/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-detail-line-items#delete-purchase-order-contract-detail-line-item.
The resource includes the fields from the ContractDetailLineItemT template.
- purchase_order_contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/purchase_order_contracts/{{=Procore.UI.PurchaseOrderContractEditor.getValue(parameters)}}/line_items.The action has the following user-defined parameters:
- purchase_order_contract_id: Required. Specify purchase order contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-line-items#list-purchase-order-contract-line-items.
- [Read single] action
-
Endpoint URL address:
/purchase_order_contracts/{{=Procore.UI.PurchaseOrderContractEditor.getValue(parameters)}}/line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- purchase_order_contract_id: Required. Specify purchase order contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-line-items#show-purchase-order-contract-line-item.
- [Create] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-line-items#create-purchase-order-contract-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-line-items#update-purchase-order-contract-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.purchase_order_contract_id}}/line_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contract-line-items#delete-purchase-order-contract-line-item.
The resource includes the fields from the LineItemT template.
- purchase_order_contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/purchase_order_contracts.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contracts#list-of-purchase-order-contracts.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/purchase_order_contracts/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contracts#show-purchase-order-contract.
-
project_id:
- [Create] action
-
Endpoint URL address:
/purchase_order_contracts.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, purchase_order_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contracts#create-purchase-order-contract.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, purchase_order_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contracts#update-purchase-order-contract.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_order_contracts/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/purchase-order-contracts#delete-purchase-order-contract.
The resource includes the fields from the BaseContractT template.
- assignee_id
Template: Id.
- assignee
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id.
-
Uses template:
- bill_to_address
Template: ShortText.
- billing_schedule_of_values_status
Template: ShortText.
- delivery_date
Template: Date.
- payment_terms
Template: ShortText.
- ship_to_address
Template: ShortText.
- ship_via
Template: ShortText.
- attachments
Template: LongText. A composite field.
- detail_line_items
A read-only field. The value is gathered from
/purchase_order_contracts/{{=item.id}}/line_item_contract_detailsaddress. Field components:- An array.
-
Uses template:
ContractDetailLineItemT.
- line_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Purchase Order Contract Line Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'purchase_order_contract_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
LineItemT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=Procore.UI.RequisitionEditor.getValue(parameters)}}/change_order_items.The action has the following user-defined parameters:
- requisition_id: Required. Specify requisition identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
The resource includes the fields from the RequisitionChangeOrderItemT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=Procore.UI.RequisitionEditor.getValue(parameters)}}/contract_detail_items.The action has the following user-defined parameters:
- requisition_id: Required. Specify requisition identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
The resource includes the fields from the RequisitionContractDetailItemT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=Procore.UI.RequisitionEditor.getValue(parameters)}}/contract_items.The action has the following user-defined parameters:
- requisition_id: Required. Specify requisition identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
The resource includes the fields from the RequisitionContractItemT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/requisitions.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/requisitions-subcontractor-invoices#list-requisitions-subcontractor-invoices-for-project.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/requisitions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/requisitions-subcontractor-invoices#show-requisition-subcontractor-invoice.
-
project_id:
- [Create] action
-
Endpoint URL address:
/requisitions.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, commitment_id: item.commitment_id, attachments: item.attachments, requisition: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/requisitions-subcontractor-invoices#create-requisition-subcontractor-invoices-for-commitment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/requisitions/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, commitment_id: item.commitment_id, attachments: item.attachments, requisition: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/requisitions-subcontractor-invoices#update-requisition-subcontractor-invoice.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/requisitions/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/requisitions-subcontractor-invoices#delete-requisition-subcontractor-invoice.
- id
A key field. Template: Id.
- electronic_signature_id
Template: Id.
- billing_date
Template: Date.
- commitment_id
A key field. Template: Id.
- commitment_type
Template: ShortText.
- contract_name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- invoice_number
Data type: DT_I4
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- payment_date
Template: Date.
- period_id
Template: Id.
- requisition_start
Template: Date.
- requisition_end
Template: Date.
- status
Template: ShortText.
- erp_status
Template: ShortText.
- submitted_at
Template: Date.
- comment
Template: ShortText.
- final
Data type: DT_BOOL
- number
Data type: DT_I4
- percent_complete
Template: ShortText.
- vendor_name
Template: ShortText.
- total_claimed_amount
Data type: DT_R8
- deletable
Data type: DT_BOOL
- custom_fields
The gathered value is processed with
{{=_.map(value, function(v, k) { return _.extend({ id: k }, v); })}}expression. Field components:- An array.
- Contains the following components: id, data_type, value.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- summary
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: balance_to_finish_including_retainage, completed_work_retainage_percent, completed_work_retainage_amount, contract_sum_to_date, current_payment_due, formatted_period, less_previous_certificates_for_payment, negative_change_order_item_total, negative_new_change_order_item_total, negative_previous_change_order_item_total, net_change_by_change_orders, original_contract_sum, positive_change_order_item_total, positive_new_change_order_item_total, positive_previous_change_order_item_total, stored_materials_retainage_amount, stored_materials_retainage_percent, tax_applicable_to_this_payment, total_completed_and_stored_to_date, total_earned_less_retainage, total_retainage.
-
Uses template:
- action_policy
Template: LongText. A read-only field. A composite field.
- change_histories
A read-only field. The value is gathered from
/requisitions/{{=item.id}}/change_historiesaddress. Field components:- An array.
- Contains the following components: id, column, old_value, new_value, action_by, action_by_id, created_at, ref_id, ref_type.
- change_order_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Requisition Change Order Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'requisition_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
RequisitionChangeOrderItemT.
- contract_detail_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Requisition Contract Detail Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'requisition_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
RequisitionContractDetailItemT.
- contract_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Requisition Contract Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'requisition_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
RequisitionContractItemT.
- details
A read-only field. The value is gathered from
/requisitions/{{=item.id}}/detailaddress. Field components:- An array.
- Contains the following components: id, cost_code_id, description_of_work, scheduled_value, work_completed_from_previous_application, work_completed_this_period, materials_presently_stored, total_completed_and_stored_to_date, total_completed_and_stored_to_date_percent, work_completed_retainage_from_previous_application, materials_stored_retainage_from_previous_application, work_completed_retainage_retained_this_period, work_completed_retainage_percent_this_period, materials_stored_retainage_currently_retained, materials_stored_retainage_percent_this_period, work_completed_retainage_released_this_period, materials_stored_retainage_released_this_period, scheduled_quantity, scheduled_unit_price, work_completed_this_period_quantity, work_completed_from_previous_application_quantity, balance_to_finish, item_number, item_type, total_completed_and_stored_to_date_quantity, work_completed_retainage_currently_retained, materials_stored_retainage_retained_this_period, total_retainage_currently_retained, total_retainage_from_previous_application.
- action
Field components:
- Contains the following components: add_change_order_package, remove_change_order_package.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/rfqs.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/rfqs#list-rfqs.
- [Read single] action
-
Endpoint URL address:
/rfqs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/rfqs#show-rfq.
- [Create] action
-
Endpoint URL address:
/rfqs.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.commitment_id, rfq: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/rfqs#create-rfq.
-
application/json:
- [Update] action
-
Endpoint URL address:
/rfqs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_id: item.commitment_id, rfq: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/rfqs#update-rfq.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/rfqs/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
contract_id:
{{=item.contract_id}}
Documentation: https://developers.procore.com/reference/rest/v1/rfqs#delete-rfq.
-
project_id:
The resource includes the fields from the RFQT template.
- assigned_id
Template: Id.
- change_event_id
Template: Id.
- change_event
Template: ChangeEventT.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
- contract_id
A key field. Template: Id.
- cost_code_id
Template: Id.
- location_id
Template: Id.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/work_order_contracts/{{=Procore.UI.WorkOrderContractEditor.getValue(parameters)}}/line_item_contract_details.The action has the following user-defined parameters:
- work_order_contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-detail-line-items#list-work-order-contract-detail-line-items.
- [Create] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id}}/line_item_contract_details.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_detail_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-detail-line-items#create-work-order-contract-detail-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id}}/line_item_contract_details/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, contract_detail_line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-detail-line-items#update-work-order-contract-detail-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id]}/line_item_contract_details/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-detail-line-items#delete-work-order-contract-detail-line-item.
-
project_id:
The resource includes the fields from the ContractDetailLineItemT template.
- work_order_contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/work_order_contracts/{{=Procore.UI.WorkOrderContractEditor.getValue(parameters)}}/line_items.The action has the following user-defined parameters:
- work_order_contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-line-items#list-work-order-contract-line-items.
- [Read single] action
-
Endpoint URL address:
/work_order_contracts/{{=Procore.UI.WorkOrderContractEditor.getValue(parameters)}}/line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- work_order_contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-line-items#show-work-order-contract-line-item.
- [Create] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id}}/line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-line-items#create-work-order-contract-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id}}/line_items/{{item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-line-items#update-work-order-contract-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/work_order_contracts/{{=item.work_order_contract_id}}/line_items/{{item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contract-line-items#delete-work-order-contract-line-item.
-
project_id:
The resource includes the fields from the LineItemT template.
- work_order_contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/work_order_contracts.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contracts#list-work-order-contracts.
- [Read single] action
-
Endpoint URL address:
/work_order_contracts/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contracts#show-work-order-contract.
-
project_id:
- [Create] action
-
Endpoint URL address:
/work_order_contracts.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, work_order_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contracts#create-work-order-contract.
-
application/json:
- [Update] action
-
Endpoint URL address:
/work_order_contracts/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, work_order_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contracts#update-work-order-contract.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/work_order_contracts/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/work-order-contracts#delete-work-order-contract.
-
project_id:
The resource includes the fields from the BaseContractT template.
- actual_completion_date
Template: Date.
- contract_start_date
Template: Date.
- contract_estimated_completion_date
Template: Date.
- exclusions
Template: ShortText.
- inclusions
Template: ShortText.
- attachments
Template: LongText. A composite field.
- detail_line_items
A read-only field. The value is gathered from
/work_order_contracts/{{=item.id}}/line_item_contract_detailsaddress. Field components:- An array.
-
Uses template:
ContractDetailLineItemT.
- line_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Work Order Contract Line Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'purchase_order_contract_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
LineItemT.
- sov_status
Template: ShortText. The value is sent to
/work_order_contracts/{{=item.id}}/subcontractor_schedule_of_values_statusaddress.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/direct_costs.Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#list-direct-cost-items.
- [Read single] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/direct_costs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#show-direct-cost-item.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs.The following request parameters will be automatically processed:
-
application/json:
{{={ attachments: item.attachments, item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#create-direct-cost-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ attachments: item.attachments, item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#update-direct-cost-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#delete-direct-cost-item.
- id
A key field. Template: Id.
- amount
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- direct_cost_type
Template: ShortText.
- direct_cost_date
Template: Date.
- grand_total
Data type: DT_R8
- invoice_number
Template: ShortText.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- payment_date
Template: Date.
- received_date
Template: Date.
- status
Template: ShortText.
- terms
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- vendor
Template: ShortText.
- vendor_id
Template: Id.
- vendor_name
Template: ShortText.
- currency_configuration
Template: CurrencyConfigurationT. A read-only field.
- employee_id
Template: Id.
- employee
Template: RefT. A read-only field.
- attachments
Template: LongText. A composite field.
- line_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Direct Cost Line Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'direct_cost_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
LineItemT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/direct_costs/{{=parameters.direct_cost_id}}/line_items.The action has the following user-defined parameters:
- direct_cost_id: Required. Specify direct cost identifier.
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#list-direct-cost-line-items.
- [Read single] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}/direct_costs/{{=parameters.direct_cost_id}}/line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- direct_cost_id: Required. Specify direct cost identifier.
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#show-direct-cost-line-item.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs/{{=item.direct_cost_id}}/line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#create-direct-cost-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs/{{=item.direct_cost_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#update-direct-cost-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/direct_costs/{{=item.direct_cost_id}}/line_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/direct-costs#delete-a-direct-cost-line-item.
The resource includes the fields from the LineItemT template.
- direct_cost_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/prime_contracts/{{=Procore.UI.PrimeContractEditor.getValue(parameters)}}/payment_applications.The action has the following user-defined parameters:
- prime_contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/payment-applications-owner-invoices#list-payment-applications-owner-invoices-for-prime-contract.
- [Read single] action
-
Endpoint URL address:
/payment_applications/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/payment-applications-owner-invoices#show-payment-application-owner-invoice.
-
project_id:
- [Read project] action
-
Endpoint URL address:
/payment_applications.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/payment-applications-owner-invoices#list-payment-applications-owner-invoices-for-a-project.
- [Create] action
-
Endpoint URL address:
/prime_contracts/{{=item.prime_contract_id}}/payment_applications.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, payment_application: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/payment-applications-owner-invoices#create-payment-application-owner-invoice-for-prime-contract.
-
application/json:
- [Update] action
-
Endpoint URL address:
/prime_contracts/{{=item.prime_contract_id}}/payment_applications/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, payment_application: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/payment-applications-owner-invoices#update-payment-application-owner-invoice-for-prime-contract.
-
application/json:
The resource includes the fields from the PaymentApplicationT template.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- prime_contract_id
A key field. Template: Id.
- commitment_billing_period_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/prime_contracts/{{=Procore.UI.PrimeContractEditor.getValue(parameters)}}/line_items.The action has the following user-defined parameters:
- prime_contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contract-line-items#list-prime-contract-line-items.
- [Read single] action
-
Endpoint URL address:
/prime_contracts/{{=Procore.UI.PrimeContractEditor.getValue(parameters)}}/line_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- prime_contract_id: Required. Specify prime contract identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contract-line-items#show-prime-contract-line-item.
- [Create] action
-
Endpoint URL address:
/prime_contracts/{{=item.prime_contract_id}}/line_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contract-line-items#create-prime-contract-line-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/prime_contracts/{{=item.prime_contract_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, line_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contract-line-items#update-prime-contract-line-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/prime_contracts/{{=item.prime_contract_id}}/line_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contract-line-items#delete-a-prime-contract-line-item.
-
project_id:
The resource includes the fields from the LineItemT template.
- prime_contract_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/prime_contracts.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#list-all-prime-contracts.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/prime_contract/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#show-prime-contract.
-
project_id:
- [Read first] action
-
Endpoint URL address:
/prime_contract.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#show-first-prime-contract.
-
project_id:
- [Create] action
-
Endpoint URL address:
/prime_contract.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, prime_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#create-prime-contract.
-
application/json:
- [Update] action
-
Endpoint URL address:
/prime_contract/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, prime_contract: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#update-prime-contract.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/prime_contract/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/prime-contracts#delete-prime-contract.
-
project_id:
- id
A key field. Template: Id.
- accounting_method
Template: ShortText.
- actual_completion_date
Template: Date.
- approval_letter_date
Template: Date.
- approved_change_orders
Template: ShortText.
- contract_date
Template: Date.
- contract_estimated_completion_date
Template: Date.
- contract_start_date
Template: Date.
- contract_termination_date
Template: Date.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- executed
Data type: DT_BOOL
- execution_date
Template: Date.
- exclusions
Template: ShortText.
- grand_total
Data type: DT_R8
- inclusions
Template: ShortText.
- issued_on_date
Template: Date.
- letter_of_intent_date
Template: Date.
- number
Template: ShortText.
- origin_code
Template: ShortText.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- private
Data type: DT_BOOL
- retainage_percent
Data type: DT_R8
- returned_date
Template: Date.
- signed_contract_received_date
Template: Date.
- show_line_items_to_non_admins
Data type: DT_BOOL
- status
Template: ShortText.
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- architect_id
Template: Id.
- architect
Template: UserRefT. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- contractor_id
Template: Id.
- contractor
Template: VendorT. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- vendor_id
Template: Id.
- vendor
Template: VendorT. A read-only field.
- line_items
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Prime Contract Line Item'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'prime_contract_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
LineItemT.
- payment_applications
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Payment Application'].getData({ parameters: ['company_id=' + parameters.company_id, 'project_id=' + parameters.project_id, 'prime_contract_id=' + item.id] })expression. Field components:- An array.
-
Uses template:
PaymentApplicationT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_codes.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tax-codes#list-tax-codes.
- [Read single] action
-
Endpoint URL address:
/tax_codes/{{=item.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tax-codes#show-tax-code.
- [Create] action
-
Endpoint URL address:
/tax_codes.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}} -
application/json:
{{={ tax_code: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tax-codes#create-tax-code.
-
company_id:
- [Update] action
-
Endpoint URL address:
/tax_codes/{{=item.id}}.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}} -
application/json:
{{={ tax_code: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tax-codes#update-tax-code.
-
company_id:
- id
A key field. Template: Id.
- code
Template: ShortText.
- description
Template: ShortText.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- rate1
Data type: DT_I4
- archived
Data type: DT_BOOL
- company_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tax-types#list-tax-types.
- [Read single] action
-
Endpoint URL address:
/tax_types/{{=item.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tax-types#show-tax-type.
- [Create] action
-
Endpoint URL address:
/tax_types.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}} -
application/json:
{{={ tax_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tax-types#create-tax-type.
-
company_id:
- [Update] action
-
Endpoint URL address:
/tax_types/{{=item.id}}.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}} -
application/json:
{{={ tax_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tax-types#update-tax-type.
-
company_id:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=parameters.company_id}}/uoms.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/units-of-measure#list-units-of-measure.
- [Read single] action
-
Endpoint URL address:
/companies/{{=parameters.company_id}}/uoms/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/units-of-measure#show-unit-of-measure.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/uoms.The following request parameters will be automatically processed:
-
application/json:
{{={ uom: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/units-of-measure#create-unit-of-measure.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/uoms/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ uom: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/units-of-measure#update-unit-of-measure.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/uoms/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/units-of-measure#delete-unit-of-measure.
- id
A key field. Template: Id.
- is_standard
Data type: DT_BOOL
- name
Template: ShortText.
- description
Template: ShortText.
- uom_category
Template: RefT.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/work_breakdown_structure/wbs_codes.Documentation: https://developers.procore.com/reference/rest/v1/codes#list-project-wbs-codes.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/work_breakdown_structure/wbs_codes.Documentation: https://developers.procore.com/reference/rest/v1/codes#create-a-wbs-code.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/work_breakdown_structure/wbs_codes/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/codes#update-a-wbs-code.
- id
A key field. Template: Id.
- flat_code
Template: ShortText.
- flat_name
Template: ShortText.
- description
Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- segment_items
Field components:
- An array.
-
Uses template:
SegmentItemT.
- wbs_pattern_id
Data type: DT_I4
Based on resource template BaseProjectNoPagination.
- [Read company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/work_breakdown_structure/segments/{{=Procore.UI.CompanySegmentEditor.getValue(parameters)}}/segment_items.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- segment_id: Required. Specify segment identfier.
Documentation: https://developers.procore.com/reference/rest/v1/segment-items#list-company-segment-items.
- [Read project] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/work_breakdown_structure/segments/{{=Procore.UI.ProjectSegmentEditor.getValue(parameters)}}/segment_items.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
- segment_id: Required. Specify segment identfier.
Documentation: https://developers.procore.com/reference/rest/v1/segment-items#list-project-segment-items.
- [Create] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=item.entity_id}}/work_breakdown_structure/segments/{{=item.segment_id}}/segment_items.The action has the following user-defined parameters:
- entity: Required. Specify entity type.
- [Update] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=item.entity_id}}/work_breakdown_structure/segments/{{=item.segment_id}}/segment_items/{{=item.id}}.The action has the following user-defined parameters:
- entity: Required. Specify entity type.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=item.entity_id}}/work_breakdown_structure/segments/{{=item.segment_id}}/segment_items/{{=item.id}}.The action has the following user-defined parameters:
- entity: Required. Specify entity type.
The resource includes the fields from the SegmentItemT template.
- entity_id
A key field. Template: Id.
- segment_id
A key field. Template: Id.
- segment_item_list_id
Template: Id.
Based on resource template NoPagination.
- [Read company] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/work_breakdown_structure/segments.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/segments#list-company-wbs-segments.
- [Read project] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/work_breakdown_structure/segments.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
Documentation: https://developers.procore.com/reference/rest/v1/segments#list-project-wbs-segments.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/work_breakdown_structure/segments.The following request parameters will be automatically processed:
-
application/json:
{{={ segment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/segments#create-a-company-wbs-segment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/work_breakdown_structure/segments/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ segment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/segments#update-company-wbs-segment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/work_breakdown_structure/segments/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/segments#delete-wbs-segment.
The resource includes the fields from the SegmentT template.
- selectable_tiers
Data type: DT_BOOL
- is_included_in_project_pattern
Data type: DT_BOOL
- tiered
Data type: DT_BOOL
- company_id
A key field. Template: Id.
- item_lists
A read-only field. The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/work_breakdown_structure/segments/{{=item.id}}/listsaddress. Field components:- An array.
-
Uses template:
RefT. - Contains the following components: segment_items_count, erp_integrated, available_to_use_on_new_projects.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/app_configurations.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/app-configurations#list-app-configurations.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/app_configurations/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/app-configurations#show-app-configuration.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/app_configurations.Documentation: https://developers.procore.com/reference/rest/v1/app-configurations#create-app-configuration.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/app_configurations/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/app-configurations#update-app-configuration.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/app_configurations/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/app-configurations#delete-app-configuration.
- id
A key field. Template: Id.
- title
Template: ShortText.
- created_by
Template: UserRefT.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- company_id
Template: Id.
- applies_to_all_projects
Data type: DT_BOOL
- applies_to_company
Data type: DT_BOOL
- app_installation_id
Template: Id.
- instance_configuration
Template: LongText. A composite field.
- project_ids
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/app_installations.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/app-installations#list-app-installations.
- [Read single] action
-
Endpoint URL address:
/app_installations/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/app-installations#show-app-installation.
- [Create] action
-
Endpoint URL address:
/app_installations.Documentation: https://developers.procore.com/reference/rest/v1/app-installations#create-app-installation.
- [Update] action
-
Endpoint URL address:
/app_installations/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/app-installations#update-app-installation.
- id
A key field. Template: Id.
- app_uid
Template: ShortText.
- status
Template: ShortText. A read-only field.
- installed_by
Template: ShortText. A read-only field.
- installed_at
Template: DateTime. A read-only field.
- uninstalled_at
Template: ShortText. A read-only field.
- uninstalled_by
Template: ShortText. A read-only field.
- manifest_url
Template: ShortText. A read-only field.
- developer_app
Template: LongText. A read-only field. A composite field.
- components
Template: LongText. A read-only field. A composite field.
- company_id
Template: Id.
- project_id
Template: Id.
- app_installation
Field components:
-
Uses template:
ShortText. - Contains the following components: status, installation_configuration.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/offices.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/company-offices#list-company-offices.
- [Read single] action
-
Endpoint URL address:
/offices/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/company-offices#show-company-office.
- [Create] action
-
Endpoint URL address:
/offices.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, office: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-offices#create-company-office.
-
application/json:
- [Update] action
-
Endpoint URL address:
/offices/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, office: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-offices#update-company-office.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/offices/{{=item.id}}.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}}
Documentation: https://developers.procore.com/reference/rest/v1/company-offices#delete-a-company-office.
-
company_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- address
Template: ShortText.
- city
Template: ShortText.
- state_code
Template: ShortText.
- country_code
Template: ShortText.
- zip
Template: ShortText.
- phone
Template: ShortText.
- fax
Template: ShortText.
- division
Template: ShortText.
- logo
Field components:
-
Uses template:
Id. - Contains the following components: id, name, url, filename.
-
Uses template:
- company_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/programs.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/programs#list-programs.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/programs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/programs#show-program.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/programs.The following request parameters will be automatically processed:
-
application/json:
{{={ program: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/programs#create-program.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/programs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ program: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/programs#update-program.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/programs/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/programs#delete-program.
- id
A key field. Template: Id.
- name
Template: ShortText.
- address_freeform
Template: ShortText.
- website
Template: ShortText.
- zip
Data type: DT_I4
- company_id
A key field. Template: Id.
Based on resource template CompanyType.
Based on resource template CompanyType.
Based on resource template CompanyType.
Based on resource template CompanyType.
- is_bidding_stage
Data type: DT_BOOL
- category
Template: ShortText.
Based on resource template CompanyType.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/insurances.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-insurances#list-company-insurances.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/insurances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-insurances#show-company-insurance.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/insurances.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-insurances#create-company-insurance.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/insurances/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-insurances#update-company-insurance.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/insurances/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-insurances#delete-company-insurance.
The resource includes the fields from the InsuranceT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/people.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-people#list-company-people.
- [Read inactive] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/people/inactive.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-inactive-people#list-inactive-company-people.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/people/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ person: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-people#update-company-person.
-
application/json:
The resource includes the fields from the PersonT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/users.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
filters[vendor_id]:
{{=Procore.getArrParameter(parameters.get('filters[vendor_id]'))}} -
filters[trade_id]:
{{=Procore.getArrParameter(parameters.get('filters[trade_id]'))}}
Documentation: https://developers.procore.com/reference/rest/v1/company-users#list-company-users.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/users/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-users#show-company-user.
- [Read inactive] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/users/inactive.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-inactive-users.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/users.The following request parameters will be automatically processed:
-
application/json:
{{={ user: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-users#create-company-user.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/users/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ user: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-users#update-company-user.
-
application/json:
The resource includes the fields from the UserT template.
- default_permission_template_id
Template: Id.
- company_permission_template_id
Template: Id.
- project_assignments
The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/users/{{=item.id}}/project_assignmentsaddress. Field components:- An array.
- Contains the following components: project_id, name, project_number, address, stage, is_assigned, active, roles, permission_template_name.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/vendors/{{=Procore.UI.CompanyVendorEditor.getValue(parameters)}}/insurances.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-vendor-insurances#list-company-vendor-insurances.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/vendors/{{=Procore.UI.CompanyVendorEditor.getValue(parameters)}}/insurances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-vendor-insurances#show-company-vendor-insurance.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/vendors/{{=item.vendor_id}}/insurances.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-vendor-insurances#create-company-vendor-insurance.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/vendors/{{=item.vendor_id}}/insurances/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-vendor-insurances#update-company-vendor-insurance.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/vendors/{{=item.vendor_id}}/insurances/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-vendor-insurances#delete-company-vendor-insurance.
The resource includes the fields from the InsuranceT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/vendors.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}} -
filters[trade_id]:
{{=Procore.getArrParameter(parameters.get('filters[trade_id]'))}} -
filters[parent_id]:
{{=Procore.getArrParameter(parameters.get('filters[parent_id]'))}}
Documentation: https://developers.procore.com/reference/rest/v1/company-vendors#list-company-vendors.
- [Read single] action
-
Endpoint URL address:
/vendors/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-vendors#show-company-vendor.
- [Read inactive] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/vendors/inactive.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-inactive-vendors.
- [Create] action
-
Endpoint URL address:
/vendors.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, vendor: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-vendors#create-company-vendor.
-
application/json:
- [Update] action
-
Endpoint URL address:
/vendors/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, vendor: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-vendors#update-company-vendor.
-
application/json:
The resource includes the fields from the VendorT template.
- company_id
A key field. Template: Id.
- vendor_group_id
Template: Id.
- parent_id
Template: Id.
- primary_contact_id
Template: Id.
- trade_ids
Template: LongText. A composite field.
- bidding_distribution_ids
Template: LongText. A composite field.
- standard_cost_code_ids
Template: LongText. A composite field.
- comments
The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/vendors/{{=item.id}}/commentsaddress. Field components:- An array.
- Contains the following components: id, body, created_at, rating, attachments, created_by.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/folders/{{=Procore.getFolderId(Procore.UI.CompanyEditor.getValue(parameters), parameters.get('path', ''))}}.
The result is extracted from:{{=response.folders}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- path: Specify path to retrieve list.
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#list-company-folders-and-files.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/folders.The following request parameters will be automatically processed:
-
application/json:
{{={ folder: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#create-company-folder.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/folders/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ folder: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#update-company-folder.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/folders/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#delete-company-folder.
The resource includes the fields from the FolderT template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/folders/{{=Procore.getFolderId(Procore.UI.CompanyEditor.getValue(parameters), parameters.get('path', ''))}}.
The result is extracted from:{{=response.files}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- path: Specify path to retrieve list.
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#list-company-folders-and-files.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/files/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#show-company-file.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/files.The following request parameters will be automatically processed:
-
application/json:
-
item:
{{={ file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#create-company-file.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/files/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
-
item:
{{={ file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#update-company-file.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/files/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-folders-and-files#delete-company-file.
The resource includes the fields from the FileT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/custom_field_metadata.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/custom-fields#list-custom-field-metadata.
The resource includes the fields from the CustomFieldMetadataT template.
- source_type
Template: ShortText.
- source_id
Template: Id.
- lov_entries
Field components:
- An array.
-
Uses template:
LOVEntryT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/custom_field_definitions.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/custom-fields#list-custom-field-definitions.
- id
A key field. Template: Id.
- label
Template: ShortText.
- active
Data type: DT_BOOL
- company_id
Template: Id.
- data_type
Template: ShortText.
- variant
Template: ShortText.
- description
Template: ShortText.
- default_value
Template: ShortText.
- configurable_field_sets_count
Data type: DT_I4
- custom_field_lov_entries
Field components:
- An array.
-
Uses template:
LOVEntryT.
- configurable_field_sets
The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/custom_field_definitions/{{=item.id}}/configurable_field_setsaddress. Field components:- An array.
-
Uses template:
ConfigurableFieldSetT.
Based on resource template Base.
- [Read company] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/configurable_field_sets.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/configurable-field-sets#list-configurable-field-sets.
- [Read project] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/configurable_field_sets.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/configurable-field-sets#list-project-configurable-field-sets.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/configurable_field_sets.The following request parameters will be automatically processed:
-
application/json:
{{={ configurable_field_set: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/configurable-field-sets#create-configurable-field-sets.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/configurable_field_sets/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ configurable_field_set: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/configurable-field-sets#update-configurable-field-set.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/configurable_field_sets/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/configurable-field-sets#delete-configurable-field-set.
The resource includes the fields from the ConfigurableFieldSetT template.
- company_id
A key field. Template: Id.
- project_ids
Template: LongText. A composite field.
- company_default
Data type: DT_BOOL
- company_configurable_field_set_default_column_name
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/cost_codes.Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#list-cost-codes.
- [Read single] action
-
Endpoint URL address:
/cost_codes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#show-cost-code.
- [Create] action
-
Endpoint URL address:
/cost_codes.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, sub_job_id: item.sub_job_id, configurable_field_set: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#create-cost-code.
-
application/json:
- [Update] action
-
Endpoint URL address:
/cost_codes/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, sub_job_id: item.sub_job_id, configurable_field_set: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#update-cost-code.
-
application/json:
The resource includes the fields from the CostCodeT template.
- sub_job_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/standard_cost_codes.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#list-standard-cost-codes.
- [Read single] action
-
Endpoint URL address:
/standard_cost_codes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#show-standard-cost-code.
- [Create] action
-
Endpoint URL address:
/standard_cost_codes.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, standard_cost_code_list_id: item.standard_cost_code_list_id, standard_cost_code: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#create-standard-cost-code.
-
application/json:
- [Update] action
-
Endpoint URL address:
/standard_cost_codes/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, standard_cost_code_list_id: item.standard_cost_code_list_id, standard_cost_code: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/cost-codes#update-standard-cost-code.
-
application/json:
The resource includes the fields from the CodeT template.
- standard_cost_code_list_id
A key field. Template: Id.
- parent_id
Template: Id.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- company_id
A key field. Template: Id.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/sub_jobs.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/sub-jobs#list-sub-jobs.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/sub_jobs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/sub-jobs#show-sub-job.
-
project_id:
- [Create] action
-
Endpoint URL address:
/sub_jobs.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, sub_job: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/sub-jobs#create-sub-job.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sub_jobs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, sub_job: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/sub-jobs#update-sub-job.
-
application/json:
The resource includes the fields from the SubJobT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/equipment.Documentation: https://developers.procore.com/reference/rest/v1/admin-equipment#list-equipment.
The resource includes the fields from the RefT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/departments.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/departments#list-departments.
- [Read single] action
-
Endpoint URL address:
/departments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
company_id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/departments#show-department.
- [Create] action
-
Endpoint URL address:
/departments.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, department: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/departments#create-department.
-
application/json:
- [Update] action
-
Endpoint URL address:
/departments/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, department: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/departments#update-department.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/departments/{{=item.id}}.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}}
Documentation: https://developers.procore.com/reference/rest/v1/departments#delete-department.
-
company_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- origin_data
Template: ShortText.
- origin_id
Template: ShortText.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/locations.Documentation: https://developers.procore.com/reference/rest/v1/locations#list-project-locations.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/locations/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/locations#show-project-location.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/locations.The following request parameters will be automatically processed:
-
application/json:
{{={ location: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/locations#create-location-admin.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/locations/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ location: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/locations#update-project-location.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/locations/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/locations#delete-project-location.
The resource includes the fields from the LocationT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/project_roles.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/project-roles#list-project-roles.
-
project_id:
- [Create] action
-
Endpoint URL address:
/project_roles.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, project_role: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-roles#create-project-role.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/project_roles/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/project-roles#delete-project-role.
-
project_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- role
Template: ShortText.
- user_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/people.Documentation: https://developers.procore.com/reference/rest/v1/project-people#list-project-people.
- [Read inactive] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/people/inactive.Documentation: https://developers.procore.com/reference/rest/v1/project-inactive-people#list-inactive-project-people.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/people.The following request parameters will be automatically processed:
-
application/json:
{{={ person: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-people#create-project-person.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/people/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ person: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-people#update-project-person.
-
application/json:
The resource includes the fields from the PersonT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/users.Documentation: https://developers.procore.com/reference/rest/v1/project-users#list-project-users.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/users/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/project-users#show-project-user.
- [Read inactive] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/users/inactive.Documentation: https://developers.procore.com/reference/rest/v1/project-inactive-users#list-project-inactive-users.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users.The following request parameters will be automatically processed:
-
application/json:
{{={ user: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-users#create-project-user.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ user: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-users#update-project-user.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/users/{{=item.id}}/actions/remove.Documentation: https://developers.procore.com/reference/rest/v1/project-users#remove-a-user-from-the-project.
The resource includes the fields from the UserT template.
- welcome_email_sent_at
Template: ShortText.
- permission_template
Template: PermissionTemplateT.
- company_permission_template
Template: PermissionTemplateT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/vendors/{{=Procore.UI.ProjectVendorEditor.getValue(parameters)}}/insurances.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developers.procore.com/reference/rest/v1/project-vendor-insurances#list-project-vendor-insurances.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/vendors/{{=Procore.UI.ProjectVendorEditor.getValue(parameters)}}/insurances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- vendor_id: Required. Specify vendor identifier.
Documentation: https://developers.procore.com/reference/rest/v1/project-vendor-insurances#show-project-vendor-insurance.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors/{{=item.vendor_id}}/insurances.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-vendor-insurances#create-project-vendor-insurance.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors/{{=item.vendor_id}}/insurances/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-vendor-insurances#update-project-vendor-insurance.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors/{{=item.vendor_id}}/insurances/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-vendor-insurances#delete-project-vendor-insurance.
The resource includes the fields from the InsuranceT template.
- project_id
A key field. Template: Id.
- vendor_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/vendors.Documentation: https://developers.procore.com/reference/rest/v1/project-vendors#list-project-vendors.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/vendors/{id}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/project-vendors#show-project-vendor.
- [Read inactive] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/vendors/inactive.Documentation: https://developers.procore.com/reference/rest/v1/project-inactive-vendors#list-project-inactive-vendors.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors.The following request parameters will be automatically processed:
-
application/json:
{{={ vendor: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-vendors#create-project-vendor.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ vendor: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-vendors#update-project-vendor.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/vendors/{{=item.id}}/actions/remove.Documentation: https://developers.procore.com/reference/rest/v1/project-vendors#delete-from-project.
The resource includes the fields from the VendorT template.
- business
Template: RefT. A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: dba, website, about, published, primary_slug, logo_url, source, addresses, provided_services, construction_sectors, business_types, project_types, classifications, coverage_areas.
-
Uses template:
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/insurances.Documentation: https://developers.procore.com/reference/rest/v1/project-insurances#list-project-insurances.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/insurances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/project-insurances#show-project-insurance.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/insurances.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-insurances#create-project-insurance.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/insurances/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ insurance: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-insurances#update-project-insurance.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/insurances/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-insurances#delete-project-insurance.
The resource includes the fields from the InsuranceT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/project_memberships.Documentation: https://developers.procore.com/reference/rest/v1/project-memberships#list-project-memberships.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/project_memberships.The following request parameters will be automatically processed:
-
application/json:
{{={ project_membership: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-memberships#create-project-membership.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/project_memberships/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-memberships#delete-project-membership.
- id
A key field. Template: Id.
- party_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/document_custom_tags.Documentation: https://developers.procore.com/reference/rest/v1/project-documents#list-project-document-custom-tags.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/document_custom_tags.The following request parameters will be automatically processed:
-
application/json:
{{={ document_id: item.document_id, document_custom_tag: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-documents#create-document-custom-tag.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/document_custom_tags/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-documents#delete-document-custom-tag.
The resource includes the fields from the RefT template.
- document_id
A key field. Template: Id.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=Procore.getFolderId(Procore.UI.CompanyEditor.getValue(parameters), parameters.get('path', ''), Procore.UI.ProjectEditor.getValue(parameters))}}.
The result is extracted from:{{=response.folders}}.The action has the following user-defined parameters:
- path: Specify path to retrieve list.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#list-project-folders-and-files.
- [Create] action
-
Endpoint URL address:
/folders.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ folder: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#create-project-folder.
-
project_id:
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ folder: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#update-project-folder.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#delete-project-folder.
-
project_id:
The resource includes the fields from the FolderT template.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=Procore.getFolderId(Procore.UI.CompanyEditor.getValue(parameters), parameters.get('path', ''), Procore.UI.ProjectEditor.getValue(parameters))}}.
The result is extracted from:{{=response.files}}.The action has the following user-defined parameters:
- path: Specify path to retrieve list.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#list-project-folders-and-files.
- [Read single] action
-
Endpoint URL address:
/files/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#show-project-file.
-
project_id:
- [Create] action
-
Endpoint URL address:
/files.The following request parameters will be automatically processed:
-
application/json:
-
project_id:
{{=item.project_id}} -
item:
{{={ file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#create-project-file.
-
application/json:
- [Update] action
-
Endpoint URL address:
/files/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
-
project_id:
{{=item.project_id}} -
item:
{{={ file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#update-project-file.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/files/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/project-folders-and-files#delete-project-file.
-
project_id:
The resource includes the fields from the FileT template.
- [External]
-
The external fields URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/configurable_field_sets. The external fields list is extracted from:{{=Procore.getCustomFields(response, 'Folder')}}.- Custom.{{=external.label}}
Data type: {{=Procore.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item.custom_fields[field.external.name].value}}expression.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/links.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/links#list-links.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/links/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/links#show-link.
-
project_id:
- [Read recycled] action
-
Endpoint URL address:
/links/recycle_bin.Documentation: https://developers.procore.com/reference/rest/v1/links#list-recycled-links.
- [Create] action
-
Endpoint URL address:
/links.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ link: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/links#create-link.
-
project_id:
- [Update] action
-
Endpoint URL address:
/links/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ link: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/links#update-link.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/links/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/links#delete-link.
-
project_id:
- id
A key field. Template: Id.
- title
Template: ShortText.
- url
Template: ShortText.
- deleted_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/task_item_comments.Documentation: https://developers.procore.com/reference/rest/v1/task-item-comments#list-task-item-comments.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/projects/{{=item.project_id}}/task_item_comments.The following request parameters will be automatically processed:
-
application/json:
{{={ task_item_comment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/task-item-comments#create-a-task-item-comment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/projects/{{=item.project_id}}/task_item_comments/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ task_item_comment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/task-item-comments#update-a-task-item-comment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/projects/{{=item.project_id}}/task_item_comments/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/task-item-comments#delete-a-task-item-comment.
- id
A key field. Template: Id.
- comment
Template: ShortText.
- status
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- created_by
Template: UserRefT. A read-only field.
- task_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/task_items.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/task-items#list-task-items.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/task_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/task-items#show-task-item.
-
project_id:
- [Create] action
-
Endpoint URL address:
/task_items.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ task_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/task-items#create-task-item.
-
project_id:
- [Update] action
-
Endpoint URL address:
/task_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ task_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/task-items#update-task-item.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/task_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/task-items#destroy-task-item.
-
project_id:
- id
A key field. Template: Id.
- number
Template: ShortText.
- date_notified
Template: Date.
- description
Template: ShortText.
- due_date
Template: DateTime.
- status
Template: ShortText.
- private
Data type: DT_BOOL
- task_item_category_id
Template: Id.
- task_item_category
Template: RefT. A read-only field.
- assignee
Template: UserRefT. A read-only field.
- title
Template: ShortText.
- assigned_id
Template: Id.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workflow_activity_histories.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- workflow_instance_id: Required. Specify workflow instance identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/workflow-activity-histories#list-workflow-activity-histories.
- [Read single] action
-
Endpoint URL address:
/workflow_activity_histories/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- workflow_instance_id: Required. Specify workflow instance identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/workflow-activity-histories#show-workflow-activity-history.
- [Create] action
-
Endpoint URL address:
/workflow_activity_histories.The following request parameters will be automatically processed:
-
company_id:
{{=item.company_id}} -
workflow_instance_id:
{{=item.workflow_instance_id}} -
application/json:
{{={ workflow_activity_history: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/workflow-activity-histories#create-workflow-activity-history.
-
company_id:
- id
A key field. Template: Id.
- attachments
Template: LongText. A composite field.
- bic_duration
Template: ShortText. A read-only field.
- bic_start
Template: DateTime. A read-only field.
- bic_end
Template: DateTime. A read-only field.
- comments
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- performed_by_id
Template: Id.
- performed_by_name
Template: ShortText. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- workflow_activity_id
Template: Id.
- workflow_activity_name
Template: ShortText. A read-only field.
- workflow_instance_id
Template: Id.
- workflow_user_role_id
Template: Id.
- workflow_user_role_name
Template: ShortText. A read-only field.
- workflow_state_id
Template: Id.
- workflow_state_name
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workflow_instances.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/workflow-instances#list-workflow-instances.
- [Read single] action
-
Endpoint URL address:
/workflow_instances/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/workflow-instances#show-workflow-instance.
- id
A key field. Template: Id.
- becomes_overdue_at
Template: DateTime.
- current_state_set_at
Template: DateTime.
- workflowed_object_id
Template: Id.
- workflowed_object_type
Template: ShortText.
- project
Template: RefT. A read-only field.
- current_workflow_activities
Field components:
- An array.
-
Uses template:
RefT. - Contains the following components: workflow_user_role, perform_activity.
- current_workflow_state
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: status.
-
Uses template:
- workflow
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: description, class_name, created_at, updated_at, domain.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/workflow_permanent_logs.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/workflow-permanent-logs#list-workflow-permanent-logs.
- id
A key field. Template: Id.
- activity
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- ball_in_court_duration
Template: ShortText.
- comments
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- performed_by
Template: ShortText.
- user_role
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/actual_production_quantities.Documentation: https://developers.procore.com/reference/rest/v1/actual-production-quantities#list-all-actual-production-quantities.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/actual_production_quantities/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/actual-production-quantities#show-actual-production-quantity.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/actual_production_quantities.The following request parameters will be automatically processed:
-
application/json:
{{={ actual_production_quantity: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/actual-production-quantities#create-actual-production-quantity.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/actual_production_quantities/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ actual_production_quantity: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/actual-production-quantities#update-actual-production-quantity.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/actual_production_quantities/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/actual-production-quantities#delete-actual-production-quantity.
- id
A key field. Template: Id.
- unit_of_measure
Template: ShortText.
- quantity
Data type: DT_R8
- timesheet_id
Template: Id.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- crew_id
Template: Id.
- crew
Template: CrewT. A read-only field.
- sub_job_id
Template: Id.
- sub_job
Template: SubJobT. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- cost_code_id
Template: Id.
- cost_code
Template: BaseCostCodeT. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- date
Template: Date.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/budgeted_production_quantities.Documentation: https://developers.procore.com/reference/rest/v1/budgeted-production-quantities#list-all-project-budgeted-production-quantities.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/budgeted_production_quantities/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/budgeted-production-quantities#show-a-budgeted-production-quantity.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budgeted_production_quantities.The following request parameters will be automatically processed:
-
application/json:
{{={ budgeted_production_quantity: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budgeted-production-quantities#create-a-new-budgeted-production-quantity.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budgeted_production_quantities/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ budgeted_production_quantity: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/budgeted-production-quantities#update-a-budgeted-production-quantity.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/budgeted_production_quantities/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/budgeted-production-quantities#delete-a-budgeted-production-quantity.
- id
A key field. Template: Id.
- unit_of_measure
Template: ShortText.
- cost_code_id
Template: Id.
- cost_code
Template: BaseCostCodeT. A read-only field.
- quantity
Data type: DT_R8
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/field_production_report.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/field-production-report#list-field-production-report-summary.
-
project_id:
- cost_code_id
Template: Id.
- cost_code
Template: ShortText.
- budgeted_hours
Data type: DT_I4
- actual_hours
Data type: DT_R8
- remaining_hours
Data type: DT_R8
- hours_utilization
Template: ShortText.
- projected_hours_at_completion
Data type: DT_R8
- earned_hours
Data type: DT_I4
- budgeted_quantity
Data type: DT_I4
- actual_quantity
Data type: DT_I4
- remaining_quantities
Data type: DT_I4
- unit_of_measure
Template: ShortText.
- percent_complete
Template: ShortText.
- budgeted_production_rate
Data type: DT_I4
- actual_production_rate
Data type: DT_R8
- production_rate_variance
Data type: DT_R8
- is_budgeted
Template: ShortText.
- sub_job_name
Template: ShortText.
- sub_job_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_categories.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-category#list-all-equipment-categories.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_categories/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-category#show-an-equipment-category.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_categories.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-category#create-equipment-category.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_categories/{{item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-category#update-equipment-category.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_categories/{{item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-category#delete-equipment-category.
The resource includes the fields from the EquipmentEntityT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment_logs.Documentation: https://developers.procore.com/reference/rest/v1/equipment-log#list-project-equipment-logs.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment_logs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-log#show-an-project-equipment-log.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_logs.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-log#create-an-project-equipment-log.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_logs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-log#update-an-project-equipment-log.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_logs/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-log#delete-an-project-equipment-log.
- id
A key field. Template: Id.
- managed_equipment_id
Template: Id.
- onsite
Template: Date.
- offsite
Template: Date.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT.
- formatted_offsite
Template: ShortText. A read-only field.
- formatted_onsite
Template: ShortText. A read-only field.
- responsible_contractor
Template: ShortText.
- inspection_date
Template: Date.
- induction_checklist_list_id
Template: Id.
- induction_number
Template: ShortText.
- induction_status
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment_maintenance_logs.Documentation: https://developers.procore.com/reference/rest/v1/equipment-maintenance-log#list-project-equipment-maintenance-logs.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment_maintenance_logs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-maintenance-log#show-project-equipment-maintenance-log.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_maintenance_logs.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_maintenance_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-maintenance-log#create-project-equipment-maintenance-log.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_maintenance_logs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_maintenance_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-maintenance-log#update-project-equipment-maintenance-log.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment_maintenance_logs/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-maintenance-log#delete-project-equipment-maintenance-log.
- id
A key field. Template: Id.
- managed_equipment_id
Template: Id.
- last_service_date
Template: Date.
- next_service_date
Template: Date.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_makes.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-make#list-all-equipment-makes.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_makes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-make#show-an-equipment-make.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_makes.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_make: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-make#create-an-equipment-make.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_makes/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_make: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-make#update-an-equipment-make.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_makes/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-make#delete-an-equipment-make.
The resource includes the fields from the EquipmentEntityT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_models.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-model#list-all-equipment-models.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_models/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-model#show-an-equipment-model.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_models.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_model: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-model#create-an-equipment-model.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_models/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_model: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-model#update-an-equipment-model.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_models/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-model#delete-an-equipment-model.
The resource includes the fields from the EquipmentEntityT template.
- managed_equipment_make_id
Template: Id.
- managed_equipment_make
Template: EquipmentEntityT. A read-only field.
- managed_equipment_type_id
Template: Id.
- managed_equipment_type
Template: EquipmentEntityT. A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: managed_equipment_category_id, managed_equipment_category.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-type#list-all-equipment-types.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/equipment-type#show-an-equipment-type.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_types.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-type#create-an-equipment-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/equipment-type#update-an-equipment-type.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment_types/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/equipment-type#delete-a-equipment-type.
The resource includes the fields from the EquipmentEntityT template.
- managed_equipment_category_id
Template: Id.
- managed_equipment_category
Template: EquipmentEntityT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#list-all-equipment.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#show-equipment.
- [Read search] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment/query.
The action uses POST method.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- search_keyword: Required. Specify keyword.
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#search-all-equipment.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#create-equipment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#update-equipment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/managed_equipment/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---company-level#delete-equipment.
The resource includes the fields from the ManagedEquipmentT template.
- change_history
A read-only field. The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/managed_equipment/{{=item.id}}/change_historyaddress. Field components:- An array.
- Contains the following components: column, created_at, created_by, new_value, old_value.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment.Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#list-all-equipment.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#show-equipment.
- [Read search] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/managed_equipment/search.
The action uses POST method.Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#search-all-equipment.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#create-a-new-equipment.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ managed_equipment: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#update-an-equipment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/managed_equipment/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/managed-equipment---project-level#delete-an-equipment.
The resource includes the fields from the ManagedEquipmentT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/materials.Documentation: https://developers.procore.com/reference/rest/v1/material#list-materials.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/materials/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/material#show-material.
- [Create] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/materials/bulk_create.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}} -
application/json:
{{={ time_and_material_materials: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/material#bulk-create-materials.
- [Update] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/materials/bulk_update.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}} -
application/json:
{{={ time_and_material_materials: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/material#bulk-update-materials.
- [Delete] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/materials/bulk_destroy.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}} -
application/json:
{{={ time_and_material_materials: { time_and_material_materials_ids: _.pluck(batch, 'id') } } }}
Documentation: https://developers.procore.com/reference/rest/v1/material#bulk-delete-materials.
The resource includes the fields from the MaterialT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entry_attachments.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-attachment#list-all-attachments.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entry_attachments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-attachment#show-an-individual-time-and-material-attachment.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entry_attachments/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-attachment#delete-a-time-and-material-attachment.
The resource includes the fields from the AttachmentT template.
- presentation_url
Template: ShortText.
- thumbnail_url
Template: ShortText.
- content
Data type: DT_IMAGE The value is gathered from
{{=item.url}}address.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entries.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#list-all-time-and-material-entry.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entries/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#show-time-and-material-entry.
- [Read search] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entries/search.
The action uses POST method.The action has the following user-defined parameters:
- search_keyword: Required. Specify keyword.
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#list-all-time-and-material-entry-matching-the-search-keyword.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entries.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_entry: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#create-a-new-time-and-material-entry.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entries/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_entry: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#update-a-time-and-material-entry.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entries/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-entry#delete-a-time-and-material-entry.
- id
A key field. Template: Id.
- name
Template: ShortText.
- reference_number
Template: ShortText.
- description
Template: ShortText.
- status
Template: ShortText.
- private
Data type: DT_BOOL
- number
Data type: DT_I4
- customer_signature_id
Template: Id.
- company_signature_id
Template: Id.
- location_id
Template: Id.
- customer_id
Template: Id.
- work_performed_on_date
Template: DateTime.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- created_by_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_equipment_logs.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-equipment-log#list-of-all-time-and-material-equipment-logs.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_equipment_logs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-equipment-log#show-time-and-material-equipment-log.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_equipment_logs.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_equipment_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-equipment-log#create-a-new-time-and-material-equipment-log.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_equipment_logs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_equipment_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-equipment-log#update-a-time-and-material-equipment-log.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_equipment_logs/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-equipment-log#delete-a-time-and-material-equipment-log.
The resource includes the fields from the MaterialT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entries/signatures.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-signature#list-signatures.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_entries/signatures/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-signature#show-a-signature.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entries/signatures.The following request parameters will be automatically processed:
-
application/json:
{{={ signature: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-signature#create-signature-for-time-and-material-entry.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_entries/signatures/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-signature#delete-signature.
The resource includes the fields from the SignatureT template.
- user_id
Template: Id.
- data
Data type: DT_IMAGE The value is gathered from
{{=item.url}}address. Before setting, the value is processed with{{=Convert.ToBase64String(value.readAll())}}expression.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_timecards.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-timecard#list-time-and-material-timecards.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/time_and_material_timecards/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-timecard#show-time-and-material-timecard.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_timecards.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_timecard: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-timecard#create-time-and-material-timecard.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_timecards/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ time_and_material_timecard: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-timecard#update-time-and-material-timecard.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/time_and_material_timecards/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/time-and-material-timecard#delete-time-and-material-timecard.
- id
A key field. Template: Id.
- hours_worked
Data type: DT_R8
- time_and_material_entry_id
Template: Id.
- timecard_time_type_id
Template: Id.
- work_classification_id
Template: Id.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- login_information_id
Template: Id.
- login_information
Template: UserRefT. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/gps_positions.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/gps-positions#list-gps-positions.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/gps_positions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/gps-positions#show-gps-position.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/gps_positions.The following request parameters will be automatically processed:
-
application/json:
{{={ gps_position: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/gps-positions#create-gps-position.
-
application/json:
- id
A key field. Template: Id.
- company_id
A key field. Template: Id.
- latitude
Data type: DT_R8
- longitude
Data type: DT_R8
- altitude
Data type: DT_I4
- horizontal_accuracy
Data type: DT_I4
- vertical_accuracy
Data type: DT_I4
- timestamp
Template: DateTime.
- created_by
Template: UserRefT. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/timecard_entries.Documentation: https://developers.procore.com/reference/rest/v1/timecard-entries#list-timecard-entries-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/timecard_entries/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/timecard-entries#show-timecard-entry-project.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/timecard_entries.The following request parameters will be automatically processed:
-
application/json:
{{={ timecard_entry: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/timecard-entries#create-timecard-entry-project.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/timecard_entries/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ timecard_entry: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/timecard-entries#update-timecard-entry-project.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/timecard_entries/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/timecard-entries#delete-timecard-entry-project.
- id
A key field. Template: Id.
- billable
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- date
Template: Date.
- datetime
Template: DateTime.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- hours
Data type: DT_R8
- timesheet_status
Template: ShortText.
- approval_status
Template: ShortText.
- lunch_time
Data type: DT_R8
- time_in
Template: DateTime.
- time_out
Template: DateTime.
- injured
Data type: DT_BOOL
- signed
Data type: DT_BOOL
- origin_id
Template: Id.
- origin_data
Template: ShortText.
- timesheet_id
Template: Id.
- timesheet
Template: RefT. A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, updated_at, date, number, created_by, status.
-
Uses template:
- updated_at
Template: DateTime. A read-only field.
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- crew
Template: CrewT. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- party
Template: RefT. A read-only field.
- procore_signature
Template: SignatureT. The value is sent to
/projects/{{=item.project_id}}/timecard_entries/{{=item.id}}/signaddress.- sub_job_id
Template: Id.
- sub_job
Template: RefT. A read-only field. Field components:
- Contains the following components: code.
- created_by
Template: UserRefT. A read-only field.
- login_information_id
Template: Id.
- login_information
Template: UserRefT. A read-only field.
- timecard_time_type_id
Template: Id.
- timecard_time_type
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, abbreviated_time_type, company_id, global, time_type.
-
Uses template:
- line_item_type_id
Template: Id.
- custom_fields
Template: LongText. A composite field.
- [External]
-
The external fields URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/configurable_field_sets. The external fields list is extracted from:{{=Procore.getCustomFields(response, 'ProjectTimesheetTimecardEntry')}}.- Custom.{{=external.label}}
Data type: {{=Procore.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item.custom_fields[field.external.name].value}}expression.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/timesheets/filters/{{=parameters.type}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- type: Required. Specify type.
- key
Data type: DT_I4
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/work_classifications.Documentation: https://developers.procore.com/reference/rest/v1/work-classification---project-level#list-all-classifications.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/work_classifications/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/work-classification---project-level#show-classification.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/work_classifications.The following request parameters will be automatically processed:
-
application/json:
{{={ work_classification: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-classification---project-level#create-a-new-classification.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/work_classifications/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ work_classification: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/work-classification---project-level#update-a-classification.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/work_classifications/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/work-classification---project-level#delete-a-classification.
- id
A key field. Template: Id.
- name
Template: ShortText.
- abbreviation
Template: ShortText.
- company_visible
Data type: DT_BOOL A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- created_by_id
Template: Id. A read-only field.
- project_ids
Template: LongText. A read-only field. A composite field.
- is_active
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/pdf_template_configs.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/pdf-template-configs#list-pdf-template-configs.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/pdf_template_configs/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/pdf-template-configs#return-a-pdf-template-config.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/pdf_template_configs.The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}} -
application/json:
{{={ pdf_template_config: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/pdf-template-configs#create-pdf-template-config.
-
Procore-Company-Id:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/pdf_template_configs/{{=item.id}}/update_default_project.The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}} -
application/json:
{{={ pdf_template_config: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/pdf-template-configs#update-a-pdf-template-config.
-
Procore-Company-Id:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/pdf_template_configs/{{=item.id}}.The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}}
Documentation: https://developers.procore.com/reference/rest/v1/pdf-template-configs#delete-pdf-template-config.
-
Procore-Company-Id:
- id
A key field. Template: Id.
- description
Template: ShortText.
- template_name
Template: ShortText.
- default_project
Data type: DT_BOOL
- pdf_config_options
Field components:
- Contains the following components: collapse_na_sections, show_na_items, show_status_change, show_activity_details, disclaimer_footer_text, attendees_table_format, attendees_phone_number_display.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bid_contacts.Documentation: https://developers.procore.com/reference/rest/v1/bid-contacts#list-bid-contacts.
- id
A key field. Template: Id.
- address
Template: ShortText.
- avatar
Template: ShortText.
- business_id
Template: ShortText.
- business_phone
Template: ShortText.
- business_phone_extension
Data type: DT_I4
- city
Template: ShortText.
- contact_id
Template: Id.
- country_code
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- email_address
Template: ShortText.
- email_signature
Template: ShortText.
- employee_id
Template: ShortText.
- erp_integrated_accountant
Data type: DT_BOOL
- fax_number
Template: ShortText.
- first_name
Template: ShortText.
- initials
Template: ShortText.
- is_active
Data type: DT_BOOL
- is_employee
Data type: DT_BOOL
- job_title
Template: ShortText.
- last_login_at
Template: DateTime. A read-only field.
- last_name
Template: ShortText.
- mobile_phone
Template: ShortText.
- name
Template: ShortText.
- notes
Template: ShortText.
- origin_id
Template: ShortText.
- origin_data
Template: ShortText.
- state_code
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- welcome_email_sent_at
Template: DateTime. A read-only field.
- zip
Template: ShortText.
- work_classification_id
Template: Id.
- permission_template
Template: PermissionTemplateT.
- company_permission_template
Template: PermissionTemplateT.
- vendor
Template: RefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bid_packages/{{=Procore.UI.BidPackageEditor.getValue(parameters)}}/bid_forms.The action has the following user-defined parameters:
- bid_package_id: Required. Specify bid package identifier.
Documentation: https://developers.procore.com/reference/rest/v1/bid-forms#index-bid-forms.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/bid_packages/{{=item.bid_package_id}}/bid_forms.Documentation: https://developers.procore.com/reference/rest/v1/bid-forms#create-a-bid-form.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/bid_packages/{{=item.bid_package_id}}/bid_forms/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/bid-forms#update-bid-form.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/bid_packages/{{=item.bid_package_id}}/bid_forms/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/bid-forms#delete-bid-form.
- id
A key field. Template: Id.
- title
Template: ShortText.
- bid_package_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bids.Documentation: https://developers.procore.com/reference/rest/v1/bids#list-bids-within-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bids/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/bids#show-a-bid-within-a-project.
- [Read package] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bid_packages/{{=Procore.UI.BidPackageEditor.getValue(parameters)}}/bids.The action has the following user-defined parameters:
- bid_package_id: Required. Specify bid package identifier.
Documentation: https://developers.procore.com/reference/rest/v1/bids#list-bids-within-a-bid-package.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/bid_packages/{{=item.bid_package_id}}/bids.The following request parameters will be automatically processed:
-
application/json:
{{={ bid: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bids#create-bid.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/bid_packages/{{=item.bid_package_id}}/bids/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ bid: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bids#update-a-bid-from-a-bid-package.
-
application/json:
- id
A key field. Template: Id.
- bid_package_id
A key field. Template: Id.
- bid_package_title
Template: ShortText.
- bid_form_title
Template: ShortText.
- bid_status
Template: ShortText.
- awarded
Data type: DT_BOOL
- invitation_last_sent_at
Template: DateTime. A read-only field.
- is_bidder_committed
Data type: DT_BOOL
- lump_sum_amount
Data type: DT_R8
- lump_sum_enabled
Data type: DT_BOOL
- submitted
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- due_date
Template: DateTime.
- bidder_comments
Template: ShortText.
- bid_requester
Field components:
-
Uses template:
ShortText. - Contains the following components: company, contact, company_address, company_phone, company_website, email_address, first_name, last_name, mobile_phone, vendor_address, business_phone, fax_number.
-
Uses template:
- vendor_id
Template: Id.
- vendor
Template: RefT. A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: avatar_url, trades.
-
Uses template:
- project
Field components:
-
Uses template:
ShortText. - Contains the following components: name, address.
-
Uses template:
- recipient_ids
Template: LongText. A composite field.
- uploads
A read-only field. The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/bids/{{=item.id}}/uploadsaddress. Field components:- An array.
-
Uses template:
RefT. - Contains the following components: created_at, expired, links, uuid, url, fields.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/bid_packages.Documentation: https://developers.procore.com/reference/rest/v1/project-bid-packages#list-bid-packages.
- id
A key field. Template: Id.
- bid_due_date
Template: DateTime.
- number
Data type: DT_I4
- title
Template: ShortText.
- submitted_bids_count
Data type: DT_I4
- documents
The value is gathered from
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/planroom/bid_packages/{{=item.id}}/documentsaddress. The gathered value is processed with{{=response.files}}expression. Field components:- An array.
- Contains the following components: size, file_path, s3_source, type, drawing.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/coordination_issue_activities.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issue-activities#list-coordination-issue-activities.
-
project_id:
- id
A key field. Template: Id.
- coordination_issue_id
Template: Id.
- type
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/coordination_issue_activities/feed.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issue-activity-feed#list-coordination-issue-activity-feed-items.
-
project_id:
- id
A key field. Template: Id.
- coordination_issue_id
Template: Id.
- type
Template: ShortText.
- details
Field components:
-
Uses template:
Id. - Contains the following components: id, old_assignee, new_assignee, comment, created_by.
-
Uses template:
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/coordination_issues/status_count.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issue-counts#list-grouped-coordination-issue-status-count.
-
project_id:
- group_by
Template: ShortText.
- group_id
Template: Id.
- group_label
Template: ShortText.
- open_count
Data type: DT_I4
- blocked_count
Data type: DT_I4
- unblocked_count
Data type: DT_I4
- ready_for_review_count
Data type: DT_I4
- moved_to_observation_count
Data type: DT_I4
- closed_count
Data type: DT_I4
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/coordination_issues/assignees.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issue-potential-assignees#list-coordination-issue-assignable-users.
-
project_id:
The resource includes the fields from the UserRefT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/coordination_issues.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#list-coordination-issues.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/coordination_issues/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#show-coordination-issue.
-
project_id:
- [Read deleted] action
-
Endpoint URL address:
/coordination_issues/recycle_bin.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issue-recycle-bin.
-
project_id:
- [Create] action
-
Endpoint URL address:
/coordination_issues.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, coordination_issue: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#create-coordination-issue.
-
application/json:
- [Update] action
-
Endpoint URL address:
/coordination_issues/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, coordination_issue: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#update-coordination-issue.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/coordination_issues/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#delete-coordination-issue.
-
project_id:
- id
A key field. Template: Id.
- uuid
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- status
Template: ShortText.
- issue_number
Data type: DT_I4
- creation_source
Template: ShortText.
- due_date
Template: ShortText.
- coordination_issue_file_id
Template: Id.
- coordination_issue_file
Template: FileT. A read-only field.
- bim_model_id
Template: Id.
- comments_count
Data type: DT_I4
- issue_type
Template: ShortText.
- priority
Template: ShortText.
- drawing_revision_id
Template: Id.
- drawing_revision
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, title.
-
Uses template:
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- origin
Field components:
-
Uses template:
ShortText. - Contains the following components: title, origin_id, origin_type, deep_link_url.
-
Uses template:
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- assignee
Template: UserRefT. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- updated_by
Template: UserRefT. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- viewpoints
Field components:
- An array.
-
Uses template:
ViewpointT.
- attachment_upload_uuids
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- linked_procore_items
Field components:
- An array.
- Contains the following components: id, coordination_issue_id, item_id, item_type, item_url, item_data.
- linked_drawings
Field components:
- An array.
- Contains the following components: id, title, url.
- linked_observation_items
Field components:
- An array.
- Contains the following components: id, number, personal, title, url, created_by_id.
- drawing_markup_preview_images
Field components:
- An array.
-
Uses template:
RefT. - Contains the following components: drawing_revision_id, content_type, url.
- custom_fields
Template: LongText. A composite field.
- change_history
A read-only field. The value is gathered from
/coordination_issues/{{=item.id}}/change_historyaddress. Field components:- An array.
- Contains the following components: id, column, readable_column, old_value, new_value, created_by, created_at.
- status_changes
A read-only field. The value is gathered from
/coordination_issues/{{=item.id}}/status_changesaddress. Field components:- An array.
- Contains the following components: id, coordination_issue_id, old_status, new_status, created_by_id, created_by, linked_rfi, linked_observation_item, created_at.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/generic_tool_items.The action has the following user-defined parameters:
- generic_tool_id: Required. Specify generic tool identifier.
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#list-generic-tool-items.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/generic_tools/{{=item.generic_tool_id}}/generic_tool_items.The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#create-generic-tool-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/generic_tool_items.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
- generic_tool_id: Required. Specify generic tool identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}} -
application/json:
{{={ generic_tool_items: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#batch-update-generic-tool-items.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/generic_tools/{{=item.generic_tool_id}}/generic_tool_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/correspondences#delete-generic-tool-item.
The resource includes the fields from the GenericToolItemT template.
- generic_tool_id
A key field. Template: Id.
- change_histories
A read-only field. The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/generic_tool_items/{{=item.id}}/change_historiesaddress. Field components:- An array.
- Contains the following components: id, column, readable_column, formatted_column, old_value, new_value, created_by, created_at.
- users_with_permission
A read-only field. The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/generic_tool_items/{{=item.id}}/users_with_permissionaddress. Field components:- An array.
-
Uses template:
UserRefT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/generic_tool_items/{{=parameters.generic_tool_item_id}}/generic_tool_item_responses.The action has the following user-defined parameters:
- generic_tool_id: Required. Specify generic tool identifier.
- generic_tool_item_id: Required. Specify generic tool item identifier.
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#list-responses-for-a-generic-tool-item.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/generic_tools/{{=item.generic_tool_id}}/generic_tool_items/{{=item.generic_tool_item_id}}/generic_tool_item_responses.The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool_item_response: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#create-generic-tool-item-response.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/generic_tools/{{=item.generic_tool_id}}/generic_tool_items/{{=item.generic_tool_item_id}}/generic_tool_item_responses/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool_item_response: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#update-generic-tool-item-response.
-
application/json:
- id
A key field. Template: Id.
- notes
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- official
Data type: DT_BOOL
- position
Data type: DT_I4 A read-only field.
- status
Template: ShortText. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- generic_tool_id
A key field. Template: Id.
- generic_tool_item_id
A key field. Template: Id.
- skip_emails
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/correspondence_type_items.Documentation: https://developers.procore.com/reference/rest/v1/correspondences#list-correspondence-type-items.
- [Update] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/correspondence_type_items.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool_items: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#batch-update-correspondence-type-items.
The resource includes the fields from the GenericToolItemT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/generic_tools.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#list-generic-tools.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/generic_tools.The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#create-generic-tool.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/generic_tools/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/correspondences#update-generic-tool.
- id
A key field. Template: Id.
- domain_id
Template: Id.
- title
Template: ShortText.
- abbreviation
Template: ShortText.
- private_by_default
Data type: DT_BOOL
- company_id
A key field. Template: Id.
- new_project_default
Data type: DT_BOOL
- send_overdue_notifications
Data type: DT_BOOL
- available_read_users
The value is gathered from
/projects/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/generic_tools/{{=item.id}}/generic_tool_items/available_read_usersaddress. Field components:- An array.
-
Uses template:
UserRefT.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/generic_tools/{{=Procore.UI.GenericToolEditor.getValue(parameters)}}/statuses.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- generic_tool_id: Required. Specify generic tool identifier.
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#list-statuses-for-a-generic-tool.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/generic_tools/{{=item.generic_tool_id}}/statuses.The following request parameters will be automatically processed:
-
application/json:
{{={ generic_tool_status: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/correspondences#create-generic-tool-status.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/generic_tools/{{=item.generic_tool_id}}/statuses/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/correspondences#delete-generic-tool-status.
- id
A key field. Template: Id.
- status_name
Template: ShortText.
- status
Template: ShortText.
- company_id
A key field. Template: Id.
- generic_tool_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/crews.Documentation: https://developers.procore.com/reference/rest/v1/crews#list-all-project-crews.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/crews/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/crews#show-a-crew.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/crews.The following request parameters will be automatically processed:
-
application/json:
{{={ crew: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/crews#create-a-new-crew.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/crews/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ crew: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/crews#update-a-crew.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/crews/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/crews#delete-a-crew.
The resource includes the fields from the CrewT template.
- employee_ids
Template: LongText. A composite field.
Based on resource template Log.
- comments
Template: ShortText.
- involved_name
Template: ShortText.
- involved_company
Template: ShortText.
- time_hour
Data type: DT_I4
- time_minute
Data type: DT_I4
Based on resource template Log.
- hours_idle
Template: ShortText.
- hours_operating
Template: ShortText.
- inspected
Data type: DT_BOOL
- inspection_hour
Data type: DT_I4
- inspection_minute
Data type: DT_I4
- notes
Template: ShortText.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- equipment_id
Template: Id.
- equipment_name
Template: ShortText.
- equipment
Template: RefT. A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: project_id, position.
-
Uses template:
- custom_fields
Template: LongText. A composite field.
Based on resource template Log.
- apprentice_hours
Template: ShortText.
- first_year_hours
Template: ShortText.
- foreman_hours
Template: ShortText.
- journeyman_hours
Template: ShortText.
- local_city_hours
Template: ShortText.
- local_county_hours
Template: ShortText.
- minority_hours
Template: ShortText.
- notes
Template: ShortText.
- number_of_apprentice_workers
Data type: DT_I4
- number_of_foreman_workers
Data type: DT_I4
- number_of_journeyman_workers
Data type: DT_I4
- number_of_other_workers
Data type: DT_I4
- other_hours
Template: ShortText.
- status
Template: ShortText.
- veteran_hours
Template: ShortText.
- women_hours
Template: ShortText.
- vendor_id
Template: Id.
- vendor
Template: RefT. A read-only field.
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- custom_fields
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/daily_log_headers/index.Documentation: https://developers.procore.com/reference/rest/v1/daily-log-headers#get-daily-log-headers-for-the-project.
- id
A key field. Template: Id.
- log_date
Template: Date.
- log_datetime
Template: DateTime.
- completed
Data type: DT_BOOL
- completed_by
Template: UserRefT.
- completed_at
Template: DateTime.
- completable
Data type: DT_BOOL
- distributed
Data type: DT_BOOL
- distributed_by
Template: UserRefT.
- distributed_at
Template: DateTime.
- distributable
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/daily_logs/delay_log_types.Documentation: https://developers.procore.com/reference/rest/v1/delay-log-types#list-delay-log-types.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/daily_logs/delay_log_types.The following request parameters will be automatically processed:
-
application/json:
{{={ delay_log_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/delay-log-types#create-new-delay-log-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/daily_logs/delay_log_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ delay_log_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/delay-log-types#update-a-delay-log-type.
-
application/json:
- id
A key field. Template: Id.
- display_name
Template: ShortText.
- translation_key
Template: ShortText.
- visible
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Log.
- comments
Template: ShortText.
- delay_type
Template: ShortText.
- duration
Data type: DT_I4
- end_time
Template: ShortText.
- end_time_hour
Data type: DT_I4
- end_time_minute
Data type: DT_I4
- status
Template: ShortText.
- start_time_hour
Data type: DT_I4
- start_time_minute
Data type: DT_I4
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- daily_log_header_id
Template: Id.
Based on resource template Log.
- comments
Template: ShortText.
- contents
Template: ShortText.
- delivery_from
Data type: DT_I4
- status
Template: ShortText.
- time_hour
Data type: DT_I4
- time_minute
Data type: DT_I4
- tracking_number
Template: ShortText.
Based on resource template Log.
- comments
Template: ShortText.
- quantity_delivered
Data type: DT_I4
- quantity_removed
Data type: DT_I4
- vendor_id
Template: Id.
- vendor
Template: RefT. A read-only field.
Based on resource template Log.
- area
Template: ShortText.
- comments
Template: ShortText.
- end_hour
Data type: DT_I4
- end_minute
Data type: DT_I4
- inspecting_entity
Template: ShortText.
- inspection_type
Template: ShortText.
- inspector_name
Template: ShortText.
- start_hour
Data type: DT_I4
- start_minute
Data type: DT_I4
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
Based on resource template Log.
- man_hours
Template: ShortText.
- notes
Template: ShortText.
- num_workers
Data type: DT_I4
- num_hours
Template: ShortText.
- status
Template: ShortText.
- vendor
Template: RefT. A read-only field.
- user_id
Template: Id.
- user
Template: UserRefT. A read-only field.
- contact_id
Template: Id.
- contact
Template: RefT. A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: business_phone, business_phone_extension, email, fax_number, job_title, login_information_id, mobile_phone, vendor_name.
-
Uses template:
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- custom_fields
Template: LongText. A composite field.
Based on resource template Log.
- comment
Template: ShortText.
- daily_log_header_id
Template: Id.
- is_issue_day
Data type: DT_BOOL
- status
Template: ShortText.
- created_by_collaborator
Data type: DT_BOOL
- custom_fields
Template: LongText. A composite field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- psp_thread_joins
Template: LongText. A composite field.
Based on resource template Log.
- category
Template: ShortText.
- comments
Template: ShortText.
- plan_number
Template: ShortText.
- revision
Template: ShortText.
- title
Template: ShortText.
Based on resource template Log.
- company
Template: ShortText.
- contract
Template: ShortText.
- line_item_id
Template: Id.
- line_item_description
Template: ShortText.
- line_item_holder
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, title, number, type.
-
Uses template:
- notes
Template: ShortText.
- previously_delivered
Template: ShortText.
- previously_used
Template: ShortText.
- quantity_delivered
Template: ShortText.
- quantity_used
Template: ShortText.
Based on resource template Log.
- description
Template: ShortText.
- quantity
Data type: DT_I4
- unit
Template: ShortText.
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
Based on resource template Log.
- comments
Template: ShortText.
- compliance_due
Template: Date.
- issued_to
Template: ShortText.
- safety_notice
Template: ShortText.
- subject
Template: ShortText.
- time_hour
Data type: DT_I4
- time_minute
Data type: DT_I4
Based on resource template Log.
- begin_hour
Data type: DT_I4
- begin_minute
Data type: DT_I4
- details
Template: ShortText.
- end_hour
Data type: DT_I4
- end_minute
Data type: DT_I4
- status
Template: ShortText.
- subject
Template: ShortText.
- custom_fields
Template: LongText. A composite field.
Based on resource template Log.
- approximate_quantity
Data type: DT_I4
- description
Template: ShortText.
- disposal_location
Template: ShortText.
- material
Template: ShortText.
- method_of_disposal
Template: ShortText.
- time_hour
Data type: DT_I4
- time_minute
Data type: DT_I4
- vendor_id
Template: Id.
- vendor
Template: RefT. A read-only field.
Based on resource template Log.
- average
Data type: DT_I4
- calamity
Template: ShortText.
- comments
Template: ShortText.
- is_weather_delay
Data type: DT_I4
- ground
Template: ShortText.
- precipitation
Data type: DT_BOOL
- sky
Template: ShortText.
- temperature
Template: ShortText.
- time
Template: ShortText.
- wind
Template: ShortText.
- drawing_revision_ids
Template: LongText. A composite field.
- file_version_ids
Template: LongText. A composite field.
- form_ids
Template: LongText. A composite field.
- image_ids
Template: LongText. A composite field.
- upload_ids
Template: LongText. A composite field.
Based on resource template Log.
- comments
Template: ShortText.
- hourly_rate
Data type: DT_I4
- hours
Data type: DT_I4
- reimbursable
Data type: DT_BOOL
- resource_name
Template: ShortText.
- showed
Data type: DT_BOOL
- workers
Data type: DT_I4
- scheduled_tasks
A read-only field. Field components:
- An array.
- Contains the following components: id, work_log_id, task_name, task_percentage, task_id, task_row_number.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/drawing_areas.Documentation: https://developers.procore.com/reference/rest/v1/drawing-areas#list-drawing-areas.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/drawing_areas.Documentation: https://developers.procore.com/reference/rest/v1/drawing-areas#create-drawing-area.
- id
A key field. Template: Id.
- name
Template: ShortText.
- drawings_count
Data type: DT_I4 A read-only field.
- description
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/drawing_disciplines.Documentation: https://developers.procore.com/reference/rest/v1/drawing-disciplines#list-drawing-disciplines.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/drawing_disciplines/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/drawing-disciplines#update-drawing-discipline.
- id
A key field. Template: Id.
- name
Template: ShortText.
- position
Data type: DT_I4 A read-only field.
- abbreviations
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/drawing_uploads.Documentation: https://developers.procore.com/reference/rest/v1/drawings#list-drawing-uploads.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/drawing_uploads/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/drawings#show-drawing-upload.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/drawing_uploads.Documentation: https://developers.procore.com/reference/rest/v1/drawings#create-drawing-upload.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/drawing_uploads/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/drawings#delete-drawing-upload.
- id
A key field. Template: Id.
- created_by_id
Template: Id. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- error_email_sent
Data type: DT_BOOL
- notify_on_success
Data type: DT_BOOL
- deletion_in_progress
Data type: DT_BOOL
- success_email_sent
Data type: DT_BOOL
- drawing_area_id
Template: Id.
- status
Template: ShortText.
- pre_adaptive_complete
Data type: DT_BOOL
- drawing_number_contains_revision
Data type: DT_BOOL
- get_info_from_filename
Data type: DT_BOOL
- language
Template: ShortText.
- drawing_log_imports
Field components:
- An array.
- Contains the following components: id, filename, drawing_set_id, drawing_date, received_date, default_revision, drawing_id, custom_fields.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/drawing_areas/{{=parameters.drawing_area_id}}/drawings.The action has the following user-defined parameters:
- drawing_area_id: Required. Specify drawing area identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/drawings#list-drawings.
- [Create] action
-
Endpoint URL address:
/drawing_areas/{{=item.drawing_area_id}}/drawings.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ drawing: _.extend({ drawing_discipline: { name: item.discipline } }, item) } }}
Documentation: https://developers.procore.com/reference/rest/v1/drawings#create-drawing.
-
project_id:
- [Update] action
-
Endpoint URL address:
/drawing_areas/{{=item.drawing_area_id}}/drawings/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ drawing: _.extend({ drawing_discipline: { name: item.discipline } }, item) } }}
Documentation: https://developers.procore.com/reference/rest/v1/drawings#update-drawing.
-
project_id:
- id
A key field. Template: Id.
- discipline
Template: ShortText.
- number
Template: ShortText.
- title
Template: ShortText.
- obsolete
Data type: DT_BOOL
- current_revision
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, floorplan, has_drawing_sketches, pdf_size, pdf_url, png_size, png_url, revision_number, thumbnail_url, large_thumbnail_url, updated_at.
-
Uses template:
- drawing_area_id
A key field. Template: Id.
- ordered_revision_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/communication_tags.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/communication-tags#list-communication-tags.
-
project_id:
- [Create] action
-
Endpoint URL address:
/communication_tags.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ communication_tag: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/communication-tags#create-communication-tag.
-
project_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- title
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/project/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/email_communications/emails.
The result is extracted from:{{=response.emails}}.The action has the following user-defined parameters:
- topic_type: Required. Specify topic type.
- topic_id: Required. Specify topic identifier.
Documentation: https://developers.procore.com/reference/rest/v1/email-communications#list-of-emails.
- [Create] action
-
Endpoint URL address:
/project/{{=item.project_id}}/email_communications/{{=item.communication_id}}/emails.The following request parameters will be automatically processed:
-
application/json:
{{={ email: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/email-communications#create-email.
-
application/json:
- id
A key field. Template: Id.
- communication_id
A key field. Template: Id.
- subject
Template: ShortText.
- private
Data type: DT_BOOL
- prostore_file_ids
Template: LongText. A composite field.
- attachments
A read-only field. Field components:
- An array.
-
Uses template:
AttachmentT.
- bcc_distribution_ids
Template: LongText. A composite field.
- bcc_distribution
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- body
Template: ShortText.
- cc_distribution_ids
Template: LongText. A composite field.
- cc_distribution
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- distribution_ids
Template: LongText. A composite field.
- distribution
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- email_sent_at
Template: DateTime. A read-only field.
- login_information
Template: UserRefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/instruction_types.Documentation: https://developers.procore.com/reference/rest/v1/instruction-types#list-instruction-types-on-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/instruction_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/instruction-types#show-instruction-type.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instruction_types.The following request parameters will be automatically processed:
-
application/json:
{{={ instruction_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/instruction-types#create-instruction-types.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instruction_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ instruction_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/instruction-types#update-instruction-type.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instruction_types/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/instruction-types#delete-instruction-type.
- id
A key field. Template: Id.
- name
Template: ShortText.
- prefix
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/instructions.Documentation: https://developers.procore.com/reference/rest/v1/instructions#list-instructions-on-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/instructions/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/instructions#show-instruction.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instructions.The following request parameters will be automatically processed:
-
application/json:
{{={ instruction: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/instructions#create-instructions.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instructions/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ instruction: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/instructions#update-instruction.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/instructions/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/instructions#delete-instruction.
- id
A key field. Template: Id.
- number
Data type: DT_I4
- title
Template: ShortText.
- rich_text_description
Template: ShortText.
- plain_text_description
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- date_received
Template: Date.
- date_issued
Template: DateTime.
- status
Template: ShortText.
- private
Data type: DT_BOOL
- schedule_impact
Field components:
-
Uses template:
ShortText. - Contains the following components: status, value.
-
Uses template:
- cost_impact
Field components:
-
Uses template:
ShortText. - Contains the following components: status, value.
-
Uses template:
- instruction_type_id
Template: Id.
- instruction_from_id
Template: Id.
- instruction_type
Template: RefT. A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: prefix.
-
Uses template:
- created_by
Template: UserRefT. A read-only field.
- instruction_from
Template: UserRefT.
- distribution_member_ids
Template: LongText. A composite field.
- distribution_members
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- attention_ids
Template: LongText. A composite field.
- attentions
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- trade_ids
Template: LongText. A composite field.
- trades
A read-only field. Field components:
- An array.
-
Uses template:
TradeT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/meetings/{{=parameters.meeting_id}}.
The result is extracted from:{{=response.attendees}}.The action has the following user-defined parameters:
- meeting_id: Required. Specify meeting identifier.
Documentation: https://developers.procore.com/reference/rest/v1/meetings#show-meeting.
- [Create] action
-
Endpoint URL address:
/meeting_attendee_records.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
meeting_id:
{{=item.project_id}} -
application/json:
{{={ meeting_attendee_record: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-attendees#create-meeting-attendee-record.
-
project_id:
- [Update] action
-
Endpoint URL address:
/meeting_attendee_records/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
meeting_id:
{{=item.project_id}} -
application/json:
{{={ meeting_attendee_record: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-attendees#update-meeting-attendee-record.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/meeting_attendee_records/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
meeting_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-attendees#delete-meeting-attendee-record.
-
project_id:
The resource includes the fields from the UserRefT template.
- meeting_id
A key field. Template: Id.
- status
Template: ShortText.
- login_information_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/meeting_categories.The action has the following user-defined parameters:
- meeting_id: Required. Specify meeting identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-categories#list-meeting-categories.
- [Create] action
-
Endpoint URL address:
/meeting_categories.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, meeting_id: item.meeting_id, meeting_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-categories#create-meeting-category.
-
application/json:
- [Update] action
-
Endpoint URL address:
/meeting_categories/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, meeting_id: item.meeting_id, meeting_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-categories#update-meeting-category.
-
application/json:
- id
A key field. Template: Id.
- title
Template: ShortText.
- position
Data type: DT_I4
- meeting_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/meeting_templates.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/meeting-templates#list-meeting-templates.
- id
A key field. Template: Id.
- name
Template: ShortText.
- overview
Template: ShortText.
- private
Data type: DT_BOOL
- agendas
Field components:
- An array.
- Contains the following components: id, title, category, description, attachments.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/meetings/{{=parameters.meeting_id}}.
The result is extracted from:{{=function() { var category = _.find(response.meeting_categories, function(category) { return category.id == parameters.meeting_category_id; }); return category && category.meeting_topic || []; }()}}.The action has the following user-defined parameters:
- meeting_id: Required. Specify meeting identifier.
- meeting_category_id: Required. Specify meeting category identifier.
Documentation: https://developers.procore.com/reference/rest/v1/meetings#show-meeting.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/meeting_topics.The following request parameters will be automatically processed:
-
application/json:
{{={ meeting_id: item.meeting_id, meeting_topic: item, attachments: item.attachments } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-topics#create-meeting-topic.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/meeting_topics/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ meeting_id: item.meeting_id, meeting_topic: item, attachments: item.attachments } }}
Documentation: https://developers.procore.com/reference/rest/v1/meeting-topics#update-meeting-topic.
-
application/json:
The resource includes the fields from the MeetingTopicT template.
- meeting_id
A key field. Template: Id.
- meeting_category_id
Template: Id.
- assignment_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/meetings.
The result is extracted from:{{=response.meetings}}.Documentation: https://developers.procore.com/reference/rest/v1/meetings#list-meetings.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/meetings/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/meetings#show-meeting.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/meetings.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, meeting: item, attachments: item.attachments, prostore_file_ids: item.prostore_file_ids } }}
Documentation: https://developers.procore.com/reference/rest/v1/meetings#create-meeting.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/meetings/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, meeting: item, attachments: item.attachments, prostore_file_ids: item.prostore_file_ids } }}
Documentation: https://developers.procore.com/reference/rest/v1/meetings#update-meeting.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/meetings/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/meetings#delete-meeting.
- id
A key field. Template: Id.
- title
Template: ShortText.
- position
Data type: DT_I4 A read-only field.
- description
Template: ShortText.
- mode
Template: ShortText.
- starts_at
Template: DateTime.
- ends_at
Template: DateTime.
- parent_id
Data type: DT_I4
- location
Template: ShortText.
- meeting_topics_count
Data type: DT_I4
- occurred
Data type: DT_BOOL
- is_private
Data type: DT_BOOL
- minutes
Template: ShortText.
- overview
Template: ShortText.
- time_zone
Template: ShortText.
- conclusion
Template: ShortText.
- is_draft
Data type: DT_BOOL
- prostore_file_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_file_extractions.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-file-extractions#list-bim-file-extractions.
-
project_id:
- id
A key field. Template: Id.
- bim_file_upload_id
Template: Id.
- bim_file_upload
Field components:
-
Uses template:
Id. - Contains the following components: id, bim_file_id, document_upload_id, file_version, attachment, created_by, created_at, updated_at, metadata.
-
Uses template:
- bim_model_revision_id
Template: Id.
- status
Template: ShortText.
- progress
Data type: DT_R8
- retry_count
Data type: DT_I4
- extraction_format_requests
Field components:
- An array.
- extraction_items
Field components:
- An array.
- Contains the following components: id, bim_file_extraction_id, item_type, progress, artifact, error, created_at, updated_at.
- errors
Field components:
- An array.
-
Uses template:
ErrorT.
- created_by
Template: UserRefT. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_files.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-files#list-bim-files.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_files/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-files#show-bim-file.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_files.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-files#create-bim-file.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bim_files/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_file: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-files#update-bim-file.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_files/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-files#delete-bim-file.
-
project_id:
The resource includes the fields from the FileT template.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_levels.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-levels#list-bim-levels.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_levels/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-levels#show-bim-level.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_levels.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_level: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-levels#create-bim-level.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bim_levels/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_level: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-levels#update-bim-level.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_levels/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-levels#delete-bim-level.
-
project_id:
The resource includes the fields from the BIMLevelT template.
- bim_file
Template: FileT. A read-only field.
- location
Template: LocationT. A read-only field.
- created_by
Template: UserRefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_model_revision_plans.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revision-plans#list-bim-model-revision-plans.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_model_revision_plans/{{=paramerters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revision-plans#show-bim-model-revision-plan.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_model_revision_plans.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_model_revision_plan: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revision-plans#create-bim-model-revision-plan.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_model_revision_plans/{{=item.id{}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revision-plans#delete-bim-model-revision-plan.
-
project_id:
- id
A key field. Template: Id.
- bim_model_revision_id
Template: Id.
- bim_plan_id
Template: Id.
- bim_plan
Template: BIMPlanT. A read-only field.
- bim_level
Template: BIMLevelT.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- properties
A read-only field. The value is gathered from
/bim_model_revisions/{{=item.id}}/propertiesaddress. Field components:- An array.
- Contains the following components: object_id, category, name, typed_value, uom, value.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_model_revisions.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#list-bim-model-revisions.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_model_revisions/{{=parameters.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#show-bim-model-revision.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_model_revisions.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_model_revision: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#create-bim-model-revision.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bim_model_revisions/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_model_revision: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#update-bim-model-revision.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_model_revisions/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#delete-bim-model-revision.
-
project_id:
The resource includes the fields from the BIMModelRevisionT template.
- bim_file_id
Template: Id.
- home_viewpoint_id
Template: Id.
- published_model_upload_uuid
Template: ShortText.
- object_definition_upload_uuid
Template: ShortText.
- objects
A read-only field. The value is gathered from
/bim_model_revisions/{{=item.id}}/objectsaddress. Field components:- An array.
- Contains the following components: id, value.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_models.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-models#list-bim-models.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_models/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-models#show-bim-model.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_models.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_model: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-models#create-bim-model.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bim_models/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_model: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-models#update-bim-model.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_models/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-models#delete-bim-model.
-
project_id:
- id
A key field. Template: Id.
- title
Template: ShortText.
- revisions_count
Data type: DT_I4 A read-only field.
- web_url
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- current_revision
Template: BIMModelRevisionT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_plans.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-plans#list-bim-plans.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/bim_plans/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-plans#show-bim-plan.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_plans.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_plan: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-plans#create-bim-plan.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bim_plans/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, view: 'compact', bim_plan: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-plans#update-bim-plan.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bim_plans/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-plans#delete-bim-plan.
-
project_id:
The resource includes the fields from the BIMPlanT template.
- upload_uuid
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/bim_view_folders.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-view-folders#list-bim-view-folders.
-
project_id:
- [Create] action
-
Endpoint URL address:
/bim_view_folders.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_view_folder: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-view-folders#create-bim-view-folder.
-
application/json:
- id
A key field. Template: Id.
- name
Template: ShortText.
- parent_id
Template: Id.
- bim_file_id
Template: Id.
- created_by_id
Template: Id. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProjectNoPagination.
- [Read coordination-issue] action
-
Endpoint URL address:
/coordination_issues/{{=parameters.coordination_issue_id}}.
The result is extracted from:{{=response.viewpoints}}.The action has the following user-defined parameters:
- coordination_issue_id: Required. Specify coordination issue identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/coordination-issues#show-coordination-issue.
- [Read model-revision] action
-
Endpoint URL address:
/bim_model_revisions/{{=parameters.model_revision_id}}.
The result is extracted from:{{=response.viewpoints}}.The action has the following user-defined parameters:
- model_revision_id: Required. Specify model revision identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/bim-model-revisions#show-bim-model-revision.
- [Create] action
-
Endpoint URL address:
/bim_viewpoints.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, bim_viewpoint: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/bim-viewpoints#create-a-bim-viewpoint.
-
application/json:
The resource includes the fields from the ViewpointT template.
- upload_uuid
Template: ShortText.
- action
Field components:
- Contains the following components: associations.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/image_categories.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/image-categories#list-image-categories.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/image_categories/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/image-categories#show-image-category.
-
project_id:
- [Create] action
-
Endpoint URL address:
/image_categories.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ image_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/image-categories#create-image-category.
-
project_id:
- [Update] action
-
Endpoint URL address:
/image_categories/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ image_category: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/image-categories#update-image-category.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/image_categories/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/image-categories#delete-image-category.
-
project_id:
- id
A key field. Template: Id.
- count
Data type: DT_I4 A read-only field.
- cover_photo
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- links
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: show, delete, update.
-
Uses template:
- name
Template: ShortText.
- private
Data type: DT_BOOL
- updated_at
Template: DateTime. A read-only field.
- position
Data type: DT_I4 A read-only field.
- album_cover_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/images.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/images#list-images.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/images/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/images#show-image.
-
project_id:
- [Create] action
-
Endpoint URL address:
/images.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
-
item:
{{=item}} -
file:
{{=item.data}}
Documentation: https://developers.procore.com/reference/rest/v1/images#create-image.
-
project_id:
- [Update] action
-
Endpoint URL address:
/images/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ image: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/images#update-image.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/images/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/images#delete-image.
-
project_id:
- id
A key field. Template: Id.
- url
Template: ShortText. A read-only field.
- size
Data type: DT_I4 A read-only field.
- filename
Template: ShortText.
- description
Template: ShortText.
- thumbnail_url
Template: ShortText. A read-only field.
- taken_at
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- image_category_name
Template: ShortText.
- image_category_id
Template: Id.
- permanently_deleted
Data type: DT_BOOL
- private
Data type: DT_BOOL
- starred
Data type: DT_BOOL
- width
Data type: DT_I4
- height
Data type: DT_I4
- image_category_private
Data type: DT_BOOL
- origin_id
Data type: DT_I4
- daily_log_header_id
Template: Id.
- gps_lat
Template: ShortText.
- gps_long
Template: ShortText.
- uploader
Template: UserRefT.
- links
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: self, update, delete, permanentlyDelete, retrieve.
-
Uses template:
- trade_ids
Template: LongText. A composite field.
- trades
A read-only field. Field components:
- An array.
-
Uses template:
TradeT.
- comments_count
Data type: DT_I4 A read-only field.
- provider_type
Template: ShortText.
- provider_id
Template: Id.
- source
Template: ShortText.
- log_date
Template: Date.
- data
Data type: DT_IMAGE The value is gathered from
{{=item.url}}address.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/calendar_items.Documentation: https://developers.procore.com/reference/rest/v1/calendar-items#list-calendar-items.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/calendar_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/calendar-items#show-calendar-item.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/calendar_items.The following request parameters will be automatically processed:
-
application/json:
{{={ calendar_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/calendar-items#create-calendar-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/calendar_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ calendar_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/calendar-items#update-calendar-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/calendar_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/calendar-items#delete-calendar-item.
- id
A key field. Template: Id.
- assigned_id
Template: Id.
- assigned
Template: UserRefT. A read-only field.
- color
Template: ShortText.
- created_by
Template: UserRefT. A read-only field.
- description
Template: ShortText.
- finish
Template: Date.
- full_outline_path
Template: ShortText.
- milestone
Data type: DT_BOOL
- name
Template: ShortText.
- percentage
Data type: DT_I4
- private
Data type: DT_BOOL
- start
Template: Date.
- task_name
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/lookaheads/{{=parameters.lookahead_id}}.
The result is extracted from:{{=response.lookahead_tasks}}.The action has the following user-defined parameters:
- lookahead_id: Required. Specify lookahead identifier.
Documentation: https://developers.procore.com/reference/rest/v1/lookaheads#show-lookahead.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/lookahead_tasks.The following request parameters will be automatically processed:
-
application/json:
{{={ lookahead_task: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/lookahead-tasks#create-lookahead-task.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/lookahead_tasks/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ lookahead_task: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/lookahead-tasks#update-lookahead-task.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/lookahead_tasks/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/lookahead-tasks#delete-lookahead-task.
The resource includes the fields from the LookaheadTaskT template.
- lookahead_id
Template: Id.
- resource_ids
Template: LongText. A composite field.
- assignee_ids
Template: LongText. A composite field.
- vendor_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/lookaheads.Documentation: https://developers.procore.com/reference/rest/v1/lookaheads#list-lookaheads.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/lookaheads/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/lookaheads#show-lookahead.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/lookaheads.The following request parameters will be automatically processed:
-
application/json:
{{={ lookahead: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/lookaheads#create-lookahead.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/lookaheads/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/lookaheads#delete-lookahead.
- id
A key field. Template: Id.
- start_date
Template: DateTime.
- end_date
Template: DateTime.
- copied_from_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/schedule_integration.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/schedule-integration#list-schedule-imports.
-
project_id:
- id
A key field. Template: Id.
- message
Template: ShortText.
- processed_at
Template: DateTime. A read-only field.
- success
Data type: DT_BOOL
- uploaded_at
Template: DateTime. A read-only field.
- uploaded_by
Template: UserRefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/resources.Documentation: https://developers.procore.com/reference/rest/v1/schedule-resources#list-resources.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/schedule/resources/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/schedule-resources#show-resource.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/resources.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, resource: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/schedule-#create-resource.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/resources/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, resource: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/schedule-resources#update-resource.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/schedule/resources/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/schedule-resources#delete-resource.
- id
A key field. Template: Id.
- deleted_at
Template: DateTime. A read-only field.
- name
Template: ShortText.
- schedule_attributes
Template: LongText. A composite field.
- source_uid
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/tasks.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tasks.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/tasks/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/tasks#show-task.
-
project_id:
- [Create] action
-
Endpoint URL address:
/tasks.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, task: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tasks#create-task.
-
application/json:
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, task: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/tasks#update-task.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/tasks#delete-task.
-
project_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- task_name
Template: ShortText.
- key
Template: ShortText.
- start_datetime
Template: DateTime.
- finish_datetime
Template: DateTime.
- percentage
Data type: DT_I4
- color
Template: ShortText.
- parent_id
Template: Id.
- pending
Data type: DT_BOOL
- activity_id
Template: ShortText.
- schedule_activity_id
Template: ShortText.
- resource_name
Template: ShortText.
- critical_path
Data type: DT_BOOL
- milestone
Data type: DT_BOOL
- actual_start
Template: DateTime.
- actual_finish
Template: DateTime.
- row_number
Data type: DT_I4
- has_children
Data type: DT_BOOL
- full_outline_path
Template: ShortText.
- source_uid
Template: ShortText.
- wbs
Template: ShortText.
- schedule_duration
Data type: DT_I4
- resource_ids
Template: LongText. A composite field.
- notes
Template: ShortText.
- baseline_start
Template: DateTime.
- baseline_finish
Template: DateTime.
- start_variance
Data type: DT_R8
- finish_variance
Data type: DT_R8
- manually_edited
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- updated_by
Template: UserRefT. A read-only field.
- start
Template: DateTime.
- finish
Template: DateTime.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis/{{=parameters.rfi_id}}/replies.The action has the following user-defined parameters:
- rfi_id: Required. Specify RFI identifier.
Documentation: https://developers.procore.com/reference/rest/v1/replies#list-rfi-replies.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis/{{=parameters.rfi_id}}/replies/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- rfi_id: Required. Specify RFI identifier.
Documentation: https://developers.procore.com/reference/rest/v1/replies#show-rfi-reply.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/rfis/{{=item.rfi_id}}/replies.Documentation: https://developers.procore.com/reference/rest/v1/replies#create-rfi-reply.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/rfis/{{=item.rfi_id}}/replies/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/replies#update-rfi-reply.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/rfis/{{=item.rfi_id}}/replies/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/replies#delete-an-rfi-response.
- id
A key field. Template: Id.
- official
Data type: DT_BOOL
- answer_date
Template: DateTime.
- plain_text_body
Template: ShortText.
- rich_text_body
Template: ShortText.
- created_by
Template: ShortText. A read-only field.
- created_by_id
Template: Id. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- rfi_id
A key field. Template: Id.
- reply
Field components:
-
Uses template:
LongText. - Contains the following components: body, official.
-
Uses template:
- drawing_revision_ids
Template: LongText. A composite field.
- file_version_ids
Template: LongText. A composite field.
- form_ids
Template: LongText. A composite field.
- image_ids
Template: LongText. A composite field.
- upload_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis.Documentation: https://developers.procore.com/reference/rest/v1/rfis#list-rfis.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/rfis#show-rfi.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis/recycle_bin.Documentation: https://developers.procore.com/reference/rest/v1/rfis#list-recycled-rfis.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/rfis.The following request parameters will be automatically processed:
-
application/json:
{{={ rfi: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/rfis#create-rfi.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/rfis/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ rfi: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/rfis#update-rfi.
-
application/json:
- id
A key field. Template: Id.
- created_by
Template: UserRefT. A read-only field.
- link
Template: ShortText.
- questions
Field components:
- An array.
- Contains the following components: id, body, errors.
- custom_fields
Template: LongText. A composite field.
- assignee_id
Template: Id.
- assignee
Template: UserRefT. A read-only field.
- assignee_ids
Template: LongText. A composite field.
- assignees
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- ball_in_court
Template: UserRefT. A read-only field.
- ball_in_courts
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- cost_impact
Field components:
-
Uses template:
ShortText. - Contains the following components: status, value.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- deleted
Data type: DT_BOOL
- deleted_at
Template: DateTime. A read-only field.
- due_date
Template: Date.
- initiated_at
Template: DateTime.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- full_number
Template: ShortText.
- number
Data type: DT_I4
- prefix
Template: ShortText.
- private
Data type: DT_BOOL
- received_from_login_information_id
Template: Id.
- received_from
Template: UserRefT. A read-only field.
- reference
Template: ShortText.
- responsible_contractor_id
Template: Id.
- responsible_contractor
Template: RefT. A read-only field.
- rfi_manager_id
Template: Id.
- rfi_manager
Template: UserRefT. A read-only field.
- schedule_impact
Field components:
-
Uses template:
ShortText. - Contains the following components: status, value.
-
Uses template:
- status
Template: ShortText.
- translated_status
Template: ShortText.
- subject
Template: ShortText.
- time_resolved
Template: DateTime.
- updated_at
Template: DateTime. A read-only field.
- required_assignee_ids
Template: LongText. A composite field.
- draft
Data type: DT_BOOL
- distribution_ids
Template: LongText. A composite field.
- project_stage_id
Template: Id.
- specification_section_id
Template: Id.
- question
Field components:
-
Uses template:
LongText. - Contains the following components: body, attachments, drawing_revision_ids, file_version_ids, form_ids, image_ids, upload_ids.
-
Uses template:
Data type: DT_IMAGE A read-only field. The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/rfis/{{=item.id}}.pdfaddress.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/specification_section_divisions.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/specification-section-divisions#list-specification-section-divisions-for-a-project.
-
project_id:
- [Create] action
-
Endpoint URL address:
/specification_section_divisions.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ specification_section_division: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/specification-section-divisions#create-specification-section-division-for-a-project.
-
project_id:
- id
A key field. Template: Id.
- number
Template: ShortText.
- description
Template: ShortText.
- url
Template: ShortText. A read-only field.
- specification_section_revisions
A read-only field. The value is gathered from
/specification_section_revisionsaddress. Field components:- An array.
- Contains the following components: id, specification_section_id, specification_section_division_id, specification_set_id, number, description, url, revision, issued_date, received_date, updated_at, custom_fields.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/specification_sections.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/specification-sections#list-specification-sections.
-
project_id:
- [Create] action
-
Endpoint URL address:
/specification_sections.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}} -
application/json:
{{={ specification_section: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/specification-sections#create-specification-section-for-a-project.
-
project_id:
The resource includes the fields from the SpecificationSectionT template.
- specification_section_division_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/specification_sets.Documentation: https://developers.procore.com/reference/rest/v1/specification-sets#list-specification-sets.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/specification_sets/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/specification-sets#show-specification-set.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/specification_sets.Documentation: https://developers.procore.com/reference/rest/v1/specification-sets#create-specification-set.
- id
A key field. Template: Id.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- date
Template: ShortText.
- position
Data type: DT_I4
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/specification_uploads.Documentation: https://developers.procore.com/reference/rest/v1/specification-uploads#list-specification-uploads.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/specification_uploads.Documentation: https://developers.procore.com/reference/rest/v1/specification-uploads#create-specification-upload.
- id
A key field. Template: Id.
- issued_date
Template: Date.
- received_date
Template: Date.
- status
Template: ShortText.
- spec_format
Template: ShortText.
- specification_set_id
Template: Id.
- locale
Template: ShortText.
- specification_section_id
Template: Id.
- default_revision
Template: ShortText.
- files
Template: LongText. A composite field.
- upload_uuids
Template: LongText. A composite field.
- ignore_number
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals.Documentation: https://developers.procore.com/reference/rest/v1/submittals#list-submittals-on-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/submittals#show-submittal.
- [Read deleted] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals/recycle_bin.Documentation: https://developers.procore.com/reference/rest/v1/submittals#list-of-deleted-submittals.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/submittals.The following request parameters will be automatically processed:
-
application/json:
{{={ submittal: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/submittals#create-submittal.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/submittals/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ submittal: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/submittals#update-submittal.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/submittals/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/submittals#delete-submittal.
The resource includes the fields from the SubmittalT template.
- cost_code_id
Template: Id.
- distribution_member_ids
Template: LongText. A composite field.
- drawing_ids
Template: LongText. A composite field.
- last_distributed_submittal
Field components:
-
Uses template:
Id. - Contains the following components: id, distributed_attachments, distributed_responses, distributed_by, distributed_to, message, sent_at.
-
Uses template:
- linked_drawing_ids
Template: LongText. A composite field.
- location_id
Template: Id.
- received_from_id
Template: Id.
- responsible_contractor_id
Template: Id.
- status_id
Template: Id.
- sub_job_id
Template: Id.
- submit_by
Template: Date.
- submittal_manager_id
Template: Id.
- submittal_package_id
Template: Id.
- actual_delivery_date
Template: Date.
- confirmed_delivery_date
Template: Date.
- design_team_review_time
Data type: DT_I4
- internal_review_time
Data type: DT_I4
- lead_time
Data type: DT_I4
- prostore_file_ids
Template: LongText. A composite field.
- required_on_site_date
Template: Date.
- scheduled_task_key
Template: ShortText.
- scheduled_task_id
Template: Id.
- source_submittal_log_id
Template: Id.
- specification_section_id
Template: Id.
- workflow_data
Field components:
- An array.
- revisions
A read-only field. The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals/{{=item.id}}/revisionsaddress. Field components:- An array.
-
Uses template:
SubmittalT.
- get_workflow_data
The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals/{{=item.id}}/workflow_dataaddress. Field components:- Contains the following components: steps, approvers, attachments.
Data type: DT_IMAGE The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/submittals/{{=item.id}}.pdfaddress.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_approvers.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-approvers#list-action-plan-approvers.
- id
A key field. Template: Id.
- plan_id
Template: Id.
- updated_at
Template: ShortText.
- party
Template: APUserT.
- signature
Template: APSignatureT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_item_assignees.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#list-action-plan-item-assignees.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_item_assignees/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#show-action-plan-item-assignee.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_item_assignees.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#list-recycled-action-plan-item-assignees.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_item_assignees.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_item_assignee: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#create-action-plan-item-assignee.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_item_assignees/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_item_assignee: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#update-action-plan-item-assignee.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_item_assignees/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-item-assignees#delete-action-plan-item-assignee.
The resource includes the fields from the APIAssigneeT template.
- plan_item_id
Template: Id.
- party_id
Template: Id.
- plan_id
Template: Id.
- role_id
Template: Id.
- verification_method_id
Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_items.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#list-action-plan-items.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#show-action-plan-item.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_items.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#list-recycled-action-plan-items.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_items.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#create-action-plan-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#update-action-plan-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-items#delete-action-plan-item.
- id
A key field. Template: Id.
- plan_item_assignees
Field components:
- An array.
-
Uses template:
APIAssigneeT.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- due_at
Template: DateTime.
- holding_type
Template: ShortText.
- is_blocked
Data type: DT_BOOL
- is_blocking
Data type: DT_BOOL
- plan_id
Template: Id.
- position
Data type: DT_I4
- plan_section_id
Template: Id.
- status_id
Template: Id.
- status
Template: RefT. A read-only field.
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- action
The value is sent to
/projects/{{=item.project_id}}/action_plans/plan_items/{{=item.id}}/moveaddress. Field components:-
Uses template:
Id. - Contains the following components: next_plan_item_id, plan_section_id.
-
Uses template:
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/parties.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-parties#list-action-plan-parties.
The resource includes the fields from the APUserT template.
- potential_approver
Data type: DT_BOOL
- potential_assignee
Data type: DT_BOOL
- potential_manager
Data type: DT_BOOL
- potential_receiver
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_receivers.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-receivers#list-action-plan-receivers.
- id
A key field. Template: Id.
- plan_id
Template: Id.
- updated_at
Template: DateTime. A read-only field.
- party
Template: APUserT.
- signature
Template: APSignatureT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_references.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-references#list-action-plan-references.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_references/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-references#show-action-plan-reference.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_references.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-references#list-recycled-action-plan-references.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_references.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_reference: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-references#create-action-plan-reference.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_references/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-references#delete-action-plan-reference.
- id
A key field. Template: Id.
- plan_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- payload
Field components:
-
Uses template:
AttachmentT. - Contains the following components: attachment, drawing_id, drawing_revision_id, file_version_id, folder_id, specification_section_id, specification_section_current_revision_id, submittal_log_id, generic_tool_item_id, form_id, meeting_id, observation_item_id.
-
Uses template:
- plan_id
Template: Id.
- type
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_sections.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#list-action-plan-sections.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_sections/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#show-action-plan-section.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_sections.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#list-recycled-action-plan-sections.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_sections.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_section: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#create-action-plan-section.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_sections/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_section: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#update-action-plan-section.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_sections/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-sections#delete-action-plan-section.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- plan_id
Template: Id.
- position
Data type: DT_I4
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- action
Field components:
- Contains the following components: move.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_test_record_requests.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-record-requests#list-action-plan-test-record-requests.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_test_record_requests/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-record-requests#show-action-plan-test-record-request.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_test_record_requests.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-record-requests#list-recycled-action-plan-test-record-requests.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_test_record_requests.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_test_record_request: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-record-requests#create-action-plan-test-record-request.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_test_record_requests/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-record-requests#delete-action-plan-test-record-request.
- id
A key field. Template: Id.
- plan_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- payload
Field components:
-
Uses template:
Id. - Contains the following components: checklist_template_id, form_template_id, generic_tool_id.
-
Uses template:
- plan_id
Template: Id.
- plan_test_records_count
Data type: DT_I4 A read-only field.
- type
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_test_records.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-records#list-action-plan-test-records.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_test_records/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-records#view-an-action-plan-test-record.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_test_records.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-records#list-recyled-action-plan-test-records.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_test_records.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_test_record: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-records#create-action-plan-test-record.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_test_records/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-test-records#delete-action-plan-test-record.
- id
A key field. Template: Id.
- plan_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- payload
Field components:
-
Uses template:
Id. - Contains the following components: checklist_id, checklist_template_id, form_id, form_template_id, generic_tool_id, generic_tool_item_id, meeting_id, submittal_log_id, observation_item_id, attachment.
-
Uses template:
- plan_id
Template: Id.
- plan_test_record_request_id
Template: Id.
- type
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/action_plans/verification_methods.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-verification-methods#list-action-plan-verification-methods.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/action_plans/verification_methods/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-verification-methods#show-action-plan-verification-method.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/action_plans/verification_methods.The following request parameters will be automatically processed:
-
application/json:
{{={ verification_method: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-verification-methods#create-action-plan-verification-methods.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/action_plans/verification_methods/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ verification_method: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plan-verification-methods#update-action-plan-verification-method.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/action_plans/verification_methods/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plan-verification-methods#delete-action-plan-verification-method.
The resource includes the fields from the VerificationMethodT template.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plans.Documentation: https://developers.procore.com/reference/rest/v1/action-plans#list-action-plans.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plans/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plans#show-action-plan.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plans.Documentation: https://developers.procore.com/reference/rest/v1/action-plans#list-recycled-action-plan.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plans.The following request parameters will be automatically processed:
-
application/json:
{{={ plan: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plans#create-action-plan.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plans/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ plan: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/action-plans#update-action-plan.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plans/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/action-plans#delete-action-plan.
- id
A key field. Template: Id.
- closed_item_count
Data type: DT_I4 A read-only field.
- created_at
Template: DateTime. A read-only field.
- custom_fields
Template: LongText. A composite field.
- description
Template: ShortText.
- description_plain_text
Template: ShortText.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- manager_id
Template: Id.
- manager
Template: APUserT. A read-only field.
- number
Data type: DT_I4
- plan_type_id
Template: Id.
- plan_type
Template: APTypeT. A read-only field.
- plan_status
Template: RefT. A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, global, status, updated_at.
-
Uses template:
- plan_approvers_attributes
Field components:
- An array.
- plan_approvers
A read-only field. Field components:
- An array.
- Contains the following components: id, plan_id, updated_at, party, signature.
- plan_receivers_attributes
Field components:
- An array.
- plan_receivers
A read-only field. Field components:
- An array.
- Contains the following components: id, plan_id, updated_at, party, signature.
- private
Data type: DT_BOOL
- status
Template: ShortText.
- status_type
Template: ShortText.
- title
Template: ShortText.
- total_item_count
Data type: DT_I4 A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_item_assignees.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-item-assignees#list-action-plan-template-item-assignees.
- [Create] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_item_assignees/bulk_create.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ plan_template_item_assignees: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-item-assignees#bulk-create-action-plan-template-item-assignees.
- [Update] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_item_assignees/bulk_update.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ plan_template_item_assignees: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-item-assignees#bulk-update-action-plan-template-item-assignees.
- id
Template: Id.
- plan_template_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- is_holding
Data type: DT_BOOL
- party_id
Template: Id.
- party
Template: APUserT. A read-only field.
- plan_template_id
Template: Id.
- role
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- verification_method_id
Template: Id.
- verification_method
Template: VerificationMethodT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_items.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-items#list-project-action-plan-template-items.
- [Update] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_items/bulk_update.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ plan_template_items: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-items#bulk-update-action-plan-template-item.
- id
Template: Id.
- plan_template_item_assignees
A read-only field. Field components:
- An array.
- Contains the following components: id, created_at, is_holding, party, role, updated_at, verification_method.
- created_at
Template: DateTime. A read-only field.
- due_at
Template: DateTime.
- description
Template: ShortText.
- holding_type
Template: ShortText.
- plan_template_id
Template: Id.
- position
Data type: DT_I4
- plan_template_section_id
Template: Id.
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_references.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-references#list-project-action-plan-template-references.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_references/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-references#show-project-action-plan-template-reference.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/action_plans/plan_template_references.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-references#list-recycled-project-action-plan-template-references.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_template_references.The following request parameters will be automatically processed:
-
application/json:
{{={ plan_template_reference: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-references#create-project-action-plan-template-reference.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/action_plans/plan_template_references/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-references#delete-project-action-plan-template-reference.
- id
A key field. Template: Id.
- plan_template_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- payload
Field components:
-
Uses template:
AttachmentT. - Contains the following components: attachment, drawing_id, drawing_revision_id, file_version_id, folder_id, specification_section_id, specification_section_current_revision_id, generic_tool_item_id, form_id, meeting_id, observation_item_id.
-
Uses template:
- plan_template_id
Template: Id.
- type
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_sections.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-template-sections#list-project-action-plan-template-sections.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- plan_template_id
Template: Id.
- position
Data type: DT_I4
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_test_record_requests.
- [Create] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_template_test_record_requests/bulk_create.The action has the following user-defined parameters:
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ plan_template_test_record_requests: batch } }}
- id
Template: Id.
- plan_template_item_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- payload
Field components:
-
Uses template:
Id. - Contains the following components: checklist_template_id, form_template_id, generic_tool_id.
-
Uses template:
- plan_template_id
Template: Id.
- type
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/action_plans/plan_templates.Documentation: https://developers.procore.com/reference/rest/v1/project-action-plan-templates#list-of-project-action-plan-templates.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- description_plain_text
Template: ShortText.
- location
Template: LocationT. A read-only field.
- manager
Template: APUserT.
- status
Template: ShortText.
- private
Data type: DT_BOOL
- title
Template: ShortText.
- plan_type
Template: APTypeT. A read-only field.
- provider_type
Template: ShortText.
- updated_at
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/form_templates.Documentation: https://developers.procore.com/reference/rest/v1/form-templates#list-company-form-templates-from-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/form_templates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/form-templates#show-company-form-template-from-project.
The resource includes the fields from the FormTemplateT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/form_templates.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/form-templates#list-company-form-templates.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/form_templates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/form-templates#show-company-form-template.
- [Read recycled] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/recycle_bin/form_templates.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/form-templates#list-recycled-company-form-templates.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/form_templates.The following request parameters will be automatically processed:
-
application/json:
{{={ form_template: item } }} -
fillable_pdf:
{{=item.fillable_pdf_data}}
Documentation: https://developers.procore.com/reference/rest/v1/form-templates#create-company-form-template.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/form_templates/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ form_template: item } }} -
fillable_pdf:
{{=item.fillable_pdf_data}}
Documentation: https://developers.procore.com/reference/rest/v1/form-templates#update-company-form-template.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/form_templates/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/form-templates#delete-company-form-template.
The resource includes the fields from the FormTemplateT template.
- company_id
A key field. Template: Id.
- fillable_pdf_data
Data type: DT_IMAGE
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/forms.Documentation: https://developers.procore.com/reference/rest/v1/forms#list-forms-on-a-project.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/forms/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/forms#show-form.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/forms.Documentation: https://developers.procore.com/reference/rest/v1/forms#list-recycled-project-forms.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/forms.The following request parameters will be automatically processed:
-
application/json:
{{={ form: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/forms#create-form.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/forms/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/forms#update-form.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/forms/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/forms#delete-form.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- form_template_id
Template: Id.
- form_template_name
Template: ShortText.
- name
Template: ShortText.
- private
Data type: DT_BOOL
- created_by
Template: UserRefT.
- updated_at
Template: DateTime. A read-only field.
- fillable_pdf
Template: AttachmentT.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- thumbnail_url
Template: ShortText.
- viewable
Data type: DT_BOOL
- viewable_document_id
Data type: DT_I4
- holder_class
Template: ShortText.
- download_all_uuid
Template: LongText. A composite field.
- attachment
Template: AttachmentT.
- permissions
Field components:
- Contains the following components: can_edit.
Based on resource template IncidentType.
Based on resource template IncidentType.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/severity_levels/{{=parameters.severity_level_id}}/alert_recipients.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- severity_level_id: Required. Specify severity level identifier.
Documentation: https://developers.procore.com/reference/rest/v1/alert-recipients#list-incident-alert-recipients.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/severity_levels/{{=parameters.severity_level_id}}/alert_recipients/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- severity_level_id: Required. Specify severity level identifier.
Documentation: https://developers.procore.com/reference/rest/v1/alert-recipients#show-incident-alert-recipient.
- [Upsert] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/incidents/severity_levels/{{=item.severity_level_id}}/alert_recipients/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.procore.com/reference/rest/v1/alert-recipients#update-existing-or-create-a-new-incident-alert-recipient.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/incidents/severity_levels/{{=item.severity_level_id}}/alert_recipients/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/alert-recipients#delete-incident-alert-recipient.
- id
A key field. Template: Id.
- login
Template: ShortText. A read-only field.
- name
Template: ShortText. A read-only field.
- company_id
A key field. Template: Id.
- severity_level_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/alerts.Documentation: https://developers.procore.com/reference/rest/v1/alerts#list-incident-alerts.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/alerts/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/alerts#show-incident-alert.
- id
A key field. Template: Id.
- event_id
Template: Id.
- emailed_at
Template: DateTime.
- filing_type
Template: RefT. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, severity_level, updated_at.
-
Uses template:
- injury
Field components:
-
Uses template:
Id. - Contains the following components: id, number, full_number, incident_id, recordable, type, date_returned_to_work, affected_party, affected_person, harm_source, date_of_death, filing_type, hospitalized_overnight, treated_in_er, treatment_facility_address, treatment_facility, treatment_provider, work_days_absent, work_days_restricted, work_days_transferred, body_diagram_type, affliction_type, affected_body_part, affected_body_parts, afflictions, custom_fields, body_parts.
-
Uses template:
- pushed_at
Template: DateTime.
- recipient
Template: UserRefT.
- severity_level
Template: SeverityLevelT.
- triggered_at
Template: DateTime.
- triggered_by
Template: UserRefT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/body_parts.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/body-parts#list-body-parts.
- id
A key field. Template: Id.
- name
Template: ShortText.
- selectable
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- parent_id
Template: Id.
Based on resource template IncidentType.
Based on resource template IncidentType.
Based on resource template BaseProjectNoPagination.
- [Read work activity] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals/filter_options/work_activities.Documentation: https://developers.procore.com/reference/rest/v1/environmental-filter-options#get-work-activity-filter-options.
- [Read managed equipment] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals/filter_options/managed_equipment.Documentation: https://developers.procore.com/reference/rest/v1/environmental-filter-options#get-managed-equipment-filter-options.
- [Read affected company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals/filter_options/affected_companies.Documentation: https://developers.procore.com/reference/rest/v1/environmental-filter-options#get-affected-company-filter-options.
- [Read environmental type] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals/filter_options/environmental_types.Documentation: https://developers.procore.com/reference/rest/v1/environmental-filter-options#get-environmental-type-filter-options.
- key
Template: Id.
- value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/environmental_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/environmental-types#list-environmental-types.
The resource includes the fields from the IncidentTypeT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals.Documentation: https://developers.procore.com/reference/rest/v1/environmentals#list-environmentals.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/environmentals/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/environmentals#show-environmental.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents/environmentals.Documentation: https://developers.procore.com/reference/rest/v1/environmentals#list-recycled-environmentals.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/environmentals.The following request parameters will be automatically processed:
-
application/json:
{{={ environmental: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/environmentals#create-environmental.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/environmentals/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/environmentals#update-environmental.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/environmentals/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/environmentals#destroy-environmental.
The resource includes the fields from the IncidentEnvironmentalT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/injury_filing_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/filing-types#list-incident-filing-types.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/injury_filing_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/filing-types#show-filing-type.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/incidents/injury_filing_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ filing_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/filing-types#update-filing-type.
-
application/json:
- id
A key field. Template: Id.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- severity_level_id
Template: Id.
- severity_level
Template: SeverityLevelT. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- company_id
A key field. Template: Id.
Based on resource template IncidentType.
Based on resource template IncidentType.
Based on resource template BaseProjectNoPagination.
- [Read hazard] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/filter_options/hazards.Documentation: https://developers.procore.com/reference/rest/v1/incident-filter-options#get-hazard-filter-options.
- [Read status] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/filter_options/statuses.Documentation: https://developers.procore.com/reference/rest/v1/incident-filter-options#get-status-filter-options.
- [Read location] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/filter_options/locations.Documentation: https://developers.procore.com/reference/rest/v1/incident-filter-options#get-location-filter-options.
- [Read contributing behavior] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/filter_options/contributing_behaviors.Documentation: https://developers.procore.com/reference/rest/v1/incident-filter-options#get-contributing-behavior-filter-options.
- [Read contributing condition] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/filter_options/contributing_conditions.Documentation: https://developers.procore.com/reference/rest/v1/incident-filter-options#get-contributing-condition-filter-options.
- key
Template: Id.
- value
Template: ShortText.
Based on resource template NoPagination.
- [Read status] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/statuses.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/incident-picker-options#get-incident-statuses.
- [Read filing type] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/filing_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/incident-picker-options#get-filing-types.
- [Read uom] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/units_of_measure.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/incident-picker-options#get-units-of-measure.
- [Read affected body part] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/affected_body_parts.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/incident-picker-options#get-affected-body-parts.
- label
Template: ShortText.
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents.Documentation: https://developers.procore.com/reference/rest/v1/incidents#list-incidents.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/incidents#show-incident.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents.Documentation: https://developers.procore.com/reference/rest/v1/incidents#list-recycled-incidents.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents.The following request parameters will be automatically processed:
-
application/json:
{{={ incident: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/incidents#create-incident.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ incident: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/incidents#update-incident.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/incidents#delete-incident.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- event_date
Template: DateTime.
- number
Data type: DT_I4
- private
Data type: DT_BOOL
- recordable
Data type: DT_BOOL
- records_count
Data type: DT_I4
- open_observations_count
Data type: DT_I4
- closed_observations_count
Data type: DT_I4
- actions_count
Data type: DT_I4
- witness_statements_count
Data type: DT_I4
- status
Template: ShortText.
- time_unknown
Data type: DT_BOOL
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- contributing_behavior_id
Template: Id.
- contributing_behavior
Template: IncidentTypeT. A read-only field.
- contributing_condition_id
Template: Id.
- contributing_condition
Template: IncidentTypeT. A read-only field.
- hazard_id
Template: Id.
- hazard
Template: IncidentTypeT. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- attachments_count
Data type: DT_I4 A read-only field.
- custom_fields
Template: LongText. A composite field.
- distribution_member_ids
Template: LongText. A composite field.
- witness_statements_attributes
Field components:
- An array.
- Contains the following components: statement, date_received, witness_id.
- upload_uuids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries.Documentation: https://developers.procore.com/reference/rest/v1/injuries#list-injuries.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/injuries#show-injury.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents/injuries.Documentation: https://developers.procore.com/reference/rest/v1/injuries#list-recycled-injuries.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/injuries.The following request parameters will be automatically processed:
-
application/json:
{{={ injury: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/injuries#create-injury.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/injuries/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ injury: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/injuries#update-injury.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/injuries/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/injuries#destroy-injury.
The resource includes the fields from the InjuryT template.
Based on resource template BaseProject.
- [Read filing type] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/filing_types.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-filing-type-filter-options.
- [Read harm source] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/harm_sources.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-harm-source-filter-options.
- [Read work activity] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/work_activities.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-work-activity-filter-options.
- [Read affected party] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/affected_parties.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-affected-parties-filter-options.
- [Read affected person] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/affected_persons.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-affected-persons-filter-options.
- [Read afflication type] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/affliction_types.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-affliction-type-filter-options.
- [Read managed equipment] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/managed_equipment.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-managed-equipment-filter-options.
- [Read affected company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/affected_companies.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-affected-company-filter-options.
- [Read affected body part] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/injuries/filter_options/affected_body_parts.Documentation: https://developers.procore.com/reference/rest/v1/injury-filter-options#get-affected-body-part-filter-options.
- key
Template: ShortText.
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read harm source] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/harm_sources.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-harm-source-filter-options.
- [Read work activity] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/work_activities.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-work-activity-filter-options.
- [Read affected party] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/affected_parties.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-affected-parties-filter-options.
- [Read affected person] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/affected_persons.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-affected-persons-filter-options.
- [Read managed equipment] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/managed_equipment.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-managed-equipment-filter-options.
- [Read affected company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/filter_options/affected_companies.Documentation: https://developers.procore.com/reference/rest/v1/near-miss-filter-options#get-affected-company-filter-options.
- key
Template: ShortText.
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses.Documentation: https://developers.procore.com/reference/rest/v1/near-misses#list-near-misses.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/near_misses/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/near-misses#show-near-miss.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents/near_misses.Documentation: https://developers.procore.com/reference/rest/v1/near-misses#list-recycled-near-misses.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/near_misses.The following request parameters will be automatically processed:
-
application/json:
{{={ near_miss : item } }}
Documentation: https://developers.procore.com/reference/rest/v1/near-misses#create-near-miss.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/near_misses/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ near_miss : item } }}
Documentation: https://developers.procore.com/reference/rest/v1/near-misses#update-near-miss.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/near_misses/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/near-misses#destroy-near-miss.
The resource includes the fields from the NearMissT template.
Based on resource template BaseProject.
- [Read work activity] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages/filter_options/work_activities.Documentation: https://developers.procore.com/reference/rest/v1/property-damage-filter-options#get-work-activity-filter-options.
- [Read managed equipment] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages/filter_options/managed_equipment.Documentation: https://developers.procore.com/reference/rest/v1/property-damage-filter-options#get-managed-equipment-filter-options.
- [Read affected company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages/filter_options/affected_companies.Documentation: https://developers.procore.com/reference/rest/v1/property-damage-filter-options#get-affected-company-filter-options.
- [Read responsible company] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages/filter_options/responsible_companies.Documentation: https://developers.procore.com/reference/rest/v1/property-damage-filter-options#get-responsible-company-filter-options.
- key
Data type: DT_I4
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages.Documentation: https://developers.procore.com/reference/rest/v1/property-damages#list-property-damages.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/incidents/property_damages/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/property-damages#show-property-damage.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents/property_damages.Documentation: https://developers.procore.com/reference/rest/v1/property-damages#list-recycled-property-damages.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/property_damages.The following request parameters will be automatically processed:
-
application/json:
{{={ property_damage: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/property-damages#create-property-damage.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/property_damages/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ property_damage: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/property-damages#update-property-damage.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/incidents/property_damages/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/property-damages#destroy-property-damage.
The resource includes the fields from the PropertyDamageT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/severity_levels.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/severity-levels#list-incident-severity-levels.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/incidents/severity_levels/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/severity-levels#show-incident-severity-level.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/incidents/severity_levels/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ severity_level: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/severity-levels#update-incident-severity-level.
-
application/json:
The resource includes the fields from the SeverityLevelT template.
- company_id
A key field. Template: Id.
- alert_recipient_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/incidents/witness_statements.Documentation: https://developers.procore.com/reference/rest/v1/witness-statements#list-recycled-witness-statements.
The resource includes the fields from the WitnessStatementT template.
Based on resource template IncidentType.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/alternative_response_sets.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/alternative-response-sets#list-alternative-response-sets.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/alternative_response_sets/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/alternative-response-sets#show-alternative-response-set.
- id
A key field. Template: Id.
- conforming_response
Template: ShortText.
- deficient_response
Template: ShortText.
- global
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_item_comments.Documentation: https://developers.procore.com/reference/rest/v1/checklist-comments#list-checklist-inspection-comments.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/checklist/list_item_comments.Documentation: https://developers.procore.com/reference/rest/v1/checklist-comments#list-recycled-checklist-inspection-comments.
- [Create] action
-
Endpoint URL address:
/checklist/lists/{{=item.list_id}}/comments.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, item_id: item.item_id, comment: { body: item.body } } }}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-comments#create-checklist-comment.
-
application/json:
- id
A key field. Template: Id.
- body
Template: ShortText.
- item_id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- list_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_item_attachments.Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-attachments#list-checklist-inspections-item-attachments.
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/checklist/list_item_attachments.Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-attachments#list-recycled-checklist-inspections-item-attachments.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/list_item_attachments/bulk_create.Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-attachments#bulk-create-checklist-inspections-item-attachments.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/list_item_attachments/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-attachments#delete-checklist-inspections-item-attachment.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- attachment
Template: AttachmentT. A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: thumbnail_url, viewable_document_id.
-
Uses template:
- item_id
Template: Id.
- prostore_file_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_item_observations.Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-observations#list-checklist-item-observations.
- id
A key field. Template: Id.
- checklist_item_id
Template: Id.
- checklist_list_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/checklist/item_types.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-item-types#list-available-checklist-item-types.
-
project_id:
The resource includes the fields from the ChecklistItemTypeT template.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_items.Documentation: https://developers.procore.com/reference/rest/v1/checklist-items#list-checklist-inspections-items.
- id
A key field. Template: Id.
- details
Template: ShortText.
- item_response
Field components:
-
Uses template:
Id. - Contains the following components: item_id, item_type, payload, responded_at, responder, status.
-
Uses template:
- list_id
Template: Id.
- name
Template: ShortText.
- position
Data type: DT_I4
- responded_with
Template: ShortText.
- response
Template: InspectionResponseT.
- response_set
Template: RefT. Field components:
-
Uses template:
DateTime. - Contains the following components: responses, created_at, updated_at.
-
Uses template:
- response_type_id
Template: Id.
- section_id
Template: Id.
- status
Template: ShortText.
- template_item_id
Template: Id.
- type
Template: ChecklistItemTypeT.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProjectNoPagination.
- [Read type] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/types.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-inspection-type-filter-options.
- [Read trade] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/trades.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-trade-filter-options.
- [Read status] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/statuses.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-status-filter-options.
- [Read location] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/locations.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-location-filter-options.
- [Read inspector] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/inspectors.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-inspector-filter-options.
- [Read spec section] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/spec_sections.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-specification-section-filter-options.
- [Read template] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/list_templates.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-template-filter-options.
- [Read poc] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/points_of_contact.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-point-of-contact-filter-options.
- [Read cbc] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/closed_by_contacts.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-closed-by-contact-filter-options.
- [Read responsible contractor] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/lists/filter_options/responsible_contractors.Documentation: https://developers.procore.com/reference/rest/v1/checklist-list-filter-options#list-checklist-list-responsible-contractor-filter-options.
- key
Template: ShortText.
- value
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/{{=parameters.schedule_id}}/attachments.The action has the following user-defined parameters:
- schedule_id: Required. Specify checklist schedule identifier.
Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-attachments#list-checklist-schedule-attachments.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/schedules/{{=item.schedule_id}}/attachments.The following request parameters will be automatically processed:
-
application/json:
-
attachment:
{{=item.content}}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-attachments#create-checklist-schedule-attachment.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/schedules/{{=item.schedule_id}}/attachments/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-attachments#delete-checklist-schedule-attachment.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- schedule_id
A key field. Template: Id.
- attachment
Template: AttachmentT. Field components:
-
Uses template:
ShortText. - Contains the following components: thumbnail_url, viewable_document_id.
-
Uses template:
- content
Data type: DT_IMAGE The value is gathered from
{{=item.attachment.urladdress.
Based on resource template BaseProjectNoPagination.
- [Read type] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/filter_options/types.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-filter-options#checklist-schedule-inspection-type-filter-options.
- [Read assignee] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/filter_options/assignees.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-filter-options#checklist-schedule-assignee-filter-options.
- [Read location] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/filter_options/locations.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-filter-options#checklist-schedule-location-filter-options.
- [Read template] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/filter_options/inspection_templates.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedule-filter-options#checklist-schedule-inspection-template-filter-options.
- id
Template: ShortText.
- label
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedules#list-checklist-inspection-schedules.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedules#show-checklist-schedule.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/schedules.The following request parameters will be automatically processed:
-
application/json:
{{={ schedule: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedules#create-a-checklist-inspection-schedule.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/schedules/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ schedule: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedules#update-a-checklist-inspection-schedule.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/schedules/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/checklist-schedules#delete-checklist-schedule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- first_inspection_due_at
Template: DateTime.
- ends_at
Template: DateTime.
- next_due_at
Template: DateTime.
- frequency
Template: ShortText.
- inspections_created
Data type: DT_I4
- total_inspections_scheduled
Data type: DT_I4
- inspection_template_id
Template: Id.
- inspection_template
Template: RefT. A read-only field. Field components:
-
Uses template:
LongText. - Contains the following components: attachment_ids, description, inspection_type, trade_id.
-
Uses template:
- location_id
Template: Id.
- assignee_ids
Template: LongText. A composite field.
- point_of_contact_id
Template: Id.
- responsible_contractor_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- days_created_before_due_date
Data type: DT_I4
- specification_section_id
Template: Id.
- distribution_member_ids
Template: LongText. A composite field.
- change_history
A read-only field. The value is gathered from
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/schedules/{{=item.id}}/change_historyaddress. Field components:- An array.
- Contains the following components: id, column, old_value, new_value, created_by_id, created_at.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/checklist/lists/{{=parameters.list_id}}/signature_requests.The action has the following user-defined parameters:
- list_id: Required. Specify checklist identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-signature-requests#list-checklist-signature-requests.
- [Read single] action
-
Endpoint URL address:
/checklist/lists/{{=parameters.list_id}}/signature_requests/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- list_id: Required. Specify checklist identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-signature-requests#show-checklist-signature-request.
- [Create] action
-
Endpoint URL address:
/checklist/lists/{{=item.list_id}}/signature_requests.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}} -
application/json:
{{={ signature_request: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/checklist-signature-requests#create-checklist-signature-request.
-
project_id:
- [Delete] action
-
Endpoint URL address:
/checklist/lists/{{=item.list_id}}/signature_requests/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/checklist-signature-requests#delete-checklist-signature-request.
- id
A key field. Template: Id.
- signatory_id
Template: Id.
- signatory
Template: UserRefT. A read-only field.
- signature
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, captured_by, captured_at, attachment.
-
Uses template:
- list_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/lists.The following request parameters will be automatically processed:
-
application/json:
{{={ list_template_id: item.list_template_id, list: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/checklists#create-checklist-inspection.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/checklist/lists/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/checklists#delete-checklist-inspection.
- description
Template: ShortText.
- due_at
Template: ShortText.
- inspection_date
Template: ShortText.
- inspection_type_id
Data type: DT_I4
- number
Data type: DT_I4
- managed_equipment_id
Data type: DT_I4
- point_of_contact_id
Data type: DT_I4
- inspector_ids
Template: LongText. A composite field.
- private
Data type: DT_BOOL
- responsible_contractor_id
Data type: DT_I4
- spec_section_id
Data type: DT_I4
- status
Template: ShortText.
- trade_id
Data type: DT_I4
- distribution_member_ids
Template: LongText. A composite field.
- location_id
Data type: DT_I4
- custom_field_%{custom_field_definition_id}
Template: ShortText.
- drawing_revision_ids
Template: LongText. A composite field.
- file_version_ids
Template: LongText. A composite field.
- form_ids
Template: LongText. A composite field.
- image_ids
Template: LongText. A composite field.
- upload_ids
Template: LongText. A composite field.
- list_template_id
A key field. Template: Id.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/sections.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- list_template_id: Required. Specify checklist template identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-sections#list-company-checklist-sections.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/sections/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ section: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-sections#update-company-checklist-section.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/sections/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-sections#delete-company-checklist-section.
- id
A key field. Template: Id.
- name
Template: ShortText.
- position
Data type: DT_I4
- company_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/list_templates.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#list-company-checklist-templates.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/list_templates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#show-company-checklist-template.
- [Read recycled] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/recycle_bin/checklist/list_templates.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#list-recycled-company-checklist-templates.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/list_templates.The following request parameters will be automatically processed:
-
application/json:
{{={ list_template: item, attachments: item.attachments } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#create-company-checklist-template.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/list_templates/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ list_template: item, attachments: item.attachments } }}
Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#update-company-checklist-template.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/list_templates/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/company-checklist-templates#delete-company-checklist-template.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- inspection_type_id
Template: Id.
- inspection_type
Template: RefT. A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, updated_at, audit_transaction_timestamp, source_id, deleted_at, company_id.
-
Uses template:
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- deletable
Data type: DT_BOOL A read-only field.
- company_id
A key field. Template: Id.
- alternative_response_set_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/inspection_types.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/inspection-types#list-inspection-types.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/inspection_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/inspection-types#show-inspection-type.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/inspection_types.The following request parameters will be automatically processed:
-
application/json:
{{={ inspection_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/inspection-types#create-inspection-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/inspection_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ inspection_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/inspection-types#update-inspection-type.
-
application/json:
- id
A key field. Template: Id.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- audit_transaction_timestamp
Template: DateTime.
- source_id
Template: Id.
- deleted_at
Template: DateTime. A read-only field.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/users.Documentation: https://developers.procore.com/reference/rest/v1/inspection-users#list-inspection-users.
- id
A key field. Template: Id.
- login
Template: ShortText.
- name
Template: ShortText.
- vendor
Template: RefT. A read-only field.
- potential_assignee
Data type: DT_BOOL
- potential_point_of_contact
Data type: DT_BOOL
- potential_distribution_member
Data type: DT_BOOL
- default_distribution_member
Data type: DT_BOOL
- custom_fields
Template: LongText. A composite field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/item/response_sets/{{=parameters.response_set_id}}/responses.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- response_set_id: Required. Specify response set identifier.
Documentation: https://developers.procore.com/reference/rest/v1/item-response-set-responses#list-responses-in-the-specified-item-response-set.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/item/response_sets/{{=parameters.response_set_id}}/responses/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- response_set_id: Required. Specify response set identifier.
Documentation: https://developers.procore.com/reference/rest/v1/item-response-set-responses#show-item-response-set-response.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets/{{=item.response_set_id}}/responses.The following request parameters will be automatically processed:
-
application/json:
{{={ response: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/item-response-set-responses#create-a-response-in-the-specified-item-response-set.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets/{{=item.response_set_id}}/responses/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/item-response-set-responses#add-an-existing-response-to-an-item-response-set.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets/{{=item.response_set_id}}/responses/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/item-response-set-responses#remove-a-response-from-an-item-response-set.
- id
A key field. Template: Id.
- name
Template: ShortText.
- corresponding_status
Template: ShortText.
- company_id
A key field. Template: Id.
- response_set_id
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/item/response_sets.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/item-response-sets#list-item-response-sets.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/item/response_sets/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/item-response-sets#show-item-response-set.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets.The following request parameters will be automatically processed:
-
application/json:
{{={ response_set: _.extend({ memberships_attributes: { response_attributes: item.responses } }, item) } }}
Documentation: https://developers.procore.com/reference/rest/v1/item-response-sets#create-item-response-set.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ response_set: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/item-response-sets#update-item-response-set.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/item/response_sets/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/item-response-sets#delete-item-response-set.
- id
A key field. Template: Id.
- name
Template: ShortText.
- active
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- responses
Field components:
- An array.
-
Uses template:
InspectionResponseT.
- in_use
Data type: DT_BOOL
- deletable
Data type: DT_BOOL
- procore_standard
Data type: DT_BOOL
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_templates.Documentation: https://developers.procore.com/reference/rest/v1/project-checklist-templates#list-project-checklist-templates.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/checklist/list_templates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.Documentation: https://developers.procore.com/reference/rest/v1/project-checklist-templates#show-project-checklist-template.
- id
A key field. Template: Id.
- name
Template: ShortText.
- deletable
Data type: DT_BOOL
- company_description
Template: ShortText.
- description
Template: ShortText.
- trade
Template: TradeT. A read-only field.
- synced_to
Field components:
-
Uses template:
Id. - Contains the following components: company_id, list_template_id.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/responses.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/responses#list-responses.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/checklist/responses/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/responses#show-response.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/responses.The following request parameters will be automatically processed:
-
application/json:
{{={ response: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/responses#create-a-response.
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/responses/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ response: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/responses#update-a-response.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/checklist/responses/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/responses#delete-a-response.
The resource includes the fields from the InspectionResponseT template.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/observations/items.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations#list-observation-items.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/observations/items/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations#show-observation-item.
-
project_id:
- [Read recycled] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/recycle_bin/observations/items.Documentation: https://developers.procore.com/reference/rest/v1/observations#list-recycled-observation-items.
- [Create] action
-
Endpoint URL address:
/observations/items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, attachments: item.attachments, inspection_item_failed: item.inspection_item_failed, observation: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/observations#create-observation-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/observations/items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, observation: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/observations#update-observation-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/observations/items/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/observations#delete-observation-item.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- closed_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- number
Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- description_rich_text
Template: ShortText.
- status
Template: ShortText.
- priority
Template: ShortText.
- date_notified
Template: Date.
- due_date
Template: Date.
- personal
Data type: DT_BOOL
- origin
Field components:
-
Uses template:
ShortText. - Contains the following components: type, payload.
-
Uses template:
- assignee_id
Template: Id.
- assignee
Template: RefT. A read-only field. Field components:
-
Uses template:
RefT. - Contains the following components: vendor.
-
Uses template:
- created_by_id
Template: Id.
- created_by
Template: UserRefT. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- specification_section
Field components:
-
Uses template:
Id. - Contains the following components: id, description, number, latest_revision_url.
-
Uses template:
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- type_id
Template: Id.
- type
Template: ObservationTypeT. A read-only field.
- custom_fields
Template: LongText. A composite field.
- inspection_item_failed
A key field. Template: Id.
- contributing_behavior_id
Template: Id.
- contributing_condition_id
Template: Id.
- checklist_item_id
Template: Id.
- coordination_issue_id
Template: Id.
- hazard_id
Template: Id.
- incident_action_id
Template: Id.
- distribution_member_ids
Template: Id.
- mt_location
Template: LongText. A composite field.
- drawing_revision_ids
Template: LongText. A composite field.
- file_version_ids
Template: LongText. A composite field.
- form_ids
Template: LongText. A composite field.
- image_ids
Template: LongText. A composite field.
- upload_ids
Template: LongText. A composite field.
Data type: DT_IMAGE A read-only field. The value is gathered from
{{=connection.execute({ url: '/observations/items/' + item.id + '/pdf', headers: { 'Procore-Company-Id': Procore.UI.CompanyEditor.getValue(parameters) }, parameters: { project_id: Procore.UI.ProjectEditor.getValue(parameters) } }).url}}address.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/observations/response_logs.Documentation: https://developers.procore.com/reference/rest/v1/observations#list-observations-response-logs.
- [Read item] action
-
Endpoint URL address:
/observations/items/{{=parameters.item_id}}/response_logs.The action has the following user-defined parameters:
- item_id: Required. Specify observation item identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations#list-observation-item-response-logs.
- [Create] action
-
Endpoint URL address:
/observations/items/{{=item.item_id}}/response_logs.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, response_log: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/observations#create-observation-item-response-log.
-
application/json:
- id
A key field. Template: Id.
- item_id
Template: Id.
- status
Template: ShortText.
- comment
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by_name
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT.
- created_by
Template: RefT. A read-only field.
- prostore_file_ids
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/observation_types.Documentation: https://developers.procore.com/reference/rest/v1/project-observation-types#list-project-observation-types.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/observation_types.The following request parameters will be automatically processed:
-
application/json:
{{={ observation_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-observation-types#create-project-observation-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/observation_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ observation_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/project-observation-types#update-project-observation-type.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/observation_types/{{=item.id}}.Documentation: https://developers.procore.com/reference/rest/v1/project-observation-types#delete-project-observation-type.
The resource includes the fields from the ObservationTypeT template.
Based on resource template BaseProject.
- [Read default distribution] action
-
Endpoint URL address:
/observations/default_distribution.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations#list-observation-default-distribution-members.
-
project_id:
- [Read potential distribution] action
-
Endpoint URL address:
/observations/potential_distribution_members.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations#list-observation-potential-distribution-members.
-
project_id:
- [Read assignee] action
-
Endpoint URL address:
/observations/assignees.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/observations-assignees#list-observation-assignee-options.
-
project_id:
The resource includes the fields from the UserRefT template.
- vendor
Template: RefT.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_item_templates.Documentation: https://developers.procore.com/reference/rest/v1/project-punch-item-templates#list-project-punch-item-templates.
- id
A key field. Template: Id.
- active
Data type: DT_BOOL
- company_punch_item_template_id
Template: Id.
- name
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- punch_item_manager
Template: UserRefT. A read-only field.
- final_approver
Template: UserRefT. A read-only field.
- template_category
Template: RefT. A read-only field.
- assignee
Template: UserRefT. A read-only field.
- trade
Template: TradeT. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/punch_item_types.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-item-types#list-punch-item-types.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/punch_item_types/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-item-types#show-punch-item-type.
-
project_id:
- [Create] action
-
Endpoint URL address:
/punch_item_types.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, punch_item_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/punch-item-types#create-punch-item-type.
-
application/json:
- [Update] action
-
Endpoint URL address:
/punch_item_types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, punch_item_type: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/punch-item-types#update-punch-item-type.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/punch_item_types/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-item-types#delete-punch-item-type.
-
project_id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/punch_items.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-items#list-punch-items.
-
project_id:
- [Read single] action
-
Endpoint URL address:
/punch_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-items#show-punch-item.
-
project_id:
- [Create] action
-
Endpoint URL address:
/punch_items.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, punch_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/punch-items#create-punch-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/punch_items/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, punch_item: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/punch-items#update-punch-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/punch_items/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/punch-items#delete-punch-item.
-
project_id:
- id
A key field. Template: Id.
- ball_in_court
Field components:
- An array.
-
Uses template:
UserRefT.
- closed_at
Template: DateTime. A read-only field.
- cost_impact
Template: ShortText.
- cost_impact_amount
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- description
Template: ShortText.
- due_date
Template: Date.
- name
Template: ShortText.
- reference
Template: ShortText.
- schedule_impact
Template: ShortText.
- schedule_impact_days
Data type: DT_I4
- schedule_risk
Template: ShortText.
- schedule_risk_reason
Template: ShortText.
- schedule_risk_confidence
Data type: DT_I4
- schedule_risk_probability
Data type: DT_I4
- position
Data type: DT_I4
- priority
Template: ShortText.
- private
Data type: DT_BOOL
- status
Template: ShortText.
- has_resolved_responses
Data type: DT_BOOL
- has_unresolved_responses
Data type: DT_BOOL
- updated_at
Template: DateTime. A read-only field.
- location_id
Template: Id.
- location
Template: LocationT. A read-only field.
- trade_id
Template: Id.
- trade
Template: TradeT. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- punch_item_manager_id
Template: Id.
- punch_item_manager
Template: UserRefT. A read-only field.
- final_approver_id
Template: Id.
- final_approver
Template: UserRefT. A read-only field.
- punch_item_type_id
Template: Id.
- punch_item_type
Template: RefT. A read-only field.
- cost_code_id
Template: Id.
- cost_code
Template: RefT. A read-only field.
- assignments
Field components:
- An array.
- Contains the following components: id, approved, comment, login_information_id, login_information_name, login_information, attachments, vendor, notified_at, responded_at, status, manager_accepted_at, user_name, updated_at.
- assignees
A read-only field. Field components:
- An array.
-
Uses template:
UserRefT.
- workflow_status
Template: ShortText.
- custom_fields
Template: LongText. A composite field.
- login_information_ids
Template: LongText. A composite field.
- distribution_member_ids
Template: LongText. A composite field.
- mt_location
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read assignee] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_list_assignee_options.Documentation: https://developers.procore.com/reference/rest/v1/punch-list-assignee-options#list-punch-list-assignee-options.
- [Read final approver] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_list/available_final_approvers.Documentation: https://developers.procore.com/reference/rest/v1/punch-list-available-final-approvers#punch-list-available-final-approvers.
- [Read read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_list_read_user_options.Documentation: https://developers.procore.com/reference/rest/v1/punch-list-read-user-options#list-punch-list-read-user-options.
The resource includes the fields from the UserRefT template.
Based on resource template BaseProject.
- [Read vendor] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_list/vendors.Documentation: https://developers.procore.com/reference/rest/v1/punch-list-filter-options.
- [Read assignee] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/punch_list/assignees.Documentation: https://developers.procore.com/reference/rest/v1/punch-list-filter-options#list-of-punch-list-assignee-filter-options.
- id
Template: Id.
- name
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/ui_flags.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
Documentation: https://developers.procore.com/reference/rest/v1/ui-flags#list-all-ui-flags-available-to-the-user.
- [Create] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/ui_flags.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ ui_flags: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/ui-flags#bulk-create-update-ui-flags.
- [Delete] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/ui_flags.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ ui_flags: batch } }}
Documentation: https://developers.procore.com/reference/rest/v1/ui-flags#bulk-delete-ui-flags.
- name
A key field. Template: ShortText.
- value
Template: ShortText.
- is_user_flag
Data type: DT_BOOL
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/webhooks/hooks/{{=parameters.hook_id}}/deliveries.The action has the following user-defined parameters:
- hook_id: Required. Specify hook identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/deliveries#list-webhooks-deliveries.
- event
Field components:
-
Uses template:
Id. - Contains the following components: user_id, timestamp, resource_name, resource_id, project_id, id, ulid, event_type, company_id, api_version, metadata.
-
Uses template:
- event_id
Template: Id.
- outcome
Template: ShortText.
- response_body
Template: ShortText.
- response_error
Template: ShortText.
- started_at
Template: DateTime.
- completed_at
Template: DateTime.
- response_status
Data type: DT_I4
- response_headers
Template: LongText. A composite field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/webhooks/hooks.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/hooks#list-webhooks-hooks.
-
project_id:
- [Create] action
-
Endpoint URL address:
/webhooks/hooks.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, hook: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/hooks#create-webhooks-hook.
-
application/json:
- [Update] action
-
Endpoint URL address:
/webhooks/hooks/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ company_id: item.company_id, hook: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/hooks#update-webhooks-hook.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/webhooks/hooks/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/hooks#delete-webhooks-hook.
-
project_id:
- id
A key field. Template: Id.
- api_version
Template: ShortText.
- destination_headers
Field components:
-
Uses template:
ShortText. - Contains the following components: Authorization.
-
Uses template:
- destination_url
Template: ShortText.
- owned_by_company_id
Template: Id. A read-only field.
- owned_by_project_id
Template: Id. A read-only field.
- owned_by_user_id
Template: Id. A read-only field.
- namespace
Template: ShortText.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/webhooks/hooks/{{=parameters.hook_id}}/triggers.The action has the following user-defined parameters:
- hook_id: Required. Specify hook identifier.
The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/triggers#list-webhooks-triggers.
- [Create] action
-
Endpoint URL address:
/webhooks/hooks/{{=item.webhook_hook_id}}/triggers.The following request parameters will be automatically processed:
-
application/json:
{{={ project_id: item.project_id, api_version: 'v2', trigger: item } }}
Documentation: https://developers.procore.com/reference/rest/v1/triggers#create-webhooks-trigger.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/webhooks/hooks/{{=item.webhook_hook_id}}/triggers/{{=item.id}}.The following request parameters will be automatically processed:
-
project_id:
{{=item.project_id}}
Documentation: https://developers.procore.com/reference/rest/v1/triggers#delete-webhooks-trigger.
-
project_id:
- id
A key field. Template: Id.
- webhook_hook_id
A key field. Template: Id.
- resource_name
Template: ShortText.
- resource_id
Template: Id. A read-only field.
- event_type
Template: ShortText.
- user_id
Template: Id. A read-only field.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/webhooks/resources.The following request parameters will be automatically processed:
-
project_id:
{{=Procore.UI.ProjectEditor.getValue(parameters)}}
Documentation: https://developers.procore.com/reference/rest/v1/webhook-resources#list-webhooks-resources.
-
project_id:
- api_version
Template: ShortText.
- product_category
Template: ShortText.
- tools
Template: ShortText.
- except
Template: LongText. A composite field.
- create
Template: ShortText.
- update
Template: ShortText.
- delete
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
filters[id]:
{{=Procore.getArrParameter(parameters.get('filters[id]'))}} -
_includeUserParameters:
{{=parameters}}
-
filters[id]:
- [Read single] action
-
The action has the following user-defined parameters:
- id: Required. Specify identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}}
-
page:
Based on resource template NoPagination.
- [Read] action
-
The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- project_id: Required. Specify project identifier.
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=Procore.UI.CompanyEditor.getValue(parameters)}}
- [Create] action
-
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}}
-
Procore-Company-Id:
- [Update] action
-
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}}
-
Procore-Company-Id:
- [Delete] action
-
The following request parameters will be automatically processed:
-
Procore-Company-Id:
{{=item.company_id}}
-
Procore-Company-Id:
- company_id
A key field. Template: Id.
- project_id
A key field. Template: Id.
Based on resource template BaseProjectNoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}}
-
page:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/{{=resource.objects}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- [Read single] action
-
Endpoint URL address:
/companies/{{=Procore.UI.CompanyEditor.getValue(parameters)}}/{{=resource.objects}}/{{parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- company_id: Required. Specify company identifier.
- [Create] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/{{=resource.objects}}.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = {}; result[resource.object] = item; return result; }()}}
-
application/json:
- [Update] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/{{=resource.objects}}/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = {}; result[resource.object] = item; return result; }()}}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.company_id}}/{{=resource.objects}}/{{=item.id}}.
The resource includes the fields from the RefT template.
- company_id
A key field. Template: Id.
Based on resource template BaseProject.
- [Read] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/{{=resource.objects}}.
- [Read single] action
-
Endpoint URL address:
/projects/{{=Procore.UI.ProjectEditor.getValue(parameters)}}/{{=resource.objects}}/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/{{=resource.objects}}.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = {}; result[resource.object] = item; return result; }()}}
-
application/json:
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/{{=resource.objects}}/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = {}; result[resource.object] = item; return result; }()}}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/{{=resource.objects}}/{{=item.id}}.
- id
A key field. Template: Id.
- created_at
Template: DateTime. A read-only field.
- date
Template: Date.
- datetime
Template: DateTime.
- deleted_at
Template: DateTime. A read-only field.
- permissions
A read-only field. Field components:
- Contains the following components: can_update, can_delete.
- position
Data type: DT_I4 A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: UserRefT. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
AttachmentT. - Contains the following components: share_url, viewable_type, viewable_url.
Based on resource template CompanyType.
The resource includes the fields from the IncidentTypeT template.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Id
Data type: DT_I4
- RefT
Field components:
-
Uses template:
Id. - Contains the following components: id, name.
-
Uses template:
- UserRefT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: login, company_name, locale, avatar, initials.
-
Uses template:
- CodeT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: code, full_code.
-
Uses template:
- CurrencyConfigurationT
Field components:
-
Uses template:
ShortText. - Contains the following components: currency_iso_code.
-
Uses template:
- BudgetViewDetailRowT
Field components:
-
Uses template:
Id. - Contains the following components: id, deletable, company_id, company, project_id, wbs_code_id, biller_id, root_cost_code_id, cost_code_id, cost_code_origin_id, category_id, project, biller, biller_type, root_cost_code, cost_code, category, budget_modifications, original_budget_amount, budget_forecast, currency_configuration, unbudgeted_reason.
-
Uses template:
- BudgetViewSnapshotSummaryRowT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: biller_type, budget_line_item_ids.
-
Uses template:
- BudgetViewSummaryRowT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: biller_type, original_budget_amount, budget_modifications, budget_forecast, currency_configuration.
-
Uses template:
- ManualForecastLineItemT
Field components:
-
Uses template:
Id. - Contains the following components: id, budget_line_item_id, wbs_code_id, budget_forecast_id, project_id, company_id, description, quantity, uom, unit_cost, amount, created_at, updated_at.
-
Uses template:
- MonitoringResourceT
Field components:
-
Uses template:
Id. - Contains the following components: id, description, start_date, end_date, unit_of_measure, unit_cost, units_remaining, forecast_to_complete, planned_total_cost, total_units, utilization, budget_line_item_id.
-
Uses template:
- ChangeOrderT
Field components:
-
Uses template:
Id. - Contains the following components: id, created_at, created_by_id, deleted_at, due_date, invoiced_date, number, paid_date, reviewed_at, title, status, updated_at, change_order_request_id, executed, grand_total, revision, schedule_impact_amount, change_reason, change_order_request_title, change_order_package_title, potential_change_order_acronym_number, change_order_request_acronym_number, change_order_package_acronym_number, change_order_tiers.
-
Uses template:
- ChangeOrderPackageT
Field components:
-
Uses template:
Id. - Contains the following components: id, contract_id, created_at, deleted_at, due_date, invoiced_date, number, origin_data, origin_id, paid_date, reviewed_at, title, status, updated_at.
-
Uses template:
- ChangeStatusT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: mapped_to_status, show_in_select.
-
Uses template:
- LineItemTypeT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: code, base_type, origin_data, origin_id.
-
Uses template:
- WbsCodeT
Field components:
-
Uses template:
Id. - Contains the following components: id, flat_code, description.
-
Uses template:
- BaseCostCodeT
Template: CodeT. Field components:
-
Uses template:
Id. - Contains the following components: biller_id, biller_type, created_at, deleted_at, parent_id, sortable_code, standard_cost_code_id, updated_at.
-
Uses template:
- CostCodeT
Template: BaseCostCodeT. Field components:
-
Uses template:
ShortText. - Contains the following components: biller, budgeted, origin_data, origin_id, parent, position, standard_cost_code_list_id, line_item_types.
-
Uses template:
- LineItemT
Field components:
-
Uses template:
Id. - Contains the following components: id, amount, company_id, company, cost_code_id, cost_code, created_at, deleted_at, description, extended_type, holder, line_item_type_id, line_item_type, origin_data, origin_id, position, project_id, project, quantity, tax_code_id, total_amount, extended_amount, unit_cost, uom, wbs_code_id, wbs_code, updated_at, change_event_line_item, currency_configuration.
-
Uses template:
- AttachmentT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: url, filename, content_type, size.
-
Uses template:
- ContractDetailLineItemT
Field components:
-
Uses template:
Id. - Contains the following components: id, amount, description, position, line_item_id, billed_to_date, billed_against, currency_configuration.
-
Uses template:
- BaseRequisitionItemT
Field components:
-
Uses template:
Id. - Contains the following components: id, cost_code_id, description_of_work, scheduled_value, work_completed_from_previous_application, work_completed_this_period, materials_presently_stored, total_completed_and_stored_to_date, total_completed_and_stored_to_date_percent, work_completed_retainage_from_previous_application, work_completed_retainage_retained_this_period, work_completed_retainage_percent_this_period, materials_stored_retainage_currently_retained, materials_stored_retainage_percent_this_period, work_completed_retainage_released_this_period, materials_stored_retainage_released_this_period, scheduled_quantity, scheduled_unit_price, work_completed_this_period_quantity, work_completed_from_previous_application_quantity, subcontractor_claimed_amount, wbs_code, position, currency_configuration.
-
Uses template:
- RequisitionChangeOrderItemT
Template: BaseRequisitionItemT. Field components:
-
Uses template:
Id. - Contains the following components: line_item_id, commitment_line_item_id, commitment_line_item_origin_id, change_order_package_id.
-
Uses template:
- RequisitionContractDetailItemT
Template: BaseRequisitionItemT. Field components:
-
Uses template:
Id. - Contains the following components: detail_line_item_id.
-
Uses template:
- RequisitionContractItemT
Template: BaseRequisitionItemT. Field components:
-
Uses template:
ShortText. - Contains the following components: item_type, accounting_method, line_item_id, comment, status, ssr_manual_override.
-
Uses template:
- LocationT
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: node_name, parent_id, created_at, updated_at, code.
-
Uses template:
- RFQT
Field components:
-
Uses template:
Id. - Contains the following components: id, commitment_contract_id, created_at, deleted_at, description, due_date, estimated_amount, estimated_schedule_impact, estimated_status, intent_to_quote, number, original_quote, position, private, prostore_file_ids, status, title, updated_at, specification_section, quotes, responses, potential_change_orders, change_order_packages, commitment_potential_change_orders, commitment_change_order_packages, created_by, assigned, location, cost_code.
-
Uses template:
- SegmentT
Template: RefT. Field components:
- Uses template: