Skip to navigation
v2Apps

Get App Canvas

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

Authentication

AuthorizationBearer

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

Path parameters

canvas_idstringRequired

Query parameters

returningstringOptional

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
blockslist of objectsOptional
archiveRecordobject or nullOptional
datastring or nullOptional
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.
enabledbooleanOptional

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.

featureIdstringOptional
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
resourceIdstringOptional
Identifier of the resource object to attach canvas to.
sessionIdstring or nullOptional
Identifier of a session. If specified, app status messages from the session will be reported in the canvas.
appobjectOptional
idstringOptional

Errors

404
Not Found Error