BEbenchling
Automation Step

Get AutomationStep by ID

Get a single AutomationStep by ID.

get/api/v3/automation-step/{automation_step_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

automation_step_idstring required

ID of the AutomationStep.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

__typenamestring
configAutomationStepConfig
createdAtstring datetime
idstring
inputStepDatasstring uri
modifiedAtstring datetime
outputStepDatasstring uri
statusCode'AI_PROPOSED' | 'BLOCKED' | 'FAILED' | 'HALTED' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_ERRORS' | 'WAITING'
statusMessagestring nullable
stepType'AGGREGATE_DATASET' | 'AUTOFILL_ANTIBODY_ELEMENT_SUBELEMENTS' | 'ANNOTATE_ANTIBODY_INPUTS' | 'ANOVA' | 'APPLY_COLUMN_MAPPING' | 'BIN_DATA' | 'BOLTZ2' | 'BOLTZGEN' | 'BOLTZGEN_SUCCESS' | 'BULK_IMPORT' | 'CHAI1' | 'CHART_VIEW' | 'COMPUTED_COLUMN' | 'CONCATENATE_ANTIBODY_COMPONENT_DOMAINS_TO_CHAINS' | 'CONNECTION_DATA_DATASET' | 'CONVERT_ASM_TO_CSV' | 'CONVERT_FILE_TO_DATASET_WITH_DATA_ENTRY_ASSISTANT' | 'CONVERT_JSON_TO_DATASET' | 'CONVERT_OPENFOLD2_OUTPUT' | 'CONVERT_OPENFOLD3_OUTPUT' | 'CONVERT_TO_ASM' | 'CREATE_DATASET_FROM_FILE' | 'CREATE_ENTITIES' | 'CREATE_METERING_USAGE_CHART' | 'CREATE_PROCEDURE_DATASET' | 'DATA_CATALOG_DATASET' | 'DATA_CATALOG_FILE' | 'DATA_CATALOG_FILES' | 'DATASETS_TO_PLATES' | 'DATASET_VIEW' | 'DEFINE_TEMPLATE_VARIABLES' | 'EXPERIMENT_OPTIMIZATION_BOOTSTRAP' | 'EXPERIMENT_OPTIMIZATION_CLEAN_DATA' | 'EXPERIMENT_OPTIMIZATION_EXPLANATION' | 'EXPERIMENT_OPTIMIZATION_GENERATE_SEARCH_SPACE' | 'EXPERIMENT_OPTIMIZATION_POSTERIOR_SUMMARY' | 'EXPERIMENT_OPTIMIZATION_RECOMMENDATION' | 'EXPERIMENT_OPTIMIZATION_TRAINING' | 'EXPLORATORY_DATA_ANALYSIS' | 'EXPORT_DATA_CATALOG_DATASET' | 'EXPORT_DATA_CATALOG_FILE' | 'EXTRACT_DATA_FRAME_VALUE' | 'EXTRACT_OR_REMOVE_LINES' | 'FILL_PLATE' | 'FILTER_DATASET' | 'FIND_AND_REPLACE' | 'FLAG_ROWS' | 'FORMAT_COLUMNS' | 'GENERATE_ANALYSIS_VIEW_URL' | 'GENERATE_BOLTZGEN_YAML' | 'GENERATE_BOLTZ_YAML' | 'GENERATE_FASTA' | 'GENERATE_MODEL_RUN_INPUT' | 'GENERATE_OPENFOLD2_JSON' | 'GENERATE_OPENFOLD3_JSON' | 'HIDE_COLUMNS' | 'IMPORT_PLATES' | 'IMPORT_SCRATCH_FILE' | 'INITIALIZE_DATASET' | 'INSERT_RESULT_URL_IN_DOCUMENT' | 'INTERPOLATE_MARKDOWN' | 'JOIN' | 'LAYOUT' | 'LEGACY_DATA_IMPORT_ENTRY_CREATION' | 'LEGACY_DATA_IMPORT_INITIATION' | 'LEGACY_DATA_IMPORT_TRANSCRIPTION' | 'LOOK_UP' | 'MAP_COLUMNS' | 'MAP_JSON_TO_DATASETS_AND_FILES' | 'MODEL_RUN_INFERENCE' | 'MOVE_INVENTORY_PLATES' | 'COMPUTE_NDC_ENTITY_MERGED_COLUMNS' | 'NDC_CREATE_PROTEINS_FROM_DATASET' | 'NDC_COMBINE_DOMAINS_TO_VARIABLE_PAIRS' | 'NDC_EXPAND_VARIABLE_PAIRS_TO_DOMAINS' | 'NDC_REFERENCE_EXISTING_COMPONENTS' | 'NOTEBOOK_TABLE_DATASET' | 'OPENFOLD2' | 'OPENFOLD3' | 'PARAMETER_OPTIMIZATION_CONFIGURATION' | 'PARAMETER_OPTIMIZATION_DATASET_CONFIGURATION' | 'PARAMETER_OPTIMIZATION_MODELING' | 'PARAMETER_OPTIMIZATION_PREDICTION' | 'PIVOT_DATASET' | 'PLATE_SCHEMA_DATASET' | 'PLATES_TO_DATASETS' | 'POSTPROCESS_MODEL_RUN' | 'PROCEDURE_RUN_DATA_FRAMES' | 'PROMOTE_DATASET' | 'REGISTRY_SCHEMA_DATASET' | 'PUT_PLATES_IN_INVENTORY' | 'REGRESSION' | 'REGRESSION_INTERPOLATION' | 'RENAME_COLUMNS' | 'REORDER_COLUMNS' | 'RETYPE_COLUMNS' | 'RUN_BENCHLING_BOLTZGEN' | 'RUN_CUSTOM_MODEL' | 'RUN_HAMILTON_METHOD' | 'RUN_HIGHRES_PROTOCOL' | 'RUN_OPENTRONS_PROTOCOL' | 'RUN_SCIENTIFIC_MODEL' | 'RUN_TECAN_METHOD' | 'SAVE_STRUCTURE_PREDICTION' | 'SAVE_TO_RESULTS' | 'SEND_TO_CONNECTION' | 'SEND_TO_DOCUMENT' | 'SEND_USER_NOTIFICATION' | 'SORT_COLUMNS' | 'STATIC_TEMPLATE_INPUT_TABLE' | 'TABLE_VIEW' | 'TEMPLATE_INPUT' | 'TEST_ALL_CONFIGS' | 'THIRD_PARTY' | 'TRANSFER_PLATES' | 'TRANSFORM_PROTEIN_BULK_INGEST_OUTPUT_TO_DATASET' | 'TRANSLATE_ANTIBODY_COMPONENT_DNA_TO_AA' | 'T_TEST' | 'UNION_DATASETS' | 'UNPIVOT_DATASET' | 'UPDATE_ENTITIES' | 'UPDATE_INVENTORY_PLATES' | 'UPLOAD_CSV_DATASET' | 'USER_DEFINED_FUNCTION' | 'GENERATE_NDC_ERROR_CSV' | 'VALIDATE_AND_TRANSFORM_ANTIBODY_INPUTS' | 'VARIABLE_TEMPLATE_INPUT_TABLE' | 'WAREHOUSE_SQL_DATASET' | 'WINDOW_FUNCTIONS'
stepVersioninteger

Changes

No recorded changes to this operation across all 1 revision of this API.