Procore.Api.WorkforceManagementWorkforcePlanningPeople (procore_sdk v0.3.0)

API calls for all endpoints tagged WorkforceManagementWorkforcePlanningPeople.

Summary

Functions

Remove a Person from a Group Removes a person from a given group. Note that when removing the last group_id, the Group IDs can not be empty for an assignable resource or a non-admin person. Therefore, the removing the last group id from an assignable resource or a non-admin person is not allowed.

Revoke a Person's Login Revoke a Person's login but leave them in as an assignable resource in the system

Functions

Link to this function

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

Get all People belonging to a Group Returns array of Person objects.

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.
    • :first_name (String.t): Filter results by the exact first name of the Person.
    • :last_name (String.t): Filter results by the exact last name of the Person.
    • :email (String.t): Filter results by the exact email address of the Person.
    • :employee_number (String.t): Filter results by the exact employee number of the Person.
    • :custom_fields_integration_name (String.t): Filter results by a Custom Field's integration_name. This allows searching based on custom-defined attributes in the system. Example usage: /v2/companies/{company_id}/...?my_custom_field=northwest
    • :created_at (Date.t): Filters items based on their creation timestamp. Accepts an ISO 8601 date string.
    • :created_before (Date.t): Filters items created on or before the specified date (inclusive). Accepts an ISO 8601 date string.
    • :created_after (Date.t): Filters items created on or after the specified date (inclusive). Accepts an ISO 8601 date string.
    • :updated_at (Date.t): Filters items based on their last updated timestamp. Accepts an ISO 8601 date string.
    • :updated_before (Date.t): Filters items updated on or before the specified date (inclusive). Accepts an ISO 8601 date string.
    • :updated_after (Date.t): Filters items updated on or after the specified date (inclusive). Accepts an ISO 8601 date string.

Returns

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

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

Get all People belonging to a Group Returns array of Person objects.

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.
    • :first_name (String.t): Filter results by the exact first name of the Person.
    • :last_name (String.t): Filter results by the exact last name of the Person.
    • :email (String.t): Filter results by the exact email address of the Person.
    • :employee_number (String.t): Filter results by the exact employee number of the Person.
    • :custom_fields_integration_name (String.t): Filter results by a Custom Field's integration_name. This allows searching based on custom-defined attributes in the system. Example usage: /v2/companies/{company_id}/...?my_custom_field=northwest
    • :created_at (Date.t): Filters items based on their creation timestamp. Accepts an ISO 8601 date string.
    • :created_before (Date.t): Filters items created on or before the specified date (inclusive). Accepts an ISO 8601 date string.
    • :created_after (Date.t): Filters items created on or after the specified date (inclusive). Accepts an ISO 8601 date string.
    • :updated_at (Date.t): Filters items based on their last updated timestamp. Accepts an ISO 8601 date string.
    • :updated_before (Date.t): Filters items updated on or before the specified date (inclusive). Accepts an ISO 8601 date string.
    • :updated_after (Date.t): Filters items updated on or after the specified date (inclusive). Accepts an ISO 8601 date string.

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_delete(connection, procore_company_id, company_id, person_id, opts \\ [])

Delete a Person Deletes a Person for a given company and person ID

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_get(connection, procore_company_id, company_id, person_id, opts \\ [])

Get a Single Person Returns single Person object.

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_groups_group_id_delete(connection, procore_company_id, company_id, person_id, group_id, opts \\ [])

Remove a Person from a Group Removes a person from a given group. Note that when removing the last group_id, the Group IDs can not be empty for an assignable resource or a non-admin person. Therefore, the removing the last group id from an assignable resource or a non-admin person is not allowed.

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
  • person_id (integer()): Unique identifier for the person
  • group_id (integer()): Unique identifier for the group
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_groups_post(connection, procore_company_id, company_id, person_id, opts \\ [])

Add Person to a Group Grant a Person access to or to make them available to a new Group

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdGroupsPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_post(connection, procore_company_id, company_id, person_id, opts \\ [])

Update a Person Updates a Person for a given company and person ID

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_tags_post(connection, procore_company_id, company_id, person_id, opts \\ [])

Add Tag Instance to Person Adds a Tag Instance to Person

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTagsPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_tags_tag_instance_id_delete(connection, procore_company_id, company_id, person_id, tag_instance_id, opts \\ [])

Remove Tag Instance from Person Removes a Tag Instance from a Person

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
  • person_id (integer()): Unique identifier for the person
  • tag_instance_id (integer()): Unique identifier for the tag instance
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_user_delete(connection, procore_company_id, company_id, person_id, opts \\ [])

Revoke a Person's Login Revoke a Person's login but leave them in as an assignable resource in the system

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_user_post(connection, procore_company_id, company_id, person_id, opts \\ [])

Enable a Person to Log In Enable a Person to log in after they have already been created

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
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdUserPostRequest):

Returns

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

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

Create a Person Creates a Person for a given company ID

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
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePostRequest):

Returns

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