Procore.Api.CoreProjectProjectAssignments (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectProjectAssignments.

Summary

Functions

List Project assignments for a Company User This endpoint returns the current and potential Project assignments for the specified User. This includes Project information, as well as the Permission Template and Roles assigned to a given user when they are assigned on a Project.

Functions

Link to this function

rest_v10_companies_company_id_users_user_id_project_assignments_get(connection, procore_company_id, company_id, user_id, opts \\ [])

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

List Project assignments for a Company User This endpoint returns the current and potential Project assignments for the specified User. This includes Project information, as well as the Permission Template and Roles assigned to a given user when they are assigned on a Project.

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.
  • user_id (integer()): User ID
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[active]" (boolean()): If true, returns item(s) with a status of 'active'.
    • :"filters[name]" ([String.t]): Filter item(s) with matching name.
    • :"filters[by_stage]" (RestV11ProjectsGetFiltersByOwnerTypeParameter): Return item(s) with the specified project stage ID(s).
    • :"filters[by_type]" (RestV11ProjectsGetFiltersByOwnerTypeParameter): Return item(s) with the specified project type ID(s).
    • :"filters[by_program]" (RestV11ProjectsGetFiltersByOwnerTypeParameter): Return item(s) with the specified project program ID(s).
    • :"filters[by_region]" (RestV11ProjectsGetFiltersByOwnerTypeParameter): Return item(s) with the specified project region ID(s).
    • :"filters[by_status]" (String.t): Return item(s) with the specified status value. Must be one of Active, Inactive, or All.
    • :"filters[project_roles]" (integer()): Return item(s) with the Project Role ID(s).
    • :"filters[project_permission_templates]" (integer()): Return item(s) with the Project Permissions Template ID(s).
    • :"filters[assignment_status]" (String.t): Filters projects to those matching the given assignment status.
    • :sort (String.t): Sort the results by the specified field.
    • :direction (String.t): Sort direction. Default is ascending, nulls first.

Returns

  • {:ok, [%ProjectAssignmentNormalView{}, ...]} on success
  • {:error, Tesla.Env.t} on failure