Offset suggestion

Only the GET call is available to this resources. which when provided with the part_id and the dimension_id of the peace with the measured value done by the operator, responds with the offset resource. offset contains the type, the value, suggestion, measured_value and golden_sample_offset field.

Offset Scheme

Scheme:

{
  "type": "String",
  "value": "Float",
  "suggestion": "String",
  "measured_value": "Float",
  "golden_sample_offset": "Float"
}

Example offset:

{
  "type": "X",
  "value": -0.3,
  "suggestion": "critical",
  "measured_value": 17.033,
  "golden_sample_offset": 0.003
}

GET methods

GET /api/v1/offsets

Returns the calculated offset for a specific part, dimension and measured value.

Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
  • part_id (string) – part’s id for which the value is provided
  • dimension_id (integer) – particular dimension of the part on which the measure is provided
  • value (float) – measured value for which offsets are controlled
Response JSON Object:
 
  • type (string) – the type of offset
  • value (float) – the value of offset
  • suggestion (string) – Whether the offset is “ok”, “suggested” to apply, or “critical” (must apply)
  • golden_sample_offset (float) – This is the correction that has already been applied to the measured_value based on the golden sample data
  • measured_value (float) – This is the measured value with the golden sample correction applied
Status Codes:

Example request:

GET /api/v1/offsets?part_id=ae54af76-964f-4ed8-8700-793b2ed5c20b&dimension_id=2&value=17.03&access_token=6dc30a41cc71bc624e36d6a0e4388e3fbb578a59a9e0a8eacfa9d4bfe5ba7ff2 HTTP/1.1
Host: https://offsug.hir.facts4.work

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
  "type": "X",
  "value": -0.3,
  "suggestion": "critical",
  "measured_value": 17.033,
  "golden_sample_offset": 0.003
}