Skip to navigation
Benchling APIAutomation Step

Get AutomationStep by ID

Beta
Get a single AutomationStep by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

automation_step_idstringRequired
ID of the AutomationStep.

Headers

EARLY-ACCESSstringOptional

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

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

OK
__typenamestringOptional
configmap from strings to any or nullOptional
createdAtstringOptional
idstringOptional
inputStepDatasstringOptionalformat: "uri"
modifiedAtstringOptional
outputStepDatasstringOptionalformat: "uri"
pipelineobjectOptional
statusCodeenumOptional
statusMessagestring or nullOptional
stepTypeenumOptional
stepVersionintegerOptional

Errors

400
Automation Step Get Request Bad Request Error
403
Automation Step Get Request Forbidden Error
404
Automation Step Get Request Not Found Error
429
Automation Step Get Request Too Many Requests Error
500
Automation Step Get Request Internal Server Error