Procore.Api.ProjectManagementInstructionsInstructions (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementInstructionsInstructions.

Summary

Functions

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

List Instructions on a project Return a list of all Instructions from a specified Project.

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

Delete Instruction Delete the specified Instruction.

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

Show Instruction Return detailed information on the specified Instruction.

rest_v10_projects_project_id_instructions_id_patch(connection, procore_company_id, project_id, id, body76, opts \\ [])

Update Instruction Update the specified Instruction.

rest_v10_projects_project_id_instructions_post(connection, procore_company_id, project_id, body75, opts \\ [])

Create Instructions Create a new Instruction associated with the specified Project.

Functions

Link to this function

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

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

List Instructions on a project Return a list of all Instructions from 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

Returns

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

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

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

Delete Instruction Delete the specified Instruction.

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.
  • id (integer()): Instruction ID
  • opts (keyword): Optional parameters

Returns

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

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

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

Show Instruction Return detailed information on the specified Instruction.

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.
  • id (integer()): Instruction ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_instructions_id_patch(connection, procore_company_id, project_id, id, body76, opts \\ [])

@spec rest_v10_projects_project_id_instructions_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.Body76.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdInstructionsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Update Instruction Update the specified Instruction.

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.
  • id (integer()): Instruction ID
  • body76 (Body76):
  • opts (keyword): Optional parameters
    • :send_emails (boolean()): Designates whether or not emails will be sent (default false)

Returns

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

rest_v10_projects_project_id_instructions_post(connection, procore_company_id, project_id, body75, opts \\ [])

@spec rest_v10_projects_project_id_instructions_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.Body75.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdInstructionsGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Create Instructions Create a new Instruction associated with the 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.
  • body75 (Body75):
  • opts (keyword): Optional parameters

Returns

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