Procore.Api.CoreCostCodesSubJobsSubJobs (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCostCodesSubJobsSubJobs.

Summary

Functions

List Sub Jobs Return a list of all Sub Jobs in a specified Project.

Delete Sub Job Delete a specified Sub Job. Deprecation Note: Please find the replacement endpoint in the Work Breakdown Structure documents. This endpoint will be replaced with the Delete Project Segment Item Endpoint.

Show Sub Job Return a specified Sub Jobs in a specified Project.

Functions

Link to this function

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

List Sub Jobs Return a list of all Sub Jobs in a specified Project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_sub_jobs_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_sub_jobs_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete Sub Job Delete a specified Sub Job. Deprecation Note: Please find the replacement endpoint in the Work Breakdown Structure documents. This endpoint will be replaced with the Delete Project Segment Item Endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_sub_jobs_id_get(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_sub_jobs_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, Procore.Model.RestV10SubJobsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Show Sub Job Return a specified Sub Jobs in a specified Project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_sub_jobs_id_patch(connection, procore_company_id, id, sub_job_body, opts \\ [])

@spec rest_v10_sub_jobs_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.SubJobBody.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV10SubJobsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Update Sub Job Update a specified Sub Job.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID
  • sub_job_body (SubJobBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_sub_jobs_post(connection, procore_company_id, sub_job_body, opts \\ [])

Create Sub Job Create a new Sub Job.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • sub_job_body (SubJobBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_sub_jobs_sync_patch(connection, procore_company_id, project_id, sub_job_sync_body, opts \\ [])

Sync Sub Jobs

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • sub_job_sync_body (SubJobSyncBody):
  • opts (keyword): Optional parameters

Returns

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