BEbenchling
Analysis

Update Analysis

Update Analysis.

patch/api/v3/analysis/{analysis_id}

Request

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

Path parameters

analysis_idstring required

ID of the Analysis.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

descriptionstring nullable
folderIdstring
namestring
studyIdsstring[]

Study IDS to associate with the item.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
descriptionstring nullable
idstring
modifiedAtstring datetime
namestring
statusCode'AI_PROPOSED' | 'BLOCKED' | 'FAILED' | 'HALTED' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_ERRORS' | 'WAITING'
stepsstring uri
webUrlstring

Changes

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