V3_Sample_RecordSampleData (Put)
- Last UpdatedNov 06, 2025
- 2 minute read
| Put | V3_Sample_RecordSampleData |
Resource Path:/api/v3/Sample/RecordData
Record sample context data and attribute data.
This endpoint is similar to the Sample Put endpoint with the additional option to set sample attributes.
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
The request body is of type Mes.WebApi.Models.V3.Quality.RecordSampleData.
Required. The property information for the sample result being recorded. The RecordSampleAttribute model is embedded in the RecordSampleData model to support
setting attributes for a sample.
The response body is of type Mes.WebApi.Models.V3.Quality.Sample.
OKThe following RecordSampleData model property is required.
- To identify the sample: sample_id.
Endpoint Behavior
- If update_sample_data is set to true, you must supply values for the following properties in the model, even if you want to keep the property value the same in the database: segment_requirement_id, segment_response_id, lot_no, sublot_no, priority, and spare. If you do not provide a value for one of these properties, it will be set to null if the corresponding database table column allows for null values.
- If pulled is true, the sample is marked as pulled by the user specified in pulled_by or by the caller if pulled_by is null. The pulled time will be specified in pulled_at_utc or, if pulled_at_utc is null, the pulled time will be the current time. If pulled is false, the sample pulled information is nulled out.
- If pulled is false, the pulled status is left untouched.
- If final is true, the Final flag is set and the sample is marked as finalized by the user specified in finalized_by or by the caller if finalized_by is null. The finalized-at time will be specified in finalized_at_utc or, if finalized_at_utc is null, the finalized-at time will be the current time.
- If final is false, the Final flag will be set to false and the finalized information will be cleared.
- If final is null, the finalized information is left untouched.