analyses

Update an analysis

Update an analysis.

This endpoint can be used to attach DataFrames and Files to an analysis by providing file and/or data frame ids inside the dataFrameIds and fileIds elements. This will append the dataFramess and files to the analysis.

If attaching files:

  1. Upload the files with the Create a file endpoint
  2. Use this endpoint to attach file ids via the fileIds array element

If attaching data frames:

  1. Create the data frames from existing files using the Create a data frame endpoint
  2. Use this endpoint to attach data frame ids via the dataFrameIds array element

For more details and examples on building Analysis integrations, see our developer guide.

patch/analyses/{analysis_id}

Request

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

Path parameters

analysis_idstring required

The ID of the analysis

Request body

dataFrameIdsstring[]

IDs of the data frames to append to an analysis

fileIdsstring[]

IDs of the files to append to an analysis

Response

OK

dataFrameIdsstring[]
fileIdsstring[]
folderIdstring

ID of the folder that contains the analysis

idstring

Changes

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