Compute Flow

Computes the flow identified with the ID {rflId}.

URI: compute/compute/flow/{rflId}

Parameters

Parameters in bold are mandatory

Location

Name

Description

Type

path

rflId

The ID of the flow to be computed.

See Get Resource ID for further details on how to retrieve IDs.

str

querystring

mode

The computation mode, which can be:

  • "flow", to compute the whole flow

  • "upto", to compute upstream of the selected tasks

  • "onwards", to compute downstream the selected tasks

  • "selected" to compute only the selected tasks.

str

body

taskList

The list of the tasks to be computed.

str, or list for multiple tasks

querystring

ismodule

If True, the task list is part of a module, otherwise False.

bool

body

compute_params

The computation parameters for the chosen flow, which can be:

  • "inmemory", in which case:

    • "0" is the database

    • “1" is a full in-memory computation,

    • "2" is an in-memory source saving computation.

  • "procvar": in which case the following values inherit the flow's preferences:

    • nparallel: the maximum number of task which can be computed at the same time.

    • failpolicy: the policy to use if the computation fails: it can be "stopprocess", "stopneighbours" , "continue".

    • prioritypolicy: the policy to use to calculate the priorities: it can be "parentfirst" or "priorityfirst".

    • failpolicymacro: the policy to use if the macro fails.

    • floatprec: the precision of float values.

    • cache_vault_var: if True the vault variables' values are used.

    • suppress_alert: if True alerts are not used in computation.

dict

To see details on possible response codes, go to API Responses.