API Reference
Try to find a the external label by the id
Try to find a the external label by the id
Request parameters
Responses
{
"id": 1,
"qr_code_content": "1234567890",
"label": "Label",
"description": "Description",
"order_number": "Order number",
"sequence": "Sequence",
"container": {
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
}
}
Get details from a chemical container
Chemical container information
Request parameters
Responses
{
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
}
Get details from a chemical
Chemical information
Request parameters
Responses
{
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
}
This api call returns the goldstein client based on the goldstein client token
Give client based on the token
Request parameters
Responses
{
"id": 2,
"token": "134daflhsd23",
"current_association": "equipment:1"
}
This API call creates a new Goldstein log entry
Create a new Goldstein log
Request parameters
{
"action": "login",
"association": "equipment:1",
"message": "User logged in successfully"
}
Responses
{
"id": 1,
"date": "2023-01-01T12:00Z",
"action": "login",
"association": "equipment:1",
"message": "User logged in successfully"
}
Registers the external label with the chemical container
Registers the external label with the chemical container
Request parameters
{
"container": 58,
"qr_code_content": "example"
}
Responses
{
"id": 1,
"qr_code_content": "1234567890",
"label": "Label",
"description": "Description",
"order_number": "Order number",
"sequence": "Sequence",
"container": {
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
}
}
Add a user to a chemical container
Adds a user to a chemical container and logs the change
Request parameters
{
"container": 58,
"user": 58
}
Responses
{
"id": 1,
"container": {
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
},
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"comment": "User comment",
"date_created": "2023-01-01T09:00Z",
"deleted_at": "2023-01-01T09:00Z"
}
Create a new chemical container
API to create a new chemical container
Request parameters
{
"chemical": 58,
"user": 58,
"type": 58,
"method_of_use": 58,
"purpose": 58,
"location": 58,
"sub_location": "example",
"supplier": "example",
"concentration": "example",
"amount": "example",
"amount_unit": "example"
}
Responses
Create a new chemical
API to create a new chemical
Request parameters
{
"name": "example",
"cas_number": "example",
"description": "example",
"standard_product": 58,
"physical_state": 58,
"is_halogenated": true,
"contains_metals": true
}
Responses
Create an changelog item for an equipment module (assist)
Create an changelog item
Request parameters
{
"module": 58,
"changelog": "example"
}
Responses
Action triggered when a user uploads a file to an ECN
Upload a file to an ECN
Request parameters
Responses
Create an ecn for an equipment module
Create an ecn
Request parameters
{}
Responses
{
"id": 1,
"module_id": 2,
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"ecn": "Pump chamber before use",
"description": "Since there is a problem with the pump chamber, we need to check it before use.",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"attachments": 2
}
With this API call you can store in SoloDB any external activity for an equipment module
Api to log external activity for an equipment module
Request parameters
{
"module": 2,
"account": "vdheide@example.com",
"type": 1,
"activity": "Logging of equipment activity",
"comment": "example"
}
Responses
{
"module": 2,
"account": "vdheide@example.com",
"type": 1,
"activity": "Logging of equipment activity",
"comment": "example"
}
Action triggered when a user uploads a file to an issue
Upload a file to an issue
Request parameters
Responses
Create an issue for an equipment module
Create an issue
Request parameters
{
"id": 1,
"module_id": 2,
"issue": "Water leak",
"description": "There is a water lead in one of the drains",
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"issue_type": "1",
"status": "1",
"forecast_up": "2024-01-01T09:00Z",
"actions": "Check the drain and fix the leak",
"attachments": 2
}
Responses
{
"id": 1,
"module_id": 2,
"issue": "Water leak",
"description": "There is a water lead in one of the drains",
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"issue_type": "1",
"status": "1",
"forecast_up": "2024-01-01T09:00Z",
"actions": "Check the drain and fix the leak",
"attachments": 2
}
API service to update the status of an equipment module
Update the status of the module
Request parameters
{
"module": 1,
"status": 1,
"description": "Module is now operational",
"email_trained_users": "false",
"email_responsible_users": "false"
}
Responses
Create a new message in a location
API to create a new message in a location
Request parameters
{
"title": "example",
"description": "example",
"owner": 36,
"type": 36,
"rooms": [
58
],
"areas": [
58
],
"facilities": [
58
]
}
Responses
Add a value of a process parameter to a monitor requirement result
Add a value of a process parameter to a monitor requirement result
Request parameters
{
"result": 1,
"step_parameter": 1,
"value": "10.5"
}
Responses
API service enter an ad-hoc result
Create an ad-hoc result
Request parameters
{
"requirement": 58,
"date": "example"
}
Responses
Create a run step part action
Create a run step part action
Request parameters
{
"run_step_part_id": 58,
"type": 58,
"comment": "example"
}
Responses
{
"id": 1,
"date_created": "2024-01-01T00:00:00+00:00",
"comment": "example"
}
Create a run step part
Create a run step part
Request parameters
{
"run_part_id": 58,
"run_step_id": 58,
"comment": "example"
}
Responses
{
"id": 1,
"step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": ...,
"status": ...,
"front_color": ...,
"back_color": ...,
"sequence": ...
},
"description": "Down for maintenance",
"user": {
"id": ...,
"first_name": ...,
"last_name": ...,
"initials": ...,
"full_name": ...,
"email": ...
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
...
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"part": {
"id": 1,
"short_label": "A",
"label": "Part A"
},
"date_started": "2024-01-01T00:00:00+00:00",
"part_processing_failed_in_previous_step": true,
"comment": "example",
"actions": 0,
"latest_action": {
"id": 1,
"date_created": "2024-01-01T00:00:00+00:00",
"comment": "example"
}
}
Remove user from a chemical container
Remove a user from a chemical container by container ID
Request parameters
Responses
This action deletes a chemical container
Delete a chemical container
Request parameters
Responses
This action deletes a file uploaded to equipment module ECN
Delete a file uploaded to an equipment module ECN
Request parameters
Responses
This action deletes an equipment module ecn
Delete an equipment module ecn
Request parameters
Responses
This action deletes a file uploaded to equipment module issue
Delete a file uploaded to an equipment module issue
Request parameters
Responses
This action deletes an equipment module issue
Delete an equipment module issue
Request parameters
Responses
This action deletes a monitor requirement result step parameter value
Delete a monitor requirement result step parameter value
Request parameters
Responses
Action triggered when a user deletes a batch card for a run
Delete the batch card for a run
Request parameters
Responses
Get details from an equipment module
Equipment module information
Request parameters
Responses
{
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
}
Get details from an equipment
Equipment information
Request parameters
Responses
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
}
Get details from a monitor (SPC) requirement
Monitor (SPC) requirement information
Request parameters
Responses
{
"id": 1,
"title": "IX124 thickness",
"definition": "Average thickness of IX124",
"method": "Spin according to recipe and measure thickness on three places",
"sequence": 1,
"step": {
"id": 1,
"process_module_id": 1,
"equipment_module_id": 1,
"process_id": 1
},
"targets": [
{
"id": 1,
"min_value": 0.04,
"max_value": 0.45,
"target": 0.3,
"is_value_inclusive": "true",
"unit": "um",
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
}
}
}
],
"latest_result": {
"id": 1,
"date_create": null,
"values": [
{
"float_value": 1,
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
}
},
"condition": "value > 0",
"value_is_valid": "true"
}
]
}
}
Get details from a monitor (SPC)
Monitor (SPC) information
Request parameters
Responses
{
"id": 1,
"name": "Litho monitoring",
"description": "Monitoring of litho process",
"date_created": "2021-01-01T00:00:00+00:00",
"last_update": "example",
"type": "Ac hoc",
"amount_of_steps": 12
}
Get details from a status mail
Status mail information
Request parameters
Responses
{
"id": 1,
"name": "Status mail 1",
"date_created": "2025-01-01T00:00:00+00:00",
"last_update": "example",
"filter": [
{
"Message type": [
1,
2,
3
],
"MESStatus": [
2,
3,
4
]
}
],
"equipment_filter": "equipment filter",
"sequence": 1,
"show_issues_with_priority": "true",
"show_in_navigation": "true",
"show_issues": "2",
"show_reservations": "true",
"classification": "1",
"order": "2",
"direction": "ASC",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"to": "info@example.com",
"cc": "example",
"bcc": "example",
"subject": "Subject"
}
This api call returns the goldstein client based on the goldstein client token
Give client based on the token
Request parameters
Responses
{
"id": 2,
"token": "134daflhsd23",
"current_association": "equipment:1"
}
Get a list of all chemical containers external labels
List chemical container external labels
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all chemical containers methods of use
List chemical container methods of use
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Stock",
"description": "Stock material"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all chemical containers purposes
List chemical container purposes
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all chemical containers types
List chemical container types
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Stock",
"description": "Stock material"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all chemical containers
List chemical containers
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"chemical": {
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
},
"location": {
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"is_marked_for_removal": "true",
"marked_for_removal_date": "2023-01-01T09:00Z",
"is_deleted": "true",
"supplier": "Supplier",
"concentration": "1",
"amount": "1",
"amount_unit": "kg",
"order_number": "123456",
"type": {
"id": 1,
"name": "large container"
},
"purpose": {
"id": 1,
"name": "Clean",
"description": "Cleaning chemical"
},
"method_of_use": {
"id": 1,
"name": "Stock",
"description": "Stock material"
},
"amount_of_users": 4,
"amount_of_active_users": 3,
"amount_of_inactive_users": 1,
"date_arrived": "2023-01-01T00:09Z",
"date_expire": "2024-01-01T09:00Z",
"date_opened": "2023-02-01T09:00Z",
"i_am_user": "true",
"i_am_responsible": "false"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all chemicals
List chemicals
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Acetone",
"cas_number": "67-64-1",
"ehs_link": "https://safety.company.com/chemical/acetone",
"cmr": [
"Carcinogenic"
],
"is_standard_product": "true",
"standard_product": 1,
"physical_state": 3,
"main_chemical": {
"id": 1,
"code": "Solvent",
"name": "Solvents"
},
"safety_statements": [
{
"id": 1,
"statement": "Explosive when dry",
"number": "EUH 001"
}
],
"icons": [
{
"id": 1,
"class": "example",
"description": "Wear goggles",
"image": "https://demo.solodb.net/safety/icon.png"
}
]
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all ecn note attachments
List ECN notes attachments
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"ecn": {
"id": 1,
"module_id": 2,
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"ecn": "Pump chamber before use",
"description": "Since there is a problem with the pump chamber, we need to check it before use.",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"attachments": 2
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all ecn notes
List ECN notes
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"module_id": 2,
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"ecn": "Pump chamber before use",
"description": "Since there is a problem with the pump chamber, we need to check it before use.",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"attachments": 2
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all Equipment Module External Activity Types
List Equipment Module External Activity Types
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"type": "MEASUREMENT_START",
"description": "example",
"is_active": true
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all issue note attachments
List ISSUE notes attachments
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"issue": {
"id": 1,
"module_id": 2,
"issue": "Water leak",
"description": "There is a water lead in one of the drains",
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"issue_type": "1",
"status": "1",
"forecast_up": "2024-01-01T09:00Z",
"actions": "Check the drain and fix the leak",
"attachments": 2
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all issue notes
List ISSUE notes
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"module_id": 2,
"issue": "Water leak",
"description": "There is a water lead in one of the drains",
"date_created": "2023-01-01T09:00:00+00:00",
"date_closed": "example",
"last_update": "2023-01-01T09:00:00+00:00",
"owner": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"updated_by": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"issue_type": "1",
"status": "1",
"forecast_up": "2024-01-01T09:00Z",
"actions": "Check the drain and fix the leak",
"attachments": 2
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Generate a list of all parameters per equipment module
Generate a list of all parameters per equipment module
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
},
"version": 1,
"sequence": 1,
"fix_range": 0,
"min_value": 0,
"max_value": 100,
"show_in_name": "true",
"required": "true",
"header": "Header",
"locked": "true",
"visibility": 1
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all equipments
List equipment modules
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all monitored processes
Fetch a list of all monitored processes
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Litho monitoring",
"description": "Monitoring of litho process",
"date_created": "2021-01-01T00:00:00+00:00",
"last_update": "example",
"type": "Ac hoc",
"amount_of_steps": 12
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all reservations
List reservations
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"resourceId": "2",
"start": "2023-01-01T09:00Z",
"end": "2023-01-01T12:00Z",
"title": "true",
"color": "false",
"is_technical_reservation": "false",
"is_preventive_maintenance": "false"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all Equipment module Statuses
List Equipment module statuses
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all equipment
List equipment
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of jobs
List of jobs
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"lot_id": "231201",
"lots": "Pline1232, Pline1233",
"description": "Measuring 25 samples of the job",
"date_submitted": "2024-01-01T12:00Z",
"expected_duration": 100,
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"equipment": [
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
}
]
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all location messages
List location messages
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all Messages Types
List Message types
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"type": "Personnel",
"date_created": "2021-01-01T00:00Z",
"date_updated": "2021-01-01T00:00Z"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all locations
List locations
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all step parameter values for a given result
List of all step parameter values generated for each result, mostly filtered by the requirement
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all results for a given measurement
List of all results generated for each monitor, mostly filtered by the requirement
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"date_create": null,
"values": [
{
"float_value": 1,
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": ...,
"abbr": ...,
"name": ...
},
"unit": {
"id": ...,
"abbr": ...,
"name": ...
}
},
"condition": "value > 0",
"value_is_valid": "true"
}
]
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all requirements for a given monitor
List of all targets generated for each monitor, mostly filtered by the requirement
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"min_value": 0.04,
"max_value": 0.45,
"target": 0.3,
"is_value_inclusive": "true",
"unit": "um",
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
}
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all requirements for a given module, including status
List monitor requirements, list of all requirements for a given module, including status
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"title": "IX124 thickness",
"definition": "Average thickness of IX124",
"method": "Spin according to recipe and measure thickness on three places",
"sequence": 1,
"step": {
"id": 1,
"process_module_id": 1,
"equipment_module_id": 1,
"process_id": 1
},
"targets": [
{
"id": 1,
"min_value": 0.04,
"max_value": 0.45,
"target": 0.3,
"is_value_inclusive": "true",
"unit": "um",
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": ...,
"abbr": ...,
"name": ...
},
"unit": {
"id": ...,
"abbr": ...,
"name": ...
}
}
}
],
"latest_result": {
"id": 1,
"date_create": null,
"values": [
{
"float_value": 1,
"logging_parameter": {
"id": 1,
"name": "Temperature",
"parameter": {
"id": ...,
"abbr": ...,
"name": ...
},
"unit": {
"id": ...,
"abbr": ...,
"name": ...
}
},
"condition": "value > 0",
"value_is_valid": "true"
}
]
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all files uploaded to a monitor step
List files uploaded to a monitor step
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "file.png",
"is_image": "true",
"url": "https://demo.solodb.net/file/display/1/file.png",
"extension": "png",
"date_created": "2021-09-01T12:00Z",
"size": 125493,
"has_run_step_loggings": "true",
"has_monitor_step_loggings": "false"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Generate a list of all parameters per monitor step
Generate a list of all parameters per monitor step
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"label": "Step label",
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
},
"version": 1,
"sequence": 1,
"fix_range": 0,
"min_value": 0,
"max_value": 100,
"show_in_name": "true",
"required": "true",
"header": "Header",
"locked": "true",
"visibility": 1
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all recipes
List of recipes
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": ...,
"date_created": ...,
"filename": ...,
"mime_type": ...,
"file_size": ...,
"url": ...,
"status_id": ...
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of queue elements (segments)
List job queue elements (segments)
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"job": {
"id": 1,
"lot_id": "231201",
"lots": "Pline1232, Pline1233",
"description": "Measuring 25 samples of the job",
"date_submitted": "2024-01-01T12:00Z",
"expected_duration": 100,
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"equipment": [
{
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
}
]
},
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"date_start": "2024-01-01T09:00Z",
"date_started": "1971-04-26T12:26:06Z",
"date_end": "2024-01-10T09:00Z",
"date_locked": "2023-12-25T09:00Z",
"duration": 100,
"active_duration": 50,
"identifier": "231201_1"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all zone groups
List zone groups
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all zones in rooms
List zones in rooms
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Zone 1",
"description": "Zone 1 description",
"status": "Active",
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
},
"amount": {
"equipment": 1
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all rooms
List rooms
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all changes done in a a run
List change log of a run
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"date_created": "2023-01-01T09:00Z",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"message": "Added a new run",
"type": "Added",
"source": "researcher",
"steps": [
1
],
"run_step_checklist": {
"id": 1,
"task": "Check the temperature",
"description": "Check the temperature of the product",
"is_executed": "true",
"date_executed": "2023-01-01T09:00Z"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all hold codes of a run
List all possible hold codes for a run
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"code": "HOLD",
"front_color": "#ffffff",
"back_color": "#000000",
"description": "Hold",
"is_hold": "true"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all parts of a run
List parts of a run
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"short_label": "A",
"label": "Part A"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all checklist of a run step
List checklist of a run step
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"task": "Check the temperature",
"description": "Check the temperature of the product",
"is_executed": "true",
"date_executed": "2023-01-01T09:00Z"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all files uploaded to a run step
List files uploaded to a run step
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "file.png",
"is_image": "true",
"url": "https://demo.solodb.net/file/display/1/file.png",
"extension": "png",
"date_created": "2021-09-01T12:00Z",
"size": 125493,
"has_run_step_loggings": "true",
"has_monitor_step_loggings": "false"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all parameters of a run step
List parameters of a run step
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"sequence": 1,
"visibility": 1,
"show_in_name": 1,
"emphasize": "false",
"required": "false",
"is_header": "false",
"locked": "false",
"parameter": {
"id": 1,
"abbr": "T",
"name": "Temperature"
},
"has_unit": "true",
"unit": {
"id": 1,
"abbr": "Hz",
"name": "Hertz"
},
"values": [
{
"id": 1,
"value": 1.2,
"realised": {
"id": 1,
"value": 1.3
}
}
]
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all actions on a run step part
List actions on a run step part
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"date_created": "2024-01-01T00:00:00+00:00",
"comment": "example"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all parts of a run step
List parts of run steps
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": ...,
"status": ...,
"front_color": ...,
"back_color": ...,
"sequence": ...
},
"description": "Down for maintenance",
"user": {
"id": ...,
"first_name": ...,
"last_name": ...,
"initials": ...,
"full_name": ...,
"email": ...
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
...
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": ...,
"process": ...,
"module": ...,
"in_use": ...,
"is_assembly_process": ...,
"has_local_parameters": ...
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"part": {
"id": 1,
"short_label": "A",
"label": "Part A"
},
"date_started": "2024-01-01T00:00:00+00:00",
"part_processing_failed_in_previous_step": true,
"comment": "example",
"actions": 0,
"latest_action": {
"id": 1,
"date_created": "2024-01-01T00:00:00+00:00",
"comment": "example"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all steps of a run
List of run steps
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": ...,
"date_created": ...,
"filename": ...,
"mime_type": ...,
"file_size": ...,
"url": ...,
"status_id": ...
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": ...,
"name": ...,
"number": ...,
"category": ...,
"is_active": ...,
"is_private": ...
},
"module": {
"id": ...,
"name": ...,
"mes_name": ...,
"active": ...,
"equipment": ...,
"type": ...,
"properties": ...,
"latest_status": ...
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all runs
List runs
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"label": "Run A",
"name": "Run A",
"amount_of_steps": 1,
"responsible": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"run_type": 1,
"status": "Active",
"first_unfinished_step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": ...,
"name": ...,
"number": ...,
"types": ...,
"amount_of_processes": ...
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": ...,
"name": ...,
"number": ...,
"mes_name": ...,
"active": ...,
"active_in_mes": ...,
"reservation_possible": ...,
"main_tool_module_id": ...,
"main_tool_latest_status_id": ...,
"room": ...,
"area": ...,
"facility": ...,
"vendor": ...
},
"type": {
"id": ...,
"name": ...,
"is_main_tool": ...
},
"properties": {
"id": ...,
"property": ...,
"label": ...,
"value": ...
},
"latest_status": {
"id": ...,
"status": ...,
"description": ...,
"user": ...,
"date_created": ...,
"attachments": ...
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": ...,
"name": ...,
"process_module": ...
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": ...,
"first_name": ...,
"last_name": ...,
"initials": ...,
"full_name": ...,
"email": ...
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"last_finished_step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": ...,
"name": ...,
"number": ...,
"types": ...,
"amount_of_processes": ...
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": ...,
"name": ...,
"number": ...,
"mes_name": ...,
"active": ...,
"active_in_mes": ...,
"reservation_possible": ...,
"main_tool_module_id": ...,
"main_tool_latest_status_id": ...,
"room": ...,
"area": ...,
"facility": ...,
"vendor": ...
},
"type": {
"id": ...,
"name": ...,
"is_main_tool": ...
},
"properties": {
"id": ...,
"property": ...,
"label": ...,
"value": ...
},
"latest_status": {
"id": ...,
"status": ...,
"description": ...,
"user": ...,
"date_created": ...,
"attachments": ...
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": ...,
"name": ...,
"process_module": ...
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": ...,
"first_name": ...,
"last_name": ...,
"initials": ...,
"full_name": ...,
"email": ...
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"has_batch_card": "true",
"batch_card": {
"id": 1,
"content": "This is a batch card",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2024-01-01T00:00Z",
"last_update": "2024-01-01T00:00Z"
},
"hold_code": {
"id": 1,
"hold_code": {
"id": 1,
"code": "HOLD",
"front_color": "#ffffff",
"back_color": "#000000",
"description": "Hold",
"is_hold": "true"
},
"description": "This is a description",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "1971-04-26T12:26:06Z"
},
"priority": {
"id": 1,
"priority": {
"id": 1,
"code": "H",
"front_color": "#ffffff",
"back_color": "#000000",
"description": "High"
},
"description": "This is a description",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "1971-04-26T12:26:06Z"
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"last_update": "1971-04-26T12:26:06Z",
"access": {
"edit": "true"
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all steps of a template
List of template steps
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"has_requirement": "false",
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": ...,
"date_created": ...,
"filename": ...,
"mime_type": ...,
"file_size": ...,
"url": ...,
"status_id": ...
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": ...,
"name": ...,
"number": ...,
"category": ...,
"is_active": ...,
"is_private": ...
},
"module": {
"id": ...,
"name": ...,
"mes_name": ...,
"active": ...,
"equipment": ...,
"type": ...,
"properties": ...,
"latest_status": ...
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
}
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all templates
List templates
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"name": "Default RCA Clean",
"label": "Template 99",
"description": "Executing a default RCA clean",
"date_created": "2021-01-01T00:00:00+00:00",
"last_update": "example",
"amount_of_steps": 12
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get a list of all users
List users
Request parameters
Responses
{
"_embedded": {
"items": [
{
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
]
},
"page_count": 2,
"page_size": 25,
"total_items": 40,
"page": 2
}
Get details from a recipe version
Recipe version information
Request parameters
Responses
{
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
}
Get details from a recipe
Recipe information
Request parameters
Responses
{
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
Get details from a location
Location information
Request parameters
Responses
{
"id": 1,
"code": "F1",
"name": "Fridge 1",
"amount": {
"containers": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
}
Get details from a room
Room information
Request parameters
Responses
{
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
}
Get details from a zone
Zone information
Request parameters
Responses
{
"id": 1,
"name": "Zone 1",
"description": "Zone 1 description",
"status": "Active",
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"amount": {
"zones": ...,
"locations": ...
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"amount": {
"zones": 1,
"locations": 1
}
},
"amount": {
"equipment": 1
}
}
Get details from a run
Run information
Request parameters
Responses
{
"id": 1,
"label": "Run A",
"name": "Run A",
"amount_of_steps": 1,
"responsible": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"run_type": 1,
"status": "Active",
"first_unfinished_step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": ...,
"name": ...,
"number": ...,
"types": ...,
"amount_of_processes": ...
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": ...,
"name": ...,
"number": ...,
"mes_name": ...,
"active": ...,
"active_in_mes": ...,
"reservation_possible": ...,
"main_tool_module_id": ...,
"main_tool_latest_status_id": ...,
"room": ...,
"area": ...,
"facility": ...,
"vendor": ...
},
"type": {
"id": ...,
"name": ...,
"is_main_tool": ...
},
"properties": {
"id": ...,
"property": ...,
"label": ...,
"value": ...
},
"latest_status": {
"id": ...,
"status": ...,
"description": ...,
"user": ...,
"date_created": ...,
"attachments": ...
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"last_finished_step": {
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": ...,
"name": ...,
"number": ...,
"types": ...,
"amount_of_processes": ...
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": ...,
"name": ...,
"number": ...,
"mes_name": ...,
"active": ...,
"active_in_mes": ...,
"reservation_possible": ...,
"main_tool_module_id": ...,
"main_tool_latest_status_id": ...,
"room": ...,
"area": ...,
"facility": ...,
"vendor": ...
},
"type": {
"id": ...,
"name": ...,
"is_main_tool": ...
},
"properties": {
"id": ...,
"property": ...,
"label": ...,
"value": ...
},
"latest_status": {
"id": ...,
"status": ...,
"description": ...,
"user": ...,
"date_created": ...,
"attachments": ...
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
},
"has_batch_card": "true",
"batch_card": {
"id": 1,
"content": "This is a batch card",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2024-01-01T00:00Z",
"last_update": "2024-01-01T00:00Z"
},
"hold_code": {
"id": 1,
"hold_code": {
"id": 1,
"code": "HOLD",
"front_color": "#ffffff",
"back_color": "#000000",
"description": "Hold",
"is_hold": "true"
},
"description": "This is a description",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "1971-04-26T12:26:06Z"
},
"priority": {
"id": 1,
"priority": {
"id": 1,
"code": "H",
"front_color": "#ffffff",
"back_color": "#000000",
"description": "High"
},
"description": "This is a description",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "1971-04-26T12:26:06Z"
},
"project": {
"id": 1,
"name": "Project Name",
"description": "This is the project description",
"status": "Active",
"private": "No",
"is_private": "false"
},
"last_update": "1971-04-26T12:26:06Z",
"access": {
"edit": "true"
}
}
Get details from a step
Step information
Request parameters
Responses
{
"id": 1,
"name": "Al deposition",
"sequence": 1,
"number": 1101,
"is_skipped": "true",
"is_rework": "true",
"has_step_group": "true",
"step_group": {
"id": 1,
"label": "Pre-conditioning"
},
"next_step_id": 58,
"has_label": "true",
"is_own_label": "true",
"label": {
"id": 1,
"label": "Cleaning"
},
"is_private": "false",
"has_service_work": "false",
"has_requirement": "false",
"is_finished": "false",
"finish_date": "2021-01-01T00:00Z",
"finish_user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"tags": [
"tag1"
],
"amount_of_files": 3,
"has_instructions": "true",
"instructions": "Check temperature",
"has_remark": "true",
"remark": "Check temperature",
"remark_unparsed": "* Check temperature",
"has_parts": "true",
"sub_steps": 2,
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": 1
},
"zone_group": {
"id": 1,
"name": "Group 1",
"description": "Group 1 description",
"capacity": 1,
"room": {
"id": 1,
"name": "Litho room",
"code": "1.12-Litho",
"phone": "5744",
"description": "All litho equipment is located in this room",
"amount": {
"zone_groups": ...
},
"zone_group": {
"id": ...,
"name": ...,
"description": ...,
"capacity": ...,
"room": ...,
"amount": ...
}
},
"amount": {
"zones": 1,
"locations": 1
}
}
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": 1,
"name": "Vendor Name",
"date_created": "2023-10-01T12:00Z",
"last_update": "2023-10-01T12:00Z"
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": 1,
"date_created": "2023-01-01T09:00:00+00:00",
"filename": "file.txt",
"mime_type": "text/plain",
"file_size": 1024,
"url": "https://example.com/file.txt",
"status_id": 1
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
},
"has_recipe": "true",
"recipe_version": {
"id": 1,
"version": 3,
"notes": "Released with the latest changes",
"recipe": {
"id": 1,
"name": "Recipe 1",
"process_module": {
"id": 1,
"process": {
"id": 1,
"name": "Al deposition",
"number": 1200,
"category": {
"id": 1,
"name": "Metal deposition",
"number": 1000,
"types": [
"true"
],
"amount_of_processes": 4
},
"is_active": "true",
"is_private": "false"
},
"module": {
"id": 1,
"name": "Module 1",
"mes_name": "Module 1",
"active": "true",
"equipment": {
"id": 1,
"name": "Alcatel",
"number": "EQ001",
"mes_name": "ALCATEL",
"active": "true",
"active_in_mes": "true",
"reservation_possible": "false",
"main_tool_module_id": 58,
"main_tool_latest_status_id": 58,
"room": {
"id": ...,
"name": ...,
"code": ...,
"phone": ...,
"description": ...,
"amount": ...,
"zone_group": ...
},
"area": "Area 1",
"facility": "Facility 1",
"vendor": {
"id": ...,
"name": ...,
"date_created": ...,
"last_update": ...
}
},
"type": {
"id": 1,
"name": "Load Lock",
"is_main_tool": "true"
},
"properties": {
"id": 1,
"property": "pchostname",
"label": "PC Hostname",
"value": "PC123456"
},
"latest_status": {
"id": 1,
"status": {
"id": 1,
"status": "IDLE_ERROR",
"front_color": "#000",
"back_color": "#efefef",
"sequence": 1
},
"description": "Down for maintenance",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
},
"date_created": "2023-01-01T09:00:00+00:00",
"attachments": [
{
"id": ...,
"date_created": ...,
"filename": ...,
"mime_type": ...,
"file_size": ...,
"url": ...,
"status_id": ...
}
]
}
},
"in_use": "true",
"is_assembly_process": "false",
"has_local_parameters": "false"
}
}
},
"has_rework": "true",
"rework": {
"id": 1,
"comment": "Rework required because of a residue on the wafer",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
},
"run_id": 2,
"parts": {
"amount_total": 4,
"amount_processed_step": 1,
"amount_failed_step": 1
}
}
This api call updates the goldstein client
Update goldstein client
Request parameters
{
"association_item": "example",
"association_id": 58
}
Responses
{
"id": 2,
"token": "134daflhsd23",
"current_association": "equipment:1"
}
This api call returns the goldstein client based on the current association
Give client based on the association token
Request parameters
Responses
{
"id": 2,
"token": "134daflhsd23",
"current_association": "equipment:1"
}
Update the location of a chemical container
Request parameters
Responses
Action triggered when a user sets the chemical as non-standard
Set a chemical as non-standard
Request parameters
Responses
Action triggered when a user sets the chemical as standard
Set a chemical as standard
Request parameters
Responses
Action triggered when a user updates an ECN note
Update ECN note
Request parameters
{
"holdcode": 1,
"description": "HOLD"
}
Responses
Action triggered when a user updates an ISSUE note
Update ISSUE note
Request parameters
{
"holdcode": 1,
"description": "HOLD"
}
Responses
Action triggered when a user uploads a file to a requirement of a monitor
Upload a file to a requirement (to extract the results)
Request parameters
Responses
Update a new message in a location
API to update a new message in a location
Request parameters
{}
Responses
Update the value of a monitor requirement result step parameter
Update the value of a monitor requirement result step parameter
Request parameters
{
"value": 1
}
Responses
Action triggered when a user a batch card for a run
Set a batch card for a run
Request parameters
{
"content": "This is a batch card"
}
Responses
Action triggered when a user sets a hold-code for a run
Set a hold code for a run
Request parameters
{
"holdcode": 1,
"description": "HOLD"
}
Responses
Action triggered when an operator marks a checklist item as done
Mark a checklist item as done
Request parameters
Responses
Action triggered when a run step is finished
Finish a run step
Request parameters
Responses
Action triggered when a step part action is being updated
Update data for a run step part action
Request parameters
{
"type": 1,
"comment": "Processing failed"
}
Responses
Action triggered when a step part is being updated
Update data for a run step part
Request parameters
{
"comment": "This part is broken"
}
Responses
Create a rework by adding extra steps from a template and by indicating the to be repeated steps
Create a rework operation for a run step
Request parameters
{
"reworked_run_steps": [
2
],
"template_steps": [
1
],
"comment": "example"
}
Responses
Action triggered when a run step is marked as skipped
Skip a run step
Request parameters
Responses
Action triggered when a run step is marked as un skipped
Un skip a run step
Request parameters
Responses
Action triggered when a user uploads a file to a step
Upload a file to a step
Request parameters
Responses
This api call returns the open actions for a user
Give the open for a user
Request parameters
Responses
{
"user_principal_name": "vdheide@solodb.net",
"actions": [
{
"id": 1,
"title": "Approve the reservation",
"description": "User John has made a reservation, could you please approve this reservation",
"date_created": "2021-01-01T00:00:00+00:00",
"link": "https://demo.solodb.net/user/action/view/1.html"
}
]
}
Fetch badge card details by badge UUID.
Retrieves the user badge card details using a badge UUID.
Request parameters
Responses
{
"id": 2,
"badgeUUID": "134daflhsd23",
"user": {
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
}
Get details from the current user
User information
Responses
{
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
Get details for the user by id
Get user
Responses
{
"id": 1,
"first_name": "John",
"last_name": "Doe",
"initials": "JD",
"full_name": "John Doe",
"email": "john.doe@example.com"
}
07 April 2025