BEbenchling
apps

Get App Canvas

Get the current state of the App Canvas, including user input elements.

get/app-canvases/{canvas_id}

Request

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

Path parameters

canvas_idstring required

Query parameters

returningstring

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, click here.

Response

OK

datastring nullable

Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won't be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.

enabledboolean

Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block's enabled property. If true or absent, the interactivity status will defer to the block's enabled property.

featureIdstring

Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.

resourceIdstring

Identifier of the resource object to attach canvas to.

sessionIdstring nullable

Identifier of a session. If specified, app status messages from the session will be reported in the canvas.

idstring

Changes

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