BEbenchling
Chart

Get Chart by ID

Get a single Chart by ID.

get/api/v3/chart/{chart_id}

Request

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

Path parameters

chart_idstring required

ID of the Chart.

Query parameters

returningstring[]

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

omitstring[]

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

Headers

EARLY-ACCESSstring

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

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
idstring
library'PLOTLY'
libraryConfigChartLibraryConfig

JSON object representing the direct input to a chart library on the front-end.

libraryVersionstring

Version of the library that the config corresponds to.

For example, if the library uses semver, we might store "1.2.3", "1.2.3-alpha.1", ect.

modifiedAtstring datetime
namestring
originAutomationStepDataNamestring nullable

The name of the data in originAutomationStep that this chart was created from.

originPipelineStepDataNamestring nullable

The name of the data in originAutomationStep that this chart was created from.

rasterConfigChartRasterConfig

Config used to generate the rasterized image of the chart in relation to th library that we're using.

For example, in Plotly, this could be:

  {
    width: 600
    height: 400
    scale: 0.5
    format: "png"
    engine: "kaleido"
  }
rasterDownloadUrlstring

URL to download a rasterized image of the chart.

We store these images in perpetuity in case the library and libraryConfig version of the chart can no longer be rendered.

rasterExternalFileIdstring

Changes

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