Procore.Api.WorkforceManagementWorkforcePlanningResourceRequests (procore_sdk v0.3.0)

API calls for all endpoints tagged WorkforceManagementWorkforcePlanningResourceRequests.

Summary

Functions

rest_v10_workforce_planning_v2_companies_company_id_groups_group_id_resource_requests_get(connection, procore_company_id, company_id, group_id, opts \\ [])

Get All Resource Requests for Projects in a Single Group Retrieves all Resource Requests for projects within a specified group. This is a pageable endpoint.

rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_get(connection, procore_company_id, company_id, project_id, opts \\ [])

Get All Resource Requests for a Single Project Retrieves all Resource Requests for a specified Project within a company. This is a pageable endpoint.

rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_post(connection, procore_company_id, company_id, project_id, opts \\ [])

Create a Resource Request on a Project Creates a new Resource Request for a specified project within a given company. Resource requests can be based on work hours (start_time and end_time) or percent allocation (percent_allocated).

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

Get All Resource Requests in a Company Retrieves all Resource Requests across a company. This is a pageable endpoint.

rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_delete(connection, procore_company_id, company_id, request_id, opts \\ [])

Delete a Resource Request Deletes an existing Resource Request within a company.

rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_post(connection, procore_company_id, company_id, request_id, opts \\ [])

Update a Single Resource Request Updates an existing Resource Request within a company. Only specified properties in the request body will be updated.

Functions

Link to this function

rest_v10_workforce_planning_v2_companies_company_id_groups_group_id_resource_requests_get(connection, procore_company_id, company_id, group_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_groups_group_id_resource_requests_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get All Resource Requests for Projects in a Single Group Retrieves all Resource Requests for projects within a specified group. This is a pageable endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • group_id (integer()): Unique identifier for the group
  • opts (keyword): Optional parameters
    • :page (integer()): This is a 0-based index representing the page slice of the data you want to retrieve. Each page contains up to 400 items. ### 📌 Pageable Endpoints People endpoints that return multiple records support pagination. It is recommended to use this feature to prevent network timeouts from excessively large data requests. ### 📌 Response Structure A successful response will include the following properties: - possible_pages (integer) → Total number of pages available to retrieve all data. - current_page (integer) → The 0-based index of the page retrieved. - data (array) → List of records returned for the requested page (up to 400 items per page). If a page value exceeds possible_pages, the data property will return an empty array.

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_get(connection, procore_company_id, company_id, project_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get All Resource Requests for a Single Project Retrieves all Resource Requests for a specified Project within a company. This is a pageable endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • project_id (integer()): Unique identifier for the project
  • opts (keyword): Optional parameters
    • :page (integer()): This is a 0-based index representing the page slice of the data you want to retrieve. Each page contains up to 400 items. ### 📌 Pageable Endpoints People endpoints that return multiple records support pagination. It is recommended to use this feature to prevent network timeouts from excessively large data requests. ### 📌 Response Structure A successful response will include the following properties: - possible_pages (integer) → Total number of pages available to retrieve all data. - current_page (integer) → The 0-based index of the page retrieved. - data (array) → List of records returned for the requested page (up to 400 items per page). If a page value exceeds possible_pages, the data property will return an empty array.

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_post(connection, procore_company_id, company_id, project_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_projects_project_id_resource_requests_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsPost200Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:error, Tesla.Env.t()}

Create a Resource Request on a Project Creates a new Resource Request for a specified project within a given company. Resource requests can be based on work hours (start_time and end_time) or percent allocation (percent_allocated).

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • project_id (integer()): Unique identifier for the project
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsPostRequest):

Returns

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

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

@spec rest_v10_workforce_planning_v2_companies_company_id_resource_requests_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get All Resource Requests in a Company Retrieves all Resource Requests across a company. This is a pageable endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • opts (keyword): Optional parameters
    • :page (integer()): This is a 0-based index representing the page slice of the data you want to retrieve. Each page contains up to 400 items. ### 📌 Pageable Endpoints People endpoints that return multiple records support pagination. It is recommended to use this feature to prevent network timeouts from excessively large data requests. ### 📌 Response Structure A successful response will include the following properties: - possible_pages (integer) → Total number of pages available to retrieve all data. - current_page (integer) → The 0-based index of the page retrieved. - data (array) → List of records returned for the requested page (up to 400 items per page). If a page value exceeds possible_pages, the data property will return an empty array.

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_delete(connection, procore_company_id, company_id, request_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdResourceRequestsRequestIdDelete200Response.t()}
  | {:error, Tesla.Env.t()}

Delete a Resource Request Deletes an existing Resource Request within a company.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • request_id (String.t): Unique identifier for the Resource Request.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_post(connection, procore_company_id, company_id, request_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_resource_requests_request_id_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsProjectIdResourceRequestsPost200Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:error, Tesla.Env.t()}

Update a Single Resource Request Updates an existing Resource Request within a company. Only specified properties in the request body will be updated.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company. NOTE - this is a Laborchart company ID
  • request_id (String.t): Unique identifier for the Resource Request.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdResourceRequestsRequestIdPostRequest):

Returns

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