V3_Sample_Post (Post)
- Last UpdatedNov 06, 2025
- 2 minute read
| Post | V3_Sample_Post |
Resource Path:/api/v3/Sample
| 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.GenerateSample.
The response body is of type Mes.WebApi.Models.V3.Quality.Sample.
OKThe following GenerateSample model properties are required.
- To identify the entity: entity_name and, if sites are being used, site_name.
- To identify the QM specification: qm_spec_name.
Additional Information
This endpoint creates a new manual sample for the provided entity based on the provided QM specification name and optional parameters
If only the QM specification name is provided, the system will look for a manual sample plan frequency linked to the QM specification's sample plan and, if none exist, then any defined manual frequency in the system, which will be used as the frequency for the sample.
If an optional sample plan name is provided, the system will use this and look for any manual frequencies associated to the provided sample plan. In this manner, there can be a single sample plan with the manual frequency associated to it for use by all QM specifications using this method call.
If an optional sample name is provided, it will be used in place of the system generating a sample name based on either the provided sample plan name or the default sample plan associated to the QM specification.
If the requested time is provided, it must be the current time or time in the past. When not provided, the system will use the current time.