Procore.Api.CoreProjectProjectRoles (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectProjectRoles.

Summary

Functions

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

List Project Roles Return a list of all relationships between Users and Roles in a specified Project.

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

Delete Project Role Remove a relationship between a User and a Role in a specified Project.

rest_v10_project_roles_post(connection, procore_company_id, body37, opts \\ [])

Create Project Role Create a relationship between a User and a Role in a specified Project.

Functions

Link to this function

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

@spec rest_v10_project_roles_get(Tesla.Env.client(), integer(), integer(), keyword()) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.ProjectRole.t()]}
  | {:error, Tesla.Env.t()}

List Project Roles Return a list of all relationships between Users and Roles 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
    • :"filters[created_at]" (DateTime.t): Return item(s) created within the specified ISO 8601 datetime range.
    • :"filters[add_to_project_team]" (String.t): Filter results based on the add_to_project_team column. Accepts true or false to include or exclude items accordingly.

Returns

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

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

@spec rest_v10_project_roles_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok,
     Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()}
  | {:error, Tesla.Env.t()}

Delete Project Role Remove a relationship between a User and a Role 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 of the Project Role
  • 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_project_roles_post(connection, procore_company_id, body37, opts \\ [])

@spec rest_v10_project_roles_post(
  Tesla.Env.client(),
  integer(),
  Procore.Model.Body37.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkOrderContractsWorkOrderContractIdSubcontractorScheduleOfValuesStatusPatch404Response.t()}
  | {:ok, Procore.Model.ProjectRole.t()}
  | {:error, Tesla.Env.t()}

Create Project Role Create a relationship between a User and a Role in a specified Project.

Parameters

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

Returns

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