v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Analyses

Update an Analysis

Update (replace) an existing Analysis.

This endpoint accepts the same request body fields as the Create an Analysis endpoint.

Remember this is a PUT endpoint which means you must provide all supported fields or you may lose data - you are effectively replacing the existing record with a new record containing all the fields you provide. We recommend first getting the existing record and pre-populating the request body with the current values, then change the fields you need to change.

If you wish to update a smaller number of fields please use the PATCH endpoint.

put/v1/beam/analyses/{analysis_id}

Path parameters

analysis_idstring required

An existing Beam Analysis ID.

Request body

namestring required

Name of an analysis.

external_idstring

External identifier associated with the Analysis (optional, user-defined).

labelstring[]

Comma-separated list of labels that can be used to search and filter analyses.

Response

Successful Response