Procore.Api.CoreWorkflowsLegacyWorkflowInstances (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreWorkflowsLegacyWorkflowInstances.

Summary

Functions

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

List Workflow Instances Return a list of workflow instances for a workflow. Any resource using workflow should have a workflow instance. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

rest_v10_workflow_instances_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show Workflow Instance Get information about a Workflow Instance

Functions

Link to this function

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

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

List Workflow Instances Return a list of workflow instances for a workflow. Any resource using workflow should have a workflow instance. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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.
  • opts (keyword): Optional parameters
    • :"filters[workflowed_object_id]" (integer()): Return items for a specific workflow object.
    • :"filters[workflowed_object_type]" (String.t): Return items for a specific workflow object type.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_workflow_instances_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Workflow Instance Get information about a Workflow Instance

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

Returns

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