Procore.Api.WorkforceManagementWorkforcePlanningWorkforcePlanningCustomFields (procore_sdk v0.3.0)

API calls for all endpoints tagged WorkforceManagementWorkforcePlanningWorkforcePlanningCustomFields.

Summary

Functions

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_delete(connection, procore_company_id, company_id, field_id, opts \\ [])

Delete Custom Field Deletes a Custom Field from a company.

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_get(connection, procore_company_id, company_id, field_id, opts \\ [])

Get Single Custom Field Retrieves a single Custom Field by its ID.

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_post(connection, procore_company_id, company_id, field_id, opts \\ [])

Update Custom Field Updates an existing Custom Field for a given company ID. The type property cannot be modified after creation.

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_values_delete(connection, procore_company_id, company_id, field_id, opts \\ [])

Remove Values from Custom Field Removes specified values from a Custom Field with type select or multi-select.

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_values_post(connection, procore_company_id, company_id, field_id, opts \\ [])

Add Values to Custom Field Appends new values to a Custom Field with type select or multi-select.

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

Get All Custom Fields Retrieves all Custom Fields within the specified company.

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

Create Custom Field Creates a new Custom Field for a given company ID. Custom Fields are used to store additional information about Projects or People.

Functions

Link to this function

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_delete(connection, procore_company_id, company_id, field_id, opts \\ [])

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

Delete Custom Field Deletes a Custom Field from 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
  • field_id (String.t): UUID of the Custom Field.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_get(connection, procore_company_id, company_id, field_id, opts \\ [])

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

Get Single Custom Field Retrieves a single Custom Field by its 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
  • field_id (String.t): UUID of the Custom Field.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_post(connection, procore_company_id, company_id, field_id, opts \\ [])

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

Update Custom Field Updates an existing Custom Field for a given company ID. The type property cannot be modified after creation.

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
  • field_id (String.t): UUID of the Custom Field.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdCustomFieldsFieldIdPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_values_delete(connection, procore_company_id, company_id, field_id, opts \\ [])

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

Remove Values from Custom Field Removes specified values from a Custom Field with type select or multi-select.

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
  • field_id (String.t): UUID of the Custom Field.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdCustomFieldsFieldIdValuesDeleteRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_custom_fields_field_id_values_post(connection, procore_company_id, company_id, field_id, opts \\ [])

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

Add Values to Custom Field Appends new values to a Custom Field with type select or multi-select.

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
  • field_id (String.t): UUID of the Custom Field.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdCustomFieldsFieldIdValuesPostRequest):

Returns

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

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

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

Get All Custom Fields Retrieves all Custom Fields within the specified 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, [%RestV10WorkforcePlanningV2CompaniesCompanyIdCustomFieldsGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Create Custom Field Creates a new Custom Field for a given company ID. Custom Fields are used to store additional information about Projects or People.

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 (RestV10WorkforcePlanningV2CompaniesCompanyIdCustomFieldsPostRequest):

Returns

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