Procore.Api.ProjectManagementSubmittalsSubmittals (procore_sdk v0.3.0)
API calls for all endpoints tagged ProjectManagementSubmittalsSubmittals
.
Summary
Functions
List Filter Options for Approvers Returns all Filter Options for Approvers defined for the project
List Filter Options for Ball in Court Company Returns all Filter Options for Ball in Court Company defined for the project
List Filter Options for Ball in Court Returns all Filter Options for Ball in Court defined for the project
List Filter Options for Created By Returns all Filter Options for Created By defined for the project
List Filter Options for Current Revision Returns all Filter Options for Current Revision defined for the project
List Filter Options for Specification Division Returns all Filter Options for Specification Division defined for the project
List available Submittal filters The Submittal Filter Options endpoint lists all endpoints for specific filter options
List Filter Options for Location Returns all Filter Options for Location defined for the project
List of Number Filter Options Returns all unique Submittals Number defined for the project
List Filter Options for Private Returns all Filter Options for Private defined for the project
List Filter Options for Received From Returns all Filter Options for Received From defined for the project
List Filter Options for Submittal Response Returns all Filter Options for Submittal Response defined for the project
List Filter Options for Responsible Contractor Returns all Filter Options for Responsible Contractor defined for the project
List Filter Options for Specification Section Returns all Filter Options for Specification Section defined for the project
List Filter Options for Submittal Status Returns all Filter Options for Submittal Status defined for the project
List Filter Options for Submittal Sub Job Returns all Filter Options for Submittal Sub Job defined for the project
List Filter Options for Submittal Manager Returns all Filter Options for Submittal Manager defined for the project
List Filter Options for Submittal Package Returns all Filter Options for Submittal Package defined for the project
List Filter Options for Submittal Workflow Template Returns all Filter Options for Submittal Workflow Template defined for the project
List Filter Options for Type Returns all Filter Options for Type defined for the project
List Submittals on a project Return a list of all Submittals from a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. See Downloading attachments with markup.
Show Submittal Return detailed information on the specified Submittal. See Downloading attachments with markup.
Update Submittal
Update the specified Submittal. Note: Updating the workflow_data
field is only supported when using the multipart/form-data
request format. If you attempt to update workflow_data
using a JSON
request format, the request will fail with a 400 Bad Request
response, along with the error message: "Error Updating Approvers."
Get Revisions Get the revision history of a submittal. Returns an array of submittals.
Get Workflow Data Returns attributes related to submittal workflow state
Get Next Available Number Returns the next available number. See Get Next Available Number By Spec Section if number submittals by spec section is enabled.
Get Next Available Number By Spec Section Returns the next available number and next spec section number in the project if numbers submittals by spec section is enabled.
Create Submittal Create a new Submittal associated with the specified Project.
List of deleted Submittals The Submittals endpoint returns all deleted Submittals in a project
List Submittal Associated Attachments List Submittal Associated Attachments for the specified Project
List all submittal attachments with download urls Returns the latest version of every attachment. A polling url is provided for cases where the file can be downloaded with markup. If a polling url is provided, the file can be downloaded with the latest version of markup from this endpoint. https://developers.procore.com/reference/document-markup#show-or-create-document-markup-downloadable-pdf
Check if number and revision entered are available or duplicated. Returns if the number and revision entered are available or duplicated. When duplicated, it returns the next_number attribute with the next available number.
List Submittals on a project Return a list of all Submittals from a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. See Downloading attachments with markup.
Delete Submittal Delete the specified Submittal.
Show Submittal Return detailed information on the specified Submittal. See Downloading attachments with markup.
Update Submittal
Update the specified Submittal. Note: Updating the workflow_data
field is only supported when using the multipart/form-data
request format. If you attempt to update workflow_data
using a JSON
request format, the request will fail with a 400 Bad Request
response, along with the error message: "Error Updating Approvers."
Get Revisions Get the revision history of a submittal. Returns an array of submittals.
Get Workflow Data Returns attributes related to submittal workflow state
Show Submittal in PDF format Return detailed information on the specified Submittal in PDF format.
Get Next Available Number Returns the next available number. See Get Next Available Number By Spec Section if number submittals by spec section is enabled.
Get Next Available Number By Spec Section Returns the next available number and next spec section number in the project if numbers submittals by spec section is enabled.
Create Submittal Create a new Submittal associated with the specified Project.
List of deleted Submittals The Submittals endpoint returns all deleted Submittals in a project
Functions
rest_v10_projects_project_id_submittals_filter_options_approver_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_approver_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Approvers Returns all Filter Options for Approvers defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_ball_in_court_company_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_ball_in_court_company_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsBallInCourtCompanyIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Ball in Court Company Returns all Filter Options for Ball in Court Company defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsBallInCourtCompanyIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_ball_in_court_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_ball_in_court_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Ball in Court Returns all Filter Options for Ball in Court defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_created_by_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_created_by_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsCreatedByIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Created By Returns all Filter Options for Created By defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsCreatedByIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_current_revision_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_current_revision_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsCurrentRevisionGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Current Revision Returns all Filter Options for Current Revision defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsCurrentRevisionGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_division_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_division_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsDivisionGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Specification Division Returns all Filter Options for Specification Division defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsDivisionGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List available Submittal filters The Submittal Filter Options endpoint lists all endpoints for specific filter options
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_location_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_location_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsLocationIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Location Returns all Filter Options for Location defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsLocationIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_number_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_number_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsNumberGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List of Number Filter Options Returns all unique Submittals Number defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsNumberGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_private_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_private_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsPrivateGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Private Returns all Filter Options for Private defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsPrivateGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_received_from_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_received_from_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Received From Returns all Filter Options for Received From defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_response_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_response_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsResponseIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Response Returns all Filter Options for Submittal Response defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsResponseIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_responsible_contractor_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_responsible_contractor_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsResponsibleContractorIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Responsible Contractor Returns all Filter Options for Responsible Contractor defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsResponsibleContractorIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_specification_section_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_specification_section_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsSpecificationSectionIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Specification Section Returns all Filter Options for Specification Section defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsSpecificationSectionIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_status_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_status_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsStatusIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Status Returns all Filter Options for Submittal Status defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsStatusIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_sub_job_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_sub_job_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsStatusIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Sub Job Returns all Filter Options for Submittal Sub Job defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsStatusIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_submittal_manager_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_submittal_manager_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Manager Returns all Filter Options for Submittal Manager defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsApproverIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_submittal_package_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_submittal_package_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsSubmittalPackageIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Package Returns all Filter Options for Submittal Package defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsSubmittalPackageIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_submittal_workflow_template_id_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_submittal_workflow_template_id_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsSubmittalWorkflowTemplateIdGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Filter Options for Submittal Workflow Template Returns all Filter Options for Submittal Workflow Template defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsSubmittalWorkflowTemplateIdGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_filter_options_type_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_filter_options_type_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV10ProjectsProjectIdSubmittalsFilterOptionsTypeGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List Filter Options for Type Returns all Filter Options for Type defined for the project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV10ProjectsProjectIdSubmittalsFilterOptionsTypeGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List Submittals on a project Return a list of all Submittals from a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. See Downloading attachments with markup.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[ball_in_court_id]"
(integer()): User ID. Return item(s) where the specified User ID is the Ball in Court.:"filters[created_at]"
(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[query]"(String.t): Return item(s) containing search query -
:"filters[received_from_id]"(integer()): Received From ID -
:"filters[responsible_contractor_id]"(integer()): Responsible Contractor ID -
:"filters[specification_section_id]"([integer()]): Array of Specification Section IDs. A single Specification Section ID is also accepted. -
:"filters[approver_id]"([integer()]): Array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. -
:"filters[current_revision]"(boolean()): Default false. If true, only current revisions are shown. If false, all submittals are shown, regardless of whether or not it is the current revision. -
:"filters[division]"([integer()]): Array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. -
:"filters[location_id]"([integer()]): Array of Location IDs. A single Location ID is also accepted. -
:"filters[submittal_manager_id]"([integer()]): Array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. -
:"filters[submittal_package_id]"([integer()]): Array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. -
:"filters[response_id]"([integer()]): Array of Response IDs. A single Response ID is also accepted. -
:"filters[status_id]"([integer()]): Array of Status IDs. A single Status ID is also accepted. -
:"filters[type]"([String.t]): Array of Submittal Types. A single Submittal Type is also accepted. -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[unpackaged]"(boolean()): Parseable to boolean value, filters out unpackaged Submittals. -
:"filters[number]"([String.t]): Array of Numbers. A single Number is also accepted. -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_projects_project_id_submittals_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Show Submittal Return detailed information on the specified Submittal. See Downloading attachments with markup.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_id_patch(connection, procore_company_id, project_id, id, rest_v11_projects_project_id_submittals_post_request, opts \\ [])
@spec rest_v10_projects_project_id_submittals_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdSubmittalsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Update Submittal
Update the specified Submittal. Note: Updating the workflow_data
field is only supported when using the multipart/form-data
request format. If you attempt to update workflow_data
using a JSON
request format, the request will fail with a 400 Bad Request
response, along with the error message: "Error Updating Approvers."
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDrest_v11_projects_project_id_submittals_post_request
(RestV11ProjectsProjectIdSubmittalsPostRequest):opts
(keyword): Optional parameters:send_emails
(boolean()): Designates whether or not emails will be sent (default false)
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_id_revisions_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_id_revisions_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Revisions Get the revision history of a submittal. Returns an array of submittals.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_id_workflow_data_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_id_workflow_data_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsIdWorkflowDataGet200Response.t()} | {:error, Tesla.Env.t()}
Get Workflow Data Returns attributes related to submittal workflow state
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsIdWorkflowDataGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_next_available_number_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_next_available_number_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Next Available Number Returns the next available number. See Get Next Available Number By Spec Section if number submittals by spec section is enabled.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_next_available_number_spec_section_id_get(connection, procore_company_id, project_id, spec_section_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_next_available_number_spec_section_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Next Available Number By Spec Section Returns the next available number and next spec section number in the project if numbers submittals by spec section is enabled.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.spec_section_id
(integer()): Spec Section IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_post(connection, procore_company_id, project_id, rest_v11_projects_project_id_submittals_post_request, opts \\ [])
@spec rest_v10_projects_project_id_submittals_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdSubmittalsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Create Submittal Create a new Submittal associated with the specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.rest_v11_projects_project_id_submittals_post_request
(RestV11ProjectsProjectIdSubmittalsPostRequest):opts
(keyword): Optional parameters:send_emails
(boolean()): Designates whether or not emails will be sent (default false)
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v10_projects_project_id_submittals_recycle_bin_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_projects_project_id_submittals_recycle_bin_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List of deleted Submittals The Submittals endpoint returns all deleted Submittals in a project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[ball_in_court_id]"
(integer()): User ID. Return item(s) where the specified User ID is the Ball in Court.:"filters[created_at]"
(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[query]"(String.t): Return item(s) containing search query -
:"filters[received_from_id]"(integer()): Received From ID -
:"filters[responsible_contractor_id]"(integer()): Responsible Contractor ID -
:"filters[specification_section_id]"([integer()]): Array of Specification Section IDs. A single Specification Section ID is also accepted. -
:"filters[approver_id]"([integer()]): Array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. -
:"filters[current_revision]"(boolean()): Default false. If true, only current revisions are shown. If false, all submittals are shown, regardless of whether or not it is the current revision. -
:"filters[division]"([integer()]): Array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. -
:"filters[location_id]"([integer()]): Array of Location IDs. A single Location ID is also accepted. -
:"filters[submittal_manager_id]"([integer()]): Array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. -
:"filters[submittal_package_id]"([integer()]): Array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. -
:"filters[response_id]"([integer()]): Array of Response IDs. A single Response ID is also accepted. -
:"filters[status_id]"([integer()]): Array of Status IDs. A single Status ID is also accepted. -
:"filters[type]"([String.t]): Array of Submittal Types. A single Submittal Type is also accepted. -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v10_submittal_associated_attachments_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v10_submittal_associated_attachments_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV10SubmittalAssociatedAttachmentsGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List Submittal Associated Attachments List Submittal Associated Attachments for the specified Project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:view
(String.t): view for which you are exporting
Returns
{:ok, [%RestV10SubmittalAssociatedAttachmentsGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_attachments_with_markup_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_attachments_with_markup_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsAttachmentsWithMarkupGet200ResponseInner.t() ]} | {:error, Tesla.Env.t()}
List all submittal attachments with download urls Returns the latest version of every attachment. A polling url is provided for cases where the file can be downloaded with markup. If a polling url is provided, the file can be downloaded with the latest version of markup from this endpoint. https://developers.procore.com/reference/document-markup#show-or-create-document-markup-downloadable-pdf
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV11ProjectsProjectIdSubmittalsAttachmentsWithMarkupGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_check_number_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_check_number_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsCheckNumberGet200Response.t()} | {:error, Tesla.Env.t()}
Check if number and revision entered are available or duplicated. Returns if the number and revision entered are available or duplicated. When duplicated, it returns the next_number attribute with the next available number.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsCheckNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.RestV11ProjectsProjectIdSubmittalsGet200ResponseInner.t()]} | {:error, Tesla.Env.t()}
List Submittals on a project Return a list of all Submittals from a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. See Downloading attachments with markup.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[ball_in_court_id]"
(integer()): User ID. Return item(s) where the specified User ID is the Ball in Court.:"filters[created_at]"
(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[query]"(String.t): Return item(s) containing search query -
:"filters[received_from_id]"(integer()): Received From ID -
:"filters[responsible_contractor_id]"(integer()): Responsible Contractor ID -
:"filters[specification_section_id]"([integer()]): Array of Specification Section IDs. A single Specification Section ID is also accepted. -
:"filters[approver_id]"([integer()]): Array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. -
:"filters[current_revision]"(boolean()): Default false. If true, only current revisions are shown. If false, all submittals are shown, regardless of whether or not it is the current revision. -
:"filters[division]"([integer()]): Array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. -
:"filters[location_id]"([integer()]): Array of Location IDs. A single Location ID is also accepted. -
:"filters[submittal_manager_id]"([integer()]): Array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. -
:"filters[submittal_package_id]"([integer()]): Array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. -
:"filters[response_id]"([integer()]): Array of Response IDs. A single Response ID is also accepted. -
:"filters[status_id]"([integer()]): Array of Status IDs. A single Status ID is also accepted. -
:"filters[type]"([String.t]): Array of Submittal Types. A single Submittal Type is also accepted. -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[unpackaged]"(boolean()): Parseable to boolean value, filters out unpackaged Submittals. -
:"filters[number]"([String.t]): Array of Numbers. A single Number is also accepted. -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure
rest_v11_projects_project_id_submittals_id_delete(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete Submittal Delete the specified Submittal.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_id_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Show Submittal Return detailed information on the specified Submittal. See Downloading attachments with markup.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_id_patch(connection, procore_company_id, project_id, id, rest_v11_projects_project_id_submittals_post_request, opts \\ [])
@spec rest_v11_projects_project_id_submittals_id_patch( Tesla.Env.client(), integer(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdSubmittalsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Update Submittal
Update the specified Submittal. Note: Updating the workflow_data
field is only supported when using the multipart/form-data
request format. If you attempt to update workflow_data
using a JSON
request format, the request will fail with a 400 Bad Request
response, along with the error message: "Error Updating Approvers."
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDrest_v11_projects_project_id_submittals_post_request
(RestV11ProjectsProjectIdSubmittalsPostRequest):opts
(keyword): Optional parameters:send_emails
(boolean()): Designates whether or not emails will be sent (default false)
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_id_revisions_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_id_revisions_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Revisions Get the revision history of a submittal. Returns an array of submittals.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page
Returns
{:ok, [%RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner{}, ...]}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_id_workflow_data_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_id_workflow_data_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsIdWorkflowDataGet200Response.t()} | {:error, Tesla.Env.t()}
Get Workflow Data Returns attributes related to submittal workflow state
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsIdWorkflowDataGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_idpdf_get(connection, procore_company_id, project_id, id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_idpdf_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Show Submittal in PDF format Return detailed information on the specified Submittal in PDF format.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.id
(integer()): Submittal IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_next_available_number_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_next_available_number_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Next Available Number Returns the next available number. See Get Next Available Number By Spec Section if number submittals by spec section is enabled.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_next_available_number_spec_section_id_get(connection, procore_company_id, project_id, spec_section_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_next_available_number_spec_section_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t()} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Get Next Available Number By Spec Section Returns the next available number and next spec section number in the project if numbers submittals by spec section is enabled.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.spec_section_id
(integer()): Spec Section IDopts
(keyword): Optional parameters
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsNextAvailableNumberGet200Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_post(connection, procore_company_id, project_id, rest_v11_projects_project_id_submittals_post_request, opts \\ [])
@spec rest_v11_projects_project_id_submittals_post( Tesla.Env.client(), integer(), integer(), Procore.Model.RestV11ProjectsProjectIdSubmittalsPostRequest.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t()} | {:error, Tesla.Env.t()}
Create Submittal Create a new Submittal associated with the specified Project.
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.rest_v11_projects_project_id_submittals_post_request
(RestV11ProjectsProjectIdSubmittalsPostRequest):opts
(keyword): Optional parameters:send_emails
(boolean()): Designates whether or not emails will be sent (default false)
Returns
{:ok, Procore.Model.RestV11ProjectsProjectIdSubmittalsPost201Response.t}
on success{:error, Tesla.Env.t}
on failure
rest_v11_projects_project_id_submittals_recycle_bin_get(connection, procore_company_id, project_id, opts \\ [])
@spec rest_v11_projects_project_id_submittals_recycle_bin_get( Tesla.Env.client(), integer(), integer(), keyword() ) :: {:ok, [ Procore.Model.RestV11ProjectsProjectIdSubmittalsRecycleBinGet200ResponseInner.t() ]} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
List of deleted Submittals The Submittals endpoint returns all deleted Submittals in a project
Parameters
connection
(Procore.Connection): Connection to serverprocore_company_id
(integer()): Unique company identifier associated with the Procore User Account.project_id
(integer()): Unique identifier for the project.opts
(keyword): Optional parameters:page
(integer()): Page:per_page
(integer()): Elements per page:"filters[id]"
([integer()]): Return item(s) with the specified IDs.:"filters[ball_in_court_id]"
(integer()): User ID. Return item(s) where the specified User ID is the Ball in Court.:"filters[created_at]"
(Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD
...YYYY-MM-DD
- DateYYYY-MM-DDTHH:MM:SSZ
...YYYY-MM-DDTHH:MM:SSZ
- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:"filters[query]"(String.t): Return item(s) containing search query -
:"filters[received_from_id]"(integer()): Received From ID -
:"filters[responsible_contractor_id]"(integer()): Responsible Contractor ID -
:"filters[specification_section_id]"([integer()]): Array of Specification Section IDs. A single Specification Section ID is also accepted. -
:"filters[approver_id]"([integer()]): Array of User IDs. Return item(s) where the specified User IDs are in the approver list. A single integer is also accepted. -
:"filters[current_revision]"(boolean()): Default false. If true, only current revisions are shown. If false, all submittals are shown, regardless of whether or not it is the current revision. -
:"filters[division]"([integer()]): Array of Divisions to filter on. A Division is the first two digits from the Specification Section Number. A single Division is also accepted. -
:"filters[location_id]"([integer()]): Array of Location IDs. A single Location ID is also accepted. -
:"filters[submittal_manager_id]"([integer()]): Array of Submittal Manager IDs. A single Submittal Manager ID is also accepted. -
:"filters[submittal_package_id]"([integer()]): Array of Submittal Package IDs. Returns item(s) associated with the specified Submittal Package IDs. A single integer value is also accepted. -
:"filters[response_id]"([integer()]): Array of Response IDs. A single Response ID is also accepted. -
:"filters[status_id]"([integer()]): Array of Status IDs. A single Status ID is also accepted. -
:"filters[type]"([String.t]): Array of Submittal Types. A single Submittal Type is also accepted. -
:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:
YYYY-MM-DD...
YYYY-MM-DD- Date
YYYY-MM-DDTHH:MM:SSZ...
YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC Offset
YYYY-MM-DDTHH:MM:SS+XX:00...
YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -
:sort(String.t): ### Returns -
, ...]}on success -
` on failure