BEbenchling
App Canvas

Create AppCanvas

Create AppCanvas.

post/api/v3/app-canvas

Request

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

Headers

EARLY-ACCESSstring

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

Request body

appIdstring required

API ID of the Benchling App that owns this canvas.

datastring

Optional JSON string (max 5 KiB) of app-managed data not rendered in the canvas UI.

enabledboolean

Whether the canvas is interactable. When false, all blocks are disabled regardless of their individual enabled settings.

featureIdstring required

Feature ID from the app manifest that this canvas corresponds to.

resourceIdstring required

Identifier of the resource object to attach the canvas to.

sessionIdstring

Optional app session ID whose status messages are shown in the canvas.

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
datastring nullable
enabledboolean
featureIdstring nullable
idstring
modifiedAtstring datetime
resourceIdstring
sessionIdstring nullable

Changes

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