Step (Workflow)

analyze.step.add_label(project_id, step_id, label)

Sets a label on a step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

  • label (str) – The label unique name

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.add_path(project_id, step_id, path)

Adds a step reference path in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.step.add_paths(project_id, additions)

Adds multiple step reference paths in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • additions (list) – List of moves, containing: step_id (str): Unique step identifier to_path (str): New path

Returns

None

analyze.step.config(project_id, step_id)

Gets the step configuration json

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

Returns

None

analyze.step.convert(project_id, step_id, operation)

Converts a step from current operation type to the new operation type specified

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

  • operation (str) – Step operation to convert the step to

Returns

result dict with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

dict

analyze.step.copy_directory(project_id, from_path, to_path)

Copies a folder and all paths in the hierarchy but does not duplicate referenced objects

Parameters
  • project_id (str) – Unique project identifier

  • from_path (str) – Original directory path

  • to_path (str) – Destination directory path

Returns

None

analyze.step.copy_object(from_workspace_id, from_project_id, to_project_id, to_workflow_id, path, start_position, nodes, enabled=True, update_object=True, prefix=None, suffix=None)

Copies a step as a new step.

Parameters
  • from_workspace_id (int) – Unique workspace identifier

  • from_project_id (str) – Unique project identifier

  • to_project_id (str) – Project into which to copy the steps

  • to_workflow_id (str) – Unique workflow identifier into which to copy the steps

  • path (str) – Workflow structure path

  • start_position (int) – Position within the folder

  • nodes (list) – List of nodes to copy. List of dicts with keys id, kind, enabled (optional)

  • enabled (bool) – Whether the node is enabled in the workflow if not specified in the nodes list values

  • update_object (bool) – True to update the node object workflow references

  • prefix (str) – Value to prefix on the step name

  • suffix (str) – Value to suffix on the step name

Returns

None

analyze.step.copy_reference(project_id, workflow_id, path, start_position, nodes, kind='step', enabled=True, update_object=True)

Copies a step. Does not create a new step, simply inserts a new copy of this step in the workflow

Parameters
  • project_id (str) – Unique project identifier

  • workflow_id (str) – Unique workflow identifier

  • path (str) – Workflow structure path

  • start_position (int) – Position within the folder

  • nodes (list) – List of nodes to copy. List of dicts with keys id, kind, enabled (optional)

  • kind (str) – Must be step, folder, or workflow

  • enabled (bool) – Whether the node is enabled in the workflow

  • update_object (bool) – True to update the node object workflow references

Returns

None

analyze.step.create(project_id, path, name, id=None, memo=None, operation='pass', locked=False, view_manager=False, view_explorer=False, on_error='stop', goto_step=None, on_error_retry=False, on_error_retry_limit=3, on_error_retry_delay=10, check_conditions=False, condition_on_fail='skip', condition_goto_step=None, conditions=None, source_type=None, source_name=None, target_type=None, target_name=None)

Creates a step

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Path to place step in hierarchy

  • name (str) – The object name

  • id (str, optional) – Canonical ID for Step. Must be lowercase letters, numbers, -, or _

  • memo (str) – The object description

  • operation (str) – The step type operation

  • on_error (str) – Possible values are stop, continue or goto

  • goto_step (str) – Step Identifier to Goto on error if specified

  • locked (bool) – True if the project is locked from editing

  • view_manager (bool) – Step is visible to Manager roles if True

  • view_explorer (bool) – Step is visible to Explorer roles if True

  • on_error_retry (bool) – True if the step should attempt retries on error

  • on_error_retry_limit (int) – Number of times to retry a failed step before giving up

  • on_error_retry_delay (int) – Number of seconds between retry attempts

  • check_conditions (bool) – True if conditions should be evaluated before running the step

  • condition_on_fail (str) – Possible values are skip or goto

  • condition_goto_step (str) – Step Identifier to Goto if condition fails

  • conditions (list) – List of conditions to evaluate before running the step

  • source_type (str) – Type of input source

  • source_name (str) – Name of input source

  • target_type (str) – Type of output

  • target_name (str) – Name of output

Returns

result dict with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

dict

analyze.step.create_directory(project_id, path)

Creates a folder in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Path to directory

Returns

None

analyze.step.delete(project_id, step_id, force=False)

Deletes a step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • force (bool, optional) – If true, this will delete the step, even if it is in use. Defaults to false

Returns

List of workflows that contain the step if not deleted, empty list if deleted successfully

Return type

List

analyze.step.delete_directory(project_id, path)

Deletes a folder and removes path from all objects in that directory

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Path to directory

Returns

None

analyze.step.delete_log(project_id, workflow_id, step_id)

Clears the step log

Parameters
  • project_id (str) – Unique project identifier

  • workflow_id (str) – Unique workflow identifier

  • step_id (str) – Unique step identifier

Returns

None

analyze.step.delete_unreferenced(project_id)

Deletes steps no longer referenced in any workflow

Parameters

project_id (str) – Unique project identifier

Returns

The number of steps deleted

Return type

int

analyze.step.flashback_backup(project_id, step_id)

Schedules a backup of the step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

Returns

None

analyze.step.flashback_hold(project_id, step_id, version_id)

Puts a hold on a version to prevent lifecycle cleanup after retention period

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • version_id (str) – Version of the step to hold

Returns

None

analyze.step.flashback_release(project_id, step_id, version_id)

Releases a hold on a version to allow lifecycle cleanup after retention period

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • version_id (str) – Version of the step to release

Returns

None

analyze.step.flashback_restore(project_id, step_id, version_id, target_step_id)

Restores step data to the target step specified

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • version_id (str) – Version of the step to restore

  • target_step_id (str) – Target step UUID

Returns

None

analyze.step.flashback_restore_project(project_id)

Schedules a restore of all steps in the project to their latest version stored

Parameters

project_id (str) – Unique project identifier

Returns

None

analyze.step.flashback_steps(project_id)

Provides list of steps stored in flashback

Parameters

project_id (str) – Unique project identifier

Returns

List of steps

Return type

list

analyze.step.flashback_versions(project_id, step_id)

Provides list of versions of the step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

Returns

List of step versions

Return type

list

analyze.step.get_log(project_id, workflow_id, step_id)

Retrieves the full step log

Parameters
  • project_id (str) – Unique project identifier

  • workflow_id (str) – Unique workflow identifier

  • step_id (str) – Unique step identifier

Returns

List of log messages

Return type

list

analyze.step.ids_from_path(auth_id, project_id, path)

id_from_path(project_id, path) Provides the cannonical id for the from a provided path

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Object rollup path

Returns

Unique step ID on the specified path

Return type

str

analyze.step.inputs(project_id, step_id)

Provides a list of inputs to the list of steps

Parameters
  • project_id (str) – Unique project identifier

  • step_id (list) – List or tuple of workflow step unique identifiers

Returns

None

analyze.step.labels(project_id, step_id)

Provides a list of tags for the step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

Returns

list of labels associated with Step

Return type

list

analyze.step.lock(project_id, step_ids)

Locks a step from configuration changes

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

Returns

None

analyze.step.log(project_id, workflow_id, step_id, message, level='info')

Logs a step message

Parameters
  • project_id (str) – Unique project identifier

  • workflow_id (str) – Unique workflow identifier

  • step_id (str) – Unique workflow step identifier

  • message (str) – Log message

  • level (str) – Notification level (info, debug, warn, error)

  • branch (str, optional) – Deprecated, left in for agent backwards compatibility

Returns

None

analyze.step.lookup_by_full_path(project_id, path)

Returns ID for path provided

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

Step unique identifier

Return type

str

analyze.step.lookup_by_name(project_id, name)

Returns ID for name provided

Parameters
  • project_id (str) – Unique project identifier

  • name (str) – Unique step name

Returns

Step unique identifier

Return type

str

analyze.step.move(project_id, step_id, rollup_id, after_position)

Deletes a workflow step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

analyze.step.move_directory(project_id, from_path, to_path)

Updates a folder name in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • from_path (str) – Original directory path

  • to_path (str) – Destination directory path

Returns

None

analyze.step.move_path(project_id, step_id, from_path, to_path)

Moves a reference path in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • from_path (str) – Original path

  • to_path (str) – Destination path

Returns

None

analyze.step.move_paths(project_id, moves)

Moves a step reference path in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • moves (list) – List of moves, containing: step_id (str): Unique step identifier from_path (str): Original path to_path (str): Destination path

Returns

None

analyze.step.on_error_continue(project_id, step_ids)

Sets step to continue on error

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

Returns

None

analyze.step.on_error_stop(project_id, step_ids)

Sets step to stop on error

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

Returns

None

analyze.step.outputs(project_id, step_id)

Provides a list of outputs to the list of steps

Parameters
  • project_id (str) – Unique project identifier

  • step_id (list) – List or tuple of workflow step unique identifiers

Returns

List of outputs associated with Step

Return type

list

analyze.step.paths(project_id, path=None)

Provides a list of paths for all steps in the project

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Initial path to search

Returns

List of Dicts consisting of:
  • path (str): Step leaf or branch path

  • type (str): leaf or branch to indicate the path type

  • id (str): For leaf type paths, the object the path points to

Return type

list

analyze.step.paths_from_id(project_id, step_id)

Provides a list of paths associated with the cannonical id

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

Returns

List of paths associated with a Step ID

Return type

list

analyze.step.remove_label(project_id, step_id, label)

Removes a label on a step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

  • label (str) – The label unique name

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.remove_path(project_id, step_id, path)

Removes a reference path in the hierarchy

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.step.search_by_label(project_id, text, criteria='contains', sort=None, keys=None)

Returns list of steps that match the search criteria

Parameters
  • project_id (str) – Unique project identifier

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

  • sort (list) – List of sort tuples using syntax (key, reverse). e.g. [(‘name’, False)]

  • keys (list) – List of keys to return. Defaults to all.

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.search_by_name(project_id, text, criteria='contains', sort=None, keys=None)

Returns list of steps that match the search criteria

Parameters
  • project_id (str) – Unique project identifier

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

  • sort (list) – List of sort tuples using syntax (key, reverse). e.g. [(‘name’, False)]

  • keys (list) – List of keys to return. Defaults to all.

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.set_config(project_id, step_id, config=None)

Sets the step configuration

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

  • config (dict) – Config parameters

Returns

None

analyze.step.shift_down(project_id, step_ids, path)

Move the node below following node within the same generation If bottom within parent, it moves to the next parent below at the same generation as it’s parent (if there is one)

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (list) – List of Unique step identifier

  • path (str) – Current hierarchy path

Returns

New path or None if cannot be moved

Return type

str

analyze.step.shift_left(project_id, step_ids, path)

Move the node one generation up (if possible)

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (list) – List of Unique step identifier

  • path (str) – Current hierarchy path

Returns

New path or None if cannot be moved

Return type

str

analyze.step.shift_right(project_id, step_ids, path)

Move the node one generation down, looking upwards in the hierarchy for a suitable parent (if there is one)

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (list) – List of Unique step identifier

  • path (str) – Current hierarchy path

Returns

New path or None if cannot be moved

Return type

str

analyze.step.shift_up(project_id, step_ids, path)

Move the node above prior node within the same generation If top within parent, it moves to the next parent above at the same generation as it’s parent (if there is one)

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (list) – List of Unique step identifier

  • path (str) – Current hierarchy path

Returns

New path or None if cannot be moved

Return type

str

analyze.step.step(project_id, step_id, keys=None)

Provides detailed step information

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

  • keys (list) – List of keys to return. Defaults to all.

Returns

result dict with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

dict

analyze.step.steps(project_id, id_filter=None, sort=None, keys=None, member_details=False)

Provides list of steps in specified project

Parameters
  • project_id (str) – Unique project identifier

  • id_filter (list/tuple) – List or tuple of object unique identifiers to which to limit the results

  • sort (list) – List of sort tuples using syntax (key, reverse). e.g. [(‘name’, False)]

  • keys (list) – List of keys to return. Defaults to all.

  • member_details (bool, optional) – If True then returns member info relating to updated_by

Returns

result tuple of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

If member_details is set to True, the dict will also contain:
  • updated_by_full_name (str): The User Name of the user that last updated the project

  • updated_by_user_id (int): The id of the user that last updated the project

  • updated_by_gravatar_hash (str): Unique hash to pull gravatar for the user.

Return type

list

analyze.step.steps_from_label(project_id, label, sort=None, keys=None)

Provides list of steps for based on set of tags. Uses AND condition.

Parameters
  • project_id (str) – Unique project identifier

  • label (str) – label name

  • sort (list) – List of sort tuples using syntax (key, reverse). e.g. [(‘name’, False)]

  • keys (list) – List of keys to return. Defaults to all.

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.steps_from_path(project_id, path, sort=None, keys=None)

Provides list of steps based on a path fragment. Path fragment can be to parent level.

Parameters
  • project_id (str) – Unique project identifier

  • path (str) – Object rollup path using unix style forward slashes

  • sort (list) – List of sort tuples using syntax (key, reverse). e.g. [(‘name’, False)]

  • keys (list) – List of keys to return. Defaults to all.

Returns

list of dicts with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

list

analyze.step.unlock(project_id, step_ids)

Unlocks a step so configuration changes are allowed

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

Returns

None

analyze.step.update(project_id, step_id, **kwargs)

Updates a step

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique step identifier

Kwargs:

name (str): The object name memo (str): The object description operation (str): The step type operation on_error (str): Possible values are stop, continue or goto goto_step (str): Step Identifier to Goto on error if specified locked (bool): True if the project is locked from editing view_manager (bool): Step is visible to Manager roles if True view_explorer (bool): Step is visible to Explorer roles if True operation (str): Step operation type on_error_retry_limit (int): Number of times to retry a failed step before giving up on_error_retry_delay (int): Number of seconds between retry attempts check_conditions (bool): True if conditions should be evaluated before running the step condition_on_fail (str): Possible values are skip or goto condition_goto_step (str): Step Identifier to Goto if condition fails conditions (list): List of conditions to evaluate before running the step source_type (str): Type of input source source_name (str): Name of input source target_type (str): Type of output target_name (str): Name of output

Returns

result dict with the following properties
  • project_id (str): Unique project identifier

  • id (str): Unique step identifier

  • name (str): Step name

  • memo (str): Step description

  • paths (list): List of paths assigned to step

  • labels (list): List of labels assigned to step

  • on_error (str): Possible values are stop, continue or goto

  • goto_step (str): Step Identifier to Goto on error if specified

  • locked (bool): True if the project is locked from editing

  • view_manager (bool): Step is visible to Manager roles if True

  • view_explorer (bool): Step is visible to Explorer roles if True

  • operation (str): Step operation type

  • on_error_retry (bool): Retry the step on error flag

  • on_error_retry_limit (int): Number of times to retry a failed step before giving up

  • on_error_retry_delay (int): Number of seconds between retry attempts

  • check_conditions (bool): True if conditions should be evaluated before running the step

  • condition_on_fail (str): Possible values are skip or goto

  • condition_goto_step (str): Step Identifier to Goto if condition fails

  • conditions (list): List of conditions to evaluate before running the step

  • source_type (str): Type of input source

  • source_name (str): Input source name or path

  • target_type (str): Type of output

  • target_name (str): Output name or path

  • update_time (str): Date and time data was updated as ISO 8601 compliant time

  • updated_by (int): User ID of last updater

Return type

dict

analyze.step.view_explorer(project_id, step_ids, allowed=True)

Sets View Explorer flag

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

  • allowed (bool) – Indicate whether Explorer role can view item

Returns

None

analyze.step.view_manager(project_id, step_ids, allowed=True)

Sets View Manager flag

Parameters
  • project_id (str) – Unique project identifier

  • step_ids (str) – Unique workflow step identifier or list of identifiers

  • allowed (bool) – Indicate whether Manager role can view item

Returns

None

analyze.step.workflows_from_id(project_id, step_id)

Provides a list of workflows associated with the cannonical id

Parameters
  • project_id (str) – Unique project identifier

  • step_id (str) – Unique workflow step identifier

Returns

List of workflows associated with a Step ID

Return type

list