V3_Sample_GetChartDataNameFilter (Get)

Summary

Get the chart data for a characteristic that is specified by its name, with optional sample filters.

Parameters

Name	Description	Data Type
charName	Required. The characteristic name.	string
siteName	Optional filter parameter. The ID of the site for 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 name 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
numPts	Optional. The maximum number of data points that will be returned for the chart. If null, all data points are included in the chart. To restrict the number of data points being returned for performance reasons, it is recommended to use this method rather than the call header's max_rows parameter. This method uses a more efficient database retrieval than the max_rows parameter.	integer
chartType	Optional. An enumeration that indicates the chart type. 2 = Xbar + Range 3 = Xbar + Sigma 5 = IX + IR (the default) 7 = MA + Range 8 = MA + Sigma 16 = p 17 = np 18 = u 19 = c 20 = DPMO	integer
lastCreatedAtUtc	Optional filter parameter. The date and time in UTC to filter the chart data by only samples that have had results added at that date and time or later. This parameter will filter on the created_at_utc column of the Result table.	string
xAxisLabel	Optional. A code that indicates on what to base the text string to use as the chart's x-axis label. The source for codes 1 to 3 will be the value in the requested_time_local column of the sample record in the Sample table. The source for codes 4 to 22 will be the values in the corresponding columns of the sample record in the Sample table. The source for code 23 will be the value in the equipment column of the link record in the Sample_Char_Link table. The codes are: 0 = sample number (the default; an incremental number generated by the chart) 1 = time 2 = date 3 = date and time 4 = sample name 5 = entity name 6 = item description 7 = work order 8 = operation ID 9 = sample frequency name 10 = sample plan name 11 = segment requirement ID 12 = segment response ID 13 = lot number 14 = sublot number 15 = user who pulled the sample 16 = local date and time when the sample was pulled 17 = user who verified the sample results 18 = spare 1 field 19 = spare 2 field 20 = spare 3 field 21 = spare 4 field 22 = QM specification name 23 = equipment used to make characteristic measurements for the sample	integer

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_GetChartDataByFilter].

OK

Remarks

The chart data can be filtered using optional filter parameters. Passing no filter parameters will retrieve all chart data for the characteristic.

Note that the chartType and xAxisLabel parameters are not filter parameters. They are used to override the chart type and x-axis label that is associated by default with the characteristic. Also, the numPts parameter is not a filter parameter per se but can be used to limit the amount of chart data that is being returned.

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