Procore.Api.CoreCompanyOperations (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyOperations.

Summary

Functions

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

List Operations List all asynchronous operations for the company

rest_v20_companies_company_id_async_operations_operation_id_get(connection, procore_company_id, company_id, operation_id, opts \\ [])

Get Operation Details Retrieve details of a specific asynchronous operation for the company

Functions

Link to this function

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

@spec rest_v20_companies_company_id_async_operations_get(
  Tesla.Env.client(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV20CompaniesCompanyIdAsyncOperationsGet200Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:error, Tesla.Env.t()}

List Operations List all asynchronous operations for the company

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :"filters[operation_type]" (String.t): Return operations of the specified type.
    • :"filters[started_after]" (DateTime.t): Return operations that started after the started_after time.
    • :"filters[started_before]" (DateTime.t): Return operations that started before the started_before time.
    • :"filters[status]" (String.t): Return operations with the specified status.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v20_companies_company_id_async_operations_operation_id_get(connection, procore_company_id, company_id, operation_id, opts \\ [])

@spec rest_v20_companies_company_id_async_operations_operation_id_get(
  Tesla.Env.client(),
  integer(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdAsyncOperationsOperationIdGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get Operation Details Retrieve details of a specific asynchronous operation for the company

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • operation_id (String.t): Unique identifier for the operation.
  • opts (keyword): Optional parameters

Returns

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