Procore.Api.WorkforceManagementWorkforcePlanningTags (procore_sdk v0.3.0)

API calls for all endpoints tagged WorkforceManagementWorkforcePlanningTags.

Summary

Functions

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

Get All Workforce Planning Tag for a Group Gets all of the Workforce Planning Tags belonging to a Group

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

Get All Workforce Planning Tag for a Company Gets all of the Workforce Planning Tags belonging to a Company

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

Create Company Tag Creates a Workforce Planning Tag for the given company

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_delete(connection, procore_company_id, company_id, tag_id, opts \\ [])

Delete a Workforce Planning Tag Deletes a Workforce Planning Tag

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_get(connection, procore_company_id, company_id, tag_id, opts \\ [])

Get a Single Workforce Planning Tag Gets a single Workforce Planning Tag

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_group_id_delete(connection, procore_company_id, company_id, tag_id, group_id, group_ids, opts \\ [])

Remove Tag Availablility to Group Removes a Workforce Planning Tag from being available to a given group or groups

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_post(connection, procore_company_id, company_id, tag_id, opts \\ [])

Make Tag from being Available to Group Makes a Workforce Planning Tag from being Available to a given Group

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_post(connection, procore_company_id, company_id, tag_id, opts \\ [])

Update Company Tag Updates a Workforce Planning Tag for the given company

Functions

Link to this function

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

@spec rest_v10_workforce_planning_v2_companies_company_id_groups_group_id_tags_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdTagsGet200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

Get All Workforce Planning Tag for a Group Gets all of the Workforce Planning Tags belonging to a 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
  • group_id (integer()): Unique identifier for the group
  • opts (keyword): Optional parameters

Returns

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

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

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdTagsGet200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

Get All Workforce Planning Tag for a Company Gets all of the Workforce Planning Tags belonging to 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
  • opts (keyword): Optional parameters

Returns

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

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

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdTagsPost200ResponseInner.t()
     ]}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:error, Tesla.Env.t()}

Create Company Tag Creates a Workforce Planning Tag for the given 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
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdTagsPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_delete(connection, procore_company_id, company_id, tag_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdTagsPost200ResponseInner.t()
     ]}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:error, Tesla.Env.t()}

Delete a Workforce Planning Tag Deletes a Workforce Planning Tag

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

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_get(connection, procore_company_id, company_id, tag_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdTagsGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:error, Tesla.Env.t()}

Get a Single Workforce Planning Tag Gets a single Workforce Planning Tag

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

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_group_id_delete(connection, procore_company_id, company_id, tag_id, group_id, group_ids, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_group_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  [String.t()],
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdTagsTagIdGroupsPost200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

Remove Tag Availablility to Group Removes a Workforce Planning Tag from being available to a given group or groups

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
  • tag_id (integer()): Unique identifier for the tag.
  • group_id (integer()): Unique identifier for the group
  • group_ids ([String.t]): Array of UUIDs for which Groups this Tag should be available to or be removed from depending on context. For adding availability, if globally_accessible is true, this can be an empty array.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_post(connection, procore_company_id, company_id, tag_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_groups_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdTagsTagIdGroupsPost200ResponseInner.t()
     ]}
  | {:error, Tesla.Env.t()}

Make Tag from being Available to Group Makes a Workforce Planning Tag from being Available to a given 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
  • tag_id (integer()): Unique identifier for the tag.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdTagsTagIdGroupsPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_post(connection, procore_company_id, company_id, tag_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_tags_tag_id_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet404Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdTagsGet200ResponseInner.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdProjectsGet403Response.t()}
  | {:error, Tesla.Env.t()}

Update Company Tag Updates a Workforce Planning Tag for the given 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
  • tag_id (integer()): Unique identifier for the tag.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdTagsTagIdPostRequest):

Returns

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