Supercoach API (2.0)
Download OpenAPI specification:Download
Interface with Rapta coaching. This is a websocket so it is bi-directional communication.Consumes a message to either start or interrupt or coaching. While both start and interrupt are supported only one can be provided (XOR).Emits messages for predictions, step advance, step complete, and step interrupt.
Request Body schema: application/json
object (StartCoachingRequest) | |
object (InterruptCoachingRequest) |
Responses
Request samples
- Payload
{- "start": {
- "assembly_id": "string",
- "operator_id": "string",
- "auto_coach_enabled": true,
- "prediction_smoothing_enabled": true,
- "prediction_smoothing_default": 0,
- "step_progression_delay": 0,
- "auto_advance_emulated_camera": true,
- "experiment_id": "string",
- "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}
}, - "interrupt": {
- "assembly_record_id": "string",
- "interrupt_type": "string",
- "step": {
- "id": "string",
- "previous_step_id": "string",
- "next_step_id": "string",
- "started_at": {
- "seconds": "string",
- "nanos": 0
}, - "status": "string",
- "confidence": 0,
- "benchmark": 0
}
}
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "assembly_record_id": "string",
- "assembly_id": "string",
- "benchmark": 0,
- "created_at": {
- "seconds": "string",
- "nanos": 0
}, - "step": {
- "id": "string",
- "previous_step_id": "string",
- "next_step_id": "string",
- "started_at": {
- "seconds": "string",
- "nanos": 0
}, - "status": "string",
- "confidence": 0,
- "benchmark": 0
}, - "status": "string",
- "error": "string",
- "prediction_label": {
- "name": "string",
- "value": "string",
- "full": "string"
}, - "message": "string",
- "figure": "string",
- "ocr_entries": [
- {
- "text": "string",
- "status": "string",
- "user_friendly_label_prefix": "string",
- "user_friendly_label": "string",
- "italicize_user_friendly_label_prefix": true,
- "italicize_user_friendly_label": true,
- "warning_message": "string",
- "variable_name": "string"
}
]
}
}
Begin coaching on a specific assembly on a specific step
path Parameters
assembly_id required | string |
step_id required | string |
Responses
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "records": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "step_data": [
- {
- "step_data_info": [ ],
- "id": null,
- "step_id": null,
- "data_type": null,
- "units": null,
- "name": null,
- "tolerance": null,
- "auto_align": null,
- "torque_data": null,
- "options": null,
- "ocr_capture_variable_info": [ ]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "total_pages": 0
}
}
Pauses coaching of the assembly
path Parameters
assembly_id required | string Example: 57618016-cd00-4fc8-85f5-e4b26304c6ba The ID of the assembly |
Request Body schema: application/json
assembly_record_id | string |
Responses
Request samples
- Payload
{- "assembly_record_id": "b79663a8-c53a-472e-9572-026ce3c6a82d"
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Complete coaching session
Declare that the ongoing coaching session is complete.
path Parameters
assembly_id required | string |
Request Body schema: application/json
step_index | integer <int32> |
assembly_record_id | string |
auto_coach_enabled | string |
Responses
Request samples
- Payload
{- "step_index": 0,
- "assembly_record_id": "string",
- "auto_coach_enabled": "string"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Set coaching context to a new step
Set coaching to a specific assembly's step. Must provide an end-time for the current step and an assembly_record_id to report the endtime to.
path Parameters
assembly_id required | string |
step required | string |
Request Body schema: application/json
assembly_record_id | string |
end_time | string The end-time for the currently coached step |
auto_coach_enabled | boolean |
Responses
Request samples
- Payload
{- "assembly_record_id": "string",
- "end_time": "string",
- "auto_coach_enabled": true
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Retrieve a list of available training actions. Used when adding a new step to the end of the assembly.
Some training actions aren't available until others have been performed. EG. Serial Number Verification isn't available until a Serial Number Capture has been made. This endpoint returns which area currently available for a given assembly.
Responses
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Determines which steps this given step is allowed to move to.
Some steps depend on other steps, such as a Serial Number Verification depending on a previous Serial Number Capture. This endpoint will return which indices a step may be allowed to move to with these dependencies in mind.
path Parameters
assembly_id required | string |
step_number required | string |
Responses
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Create a new model for a specific assembly
If not already done, this will change the global training context to this assembly.
path Parameters
assembly_id required | string |
Request Body schema: application/json
name | string |
description | string |
parent_id | string |
revision_id | string |
epochs | integer <int32> |
batch_size | integer <int32> |
complete_callback | string |
enable_multistep_model | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "parent_id": "string",
- "revision_id": "string",
- "epochs": 0,
- "batch_size": 0,
- "complete_callback": "string",
- "enable_multistep_model": true
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Edit a model for a specific assembly
If not already done, this will change the global training context to this assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
object (NeuralNet) | |
object (ModelConfiguration) |
Responses
Request samples
- Payload
{- "base_nn": {
- "type": "string",
- "product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_name": "string",
- "model_type": "string",
- "model_category": "string"
}, - "configuration": {
- "duration": 0,
- "sample_size": 0,
- "image_height": 0,
- "image_width": 0,
- "image_channels": 0,
- "batch_size": 0,
- "validation_split": 0,
- "training_steps": 0,
- "epochs": 0,
- "tfloat16": true
}
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Inform model of the start of a new step
If not already done, this will change the global training context to this assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
step_roi_zoom | string |
step_description | string |
step_camera_name | string |
step_minimum_predict | number <float> |
step_benchmark | number <float> |
step_index | integer <int32> |
label_index | integer <int32> |
Array of objects (StepDataInfo) | |
record_step | boolean |
Array of objects (OCRCaptureVariableInfo) | |
actions | string Possible values are: ML OCR_CHECK OCR_CAPTURE OCR_VERIFY OCR_ENTRY TORQUE TORQUE_ONLY INPUT OUTPUT QA QA_DWELL VIDEO_ONLY |
data_ops | string Possible values are: ADD DELETE INSERT UPDATE MOVE |
step_type | string Possible values are: MASTER CORRECT INCORRECT PERSPECTIVE IO OCCLUDED |
Responses
Request samples
- Payload
{- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "step_index": 0,
- "label_index": 0,
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "actions": "ML",
- "data_ops": "UPDATE",
- "step_type": "MASTER"
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Update model for simple database updates
If not already done, this will change the global training context to this assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
step_roi_zoom | string |
step_description | string |
step_camera_name | string |
step_minimum_predict | number <float> |
step_benchmark | number <float> |
step_index | integer <int32> |
label_index | integer <int32> |
Array of objects (StepDataInfo) | |
record_step | boolean |
Array of objects (OCRCaptureVariableInfo) | |
actions | string Possible values are: ML OCR_CHECK OCR_CAPTURE OCR_VERIFY OCR_ENTRY TORQUE TORQUE_ONLY INPUT OUTPUT QA QA_DWELL VIDEO_ONLY |
data_ops | string Possible values are: ADD DELETE INSERT UPDATE MOVE |
step_type | string Possible values are: MASTER CORRECT INCORRECT PERSPECTIVE IO OCCLUDED |
Responses
Request samples
- Payload
{- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "step_index": 0,
- "label_index": 0,
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "actions": "ML",
- "data_ops": "UPDATE",
- "step_type": "MASTER"
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Capture an IO event for a specific assembly while recording a step
Between POST /model/start
and POST /model/end
of a Torque or IO action, declare when an IO event occurred.
path Parameters
assembly_id required | string |
Request Body schema: application/json
data_ops | string Possible values are: ADD DELETE INSERT UPDATE MOVE |
step_type | string Possible values are: MASTER CORRECT INCORRECT PERSPECTIVE IO OCCLUDED |
io_name | string |
step_index | integer <int32> |
Responses
Request samples
- Payload
{- "data_ops": "UPDATE",
- "step_type": "MASTER",
- "io_name": "string",
- "step_index": 0
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Inform model of the end of a new step
Should be paired with POST /model/start/{assembly_id}
. If not already done, this will change the global training context to this assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
create_overlay | boolean |
overlay_rectangles | Array of strings |
step_index | integer <int32> |
label_index | integer <int32> |
record_step | boolean |
actions | string Possible values are: ML OCR_CHECK OCR_CAPTURE OCR_VERIFY OCR_ENTRY TORQUE TORQUE_ONLY INPUT OUTPUT QA QA_DWELL VIDEO_ONLY |
data_ops | string Possible values are: ADD DELETE INSERT UPDATE MOVE |
step_type | string Possible values are: MASTER CORRECT INCORRECT PERSPECTIVE IO OCCLUDED |
Responses
Request samples
- Payload
{- "create_overlay": true,
- "overlay_rectangles": [
- "string"
], - "step_index": 0,
- "label_index": 0,
- "record_step": true,
- "actions": "ML",
- "data_ops": "UPDATE",
- "step_type": "MASTER"
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Revert the previous `start` call
If a POST /model/end
hasn't been called yet, you may revert the previous POST /model/start
call, deleting any data that was generated from said call. This allows you to essentially "undo" the previous operation.
Responses
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Move one step to another location
After changing the global training context to a specific assembly, this endpoint allows you to move a step from one position to another position without restriction.
path Parameters
current_index required | string |
new_index required | string |
Request Body schema: application/json
assembly_id | string |
Responses
Request samples
- Payload
{- "assembly_id": "string"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Copy one step to another location
After changing the global training context to a specific assembly, this endpoint allows you to copy a step from one position to another position without restriction.
path Parameters
from_assembly_id required | string |
step_index required | string |
Request Body schema: application/json
assembly_id | string |
Responses
Request samples
- Payload
{- "assembly_id": "string"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Create an overlay for a step of a specific assembly
An overlay is made up of rectangles. These will be displayed to the operator during coaching of a specific step.
path Parameters
assembly_id required | string |
Request Body schema: application/json
overlay_rectangles | Array of strings |
step_index | integer <int32> |
Responses
Request samples
- Payload
{- "overlay_rectangles": [
- "(0.301, 0.225, 0.245, 0.44)"
], - "step_index": 0
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Check whether a step may be deleted or not.
Sometimes, a future step may depend on a previous step, such as a Serial Number Verification step depending on a previous Serial Number Capture step. This endpoint checks if other steps depend on this step or not, and responds whether it should be allowed to be deleted.
path Parameters
assembly_id required | string |
step_index required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "can_delete_step": true,
- "reason": "string"
}
}
Cancel an assembly currently in an editing session
path Parameters
assembly_id required | string |
Request Body schema: application/json
cancel_current_training | boolean |
finalize_only | boolean |
Responses
Request samples
- Payload
{- "cancel_current_training": true,
- "finalize_only": true
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Cancel an assembly currently in a training session
path Parameters
assembly_id required | string |
Request Body schema: application/json
cancel_current_training | boolean |
finalize_only | boolean |
Responses
Request samples
- Payload
{- "cancel_current_training": true,
- "finalize_only": true
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Get similarity scores of step's starting position with its potential ending positions
This endpoint returns multiple structural similarity index measures (SSIM) which represent how similar two images are. Each step is made up of multiple "end positions", or labels. This will return an SSIM comparing the STARTING position and each label. The closer to 0 the values are, the more similar they are.
Sample output:
{
"step_number": 1,
"ssim": {
# Values are populated dynamically based on the amount of labels this step has
"previous": 586.57,
"incorrect_1": 874.01,
"incorrect_2": 756.42,
...
}
}
path Parameters
assembly_id required | string |
step_number required | string |
Schedule training of a model some time later
Request Body schema: application/json
name | string |
description | string |
when | string |
assembly_id | string |
type | string The type of schedule request. Currently, the only valid value is "COMPUTE_TRAIN" |
complete_callback | string |
epochs | integer <int32> |
nn_type | string |
nn_product_type | string |
version | string |
python_version | string |
tensorflow_version | string |
model_category | string |
model_type | string |
model_name | string |
enabled_occlusion_detection | boolean |
enabled_multistep_model | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "when": "string",
- "assembly_id": "string",
- "type": "string",
- "complete_callback": "string",
- "epochs": 0,
- "nn_type": "string",
- "nn_product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_category": "string",
- "model_type": "string",
- "model_name": "string",
- "enabled_occlusion_detection": true,
- "enabled_multistep_model": true
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "action": {
- "when": "string",
- "function": "string",
- "edit_train_request": {
- "edit_request": {
- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "export": "string",
- "complete_callback": "string",
- "init_task_num": 0,
- "prev_label": "string",
- "create_overlay": true,
- "overlay_rectangles": [
- "string"
], - "cancel_current_training": true,
- "skip_video_conversion": true,
- "step_index": 0,
- "label_index": 0,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "data_type": "string",
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "new_step_index": 0,
- "finalize_only": true,
- "assembly_revision": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- null
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": null
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}, - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "step_tolerance": 0,
- "revert": true,
- "prevent_revision": true,
- "actions": [
- "string"
], - "model": {
- "base_nn": {
- "type": "string",
- "product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_name": "string",
- "model_type": "string",
- "model_category": "string"
}, - "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "configuration": {
- "duration": 0,
- "sample_size": 0,
- "image_height": 0,
- "image_width": 0,
- "image_channels": 0,
- "batch_size": 0,
- "validation_split": 0,
- "training_steps": 0,
- "epochs": 0,
- "tfloat16": true
}
}, - "data_ops": "string",
- "step_type": "string",
- "port": {
- "port": "string",
- "name": "string",
- "type": "string",
- "timeout": 0,
- "chip": "string",
- "line": 0,
- "duration": 0,
- "input_type": "string",
- "output_type": "string"
}, - "tightening_program": {
- "torque": {
- "target": 0,
- "max": 0,
- "min": 0,
- "unit": "string"
}, - "angle": {
- "target": 0,
- "max": 0,
- "min": 0,
- "threshold": 0,
- "verify": true
}, - "speed": {
- "run_speed": "string",
- "final_speed": "string",
- "downshift_threshold": "string",
- "downshift_enabled": true,
- "unit": "string"
}, - "operation_mode": "string",
- "angle_start_mode": "string",
- "max_time": 0,
- "min_time": 0,
- "reverse_allowed": true,
- "reverse_speed": 0,
- "max_reverse_torque": 0,
- "program_nr": 0,
- "description": "string",
- "step_count": 0,
- "permanent": true,
- "vendor_parameters": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "from_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "enable_data_synthesis_beta": true,
- "enable_occlusion_detection": true,
- "enable_multistep_model": true
}, - "train_request": {
- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "export": "string",
- "complete_callback": "string",
- "init_task_num": 0,
- "prev_label": "string",
- "create_overlay": true,
- "overlay_rectangles": [
- "string"
], - "cancel_current_training": true,
- "skip_video_conversion": true,
- "step_index": 0,
- "label_index": 0,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "data_type": "string",
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "new_step_index": 0,
- "finalize_only": true,
- "assembly_revision": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- null
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": null
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}, - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "step_tolerance": 0,
- "revert": true,
- "prevent_revision": true,
- "actions": [
- "string"
], - "model": {
- "base_nn": {
- "type": "string",
- "product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_name": "string",
- "model_type": "string",
- "model_category": "string"
}, - "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "configuration": {
- "duration": 0,
- "sample_size": 0,
- "image_height": 0,
- "image_width": 0,
- "image_channels": 0,
- "batch_size": 0,
- "validation_split": 0,
- "training_steps": 0,
- "epochs": 0,
- "tfloat16": true
}
}, - "data_ops": "string",
- "step_type": "string",
- "port": {
- "port": "string",
- "name": "string",
- "type": "string",
- "timeout": 0,
- "chip": "string",
- "line": 0,
- "duration": 0,
- "input_type": "string",
- "output_type": "string"
}, - "tightening_program": {
- "torque": {
- "target": 0,
- "max": 0,
- "min": 0,
- "unit": "string"
}, - "angle": {
- "target": 0,
- "max": 0,
- "min": 0,
- "threshold": 0,
- "verify": true
}, - "speed": {
- "run_speed": "string",
- "final_speed": "string",
- "downshift_threshold": "string",
- "downshift_enabled": true,
- "unit": "string"
}, - "operation_mode": "string",
- "angle_start_mode": "string",
- "max_time": 0,
- "min_time": 0,
- "reverse_allowed": true,
- "reverse_speed": 0,
- "max_reverse_torque": 0,
- "program_nr": 0,
- "description": "string",
- "step_count": 0,
- "permanent": true,
- "vendor_parameters": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "from_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "enable_data_synthesis_beta": true,
- "enable_occlusion_detection": true,
- "enable_multistep_model": true
}
}, - "complete_callback": "string"
}, - "service": "string",
- "status": {
- "code": "string",
- "product_version": "string",
- "msg": "string",
- "count": 0,
- "target": "string",
- "err_code": "string"
}
}
]
}
Gets all scheduled training sessions of a certain status
Possible status values are "queued" and "ended".
path Parameters
status required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "action": {
- "when": "string",
- "function": "string",
- "edit_train_request": {
- "edit_request": {
- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "export": "string",
- "complete_callback": "string",
- "init_task_num": 0,
- "prev_label": "string",
- "create_overlay": true,
- "overlay_rectangles": [
- "string"
], - "cancel_current_training": true,
- "skip_video_conversion": true,
- "step_index": 0,
- "label_index": 0,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "data_type": "string",
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "new_step_index": 0,
- "finalize_only": true,
- "assembly_revision": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- null
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": null
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}, - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "step_tolerance": 0,
- "revert": true,
- "prevent_revision": true,
- "actions": [
- "string"
], - "model": {
- "base_nn": {
- "type": "string",
- "product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_name": "string",
- "model_type": "string",
- "model_category": "string"
}, - "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "configuration": {
- "duration": 0,
- "sample_size": 0,
- "image_height": 0,
- "image_width": 0,
- "image_channels": 0,
- "batch_size": 0,
- "validation_split": 0,
- "training_steps": 0,
- "epochs": 0,
- "tfloat16": true
}
}, - "data_ops": "string",
- "step_type": "string",
- "port": {
- "port": "string",
- "name": "string",
- "type": "string",
- "timeout": 0,
- "chip": "string",
- "line": 0,
- "duration": 0,
- "input_type": "string",
- "output_type": "string"
}, - "tightening_program": {
- "torque": {
- "target": 0,
- "max": 0,
- "min": 0,
- "unit": "string"
}, - "angle": {
- "target": 0,
- "max": 0,
- "min": 0,
- "threshold": 0,
- "verify": true
}, - "speed": {
- "run_speed": "string",
- "final_speed": "string",
- "downshift_threshold": "string",
- "downshift_enabled": true,
- "unit": "string"
}, - "operation_mode": "string",
- "angle_start_mode": "string",
- "max_time": 0,
- "min_time": 0,
- "reverse_allowed": true,
- "reverse_speed": 0,
- "max_reverse_torque": 0,
- "program_nr": 0,
- "description": "string",
- "step_count": 0,
- "permanent": true,
- "vendor_parameters": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "from_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "enable_data_synthesis_beta": true,
- "enable_occlusion_detection": true,
- "enable_multistep_model": true
}, - "train_request": {
- "step_roi_zoom": "string",
- "step_description": "string",
- "step_camera_name": "string",
- "step_minimum_predict": 0,
- "step_benchmark": 0,
- "export": "string",
- "complete_callback": "string",
- "init_task_num": 0,
- "prev_label": "string",
- "create_overlay": true,
- "overlay_rectangles": [
- "string"
], - "cancel_current_training": true,
- "skip_video_conversion": true,
- "step_index": 0,
- "label_index": 0,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "data_type": "string",
- "step_data_infos": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "new_step_index": 0,
- "finalize_only": true,
- "assembly_revision": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- null
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": null
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}, - "record_step": true,
- "ocr_capture_variable_infos": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
], - "step_tolerance": 0,
- "revert": true,
- "prevent_revision": true,
- "actions": [
- "string"
], - "model": {
- "base_nn": {
- "type": "string",
- "product_type": "string",
- "version": "string",
- "python_version": "string",
- "tensorflow_version": "string",
- "model_name": "string",
- "model_type": "string",
- "model_category": "string"
}, - "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "configuration": {
- "duration": 0,
- "sample_size": 0,
- "image_height": 0,
- "image_width": 0,
- "image_channels": 0,
- "batch_size": 0,
- "validation_split": 0,
- "training_steps": 0,
- "epochs": 0,
- "tfloat16": true
}
}, - "data_ops": "string",
- "step_type": "string",
- "port": {
- "port": "string",
- "name": "string",
- "type": "string",
- "timeout": 0,
- "chip": "string",
- "line": 0,
- "duration": 0,
- "input_type": "string",
- "output_type": "string"
}, - "tightening_program": {
- "torque": {
- "target": 0,
- "max": 0,
- "min": 0,
- "unit": "string"
}, - "angle": {
- "target": 0,
- "max": 0,
- "min": 0,
- "threshold": 0,
- "verify": true
}, - "speed": {
- "run_speed": "string",
- "final_speed": "string",
- "downshift_threshold": "string",
- "downshift_enabled": true,
- "unit": "string"
}, - "operation_mode": "string",
- "angle_start_mode": "string",
- "max_time": 0,
- "min_time": 0,
- "reverse_allowed": true,
- "reverse_speed": 0,
- "max_reverse_torque": 0,
- "program_nr": 0,
- "description": "string",
- "step_count": 0,
- "permanent": true,
- "vendor_parameters": [
- {
- "key": "string",
- "value": "string"
}
]
}, - "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "from_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": null,
- "name": null,
- "description": null,
- "image_link": null,
- "video_link": null,
- "overlay_link": null,
- "minimum_predict": null,
- "benchmark": null,
- "roi_zoom": null,
- "camera_id": null,
- "perspective_change": null,
- "mask_perspective": null,
- "training_required": null,
- "classes": [ ],
- "assembly_id": null,
- "next_step_id": null,
- "previous_step_id": null,
- "options": null,
- "step_data": [ ]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "enable_data_synthesis_beta": true,
- "enable_occlusion_detection": true,
- "enable_multistep_model": true
}
}, - "complete_callback": "string"
}, - "service": "string",
- "status": {
- "code": "string",
- "product_version": "string",
- "msg": "string",
- "count": 0,
- "target": "string",
- "err_code": "string"
}
}
]
}
Retrieve all assembly revisions
Each Assembly is made up of one or more Assembly Revisions, which act as "versions" of a given assembly. This endpoint retrieves every revision of every assembly.
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- null
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": null,
- "target_torque": null,
- "max_torque": null,
- "torque_unit": null,
- "run_speed": null,
- "final_speed": null,
- "speed_unit": null,
- "torque_series": [ ],
- "angle_series": [ ],
- "final_angle": null,
- "angle_threshold": null,
- "verify_angle": null
}, - "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "ocr_capture_variable_info": [
- null
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}
]
}
Retrieve a specific assembly revision
path Parameters
revision_id required | string Example: d8dc6895-da23-4f4e-9eec-b508b8f9b3e2 The ID of the assembly revision |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": null,
- "label": null,
- "link": null,
- "value": null,
- "step_data_id": null,
- "type": null,
- "name": null,
- "options": null
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- null
], - "angle_series": [
- null
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": null,
- "bounding_box": null,
- "original_text_value": null,
- "step_number": null
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}
}
Create or Update a specific assembly revision
path Parameters
revision_id required | string Example: d8dc6895-da23-4f4e-9eec-b508b8f9b3e2 The ID of the assembly revision |
Request Body schema: application/json
name | string |
description | string |
image_link | string |
tenant_id | string |
training_complete | boolean |
active_revision | string |
published | boolean |
Responses
Request samples
- Payload
{- "name": "Contactor Installation",
- "description": "A new description",
- "image_link": "/model/sample/image/57618016-cd00-4fc8-85f5-e4b26304c6ba/step-3_good",
- "training_complete": true,
- "active_revision": "57618016-cd00-4fc8-85f5-e4b26304c6ba",
- "published": true
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "uuid": "string"
}
}
Retrieve the assembly for a specific assembly revision
path Parameters
revision_id required | string Example: d8dc6895-da23-4f4e-9eec-b508b8f9b3e2 The ID of the assembly revision |
rev_number required | string |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}
Set the active revision for a specific assembly revision
path Parameters
revision_id required | string Example: d8dc6895-da23-4f4e-9eec-b508b8f9b3e2 The ID of the assembly revision |
Request Body schema: application/json
assembly_id | string |
Responses
Request samples
- Payload
{- "assembly_id": "57618016-cd00-4fc8-85f5-e4b26304c6ba"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Retrieve all revisions of a specific assembly
path Parameters
revision_id required | string Example: d8dc6895-da23-4f4e-9eec-b508b8f9b3e2 The ID of the assembly revision |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": null,
- "label": null,
- "link": null,
- "value": null,
- "step_data_id": null,
- "type": null,
- "name": null,
- "options": null
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- null
], - "angle_series": [
- null
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": null,
- "bounding_box": null,
- "original_text_value": null,
- "step_number": null
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
]
}
Retrieve all coachable revisions
Each Assembly is made up of one or more Assembly Revisions, which act as "versions" of a given assembly. This endpoint retrieves the most recently published assembly for each assembly revision.
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "active_revision": "string",
- "published": true,
- "assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- null
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": null,
- "target_torque": null,
- "max_torque": null,
- "torque_unit": null,
- "run_speed": null,
- "final_speed": null,
- "speed_unit": null,
- "torque_series": [ ],
- "angle_series": [ ],
- "final_angle": null,
- "angle_threshold": null,
- "verify_angle": null
}, - "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "ocr_capture_variable_info": [
- null
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}
]
}
Retrieve all assemblies
Recall that Assembly Revisions are made up of one or more assemblies. Assemblies are the discrete items you perform coaching on. This endpoint retrieves every assembly in the database.
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": null,
- "label": null,
- "link": null,
- "value": null,
- "step_data_id": null,
- "type": null,
- "name": null,
- "options": null
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- null
], - "angle_series": [
- null
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": null,
- "bounding_box": null,
- "original_text_value": null,
- "step_number": null
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
]
}
Create an assembly
Deprecated. We recommend using POST /model/new/{assembly_id}
and navigating the training workflow to create an assembly.
Request Body schema: application/json
name | string |
description | string |
image_link | string |
tenant_id | string |
training_complete | boolean |
object (AssemblyId) | |
object (AssemblyId) | |
revision | integer <int32> |
object (Steps) | |
object (Augmentation) | |
object (DatabaseOptions) | |
classes | Array of strings |
product_version | string |
model_version | string |
published | boolean |
approver | string |
notes | string |
record_videos | boolean |
object (Timestamp) | |
active | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
Response samples
- 404
{- "status": "string",
- "msg": {
- "uuid": "string"
}
}
Retrieve a specific assembly
path Parameters
assembly_id required | string Example: 57618016-cd00-4fc8-85f5-e4b26304c6ba The ID of the assembly |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
}
Create or Update a specific assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
object (AssemblyId) | |
name | string |
description | string |
image_link | string |
tenant_id | string |
training_complete | boolean |
object (AssemblyId) | |
object (AssemblyId) | |
revision | integer <int32> |
object (Steps) | |
object (Augmentation) | |
object (DatabaseOptions) | |
classes | Array of strings |
product_version | string |
model_version | string |
published | boolean |
approver | string |
notes | string |
record_videos | boolean |
object (Timestamp) | |
active | boolean |
Responses
Request samples
- Payload
{- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "uuid": "string"
}
}
Retrieve all defined OCR Capture Variables
An OCR Capture Variable is a variable defined in a Serial Number Capture step. This retrieves all variables defined in every Serial Number Capture step for a specific assembly.
path Parameters
assembly_id required | string Example: af7ad140-9548-4bef-8c9b-792e80d3f687 The ID of the assembly |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
Get all steps for a specific assembly
Each assembly is made up of Steps. During coaching, these steps are shown to the operator chronologically to guide them from start to completion of the assembly. This endpoint retrieves every Step for a specific assembly.
path Parameters
assembly_id required | string Example: 57618016-cd00-4fc8-85f5-e4b26304c6ba The ID of the assembly |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
]
}
Append a new step to a specific assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
name | string |
description | string |
image_link | string |
video_link | string |
overlay_link | string |
minimum_predict | number <float> |
benchmark | number <float> |
roi_zoom | string |
camera_id | string |
object (AssemblyId) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "assembly_id": {
- "uuid": "string"
}
}
Response samples
- 200
{- "id": 0
}
Get a step from a specific assembly
path Parameters
assembly_id required | string |
step_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
}
Update information about a specific step
path Parameters
assembly_id required | string |
step_id required | string |
Request Body schema: application/json
id | string |
name | string |
description | string |
image_link | string |
video_link | string |
overlay_link | string |
minimum_predict | number <float> |
benchmark | number <float> |
roi_zoom | string |
camera_id | string |
perspective_change | boolean |
mask_perspective | boolean |
training_required | boolean |
classes | Array of strings |
object (AssemblyId) | |
next_step_id | string |
previous_step_id | string |
object (DatabaseOptions) | |
Array of objects (StepData) |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}
Response samples
- 200
{- "id": 0
}
Add or Update information of an augmentation for a specific assembly
path Parameters
assembly_id required | string |
Request Body schema: application/json
id | string |
object (AssemblyId) | |
lighting_aug | number <float> |
placement_aug | number <float> |
color_aug | number <float> |
Responses
Request samples
- Payload
{- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "uuid": "string"
}
}
Retrieve performance information of an operator for a specific assembly.
path Parameters
record_id required | string |
operator_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "operator_metrics": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- null
], - "assembly_id": {
- "uuid": null
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "step_data": [
- null
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "avg_time": 0,
- "avg_step_time": 0,
- "quality": 0,
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}
}
}
Checks if a given ocr capture variable type is in use on any assembly. Returns an 'in_use' status and information on the assemblies that reference the variable
Responses
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "in_use": true,
- "assembly_count": 0,
- "assemblies": [
- {
- "assembly_id": "string",
- "assembly_name": "string",
- "steps": [
- {
- "step_id": "string"
}
]
}
]
}
}
Renames an existing ocr_capture_variable pair. Updates all references to utilize the revised name
Responses
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "code": "string",
- "product_version": "string",
- "msg": "string",
- "count": 0,
- "target": "string",
- "err_code": "string"
}
}
Retrieve all defined OCR Capture Variables for a specific step
An OCR Capture Variable is a variable defined in a Serial Number Capture step. Given a Step ID, this retrieves all variables defined for that specific step.
path Parameters
step_id required | integer Example: 245 The Step ID in question |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
Delete all OCR Capture Variables for a specific step
An OCR Capture Variable is a variable defined in a Serial Number Capture step. Given a Step ID, this retrieves all variables defined for that specific step.
path Parameters
step_id required | string |
Responses
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Retrieve step data for a specific step
Each Step is made up of StepData, an array of actions that describe what occurs in this Step. This returns all StepData for a specific Step.
path Parameters
step_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
}
Add step data to a specific step
path Parameters
step_id required | string |
Request Body schema: application/json
Array of objects (StepDataInfo) | |
data_type | string Describes what this StepData's action refers to. Possible values are: 'ml', 'ocr-check', 'ocr-capture', 'ocr-verify', 'torque', 'input', 'output', 'qa'. |
units | string |
name | string |
tolerance | number <float> |
auto_align | boolean |
object (TorqueData) | |
object (DatabaseOptions) | |
Array of objects (OCRCaptureVariableInfo) |
Responses
Request samples
- Payload
{- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
Response samples
- 201
{- "id": 0
}
Get all StepDataInfo from specific StepData
Just like Steps are made up of StepData, StepData is made up of StepDataInfo. StepDataInfo is primarily key/value pairs that the are utilized for coaching in some way. The Key/Values that the StepDataInfo contains depends on the context of the StepData's data_type
field.
path Parameters
step_id required | string |
step_data_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Add a new StepDataInfo to a specific Step
path Parameters
step_id required | string |
step_data_id required | string |
Request Body schema: application/json
label | string |
link | string |
value | string |
step_data_id | string |
type | string |
name | string |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 201
{- "id": 0
}
Add or Update information about a specific StepData
path Parameters
step_id required | string |
step_data_id required | string |
Request Body schema: application/json
Array of objects (StepDataInfo) | |
id | string |
step_id | string |
data_type | string Describes what this StepData's action refers to. Possible values are: 'ml', 'ocr-check', 'ocr-capture', 'ocr-verify', 'torque', 'input', 'output', 'qa'. |
units | string |
name | string |
tolerance | number <float> |
auto_align | boolean |
object (TorqueData) | |
object (DatabaseOptions) | |
Array of objects (OCRCaptureVariableInfo) |
Responses
Request samples
- Payload
{- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
Response samples
- 200
{- "id": 0
}
Add or Update information about a specific StepDataInfo
path Parameters
step_data_info_id required | string |
Request Body schema: application/json
id | string |
label | string |
link | string |
value | string |
step_data_id | string |
type | string |
name | string |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "id": 0
}
Retrieve metrics info from a specific assembly record
Each assembly record is a coaching session performed by a particular operator. Although redundant, the operator ID of the assembly record is required as well.
path Parameters
assembly_record_id required | string Example: 796f3b09-b3a1-4410-8d1a-c8ba38c0f751 The ID of the assembly record |
operator_id required | integer Example: 1 The ID of the assembly |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "operator_metrics": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- null
], - "assembly_id": {
- "uuid": null
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "step_data": [
- null
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "avg_time": 0,
- "avg_step_time": 0,
- "quality": 0,
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}
}
}
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "assembly_records": [
- {
- "assembly_record_id": "string",
- "assembly_id": "string",
- "assembly_revisions_id": "string",
- "name": "string",
- "description": "string",
- "revision_number": 0,
- "approver": "string",
- "datetime": "string",
- "complete": true,
- "time_taken": 0,
- "benchmark": 0,
- "software_version": "string",
- "model_version": "string",
- "quality": 0,
- "confidence": 0,
- "performance": 0,
- "performance_explanation": "string",
- "captured_variables": [
- {
- "type": "string",
- "value": "string"
}
], - "steps": [
- {
- "step_record_id": "string",
- "step_id": "string",
- "step_number": "string",
- "step_name": "string",
- "datetime": "string",
- "complete": true,
- "prediction": 0,
- "time_taken": 0,
- "supervisor_override": true,
- "skipped": true,
- "status": "string",
- "performance": 0,
- "performance_explanation": "string",
- "type": "string",
- "units": "string",
- "description": "string",
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "benchmark": 0
}
], - "quality_hold": true
}
], - "total_records": 0
}
}
Retrieve information about all previous coaching sessions of a specific assembly
path Parameters
assembly_id required | string Example: 57618016-cd00-4fc8-85f5-e4b26304c6ba The ID of the assembly |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- null
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": null,
- "target_torque": null,
- "max_torque": null,
- "torque_unit": null,
- "run_speed": null,
- "final_speed": null,
- "speed_unit": null,
- "torque_series": [ ],
- "angle_series": [ ],
- "final_angle": null,
- "angle_threshold": null,
- "verify_angle": null
}, - "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "ocr_capture_variable_info": [
- null
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Retrieve information about a specific record
path Parameters
record_id required | string Example: 796f3b09-b3a1-4410-8d1a-c8ba38c0f751 The ID of the assembly record |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": null,
- "label": null,
- "link": null,
- "value": null,
- "step_data_id": null,
- "type": null,
- "name": null,
- "options": null
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- null
], - "angle_series": [
- null
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": null,
- "bounding_box": null,
- "original_text_value": null,
- "step_number": null
}
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
}
Get the most recent assembly record for a specific assembly
Despite this returning an array, it only returns the most recent record.
path Parameters
assembly_id required | string Example: 57618016-cd00-4fc8-85f5-e4b26304c6ba The ID of the assembly to retrieve records from |
limit required | integer Example: 1 Required, but currently unused. Only returns one result. |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- null
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": null,
- "target_torque": null,
- "max_torque": null,
- "torque_unit": null,
- "run_speed": null,
- "final_speed": null,
- "speed_unit": null,
- "torque_series": [ ],
- "angle_series": [ ],
- "final_angle": null,
- "angle_threshold": null,
- "verify_angle": null
}, - "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "ocr_capture_variable_info": [
- null
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Get the most recent record for a specific operator
Despite this returning an array, it only returns the most recent record.
path Parameters
operator_id required | integer Example: 1 The ID of the Operator to retrieve most recent record from |
limit required | integer Example: 1 Required, but currently unused. Only returns one result. |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- null
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": null,
- "target_torque": null,
- "max_torque": null,
- "torque_unit": null,
- "run_speed": null,
- "final_speed": null,
- "speed_unit": null,
- "torque_series": [ ],
- "angle_series": [ ],
- "final_angle": null,
- "angle_threshold": null,
- "verify_angle": null
}, - "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "ocr_capture_variable_info": [
- null
]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Retrieve performance information of specific step, performed by a specific operator, of a previously coached assembly
path Parameters
record_id required | string |
operator_id required | string |
step_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "step_data": [
- {
- "step_data_info": [ ],
- "id": null,
- "step_id": null,
- "data_type": null,
- "units": null,
- "name": null,
- "tolerance": null,
- "auto_align": null,
- "torque_data": null,
- "options": null,
- "ocr_capture_variable_info": [ ]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "operators": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
}
Add a new operator
Request Body schema: application/json
id | string |
first_name | string |
last_name | string |
num_records | integer <int32> |
role | string |
rfid | string |
password | string |
active | boolean |
has_password | boolean |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "operators": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
}
Update active status for existing operator
Request Body schema: application/json
id | string |
first_name | string |
last_name | string |
num_records | integer <int32> |
role | string |
rfid | string |
password | string |
active | boolean |
has_password | boolean |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Get the operator id given operator First Name and Last Name
Request Body schema: application/json
first_name | string |
last_name | string |
Responses
Request samples
- Payload
{- "frequency": "WEEKLY",
- "recipients": [
- "jsmith@company.com",
- "habney@company.com"
]
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "operators": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
}
Update role for existing operator
Request Body schema: application/json
id | string |
first_name | string |
last_name | string |
num_records | integer <int32> |
role | string |
rfid | string |
password | string |
active | boolean |
has_password | boolean |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Update name for existing operator
Request Body schema: application/json
id | string |
first_name | string |
last_name | string |
num_records | integer <int32> |
role | string |
rfid | string |
password | string |
active | boolean |
has_password | boolean |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Update password for an existing operator
Request Body schema: application/json
id | string |
first_name | string |
last_name | string |
num_records | integer <int32> |
role | string |
rfid | string |
password | string |
active | boolean |
has_password | boolean |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
- 400
- 500
{- "status": "ok",
- "msg": ""
}
Verifies if the provided RFID is associated with an active Operator. Returns the active operator
Request Body schema: application/json
rfid | string |
Responses
Request samples
- Payload
{- "rfid": "string"
}
Response samples
- 200
- 400
- 500
{- "status": "string",
- "msg": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
}
Authenticates operator credentials provided operator first_name, last_name, and password
Request Body schema: application/json
first_name | string |
last_name | string |
password | string |
Responses
Request samples
- Payload
{- "first_name": "string",
- "last_name": "string",
- "password": "string"
}
Response samples
- 200
- 400
- 500
{- "status": "ok",
- "msg": ""
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "operator_metrics": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- null
], - "assembly_id": {
- "uuid": null
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "step_data": [
- null
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "avg_time": 0,
- "avg_step_time": 0,
- "quality": 0,
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}
}
}
Get metrics on a previously coached assembly performed by a specific operator
path Parameters
operator_id required | string |
assembly_record_id required | string |
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "operator_metrics": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- null
], - "assembly_id": {
- "uuid": null
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "step_data": [
- null
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "avg_time": 0,
- "avg_step_time": 0,
- "quality": 0,
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}
}
}
Retrieve performance information of specific step, performed by a specific operator, of a previously coached assembly
path Parameters
operator_id required | string |
assembly_record_id required | string |
step_id required | string |
Responses
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "operator_metrics": [
- {
- "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "step": {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "step_data": [
- {
- "step_data_info": [
- {
- "id": "string",
- "label": "string",
- "link": "string",
- "value": "string",
- "step_data_id": "string",
- "type": "string",
- "name": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}
}
], - "id": "string",
- "step_id": "string",
- "data_type": "ml",
- "units": "string",
- "name": "string",
- "tolerance": 0,
- "auto_align": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "ocr_capture_variable_info": [
- {
- "variable_name": "string",
- "bounding_box": "string",
- "original_text_value": "string",
- "step_number": "string"
}
]
}
]
}, - "assembly_id": {
- "uuid": "string"
}, - "step_record": {
- "prediction": 0,
- "complete": true,
- "time_taken": 0,
- "metric_datetime": "string",
- "delta_from_benchmark": 0,
- "benchmark": 0,
- "skipped": true,
- "supervisor_override": true,
- "torque_data": {
- "program_id": 0,
- "target_torque": 0,
- "max_torque": 0,
- "torque_unit": "string",
- "run_speed": 0,
- "final_speed": 0,
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "final_angle": 0,
- "angle_threshold": 0,
- "verify_angle": true
}, - "num_incorrect": 0
}, - "assembly_record": {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- null
], - "assembly_id": {
- "uuid": null
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": null,
- "page_size": null,
- "start_date": null,
- "end_date": null
}, - "step_data": [
- null
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "avg_time": 0,
- "avg_step_time": 0,
- "quality": 0,
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}
}
}
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "records": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "step_data": [
- {
- "step_data_info": [ ],
- "id": null,
- "step_id": null,
- "data_type": null,
- "units": null,
- "name": null,
- "tolerance": null,
- "auto_align": null,
- "torque_data": null,
- "options": null,
- "ocr_capture_variable_info": [ ]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "total_pages": 0
}
}
Response samples
- 200
- 404
{- "status": "string",
- "msg": {
- "records": [
- {
- "id": {
- "uuid": "string"
}, - "ref_assembly_id": {
- "uuid": "string"
}, - "ref_assembly": {
- "id": {
- "uuid": "string"
}, - "name": "string",
- "description": "string",
- "image_link": "string",
- "tenant_id": "string",
- "training_complete": true,
- "revision_id": {
- "uuid": "string"
}, - "parent_id": {
- "uuid": "string"
}, - "revision": 0,
- "steps": {
- "steps": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "image_link": "string",
- "video_link": "string",
- "overlay_link": "string",
- "minimum_predict": 0,
- "benchmark": 0,
- "roi_zoom": "string",
- "camera_id": "string",
- "perspective_change": true,
- "mask_perspective": true,
- "training_required": true,
- "classes": [
- "string"
], - "assembly_id": {
- "uuid": "string"
}, - "next_step_id": "string",
- "previous_step_id": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": null,
- "nanos": null
}, - "end_date": {
- "seconds": null,
- "nanos": null
}
}, - "step_data": [
- {
- "step_data_info": [ ],
- "id": null,
- "step_id": null,
- "data_type": null,
- "units": null,
- "name": null,
- "tolerance": null,
- "auto_align": null,
- "torque_data": null,
- "options": null,
- "ocr_capture_variable_info": [ ]
}
]
}
]
}, - "augmentation": {
- "id": "string",
- "assembly_id": {
- "uuid": "string"
}, - "lighting_aug": 0,
- "placement_aug": 0,
- "color_aug": 0
}, - "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}, - "classes": [
- "string"
], - "product_version": "string",
- "model_version": "string",
- "published": true,
- "approver": "string",
- "notes": "string",
- "record_videos": true,
- "last_edited": {
- "seconds": "string",
- "nanos": 0
}, - "active": true
}, - "operator": {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "num_records": 0,
- "role": "string",
- "rfid": "string",
- "password": "string",
- "active": true,
- "has_password": true,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}, - "benchmark": 0,
- "complete": true,
- "assembly_record_datetime": "string",
- "num_records": 0,
- "qa_report_link": "string",
- "ocr_capture_variable_records": {
- "ocr_capture_variable_records": [
- {
- "assembly_record_id": "string",
- "step_id": "string",
- "variable_name": "string",
- "variable_value": "string"
}
]
}, - "quality_hold": true,
- "time_taken": 0,
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
], - "total_pages": 0
}
}
Response samples
- 200
- 400
{- "status": "string",
- "msg": [
- {
- "id": "string",
- "name": "string",
- "mfg": "string",
- "serial_number": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
]
}
Adds a new camera to the database
Request Body schema: application/json
id | string |
name | string |
mfg | string |
serial_number | string |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "mfg": "string",
- "serial_number": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "code": "string",
- "product_version": "string",
- "msg": "string",
- "count": 0,
- "target": "string",
- "err_code": "string"
}
}
Deletes camera from the database
Request Body schema: application/json
id | string |
name | string |
mfg | string |
serial_number | string |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "mfg": "string",
- "serial_number": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Gets an M-JPEG stream of the active camera
Gets an M-JPEG stream of the active camera. Make sure to start the camera pipeline first via POST /camera_stream
.
Request Body schema: application/json
id | string |
name | string |
mfg | string |
serial_number | string |
object (DatabaseOptions) |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "mfg": "string",
- "serial_number": "string",
- "options": {
- "page": 0,
- "page_size": 0,
- "start_date": {
- "seconds": "string",
- "nanos": 0
}, - "end_date": {
- "seconds": "string",
- "nanos": 0
}
}
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "resolution": "string",
- "resize_pipeline": "string",
- "resize_web": "string",
- "framerate": 0,
- "iso": 0,
- "rotation": 0,
- "zoom": "string",
- "ip": "string",
- "port": "string",
- "stream_path": "string",
- "pipeline_color_format": "string",
- "device_user_name": "string",
- "camera_type": "string",
- "device_serial_number": "string",
- "emulation": true,
- "user_set": "string",
- "Width": 0,
- "Height": 0,
- "OffsetX": 0,
- "OffsetY": 0,
- "ReverseX": 0,
- "ReverseY": 0,
- "PixelFormat": "string",
- "AcquisitionMode": "string",
- "ExposureAuto": "string",
- "ExposureMode": "string",
- "AcquisitionFrameRateAbs": 0,
- "AcquisitionFrameRate": 0,
- "PylonIgnoreCaps": 0,
- "DeviceUserID": "string",
- "ImageFilepath": "string",
- "CameraWidth": 0,
- "CameraHeight": 0,
- "CameraOffsetX": 0,
- "CameraOffsetY": 0,
- "AutoFocus": true,
- "MaxGain": 0,
- "MaxExposureTime": 0,
- "AutoReconnect": true,
- "WidthMax": 0,
- "HeightMax": 0,
- "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "test_config": {
- "test_dir": "string",
- "assembly_id": "string",
- "step_label": "string",
- "disable_crop": true,
- "disable_camera_change": true,
- "override_auto_step": true
}
}
}
Update the configuration of a specific camera
Request Body schema: application/json
resolution | string |
resize_pipeline | string |
resize_web | string |
framerate | number <float> |
iso | integer <int32> |
rotation | integer <int32> |
zoom | string |
ip | string |
port | string |
stream_path | string |
pipeline_color_format | string |
device_user_name | string |
camera_type | string Possible values are: UNKNOWN BASLER_ACE BASLER_GIGE BASLER_AC2 BASLER_USB BASLER_EMULATOR RASPBERRY_PI |
device_serial_number | string |
emulation | boolean |
user_set | string |
Width | integer <int32> |
Height | integer <int32> |
OffsetX | integer <int32> |
OffsetY | integer <int32> |
ReverseX | integer <int32> |
ReverseY | integer <int32> |
PixelFormat | string |
AcquisitionMode | string |
ExposureAuto | string |
ExposureMode | string |
AcquisitionFrameRateAbs | number <float> |
AcquisitionFrameRate | number <float> |
PylonIgnoreCaps | integer <int32> |
DeviceUserID | string |
ImageFilepath | string |
CameraWidth | integer <int32> |
CameraHeight | integer <int32> |
CameraOffsetX | integer <int32> |
CameraOffsetY | integer <int32> |
AutoFocus | boolean |
MaxGain | number <float> |
MaxExposureTime | integer <int32> |
AutoReconnect | boolean |
WidthMax | integer <int32> |
HeightMax | integer <int32> |
object (SystemOptions) | |
object (CameraTestConfig) |
Responses
Request samples
- Payload
{- "resolution": "string",
- "resize_pipeline": "string",
- "resize_web": "string",
- "framerate": 0,
- "iso": 0,
- "rotation": 0,
- "zoom": "string",
- "ip": "string",
- "port": "string",
- "stream_path": "string",
- "pipeline_color_format": "string",
- "device_user_name": "string",
- "camera_type": "string",
- "device_serial_number": "string",
- "emulation": true,
- "user_set": "string",
- "Width": 0,
- "Height": 0,
- "OffsetX": 0,
- "OffsetY": 0,
- "ReverseX": 0,
- "ReverseY": 0,
- "PixelFormat": "string",
- "AcquisitionMode": "string",
- "ExposureAuto": "string",
- "ExposureMode": "string",
- "AcquisitionFrameRateAbs": 0,
- "AcquisitionFrameRate": 0,
- "PylonIgnoreCaps": 0,
- "DeviceUserID": "string",
- "ImageFilepath": "string",
- "CameraWidth": 0,
- "CameraHeight": 0,
- "CameraOffsetX": 0,
- "CameraOffsetY": 0,
- "AutoFocus": true,
- "MaxGain": 0,
- "MaxExposureTime": 0,
- "AutoReconnect": true,
- "WidthMax": 0,
- "HeightMax": 0,
- "system_options": {
- "use_alignment_ai": true,
- "alignment_mode": "string",
- "alignment_ai_threshold": 0,
- "use_multistep_model": true,
- "auto_advance_video_only": true
}, - "test_config": {
- "test_dir": "string",
- "assembly_id": "string",
- "step_label": "string",
- "disable_crop": true,
- "disable_camera_change": true,
- "override_auto_step": true
}
}
Response samples
- 200
{- "status": "string",
- "msg": {
- "roi_zoom": "string",
- "camera_name": "string"
}
}
Get all Basler device usernames
Some Camera endpoints require a "device_user_name", which is an identifier for a given Basler camera. This endpoint returns all configured basler device user names. Response is returned in a JSON serialized string. Sample response:
{
"status": "ok",
"msg": "[\"RAP_CAM_01\", \"RAP_CAM_02\"]"
}
Responses
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Triggers the Auto Adjust functionality of a specific camera
Request Body schema: application/json
device_user_name required | string A Basler device username |
Responses
Request samples
- Payload
{- "device_user_name": "string"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Triggers the Auto Focus functionality of a specific camera
Request Body schema: application/json
device_user_name required | string A Basler device username |
Responses
Request samples
- Payload
{- "device_user_name": "string"
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Set the max gain of a specific camera
Request Body schema: application/json
device_user_name required | string A Basler device username |
max_gain | number <float> |
Responses
Request samples
- Payload
{- "device_user_name": "string",
- "max_gain": 0
}
Response samples
- 200
{- "status": "ok",
- "msg": ""
}
Set the max exposure time of a specific camera
Request Body schema: application/json
device_user_name | string |
max_exposure_time | integer <int32> Exposure time in microseconds |
Responses
Request samples
- Payload
{- "device_user_name": "string",
- "max_exposure_time": 0
}
Response samples
- 200
- 400
{- "status": "ok",
- "msg": ""
}
Get the health status of system components
Request Body schema: application/json
_compute_sensor_camera_basler | string Possible values are: UNKNOWN UP DOWN RESET |
_compute_sensor_mechanical_io | string Possible values are: UNKNOWN UP DOWN RESET |
_buslog_scheduler | string Possible values are: UNKNOWN UP DOWN RESET |
_store_filesys | string Possible values are: UNKNOWN UP DOWN RESET |
_store_database | string Possible values are: UNKNOWN UP DOWN RESET |
_compute_predict | string Possible values are: UNKNOWN UP DOWN RESET |
_compute_sequencer | string Possible values are: UNKNOWN UP DOWN RESET |
_compute_train.*? | string Possible values are: UNKNOWN UP DOWN RESET |
_compute_recorder | string Possible values are: UNKNOWN UP DOWN RESET |
_ui_webserver | string Possible values are: UNKNOWN UP DOWN RESET |
_buslog_reporting | string Possible values are: UNKNOWN UP DOWN RESET |
Request samples
- Payload
{- "_compute_sensor_camera_basler": "UP",
- "_compute_sensor_mechanical_io": "UP",
- "_buslog_scheduler": "UP",
- "_store_filesys": "UP",
- "_store_database": "UP",
- "_compute_predict": "UP",
- "_compute_sequencer": "UP",
- "_compute_train.*?": "UP",
- "_compute_recorder": "UP",
- "_ui_webserver": "UP",
- "_buslog_reporting": "UP"
}
Change how frequently a report is emailed, and who receives one
Request Body schema: application/json
frequency | string Values can be "DAILY", "WEEKLY", "MONTHLY" |
report_type | string Currently, the only valid value is "ASSEMBLY" |
recipients | Array of strings |
Responses
Request samples
- Payload
{- "frequency": "WEEKLY",
- "report_type": "string",
- "recipients": [
- "string"
]
}
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "id": "string",
- "recipients": [
- "string"
], - "report_type": "string",
- "frequency": "string",
- "last_ran": "string"
}
}
Return all scheduled reports
Returns a list of all scheduled reports. Currently there is only ever one scheduled report which can be continuously overwritten by POST /scheduled-report
. This will change in the future.
Responses
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "scheduled_reports": [
- {
- "id": "string",
- "recipients": [
- "string"
], - "report_type": "string",
- "frequency": "string",
- "last_ran": "string"
}
]
}
}
Update information about a specific scheduled report
path Parameters
scheduled_report_id required | integer Example: 1 The ID of the scheduled report |
Request Body schema: application/json
frequency | string Values can be "DAILY", "WEEKLY", "MONTHLY" |
recipients | Array of strings |
Responses
Request samples
- Payload
{- "frequency": "WEEKLY",
- "recipients": [
- "string"
]
}
Response samples
- 200
- 400
{- "status": "string",
- "msg": {
- "scheduled_reports": [
- {
- "id": "string",
- "recipients": [
- "string"
], - "report_type": "string",
- "frequency": "string",
- "last_ran": "string"
}
]
}
}
Set the static IP and subnet mask for this workstations Rapta Gateway.
Request Body schema: application/json
static_ip | string |
subnet_mask | string |
object (Status) |
Responses
Request samples
- Payload
{- "static_ip": "desired_rapta_ip",
- "subnet_mask": "255.255.255.0"
}
Response samples
- 200
- 400
- 500
{- "status": "ok",
- "msg": ""
}
Retrieve current status of the backup service. States whether the service is idle, ongoing backups or restorations, or if an error has occurred.
Responses
Response samples
- 200
{- "status": "string",
- "msg": {
- "backup_status": "string",
- "reason": "string",
- "service_unusable": true
}
}
Create or update a data backup connection
Request Body schema: application/json
id | string |
username | string |
uri | string |
directory | string |
backup_enabled | boolean |
backup_automatically | boolean |
exception_recipients | Array of strings |
object (Timestamp) | |
restore_message | string |
restore_status | string Possible values are: SUCCESS FAIL STARTED ENDED QUEUED UNAVAILABLE CANCELLED ERROR INVALID_ARGUMENT NOT_FOUND OK IDLE BUSY UNKNOWN INITIALIZING CHECKSUM_MISMATCH WARNING UP DOWN WRONG_VERSION |
object (Timestamp) | |
backup_message | string |
backup_status | string Possible values are: SUCCESS FAIL STARTED ENDED QUEUED UNAVAILABLE CANCELLED ERROR INVALID_ARGUMENT NOT_FOUND OK IDLE BUSY UNKNOWN INITIALIZING CHECKSUM_MISMATCH WARNING UP DOWN WRONG_VERSION |
Responses
Request samples
- Payload
{- "username": "smb_username",
- "password": "MySMBPassword",
- "uri": "127.0.0.1",
- "directory": "RaptaShare"
}
Response samples
- 200
- 400
- 500
{- "status": "ok",
- "msg": ""
}
Response samples
- 200
{- "status": "string",
- "msg": [
- {
- "device": "string",
- "model_name": "string",
- "partitions": [
- {
- "device": "string",
- "uri": "string",
- "max_storage": "string",
- "used_storage": "string",
- "free_storage": "string",
- "supported": true
}
]
}
]
}
Connect to a smart wrench device
Request Body schema: application/json
address required | string |
port | integer <int32> |
timeout_ms | integer <int32> |
connection_type | string |
manufacturer | string |
model | string |
connection_parameters | object |
Responses
Request samples
- Payload
{- "address": "string",
- "port": 0,
- "timeout_ms": 0,
- "connection_type": "string",
- "manufacturer": "string",
- "model": "string",
- "connection_parameters": { }
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "connected": true,
- "status_message": "string",
- "serial_number": 0,
- "firmware_version": 0,
- "error_code": "string",
- "ready": true
}
}
Disconnect from a smart wrench device
Request Body schema: application/json
address required | string |
Responses
Request samples
- Payload
{- "address": "string"
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "connected": true,
- "status_message": "string",
- "serial_number": 0,
- "firmware_version": 0,
- "error_code": "string",
- "ready": true
}
}
Get the current status of a smart wrench device
query Parameters
address required | string Address of the wrench |
Responses
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "connected": true,
- "status_message": "string",
- "serial_number": 0,
- "firmware_version": 0,
- "error_code": "string",
- "ready": true
}
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "configs": [
- {
- "connection_type": "string",
- "address": "string",
- "port": 0,
- "timeout_ms": 0,
- "polling_interval_ms": 0,
- "manufacturer": "string",
- "model": "string",
- "connection_parameters": [
- {
- "key": "string",
- "value": "string"
}
]
}
]
}
}
Toggle wrench functionalities (enable, disable, lock, unlock)
Request Body schema: application/json
action required | string One of 'enable', 'disable', 'lock', 'unlock' |
program_nr | integer <int32> Program number if applicable |
Responses
Request samples
- Payload
{- "action": "string",
- "program_nr": 0
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "action": "string",
- "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "torque": 0,
- "angle": "string",
- "speed": "string",
- "program_nr": 0,
- "operation_complete": true,
- "status_message": "string",
- "target_torque": 0,
- "max_torque": 0,
- "min_angle": 0,
- "max_angle": 0,
- "run_speed": "string",
- "final_speed": "string",
- "torque_unit": "string",
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "operation_timeout": true,
- "torque_status": "string",
- "angle_status": "string",
- "speed_status": "string",
- "peak_torque": 0
}
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "action": "string",
- "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "torque": 0,
- "angle": "string",
- "speed": "string",
- "program_nr": 0,
- "operation_complete": true,
- "status_message": "string",
- "target_torque": 0,
- "max_torque": 0,
- "min_angle": 0,
- "max_angle": 0,
- "run_speed": "string",
- "final_speed": "string",
- "torque_unit": "string",
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "operation_timeout": true,
- "torque_status": "string",
- "angle_status": "string",
- "speed_status": "string",
- "peak_torque": 0
}
}
Configure a tightening program
Request Body schema: application/json
program_nr required | integer <int32> |
program required | object |
Responses
Request samples
- Payload
{- "program_nr": 0,
- "program": { }
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "action": "string",
- "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "torque": 0,
- "angle": "string",
- "speed": "string",
- "program_nr": 0,
- "operation_complete": true,
- "status_message": "string",
- "target_torque": 0,
- "max_torque": 0,
- "min_angle": 0,
- "max_angle": 0,
- "run_speed": "string",
- "final_speed": "string",
- "torque_unit": "string",
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "operation_timeout": true,
- "torque_status": "string",
- "angle_status": "string",
- "speed_status": "string",
- "peak_torque": 0
}
}
Set sequence information
Request Body schema: application/json
program_nr required | integer <int32> |
sequence_number required | integer <int32> |
Responses
Request samples
- Payload
{- "program_nr": 0,
- "sequence_number": 0
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "action": "string",
- "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "torque": 0,
- "angle": "string",
- "speed": "string",
- "program_nr": 0,
- "operation_complete": true,
- "status_message": "string",
- "target_torque": 0,
- "max_torque": 0,
- "min_angle": 0,
- "max_angle": 0,
- "run_speed": "string",
- "final_speed": "string",
- "torque_unit": "string",
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "operation_timeout": true,
- "torque_status": "string",
- "angle_status": "string",
- "speed_status": "string",
- "peak_torque": 0
}
}
Response samples
- 200
- 500
{- "status": "string",
- "msg": {
- "action": "string",
- "timestamp": {
- "seconds": "string",
- "nanos": 0
}, - "torque": 0,
- "angle": "string",
- "speed": "string",
- "program_nr": 0,
- "operation_complete": true,
- "status_message": "string",
- "target_torque": 0,
- "max_torque": 0,
- "min_angle": 0,
- "max_angle": 0,
- "run_speed": "string",
- "final_speed": "string",
- "torque_unit": "string",
- "speed_unit": "string",
- "torque_series": [
- 0
], - "angle_series": [
- 0
], - "operation_timeout": true,
- "torque_status": "string",
- "angle_status": "string",
- "speed_status": "string",
- "peak_torque": 0
}
}
Set Alignment AI step id
path Parameters
step_id required | integer Example: 1 The ID of the step |
assembly_id required | integer Example: 1 The ID of the assembly |
query Parameters
mode | string Enum: "continuous" "manual" Example: mode=continuous The mode of the step |
Responses
Response samples
- 200
- 500
{- "status": "ok",
- "msg": ""
}