V3_Sample_GetChartTypeNameFilter (Get)

Summary

Get the chart type and the data for determining the control limits for a characteristic identified by its name, with optional sample filters.

Parameters

Name	Description	Data Type
charName	Required. The characteristic name.	string
siteName	Optional filter parameter. The name of the site of an entity at which a sample was pulled. Must be null if sites are not being used.	string
entName	Optional filter parameter. The name of an entity at which a sample was pulled.	string
itemId	Optional filter parameter. The item ID of a sample.	string
itemCategoryName	Optional filter parameter. The ID of an item category. Any samples of items included in the category will match this filter.	string
woId	Optional filter parameter. The work order ID of a job for which a sample was pulled.	string
operId	Optional filter parameter. The ID of an operation that is associated with the characteristic. This parameter will filter on the oper_id column of the Sample table. This parameter is used in conjunction with the processId parameter. The combination of a process and an operation in that process is entered as a context property of a QM specification that is linked to the characteristic. For more information, see Remarks below.	string
processId	Optional filter parameter. The ID of a process that is associated with the characteristic. This parameter is used in conjunction with the operId parameter. The combination of a process and an operation in that process is entered as a context property of a QM specification that is linked to the characteristic. For more information, see Remarks below.	string
segmentRequirementId	Optional filter parameter. The segment requirement ID of a sample.	string
segmentResponseId	Optional filter parameter. The segment response ID of a sample.	string
spare1	Optional filter parameter. The contents of the spare1 field for a sample.	string
spare2	Optional filter parameter. The contents of the spare2 field for a sample.	string
spare3	Optional filter parameter. The contents of the spare3 field for a sample.	string
spare4	Optional filter parameter. The contents of the spare4 field for a sample.	string
startTimeUtc	Optional filter parameter. The earliest date/time in UTC that a matching sample can have. This parameter will filter on the requested_time_utc column of the Sample table.	string
endTimeUtc	Optional filter parameter. The latest date/time in UTC that a matching sample can have. This parameter will filter on the requested_time_utc column of the Sample table.	string

Request Headers

Name	Description
trans_id	Used to supply the ID of the transaction if the call is taking part in a transaction.
max_rows	Used to supply the maximum number of rows that will be returned by the get.

200 Response

The response body is of type Array[Generated.Models.V3_Sample_GetChartTypeByFilter].

OK

Remarks

If filter parameters are passed, the operation finds all the samples (Sample table) collected for the supplied characteristic that match the supplied filters. It then finds the sample with the most recently collected measurement (Result table). If a QM specification is assigned to the sample-characteristic link (Sample_Char_Link table), it is used to look up the values assigned to the QM specification-characteristic link (QM_Spec_Char_Link table). The values returned in the array are read from the QM specification-characteristic link information. If there is no QM specification-characteristic link information or no value is recorded for the QM specification-characteristic link, then the value assigned to the characteristic is returned.

If no filter parameters are passed, the operation retrieves the chart type for the most recent sample entered for the characteristic.

The context properties of the QM specifications that are linked to a characteristic are used to determine the conditions under which samples for that characteristic will be generated. A QM specification must have an entry for at least one of the three context properties: Entity, Item Category and Item, Process and Operation (see the operId and processId filter parameters). For more information about QM specifications and characteristics, see the MES Client User Guide or help.

MES Web API V3