Skip to navigation
Benchling APIAnalysis

Apply an automation template

Beta
Apply a published automation template to an Analysis. Populates the Analysis with the template's pipeline steps, substituting the provided data frame and config variable bindings. The Analysis then runs asynchronously. The template must be published before it can be applied. Returns an async task link that can be polled for completion.

Authentication

AuthorizationBearer

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

Path parameters

analysis_idstringRequired
ID of the Analysis.

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
dataFrameVariableBindingslist of objectsRequired

Bindings that map the template’s data frame variables (see AutomationTemplateDataFrameVariable) to actual data frames. Each binding specifies which data frame to substitute for a template variable.

templateIdstringRequired
ID of the published automation template to apply.
templateVariableBindingslist of objectsOptional

Bindings that provide values for the template’s config variables (see AutomationTemplateVariable). Every config variable on the template must have a value specified; use a null variableValue to leave a variable empty.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

400
Analysis Apply Template Request Bad Request Error
403
Analysis Apply Template Request Forbidden Error
404
Analysis Apply Template Request Not Found Error
409
Analysis Apply Template Request Conflict Error
429
Analysis Apply Template Request Too Many Requests Error
500
Analysis Apply Template Request Internal Server Error