{"swagger":"2.0","info":{"title":"IoTFlows API","version":"1.3.13"},"basePath":"https://api.iotflows.com","paths":{"/v1/organizations":{"get":{"summary":"Get organizations","description":"Get the list of the organization and user's organization role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_uuid":{"type":"string","name":"organization_uuid","propertyRow":true},"organization_name":{"type":"string","name":"organization_name","propertyRow":true},"organization_description":{"type":"string","name":"organization_description","propertyRow":true},"organization_is_personal":{"type":"boolean","name":"organization_is_personal","propertyRow":true},"organization_is_private":{"type":"boolean","name":"organization_is_private","propertyRow":true},"organization_member_role_name":{"type":"string","name":"organization_member_role_name","propertyRow":true},"organization_member_role_description":{"type":"string","name":"organization_member_role_description","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create organization","description":"Creates an organization with \"Organization Owner\" role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_name":{"type":"string"},"organization_description":{"type":"string"},"organization_is_private":{"type":"boolean"},"payment_method":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/projects":{"get":{"summary":"Get projects","description":"Returns the projects of the organization that the user is part of","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"},"project_is_private":{"type":"boolean"},"project_member_role_name":{"type":"string"},"project_member_role_description":{"type":"string"}}}}}},"post":{"summary":"Create project","description":"Creates a project with \"Project Administrator\" role","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"project_name":{"type":"string"},"project_description":{"type":"string"},"project_is_private":{"type":"boolean"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/members":{"get":{"summary":"Get organization members","description":"Retrieves the members of the organization with their organization role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string","name":"user_email","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_phone_number":{"type":"string","name":"user_phone_number","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true},"user_username":{"type":"string","name":"user_username","propertyRow":true},"organization_member_role_id":{"type":"number","name":"organization_member_role_id","propertyRow":true},"organization_member_role_name":{"type":"string","name":"organization_member_role_name","propertyRow":true},"organization_member_role_description":{"type":"string","name":"organization_member_role_description","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Add organization member","description":"Adds a user to an organization with a given role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"member_username":{"type":"string","name":"member_username","propertyRow":true},"role_name":{"type":"string","name":"role_name","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"Organization member change role","description":"Changes the role of an organization member","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"member_username":{"type":"string"},"role_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Organization member remove","description":"Deletes a user from an organization","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"member_username":{"type":"string","name":"member_username","propertyRow":true},"delete_mode":{"type":"string","format":"\"delete_safe\" or \"delete_member_only\" or \"delete_all_resources\"","name":"delete_mode","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"},"202":{"description":"This user is the only administrator of at least one project or alert channel. This is shown for delete_safe mode only.","code":"202"}}}},"/v1/organizations/{organization_uuid}/alert-channels":{"get":{"summary":"Get alert channels","description":"Retrieves all of the alert channels of the organization","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"alert_channel_id":{"type":"number","name":"alert_channel_id","propertyRow":true},"alert_channel_name":{"type":"string","name":"alert_channel_name","propertyRow":true},"alert_channel_description":{"type":"string","name":"alert_channel_description","propertyRow":true},"alert_channel_uuid":{"type":"string","name":"alert_channel_uuid","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create alert channel","description":"Creates an alert channel with administrator role","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"alert_channel_name":{"type":"string"},"alert_channel_description":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}":{"put":{"summary":"Change organization","description":"Changes the name, description, or public/private mode of an organization","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_name":{"type":"string","name":"organization_name","propertyRow":true},"organization_description":{"type":"string","name":"organization_description","propertyRow":true},"organization_is_private":{"type":"boolean","name":"organization_is_private","propertyRow":true}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"delete":{"summary":"Delete an organization","description":"Deletes an organization with all of its dependent components e.g. projects, devices, clients, alert channels, and more","tags":["Organizations"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get organization","description":"Get the info of an organization","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_uuid":{"type":"string"},"organization_name":{"type":"string"},"organization_description":{"type":"string"},"organization_is_personal":{"type":"boolean"},"organization_is_private":{"type":"boolean"},"organization_member_role_name":{"type":"string"},"organization_member_role_description":{"type":"string"},"organization_auto_dt_short_downtime_category_id":{"type":"integer"},"organization_auto_dt_short_downtime_category_name":{"type":"string"},"organization_auto_dt_short_downtime_enabled":{"type":"boolean"},"organization_auto_dt_start_of_shift_category_id":{"type":"integer"},"organization_auto_dt_start_of_shift_category_name":{"type":"string"},"organization_auto_dt_start_of_shift_enabled":{"type":"boolean"},"organization_auto_dt_end_of_shift_category_id":{"type":"integer"},"organization_auto_dt_end_of_shift_category_name":{"type":"string"},"organization_auto_dt_end_of_shift_enabled":{"type":"boolean"},"down_light_color":{"type":"string","format":"{tailwind_id: 27 tailwind_hex: \"#dc2626\" down_color_id: 1 tailwind_intensity: 600 tailwind_color_name: \"Red\" tailwind_color_name_id: 3 tailwind_tailwind_color_id: 3 down_color_dark_tailwind_id: 27 down_color_light_tailwind_id: 27}"},"down_dark_color":{"type":"string","format":"{tailwind_id: 27 tailwind_hex: \"#dc2626\" down_color_id: 1 tailwind_intensity: 600 tailwind_color_name: \"Red\" tailwind_color_name_id: 3 tailwind_tailwind_color_id: 3 down_color_dark_tailwind_id: 27 down_color_light_tailwind_id: 27}"}}}}}}},"/v1/users/profile/picture":{"post":{"summary":"Change user profile picture","description":"Replaces the user's profile picture with the new picture","tags":["Users"],"consumes":["image/jpeg"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","description":"image/jpeg file","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/projects/{project_uuid}":{"put":{"summary":"Update project","description":"Updates a project's name, description, and public/private mode. Requires permission.","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"project_name":{"type":"string","name":"project_name","propertyRow":true},"project_description":{"type":"string","name":"project_description","propertyRow":true},"project_is_private":{"type":"boolean","name":"project_is_private","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"delete":{"summary":"Delete project","description":"Deletes a project with all of its dependent components e.g. devices, clients, alert channels, and more","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/projects/{project_uuid}/members":{"get":{"summary":"Get project members","description":"Returns the members of a given project","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_phone_number":{"type":"boolean"},"user_image_url":{"type":"string"},"user_username":{"type":"string"},"project_member_role_id":{"type":"number"},"project_member_role_name":{"type":"string"},"project_member_role_description":{"type":"string"}}}}}},"post":{"summary":"Project member add","description":"Adds a user to a project with a given role","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string"},"role_name":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Project member change role","description":"Changes the project role of a user","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string"},"role_name":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Project member delete","description":"Deletes a user from a project","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string","name":"member_username","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/users":{"put":{"summary":"Change user information","description":"Changes the first name, last name, and username of the user","tags":["Users"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get users","description":"Retreives the users information such as first name, last name, email, phone, more","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string","name":"user_email","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_phone_number":{"type":"string","name":"user_phone_number","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true},"user_username":{"type":"string","name":"user_username","propertyRow":true},"user_is_mfa_enabled":{"type":"boolean","name":"user_is_mfa_enabled","propertyRow":true}}},"code":"200"}}}},"/v1/users/search/containing/{containing}":{"get":{"summary":"Search users","description":"Retrieves a list of users that their name or username contain a given string","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"containing","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_username":{"type":"string","name":"user_username","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/roles":{"get":{"summary":"Get organization roles","description":"Get the list of the organization roles with their id, name, and description","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"properties":{"role_id":{"type":"string"},"role_name":{"type":"string"},"role_description":{"type":"string"}}}}}}},"/v1/projects/roles":{"get":{"summary":"Project member roles","description":"Returns the id, name, and description of project roles ","tags":["Projects"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"role_id":{"type":"string"},"role_name":{"type":"string"},"role_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/devices":{"get":{"summary":"Get organization devices","description":"Returns the devices of all of the projects within an organization","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"device_last_heard":{"type":"boolean"},"device_is_private":{"type":"boolean"},"device_created_at":{"type":"string"},"device_type":{"type":"string"},"device_system_information":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/members/search/containing/{containing}":{"get":{"summary":"Search organization members","description":"Retrieves a list of users of an organization that their name or username contain a given string","tags":["Users","Organizations"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"containing","in":"path","required":true,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_username":{"type":"string","name":"user_username","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true}}},"code":"200"}}}},"/v1/devices/types":{"get":{"summary":"Get device types","description":"Returns the device types","tags":["Devices"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_type_id":{"type":"number"},"device_type_name":{"type":"string"},"device_type_description":{"type":"string"},"device_type_version":{"type":"string"}}}}}}},"/v1/projects/{project_uuid}/devices":{"post":{"summary":"Add project device","description":"Adds a device to a project","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"device_name":{"type":"string","name":"device_name","propertyRow":true},"device_description":{"type":"string","name":"device_description","propertyRow":true},"device_is_private":{"type":"boolean","name":"device_is_private","propertyRow":true},"device_subscription_identifier":{"type":"string","format":"dev-basic or dev-standard or dev-pro","name":"device_subscription_identifier","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"config":{"type":"string","format":"\"initial_setup\": object ","name":"config","propertyRow":true}}},"code":"200"}}},"get":{"summary":"Get project devices","description":"Returns the devices of a project","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"device_last_heard":{"type":"boolean"},"device_is_private":{"type":"boolean"},"device_created_at":{"type":"string"},"device_type":{"type":"string"},"device_system_information":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}":{"put":{"summary":"Change device","description":"Changes the device information","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"device_name":{"type":"string"},"device_description":{"type":"string"},"device_is_private":{"type":"boolean"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete a device","description":"Deletes device","tags":["Devices"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/types/names":{"get":{"summary":"Get device types","description":"Returns the device types","tags":["Devices"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_type_id":{"type":"number"},"device_type_name":{"type":"string"},"device_type_description":{"type":"string"},"device_type_version":{"type":"string"}}}}}}},"/v1/alert-channels/{alert_channel_uuid}":{"put":{"summary":"Update alert channel","description":"Updates an alert channel's name and description","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"alert_channel_name":{"type":"string"},"alert_channel_description":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete alert channel","description":"Deletes an alert channel","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/alert-channels/{alert_channel_uuid}/members":{"get":{"summary":"Get alert channel members","description":"Returns the members of a given alert channel","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_phone_number":{"type":"boolean"},"user_image_url":{"type":"string"},"user_username":{"type":"string"},"alert_channel_member_role_id":{"type":"number"},"alert_channel_member_role_name":{"type":"string"},"alert_channel_member_role_description":{"type":"string"}}}}}},"post":{"summary":"Alert channel member add","description":"Adds a user to an alert channel with a given role","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string"},"role_name":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Alert channel member change role","description":"Changes the alert channel role of a user","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string"},"role_name":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Alert channel member delete","description":"Deletes a user from an alert channel","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"member_username":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/alert-channels/roles":{"get":{"summary":"Alert channel member roles","description":"Returns the id, name, and description of alert channel roles ","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"role_id":{"type":"string"},"role_name":{"type":"string"},"role_description":{"type":"string"}}}}}}},"/v1/alert-channels/{alert_channel_uuid}/members/notifications":{"put":{"summary":"Alert channel notification setting ","description":"Changes the alert channel notification settings for a member","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"notification_push_informative":{"type":"boolean","name":"notification_push_informative","propertyRow":true},"notification_push_minor":{"type":"boolean","name":"notification_push_minor","propertyRow":true},"notification_push_major":{"type":"boolean","name":"notification_push_major","propertyRow":true},"notification_sms_informative":{"type":"boolean","name":"notification_sms_informative","propertyRow":true},"notification_sms_minor":{"type":"boolean","name":"notification_sms_minor","propertyRow":true},"notification_sms_major":{"type":"boolean","name":"notification_sms_major","propertyRow":true},"notification_email_informative":{"type":"boolean","name":"notification_email_informative","propertyRow":true},"notification_email_minor":{"type":"boolean","name":"notification_email_minor","propertyRow":true},"notification_email_major":{"type":"boolean","name":"notification_email_major","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get alert channel notification setting","description":"Retrieves the alert channel notification settings of the user","tags":["Alert channels"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"notification_push_informative":{"type":"boolean"},"notification_push_minor":{"type":"boolean"},"notification_push_major":{"type":"boolean"},"notification_sms_informative":{"type":"boolean"},"notification_sms_minor":{"type":"boolean"},"notification_sms_major":{"type":"boolean"},"notification_email_informative":{"type":"boolean"},"notification_email_minor":{"type":"boolean"},"notification_email_major":{"type":"boolean"}}}}}}},"/v1/devices/{device_uuid}/clients":{"post":{"summary":"Add device client","description":"Creates a new client for a device","tags":["Devices","Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"client_name":{"type":"string","name":"client_name","propertyRow":true},"client_description":{"type":"string","name":"client_description","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_id":{"type":"string","name":"client_id","propertyRow":true},"password":{"type":"string","name":"password","propertyRow":true}}},"code":"200"}}},"get":{"summary":"Get device clients","description":"Returns the clients of a device","tags":["Devices","Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_id":{"type":"string"},"username":{"type":"string"},"client_name":{"type":"string"},"client_description":{"type":"string"}}}}}}},"/v1/clients/{client_id}":{"put":{"summary":"Change client","description":"Changes the name and description of a client (of a device)","tags":["Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"client_name":{"type":"string","name":"client_name","propertyRow":true},"client_description":{"type":"string","name":"client_description","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"password":{"type":"string","name":"password","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete client","description":"Deletes a client of a device","tags":["Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"password":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/connections":{"post":{"summary":"Create device connection","description":"Creates a new connection/session for a device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"connection_type":{"type":"string","format":"SSH, HTTP, or NODERED"},"from_port":{"type":"number"},"from_ip":{"type":"string","format":"127.0.0.1 or any local ip addresses over http"},"slug":{"type":"string","format":"\"nodered\" Only for HTTP connections"},"device_connection_subscription_type":{"type":"string","format":"FREE, MONTHLY, or YEARLY"},"connection_name":{"type":"string","format":"optional"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"connection_type":{"type":"string"},"server_url":{"type":"string"},"to_path":{"type":"string"},"message":{"type":"string"}}}}}},"delete":{"summary":"Disconnect device connection","description":"Disconnects a connection/session for a device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"from_port":{"type":"number","name":"from_port","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get device connections","description":"Gets connection/sessions of a device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_connection_slug":{"type":"string"},"device_connection_management_server_url":{"type":"string"},"device_connection_type_name":{"type":"string"}}}}}},"put":{"summary":"Enable/disable remote connection","description":"Enable/disable a remote connection for a device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"from_port":{"type":"number","name":"from_port","propertyRow":true},"enable_connection":{"type":"boolean","name":"enable_connection","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/devices/{device_uuid}/nodered/set_credentials":{"put":{"summary":"Device nodered change credentials","description":"Changes the credentials of the nodered running on the device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"nodered_username":{"type":"string"},"nodered_password":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/clients/iotcore":{"post":{"summary":"Create device iotcore client","description":"Creates a new iotcore client for a device. One iotcore client is allowed per each device.","tags":["Devices","Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"config":{"type":"string","format":"Config json for device setup","name":"config","propertyRow":true}}},"code":"200"}}}},"/v1/device_clients/{client_id}":{"get":{"summary":"Get device clients","description":"Returns the clients of a device","tags":["Devices","Clients"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/data_streams":{"get":{"summary":"Get device data streams","description":"Returns the data streams of a device","tags":["Devices","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data_stream_uuid":{"type":"string"},"data_stream_name":{"type":"string"},"data_stream_description":{"type":"string"},"data_stream_unit":{"type":"string"}}}}}},"post":{"summary":"Add device data stream","description":"Creates a new data stream for a device","tags":["Devices","Data Streams"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"data_stream_name":{"type":"string"},"data_stream_description":{"type":"string"},"data_stream_unit":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/data_streams/{data_stream_uuid}":{"put":{"summary":"Change device data stream","description":"Update data stream name, description, or unit","tags":["Devices","Data Streams"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"data_stream_name":{"type":"string"},"data_stream_description":{"type":"string"},"data_stream_unit":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"data_stream_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete deviec data stream","description":"Deletes a data stream of a device","tags":["Devices","Data Streams"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"data_stream_name":{"type":"string"},"data_stream_description":{"type":"string"},"data_stream_unit":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"data_stream_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/projects/devices/clients":{"get":{"summary":"Get organization clients","description":"Returns all clients of all devices of all projects of an organization","tags":["Organizations","Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_id":{"type":"string"},"username":{"type":"string"},"client_name":{"type":"string"},"client_description":{"type":"string"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/data_streams":{"get":{"summary":"Get organization data streams","description":"Returns data streams of all devices of all projects of an organization","tags":["Organizations","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data_stream_uuid":{"type":"string"},"data_stream_name":{"type":"string"},"data_stream_description":{"type":"string"},"data_stream_unit":{"type":"string"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/device_clients/{client_id}/project_data_streams":{"get":{"summary":"Get data streams of a device client","description":"Returns the data streams of a device client","tags":["Devices","Clients","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/device_clients/{client_id}/device_data_streams":{"get":{"summary":"Get data streams of a device client","description":"Returns the data streams of a device client","tags":["Devices","Clients","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/device_clients/{client_id}/organization_alert_channels":{"get":{"summary":"Get data streams of a device client","description":"Returns the data streams of a device client","tags":["Devices","Clients","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/data_streams/{data_stream_uuid}/historical_data":{"get":{"summary":"Get data of a data stream","description":"Returns the historical 1000 data points of a data stream","tags":["Devices","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"data_stream_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number"},"client_id":{"type":"number"},"data":{"type":"string"},"received_at":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/historical_data":{"get":{"summary":"Get data of a device","description":"Returns the last 100 historical data points of all data streams of a device","tags":["Devices","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number","name":"id","propertyRow":true},"client_id":{"type":"number","name":"client_id","propertyRow":true},"data":{"type":"string","name":"data","propertyRow":true},"received_at":{"type":"string","name":"received_at","propertyRow":true},"data_stream_uuid":{"type":"string","name":"data_stream_uuid","propertyRow":true}}},"code":"200"}}}},"/v1/projects/{project_uuid}/historical_data":{"get":{"summary":"Get data of a project","description":"Returns the last 100 historical data points of all data streams of all devices of a project","tags":["Projects","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number"},"client_id":{"type":"number"},"data":{"type":"string"},"received_at":{"type":"string"},"data_stream_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/historical_data":{"get":{"summary":"Get data of an organization","description":"Returns the last 100 historical data points of all data streams of all devices of all projects of an organization","tags":["Organizations","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number","name":"id","propertyRow":true},"client_id":{"type":"number","name":"client_id","propertyRow":true},"data":{"type":"string","name":"data","propertyRow":true},"received_at":{"type":"string","name":"received_at","propertyRow":true},"data_stream_uuid":{"type":"string","name":"data_stream_uuid","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/actions":{"get":{"summary":"Get device actions","description":"Returns the actions of a device","tags":["Devices","Actions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"action_uuid":{"type":"string"},"action_name":{"type":"string"},"action_description":{"type":"string"}}}}}},"post":{"summary":"Add device action","description":"Creates a new action for a device","tags":["Devices","Actions"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"action_name":{"type":"string","name":"action_name","propertyRow":true},"action_description":{"type":"string","name":"action_description","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/devices/{device_uuid}/actions/{action_uuid}":{"put":{"summary":"Change device action","description":"Update action name or description","tags":["Devices","Actions"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"action_name":{"type":"string"},"action_description":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"action_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete device action","description":"Deletes a device action","tags":["Devices","Actions"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"action_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/device_clients/{client_id}/device_actions":{"get":{"summary":"Get actions of a device client","description":"Returns the actions of a device client","tags":["Devices","Clients","Actions"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/device_clients/{client_id}/project_actions":{"get":{"summary":"Get actions of a device client","description":"Returns the actions of a device client","tags":["Devices","Clients","Actions"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/device_clients/{client_id}/organization_actions":{"get":{"summary":"Get actions of a device client","description":"Returns the actions of a device client","tags":["Devices","Clients","Actions"],"consumes":[],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/alert-channels/{alert_channel_uuid}/historical_data":{"get":{"summary":"Get data of an alert channel","description":"Returns the last 100 historical data of an alert channel","tags":["Devices","Alert channels"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"alert_channel_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"project_uuid":{"type":"number"},"project_name":{"type":"number"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"client_name":{"type":"string"},"client_description":{"type":"string"},"severity_level":{"type":"string"},"subject":{"type":"string"},"description":{"type":"string"},"received_at":{"type":"string"}}}}}}},"/v1/actions/{action_uuid}":{"get":{"summary":"Get action status","description":"Returns the last confirmed status of an action","tags":["Devices","Actions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"action_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"action_last_confirmed_status":{"type":"string"},"action_last_confirmed_status_timestamp":{"type":"string"}}}}}},"post":{"summary":"Call device action","description":"Calls a device action","tags":["Devices","Actions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"action_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/data_streams/{data_stream_uuid}/last_data":{"get":{"summary":"Get last data of a data stream","description":"Returns the last data point of a data stream using basic authentication","tags":["Devices","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Basic base64-encoded string of client_id:password"},{"name":"data_stream_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number","name":"id","propertyRow":true},"client_id":{"type":"number","name":"client_id","propertyRow":true},"data":{"type":"string","name":"data","propertyRow":true},"received_at":{"type":"string","name":"received_at","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/daily_device_usage/highcharts":{"get":{"summary":"Get organization daily device usage","description":"Retrieves the daily device usage of the organization","tags":["Organizations","Billing"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/billing/daily_interaction_usage/highcharts":{"get":{"summary":"Get organization daily interaction usage","description":"Retrieves the daily interaction usage of the organization","tags":["Organizations","Billing"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/this_month_usage":{"get":{"summary":"Get this month cost and usage","description":"Retrieves a summary of the usage and costs for this month","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/current_interaction_count":{"get":{"summary":"Get this month cost and usage","description":"Retrieves a summary of the usage and costs for this month","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/billing/daily_cost/highcharts":{"get":{"summary":"Get this month cost and usage","description":"Retrieves a summary of the usage and costs for this month","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/payment_methods/card":{"post":{"summary":"Add payment card ","description":"Adds a card to an organization (customer)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"payment_method":{"type":"string","format":"pm_xxxxxxx"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_secret":{"type":"string","format":"seti_xxxxxxxxxxxxxx"}}}}}},"get":{"summary":"List payment cards","description":"Retreives the list of the payment cards","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{id: \"pm_xxxx\", object: \"payment_method\", billing_details: {}, card: {brand: \"visa\", country: \"US\", exp_month: 5, exp_year: 20XX, funding: \"debit\", last4: \"XXXX\"}}"}}}}}}},"delete":{"summary":"Delete payment card ","description":"Deletes a payment card ","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"payment_method":{"type":"string","format":"pm_xxxxxxx"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_secret":{"type":"string","format":"seti_xxxxxxxxxxxxxx"}}}}}}},"/v1/organizations/{organization_uuid}/payment_methods/card/default":{"post":{"summary":"Set default payment method","description":"Sets a default payment as the default one","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"payment_method":{"type":"string","format":"pm_xxxxxxx"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/billing/email":{"put":{"summary":"Change billing email","description":"Changes the email address used for billing and invoices","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"email":{"type":"string","name":"email","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/customer":{"get":{"summary":"Get organization billing info","description":"Retreives the billing information of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"customer":{"name":"customer","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/status":{"put":{"summary":"Change device status","description":"Changes the status of the device to enabled or disabled","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"device_is_enabled":{"type":"boolean","name":"device_is_enabled","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/events":{"get":{"summary":"Get organization events","description":"Retrieves all events (activities) of the organization","tags":["Organizations","Events"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_event_id":{"type":"number"},"organization_event_organization_uuid":{"type":"string"},"organization_event_timestamp":{"type":"string"},"organization_event_user_username":{"type":"string"},"organization_event_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/billing/invoice":{"get":{"summary":"Get organization billing invoices","description":"Retreives the invoices of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"invoices":{}}}}}}},"/v1/organizations/{organization_uuid}/billing/upcoming_invoice":{"get":{"summary":"Get organization upcoming invoice","description":"Retreives the upcoming invoice of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"invoices":{}}}}}}},"/v1/payment_methods/setup_intent":{"get":{"summary":"Payment method setup intent","description":"Generates a secret code for a payment method setup intent","tags":["Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_secret":{"type":"string","format":"seti_xxxxxxxxxxxxxx","name":"client_secret","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/upcoming_invoice_line_items":{"get":{"summary":"Get organization upcoming invoice","description":"Retreives the upcoming invoice 1000 line items of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"upcoming_invoice_line_items":{}}}}}}},"/v1/billing/invoice/{invoice_id}/invoice_line_items":{"get":{"summary":"Get billing invoices line items","description":"Retreives the invoices line items of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"invoice_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"invoice_line_items":{}}}}}}},"/v1/organizations/{organization_uuid}/clients":{"get":{"summary":"Get organization clients","description":"Returns IoT API Keys (clients) of this organization","tags":["Organizations","Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_id":{"type":"string"},"username":{"type":"string"},"client_name":{"type":"string"},"client_description":{"type":"string"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}},"post":{"summary":"Add organization client","description":"Creates a new IoT API Key Client for an organization","tags":["Devices","Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"client_name":{"type":"string","name":"client_name","propertyRow":true},"client_description":{"type":"string","name":"client_description","propertyRow":true},"only_allow_subscription":{"type":"boolean","name":"only_allow_subscription","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_username":{"type":"string","name":"client_username","propertyRow":true},"client_password":{"type":"string","name":"client_password","propertyRow":true}}},"code":"200"}}}},"/v1/organization_clients/{client_id}":{"put":{"summary":"Change organization_client","description":"Changes the name and description of an organization client","tags":["Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"client_name":{"type":"string"},"client_description":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"password":{"type":"string"}}}}}},"delete":{"summary":"Delete organization client","description":"Deletes a client (IoT API Key) of an organization","tags":["Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"password":{"type":"string","name":"password","propertyRow":true}}},"code":"200"}}}},"/v1/users/search/containing":{"get":{"summary":"Search users","description":"Retrieves a list of users that their name or username contain a given string","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"containing","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_username":{"type":"string","name":"user_username","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/members/search/containing":{"get":{"summary":"Search organization members","description":"Retrieves a list of users of an organization that their name or username contain a given string","tags":["Users","Organizations"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"containing","in":"path","required":true,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_username":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_image_url":{"type":"string"}}}}}}},"/v1/clients/{client_username}/historical_status":{"get":{"summary":"Get client historical status","description":"Retreives the historical online/offline states of the client per day","tags":["Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string","name":"date","propertyRow":true},"duration":{"type":"integer","name":"duration","propertyRow":true},"state":{"type":"string","format":"ONLINE/OFFLINE/UNKNOWN","name":"state","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/connections/{current_port}":{"put":{"summary":"Modify remote connection","description":"Changes port number or slug of the remote connection","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"new_port":{"type":"number","name":"new_port","propertyRow":true},"slug":{"type":"string","name":"slug","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"current_port","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/data_streams/{data_stream_uuid}/historical_data/key_access":{"get":{"summary":"Get data of a data stream","description":"Returns the historical data of a data stream - limited to 100 records","tags":["Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Basic base64-encoded string of client_username:password"},{"name":"data_stream_uuid","in":"path","required":true,"type":"string"},{"name":"offset","in":"query","required":false,"type":"number"},{"name":"starting_date","in":"query","required":false,"type":"string","format":"YYYY-MM-DD HH:MM:SS"},{"name":"ending_date","in":"query","required":false,"type":"string","format":"YYYY-MM-DD HH:MM:SS"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"id":{"type":"number","name":"id","propertyRow":true},"client_id":{"type":"number","name":"client_id","propertyRow":true},"data":{"type":"string","name":"data","propertyRow":true},"received_at":{"type":"string","name":"received_at","propertyRow":true}}},"code":"200"}}}},"/v1/users/authorize":{"get":{"summary":"Generate user credentials","description":"Generates MQTT/WebSocket credentials for a user","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_username":{"type":"string"},"client_password":{"type":"string"}}}}}}},"/v1/clients/{client_username}/historical_status/highcharts":{"get":{"summary":"Get client historical status in highcharts format","description":"Retreives the historical online/offline states of the client per day","tags":["Clients"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"client_username","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string"},"duration":{"type":"integer"},"state":{"type":"string","format":"ONLINE/OFFLINE/UNKNOWN"}}}}}}},"/v1/geolocation/ipaddress/{ipaddress}":{"get":{"summary":"Get project devices","description":"Returns the devices of a project","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"device_last_heard":{"type":"boolean"},"device_is_private":{"type":"boolean"},"device_created_at":{"type":"string"},"device_type":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/invite":{"post":{"summary":"Invites users","description":"Invites users to organizations and projects","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"invite_data":{"type":"string","format":"{ \"version\": \"1.1.2\", \"users\": [ { \"email\": \"xxx\" } ], \"invite_data\": { \"version\": \"1.1.2\", \"organization_role_name\": \"Organization xxx\", \"projects\": [ { \"project_uuid\": \"prj_xxx\", \"project_role_name\": \"Project xxx\" } ] } }"},"invite_platform":{"type":"string","format":"DASHBOARD, CONSOLE"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/projects/{project_uuid}/temporary_clients":{"post":{"summary":"Temporary project clients","description":"Create read-only temporary real-time clients for a project","tags":["Projects","Clients"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Basic base64(organization_api_key_username:organization_api_key_password)"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"project_uuid","in":"path","required":true,"type":"string"},{"name":"Main Name","in":"body","required":false,"schema":{"type":"object","properties":{"permission_pattern":{"type":"string","format":"# (default) or a/+/b/#"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"client_username":{"type":"string"},"client_password":{"type":"string"}}}}}}},"/v1/projects/{project_uuid}/virtual_devices":{"post":{"summary":"Create virtual device","description":"Creates a virtual device in a project","tags":["Virtual Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"device_name":{"type":"string"},"device_description":{"type":"string"},"device_subscription_identifier":{"type":"string","format":"vr-dev-basic, vr-dev-standard, vr-dev-pro, ent-vr-dev-medium, or ent-vr-dev-pro"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/cloud-servers":{"post":{"summary":"Create cloud server","description":"Creates a cloud server for the organization","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"cloud_server_name":{"type":"string"},"cloud_server_description":{"type":"string"},"cloud_server_subscription_identifier":{"type":"string","format":"cns-small, cns-medium, cns-large, ent-cns-medium, or ent-cns-large"},"cloud_server_subdomain":{"type":"string"},"key_uuid":{"type":"string","format":"key_xxxxxx"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get organization cloud servers","description":"Returns the cloud servers of an organization","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"cloud_server_uuid":{"type":"string"},"cloud_server_name":{"type":"number"},"cloud_server_description":{"type":"string"},"cloud_server_url":{"type":"string"},"cloud_server_dns_record_name":{"type":"string"},"cloud_server_public_ip_address":{"type":"string"},"cloud_server_is_nodered":{"type":"boolean"},"cloud_server_is_ready":{"type":"boolean"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}":{"delete":{"summary":"Delete cloud server","description":"Permanently deletes a cloud server from th organization","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"Change Cloud Server","description":"Changes the name and description of a cloud server","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":true,"schema":{"type":"object","properties":{"cloud_server_name":{"type":"string"},"cloud_server_description":{"type":"string"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/nodered/set_settings":{"put":{"summary":"Device nodered change user settings","description":"Changes the user Settings.js configuration for the nodered running on the device","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"nodered_settings":{"type":"string","format":"JSON instructions: https://nodered.org/docs/user-guide/runtime/configuration"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/restart":{"get":{"summary":"Restart device","description":"Attempts to restarts the operating system ","tags":["Devices"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/free-trial":{"post":{"summary":"Create organization","description":"Creates an organization with \"Organization Owner\" role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_name":{"type":"string","name":"organization_name","propertyRow":true},"organization_description":{"type":"string","name":"organization_description","propertyRow":true},"organization_is_private":{"type":"boolean","name":"organization_is_private","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/subscription-trial-end-days":{"get":{"summary":"Subscription Trial End Days","description":"Gives the number of days left for the trial period of the subscription","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{trial_end_days: 30}"}}}}}}}},"/v1/organizations/{organization_uuid}/logo":{"post":{"summary":"Change organization logo","description":"Replaces the organization's logo with the new picture","tags":["Users"],"consumes":["image"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","description":"image/jpeg file","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/sftp/list":{"post":{"summary":"List directory","description":"Lists the items of a given directory in a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/sftp/mkdir":{"post":{"summary":"Create directory","description":"Creates a directory in the given path of a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/sftp/rmdir":{"post":{"summary":"Remove directory","description":"Removes a directory in the given path of a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/sftp/rename":{"post":{"summary":"Rename file","description":"Renames a file in the given path of a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"},"new_path":{"type":"string","format":"/etc2/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/sftp/chmod":{"post":{"summary":"Chmod file","description":"Changes the mode (chmod) of a given file of a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"},"mode":{"type":"number","format":"777"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/devices/{device_uuid}/sftp/get":{"post":{"summary":"Get file","description":"Downloads a file with the given path from a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":""}}}}}}}},"/v1/devices/{device_uuid}/sftp/put":{"post":{"summary":"Put file","description":"Uploads a file with the provided path to a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username","name":"username","propertyRow":true},"password":{"type":"string","format":"device password","name":"password","propertyRow":true},"host":{"type":"string","format":"sX.devices.iotflows.com","name":"host","propertyRow":true},"path":{"type":"string","format":"/etc/","name":"path","propertyRow":true},"input":{"type":"string","format":"string | Buffer | NodeJS.ReadableStream","name":"input","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":"","propertyRow":true},"name":"data [buffer]","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/sftp/delete":{"post":{"summary":"Delete file","description":"Deletes a file with the provided path from a device via SFTP","tags":["Devices","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"username":{"type":"string","format":"device username"},"password":{"type":"string","format":"device password"},"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":""}}}}}}}},"/v1/organizations/{organization_uuid}/keys":{"post":{"summary":"Generate ssh key","description":"Generates a pair-key for an organization","tags":["Organizations","Keys"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"key_name":{"type":"string","name":"key_name","propertyRow":true},"key_description":{"type":"string","name":"key_description","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get organization keys","description":"Retrieves the keys of the organization","tags":["Organizations","Keys"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_event_id":{"type":"number"},"organization_event_organization_uuid":{"type":"string"},"organization_event_timestamp":{"type":"string"},"organization_event_user_username":{"type":"string"},"organization_event_description":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/list":{"post":{"summary":"List directory","description":"Lists the items of a given directory in the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/mkdir":{"post":{"summary":"Create directory","description":"Creates a directory in the given path of the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/rmdir":{"post":{"summary":"Remove directory","description":"Removes a directory in the given path of the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/rename":{"post":{"summary":"Rename file","description":"Renames a file in the given path of the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"},"new_path":{"type":"string","format":"/etc2/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/chmod":{"post":{"summary":"Chmod file","description":"Changes the mode (chmod) of a given file of the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"},"mode":{"type":"number","format":"777"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/get":{"post":{"summary":"Get file","description":"Downloads a file with the given path from the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":""}}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/put":{"post":{"summary":"Put file","description":"Uploads a file with the provided path to the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com","name":"host","propertyRow":true},"path":{"type":"string","format":"/etc/","name":"path","propertyRow":true},"input":{"type":"string","format":"string | Buffer | NodeJS.ReadableStream","name":"input","propertyRow":true}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":"","propertyRow":true},"name":"data [buffer]","propertyRow":true}}},"code":"200"}}}},"/v1/cloud-servers/{cloud_server_uuid}/sftp/delete":{"post":{"summary":"Delete file","description":"Deletes a file with the provided path from the cloud server via SFTP","tags":["Cloud Servers","SFTP"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object","properties":{"host":{"type":"string","format":"sX.devices.iotflows.com"},"path":{"type":"string","format":"/etc/"}}}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data [buffer]":{"type":"array","items":{"type":"number","format":""}}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/reboot":{"get":{"summary":"Reboot server","description":"Reboots the cloud server","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object"}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/cloud-servers/{cloud_server_uuid}/nodered_restart":{"get":{"summary":"Restart Node-RED","description":"Restarts the Node-RED service without rebooting the cloud server","tags":["Cloud Servers"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Main","in":"body","required":false,"schema":{"type":"object"}},{"name":"cloud_server_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/interaction_count/today":{"get":{"summary":"Get today's interaction count","description":"Retrieves today's interaction count of the organization","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"count\":\"100\"}"}}}}}}}},"/v1/organizations/{organization_uuid}/interaction_count/this_month":{"get":{"summary":"Get this month's interaction count","description":"Retrieves this month's interaction count of the organization","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"count\":\"100\"}"}}}}}}}},"/v1/projects/{project_uuid}/devices_interaction_count/today":{"get":{"summary":"Get today's interaction count of devices","description":"Retrieves today's interaction count of the project devices","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"device_name\": \"xxx\",\"device_uuid\":\"dev_xxx\",\"count\":\"100\"}"}}}}}}}},"/v1/projects/{project_uuid}/devices_interaction_count/this_month":{"get":{"summary":"Get this month's interaction count","description":"Retrieves this month's interaction count of the project devices","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"device_name\": \"xxx\",\"device_uuid\":\"dev_xxx\",\"count\":\"100\"}"}}}}}}}},"/v1/organizations/{organization_uuid}/projects_interaction_count/today":{"get":{"summary":"Get today's interaction count of projects","description":"Retrieves today's interaction count of the organization projects","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"project_name\": \"xxx\",\"project_uuid\":\"prj_xxx\",\"count\":\"100\"}"}}}}}}}},"/v1/organizations/{organization_uuid}/projects_interaction_count/this_month":{"get":{"summary":"Get this month's interaction count of projects","description":"Retrieves this month's interaction count of the organization projects","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"project_name\": \"xxx\",\"project_uuid\":\"prj_xxx\",\"count\":\"100\"}","propertyRow":true},"name":"data","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/data_streams_interaction_count/today":{"get":{"summary":"Get today's interaction count for data streams","description":"Retrieves today's interaction count of the device data streams","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"data_stream_name\": \"xxx\",\"data_stream_uuid\":\"dev_xxx\",\"count\":\"100\"}","propertyRow":true},"name":"data","propertyRow":true}}},"code":"200"}}}},"/v1/devices/{device_uuid}/data_streams_interaction_count/this_month":{"get":{"summary":"Get this month's interaction count for data streams","description":"Retrieves this month's interaction count of the device data streams","tags":["Billing","Interactions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{\"data_stream_name\": \"xxx\", \"data_stream_uuid\":\"dev_xxx\",\"count\":\"100\"}"}}}}}}}},"/v1/organizations/{organization_uuid}/interaction_count/historical/highcharts":{"get":{"summary":"Get organization interaction usage","description":"Retrieves the hourly interaction counts of the organization","tags":["Organizations","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/projects/{project_uuid}/interaction_count/historical/highcharts":{"get":{"summary":"Get project interaction usage","description":"Retrieves the hourly interaction counts of the project","tags":["Projects","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/interaction_count/historical/highcharts":{"get":{"summary":"Get device interaction usage","description":"Retrieves the hourly interaction counts of the device","tags":["Devices","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/data_streams/{data_stream_uuid}/interaction_count/historical/highcharts":{"get":{"summary":"Get device interaction usage","description":"Retrieves the hourly interaction counts of the device","tags":["Data Streams","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/projects_interaction_size":{"get":{"summary":"Get projects interaction size","description":"Retrieves the interaction size of the organization's projects","tags":["Organizations","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"":{"type":"array","items":{"type":"string","format":"{\"project_name\": \"xxx\", \"project_uuid\":\"xxx\", \"size\":\"2206244864\", \"size_pretty\":\"2104 MB\"}"}}}}}}}},"/v1/projects/{project_uuid}/devices_interaction_size":{"get":{"summary":"Get devices interaction size","description":"Retrieves the interaction size of a project's devices","tags":["Projects","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"":{"type":"array","items":{"type":"string","format":"{\"device_name\": \"xxx\", \"device_uuid\":\"xxx\", \"size\":\"2206244864\", \"size_pretty\":\"2104 MB\"}"}}}}}}}},"/v1/devices/{device_uuid}/data_streams_interaction_size":{"get":{"summary":"Get data streams interaction size","description":"Retrieves the interaction size of a device's data streams","tags":["Devices","Billing","Interactions"],"consumes":[],"produces":["Highcharts array [[t0","x0]","[t1","x1]]"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"":{"type":"array","items":{"type":"string","format":"{\"data_stream_name\": \"xxx\", \"data_stream_uuid\":\"xxx\", \"size\":\"2206244864\", \"size_pretty\":\"2104 MB\"}"}}}}}}}},"/v1/devices/{device_uuid}/historical_data/topics":{"get":{"summary":"Get data stream topics of device","description":"Returns data stream topics (subtopics) of a device","tags":["Devices","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data_stream_uuid":{"type":"string"},"data_stream_name":{"type":"string"},"topics":{"type":"array","items":{"type":"string","format":""}}}}}}}},"/v1/devices/{device_uuid}/assets":{"get":{"summary":"Get assets of device","description":"Returns assets of a device","tags":["Devices","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"tags","in":"query","required":false,"type":"string","format":"comma seperated tags"},{"name":"q","in":"query","required":false,"type":"string","format":"search keywords"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"}}}}}},"post":{"summary":"Add asset","description":"Adds/creates an asset for a device","tags":["Devices","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"machine_uuid":{"type":"string"},"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_homepage_url":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_machine_uuid":{"type":"string"}}}}}}},"/v1/machines/{machine_uuid}/widgets":{"get":{"summary":"Get smart widgets of machine","description":"Returns smart widgets of a machine template","tags":["Machines","SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_uuid":{"type":"string","format":"Dynamic Line Chart"},"widget_settings":{"type":"string","format":"Dynamic line chart with one real-time flow"},"widget_template_uuid":{"type":"string","format":"1.0.0"},"widget_template_name":{"type":"string","format":"wdg_3q1dv9b4bc90bb942e86e06d9cc9a4ds"},"widget_template_description":{"type":"string","format":"Object"},"widget_template_initial_settings":{"type":"string","format":"Object"},"widget_template_required_settings":{"type":"string","format":"dynamic-line-chart"},"widget_template_image_url":{"type":"string"},"widget_designer_company_name":{"type":"string","format":"IoTFlows Inc"},"widget_designer_company_website":{"type":"string","format":"https://iotflows.com"},"widget_designer_is_verified":{"type":"boolean","format":"true"},"widget_designer_uuid":{"type":"string"}}}}}},"post":{"summary":"Create smart widget for machine","description":"Creates a smart widget for a machine template","tags":["Machines","SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"widget_template_uuid":{"type":"string"},"widget_settings":{"type":"string","format":"JSON"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_widget_uuid":{"type":"string"}}}}}}},"/v1/manufacturers":{"get":{"summary":"Get manufacturers","description":"Returns the list of manufacturers","tags":["Manufacturers","Machines"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}},"post":{"summary":"Add manufacturer","description":"Adds/creates a manufacturer","tags":["Manufacturers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Body","in":"body","required":true,"schema":{"type":"object","properties":{"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_picture":{"type":"array","items":{"type":"integer","format":"Base64 Buffer"}},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_manufacturer_uuid":{"type":"string"}}}}}}},"/v1/machines":{"get":{"summary":"Get machines","description":"Returns the list of machines and their manufacturers filter by tags","tags":["Manufacturers","Machines"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"","in":"query","description":"q","required":false,"type":"string","format":"search query ="}],"responses":{"200":{"description":"successful operation"}}},"post":{"summary":"Add machines","description":"Adds/creates a machine for a manufacturer","tags":["Manufacturers","Machines"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer"}},"machine_homepage_url":{"type":"string"},"manufacturer_uuid":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_machine_uuid":{"type":"string"}}}}}}},"/v1/manufacturers_machines":{"post":{"summary":"Add manufacturer and machine","description":"Adds/creates a manufacturer and a machine at the same time","tags":["Manufacturers","Machines"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"Body","in":"body","required":true,"schema":{"type":"object","properties":{"manufacturer_name":{"type":"string","name":"manufacturer_name","propertyRow":true},"manufacturer_description":{"type":"string","name":"manufacturer_description","propertyRow":true},"manufacturer_logo_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer","propertyRow":true},"name":"manufacturer_logo_picture","propertyRow":true},"manufacturer_homepage_url":{"type":"string","name":"manufacturer_homepage_url","propertyRow":true},"manufacturer_support_homepage_url":{"type":"string","name":"manufacturer_support_homepage_url","propertyRow":true},"manufacturer_support_email":{"type":"string","name":"manufacturer_support_email","propertyRow":true},"manufacturer_support_phone":{"type":"string","name":"manufacturer_support_phone","propertyRow":true},"machine_name":{"type":"string","name":"machine_name","propertyRow":true},"machine_description":{"type":"string","name":"machine_description","propertyRow":true},"machine_identifier":{"type":"string","name":"machine_identifier","propertyRow":true},"machine_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer","propertyRow":true},"name":"machine_picture","propertyRow":true},"machine_homepage_url":{"type":"string","name":"machine_homepage_url","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_manufacturer_uuid":{"type":"string","name":"new_manufacturer_uuid","propertyRow":true}}},"code":"200"}}}},"/v1/manufacturers/exists":{"get":{"summary":"Exists manufacturer","description":"Checks if a manufacturer with this name exists","tags":["Manufacturers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"manufacturer_name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"exists":{"type":"boolean"}}}}}}},"/v1/machines/exists":{"get":{"summary":"Exists machine","description":"Checks if a machine with this name exists","tags":["Machines"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"machine_name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"exists":{"type":"boolean"}}}}}}},"/v1/assets/{asset_uuid}":{"get":{"summary":"Get asset","description":"Returns the details of an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string","name":"asset_custom_name","propertyRow":true},"asset_custom_description":{"type":"string","name":"asset_custom_description","propertyRow":true},"asset_custom_identifier":{"type":"string","name":"asset_custom_identifier","propertyRow":true},"asset_custom_picture_url":{"type":"string","name":"asset_custom_picture_url","propertyRow":true},"asset_custom_homepage_url":{"type":"string","name":"asset_custom_homepage_url","propertyRow":true},"asset_uuid":{"type":"string","name":"asset_uuid","propertyRow":true},"machine_name":{"type":"string","name":"machine_name","propertyRow":true},"machine_description":{"type":"string","name":"machine_description","propertyRow":true},"machine_identifier":{"type":"string","name":"machine_identifier","propertyRow":true},"machine_picture_url":{"type":"string","name":"machine_picture_url","propertyRow":true},"machine_homepage_url":{"type":"string","name":"machine_homepage_url","propertyRow":true},"machine_uuid":{"type":"string","name":"machine_uuid","propertyRow":true},"manufacturer_name":{"type":"string","name":"manufacturer_name","propertyRow":true},"manufacturer_description":{"type":"string","name":"manufacturer_description","propertyRow":true},"manufacturer_logo_url":{"type":"string","name":"manufacturer_logo_url","propertyRow":true},"manufacturer_homepage_url":{"type":"string","name":"manufacturer_homepage_url","propertyRow":true},"manufacturer_support_homepage_url":{"type":"string","name":"manufacturer_support_homepage_url","propertyRow":true},"manufacturer_support_email":{"type":"string","name":"manufacturer_support_email","propertyRow":true},"manufacturer_support_phone":{"type":"string","name":"manufacturer_support_phone","propertyRow":true},"manufacturer_is_verified":{"type":"boolean","name":"manufacturer_is_verified","propertyRow":true},"machine_dashboard_uuid":{"type":"string","name":"machine_dashboard_uuid","propertyRow":true},"machine_dashboard_name":{"type":"string","name":"machine_dashboard_name","propertyRow":true},"machine_dashboard_description":{"type":"string","name":"machine_dashboard_description","propertyRow":true},"machine_dashboard_settings":{"type":"string","format":"JSON","name":"machine_dashboard_settings","propertyRow":true}}},"code":"200"}}},"put":{"summary":"Edit asset","description":"Edits an asset ","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_custom_name":{"type":"string","name":"asset_custom_name","propertyRow":true},"asset_custom_description":{"type":"string","name":"asset_custom_description","propertyRow":true},"asset_custom_identifier":{"type":"string","name":"asset_custom_identifier","propertyRow":true},"asset_custom_homepage_url":{"type":"string","name":"asset_custom_homepage_url","propertyRow":true}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"delete":{"summary":"Delete asset","description":"Deletes an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/assets/tags":{"get":{"summary":"Get asset tags of device","description":"Returns the tag keys and values of the assets of a device","tags":["Devices","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tag_key":{"type":"string"},"tag_values":{"type":"array","items":{"type":"string","format":""}}}}}}}},"/v1/organizations/{organization_uuid}/assets/tags":{"get":{"summary":"Get asset tags of organization","description":"Returns the tag keys and values of the assets of an organization","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tag_key":{"type":"string","name":"tag_key","propertyRow":true},"tag_values":{"type":"array","items":{"type":"string","format":"","propertyRow":true},"name":"tag_values","propertyRow":true}}},"code":"200"}}}},"/v1/projects/{project_uuid}/assets/tags":{"get":{"summary":"Get asset tags of project","description":"Returns the tag keys and values of the assets of a project","tags":["Projects","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"project_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tag_key":{"type":"string"},"tag_values":{"type":"array","items":{"type":"string","format":""}}}}}}}},"/v1/flows/{flow_uuid}":{"get":{"summary":"Get flow info","description":"Returns the information of a flow","tags":["Flows"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"flow_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"delete":{"summary":"Delete machine flow","description":"Deletes a flow template of a machine","tags":["Machines","Flows"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/widgets/{widget_uuid}/flows":{"get":{"summary":"Get widget flows of asset","description":"Returns the widget flows of an asset","tags":["SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"widget_uuid","in":"path","required":true,"type":"string"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/projects/{project_uuid}/assets":{"get":{"summary":"Get assets of project","description":"Returns assets of a project","tags":["Projects","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"tags","in":"query","required":false,"type":"string","format":"comma seperated tags"},{"name":"project_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":false,"type":"string","format":"search keywords"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/assets":{"get":{"summary":"Get assets of organization","description":"Returns assets of an organizations","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"tags","in":"query","required":false,"type":"string","format":"comma seperated tags"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":false,"type":"string","format":"search keywords"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string","name":"asset_custom_name","propertyRow":true},"asset_custom_description":{"type":"string","name":"asset_custom_description","propertyRow":true},"asset_custom_identifier":{"type":"string","name":"asset_custom_identifier","propertyRow":true},"asset_custom_picture_url":{"type":"string","name":"asset_custom_picture_url","propertyRow":true},"asset_custom_homepage_url":{"type":"string","name":"asset_custom_homepage_url","propertyRow":true},"asset_uuid":{"type":"string","name":"asset_uuid","propertyRow":true},"machine_name":{"type":"string","name":"machine_name","propertyRow":true},"machine_description":{"type":"string","name":"machine_description","propertyRow":true},"machine_identifier":{"type":"string","name":"machine_identifier","propertyRow":true},"machine_picture_url":{"type":"string","name":"machine_picture_url","propertyRow":true},"machine_homepage_url":{"type":"string","name":"machine_homepage_url","propertyRow":true},"manufacturer_name":{"type":"string","name":"manufacturer_name","propertyRow":true},"manufacturer_description":{"type":"string","name":"manufacturer_description","propertyRow":true},"manufacturer_logo_url":{"type":"string","name":"manufacturer_logo_url","propertyRow":true},"manufacturer_homepage_url":{"type":"string","name":"manufacturer_homepage_url","propertyRow":true},"manufacturer_support_homepage_url":{"type":"string","name":"manufacturer_support_homepage_url","propertyRow":true},"manufacturer_support_email":{"type":"string","name":"manufacturer_support_email","propertyRow":true},"manufacturer_support_phone":{"type":"string","name":"manufacturer_support_phone","propertyRow":true},"manufacturer_is_verified":{"type":"boolean","name":"manufacturer_is_verified","propertyRow":true},"device_uuid":{"type":"string","name":"device_uuid","propertyRow":true},"device_name":{"type":"string","name":"device_name","propertyRow":true},"device_description":{"type":"string","name":"device_description","propertyRow":true},"project_uuid":{"type":"string","name":"project_uuid","propertyRow":true},"project_name":{"type":"string","name":"project_name","propertyRow":true},"project_description":{"type":"string","name":"project_description","propertyRow":true},"organization_uuid":{"type":"string","name":"organization_uuid","propertyRow":true},"organization_name":{"type":"string","name":"organization_name","propertyRow":true},"organization_description":{"type":"string","name":"organization_description","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create organization asset","description":"Creates an asset for an organization","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"machine_uuid":{"type":"string","name":"machine_uuid","propertyRow":true},"asset_custom_name":{"type":"string","name":"asset_custom_name","propertyRow":true},"asset_custom_description":{"type":"string","name":"asset_custom_description","propertyRow":true},"asset_custom_identifier":{"type":"string","name":"asset_custom_identifier","propertyRow":true},"asset_custom_homepage_url":{"type":"string","name":"asset_custom_homepage_url","propertyRow":true},"department_uuid":{"type":"string","name":"department_uuid","propertyRow":true},"tags":{"type":"string","format":"comma separated tags","name":"tags","propertyRow":true},"node_uuid":{"type":"string","format":"optional","name":"node_uuid","propertyRow":true}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_machine_uuid":{"type":"string","name":"new_machine_uuid","propertyRow":true}}},"code":"200"}}}},"/v1/machines/{machine_uuid}/flows":{"post":{"summary":"Create machine flow","description":"Creates a flow template for a machine","tags":["Machines","Flows"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"flow_name":{"type":"string"},"flow_description":{"type":"string"},"flow_mqtt_subtopic":{"type":"string"},"flow_mqtt_payload_parsing_expression":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"flow_uuid":{"type":"string"}}}}}},"get":{"summary":"Get machine flows","description":"Retrieves flow templates for a machine","tags":["Machines","Flows"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"flow_name":{"type":"string"},"flow_description":{"type":"string"},"flow_mqtt_subtopic":{"type":"string"},"flow_mqtt_payload_parsing_expression":{"type":"string"}}}}}}},"/v1/widget_templates":{"get":{"summary":"Get widget templates","description":"Returns the list of widget templates","tags":["SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_type_name":{"type":"string","format":"Dynamic Line Chart"},"widget_type_description":{"type":"string","format":"Dynamic line chart with one real-time flow"},"widget_type_version":{"type":"string","format":"1.0.0"},"widget_uuid":{"type":"string","format":"wdg_3q1dv9b4bc90bb942e86e06d9cc9a4ds"},"widget_settings":{"type":"string","format":"Object"},"widget_type_required_settings":{"type":"string","format":"Object"},"widget_type_identifier":{"type":"string","format":"dynamic-line-chart"},"widget_designer_company_name":{"type":"string","format":"IoTFlows Inc"},"widget_designer_company_website":{"type":"string","format":"https://iotflows.com"},"widget_designer_is_verified":{"type":"boolean","format":"true"}}}}}}},"/v1/machines/{machine_uuid}/machine_dashboards":{"get":{"summary":"Get dashboards of machine","description":"Returns machine dashboards of a machine","tags":["Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_uuid":{"type":"string","format":"Dynamic Line Chart"},"widget_settings":{"type":"string","format":"Dynamic line chart with one real-time flow"},"widget_template_uuid":{"type":"string","format":"1.0.0"},"widget_template_name":{"type":"string","format":"wdg_3q1dv9b4bc90bb942e86e06d9cc9a4ds"},"widget_template_description":{"type":"string","format":"Object"},"widget_template_initial_settings":{"type":"string","format":"Object"},"widget_template_required_settings":{"type":"string","format":"dynamic-line-chart"},"widget_template_image_url":{"type":"string"},"widget_designer_company_name":{"type":"string","format":"IoTFlows Inc"},"widget_designer_company_website":{"type":"string","format":"https://iotflows.com"},"widget_designer_is_verified":{"type":"boolean","format":"true"},"widget_designer_uuid":{"type":"string"}}}}}},"post":{"summary":"Create machine dashboard","description":"Creates a dashboard template for a machine","tags":["Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"machine_dashboard_name":{"type":"string"},"machine_dashboard_description":{"type":"string"},"machine_dashboard_settings":{"type":"string","format":"JSON"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"new_dashboard_uuid":{"type":"string"}}}}}}},"/v1/machine_dashboards/{machine_dashboard_uuid}":{"put":{"summary":"Update machine dashboard","description":"Updates a dashboard template of a machine","tags":["Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_dashboard_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"machine_dashboard_name":{"type":"string"},"machine_dashboard_description":{"type":"string"},"machine_dashboard_settings":{"type":"string","format":"JSON"}}}}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get machine dashboard","description":"Retrieves a dashboard template of a machine","tags":["Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_dashboard_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"machine_dashobard_uuid":{"type":"string","name":"machine_dashobard_uuid","propertyRow":true},"machine_dashobard_name":{"type":"string","name":"machine_dashobard_name","propertyRow":true},"machine_dashobard_description":{"type":"string","name":"machine_dashobard_description","propertyRow":true},"machine_dashobard_settings":{"type":"string","format":"JSON","name":"machine_dashobard_settings","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete machine dashboard","description":"Deletes a machine dashboard","tags":["Assets","Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/selected_machine_dashboard":{"put":{"summary":"Select asset dashboard","description":"Changes the asset's selected machine dashboard","tags":["Assets","Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"machine_dashboard_uuid":{"type":"string"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get asset machien dashboard","description":"Returns the selected machine dashboard of an asset","tags":["Dashboards","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"machine_dashboard_uuid":{"type":"string"},"machine_dashboard_name":{"type":"string"},"machine_dashboard_description":{"type":"string"},"machine_dashboard_settings":{"type":"string","format":"JSON"}}}}}}},"/v1/assets/{asset_uuid}/data_stream_flows":{"put":{"summary":"Set asset data stream flows","description":"Assigns data streams from an asset to machine template flows","tags":["Assets","Flows","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"flow_uuid":{"type":"string"},"data_stream_uuid":{"type":"string"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get asset data stream flows","description":"Retrieves data stream machine flows of an asset ","tags":["Assets","Flows","Data Streams"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data_stream_uuid":{"type":"string","name":"data_stream_uuid","propertyRow":true},"data_stream_name":{"type":"string","name":"data_stream_name","propertyRow":true},"data_stream_description":{"type":"string","name":"data_stream_description","propertyRow":true},"data_stream_unit":{"type":"string","name":"data_stream_unit","propertyRow":true},"flow_uuid":{"type":"string","name":"flow_uuid","propertyRow":true},"flow_name":{"type":"string","name":"flow_name","propertyRow":true},"flow_description":{"type":"string","name":"flow_description","propertyRow":true},"flow_mqtt_subtopic":{"type":"string","format":"JSON","name":"flow_mqtt_subtopic","propertyRow":true},"flow_mqtt_payload_parsing_expression":{"type":"string","name":"flow_mqtt_payload_parsing_expression","propertyRow":true}}},"code":"200"}}}},"/v1/widgets/{widget_uuid}":{"get":{"summary":"Get smart widget","description":"Returns the details of a smart widget","tags":["SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"widget_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_uuid":{"type":"string","format":"Dynamic Line Chart"},"widget_settings":{"type":"string","format":"Dynamic line chart with one real-time flow"},"widget_template_uuid":{"type":"string","format":"1.0.0"},"widget_template_name":{"type":"string","format":"wdg_3q1dv9b4bc90bb942e86e06d9cc9a4ds"},"widget_template_description":{"type":"string","format":"Object"},"widget_template_initial_settings":{"type":"string","format":"Object"},"widget_template_required_settings":{"type":"string","format":"dynamic-line-chart"},"widget_template_image_url":{"type":"string"},"widget_designer_company_name":{"type":"string","format":"IoTFlows Inc"},"widget_designer_company_website":{"type":"string","format":"https://iotflows.com"},"widget_designer_is_verified":{"type":"boolean","format":"true"},"widget_designer_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete smart widget","description":"Deletes a smart widget","tags":["SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"widget_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/machine_dashboards/{machine_dashboard_uuid}/widgets":{"get":{"summary":"Get machine dashboard widgets","description":"Retrieves machine dashboard widgets","tags":["SmartWidgets","Machines","Dashboards"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"machine_dashboard_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_uuid":{"type":"string"},"widget_settings":{"type":"string","format":"JSON"},"widget_template_uuid":{"type":"string"},"widget_template_name":{"type":"string"},"widget_template_description":{"type":"string"},"widget_template_initial_settings":{"type":"string","format":"JSON"},"widget_template_required_settings":{"type":"string","format":"JSON"},"widget_template_image_url":{"type":"string"},"widget_designer_company_name":{"type":"string"},"widget_designer_company_website":{"type":"string"},"widget_designer_is_verified":{"type":"boolean"},"widget_designer_uuid":{"type":"string"}}}}}}},"/v1/machines/{machine_uuid}/widget_flows":{"get":{"summary":"Get smart widget flows of machine","description":"Returns flows of smart widgets of a machine template","tags":["Flows","Machines","SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"machine_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"widget_uuid":{"type":"string","format":"Dynamic Line Chart"},"widget_settings":{"type":"string","format":"Dynamic line chart with one real-time flow"},"widget_template_uuid":{"type":"string","format":"1.0.0"},"widget_template_name":{"type":"string","format":"wdg_3q1dv9b4bc90bb942e86e06d9cc9a4ds"},"widget_template_description":{"type":"string","format":"Object"},"widget_template_initial_settings":{"type":"string","format":"Object"},"widget_template_required_settings":{"type":"string","format":"dynamic-line-chart"},"widget_template_image_url":{"type":"string"},"widget_designer_company_name":{"type":"string","format":"IoTFlows Inc"},"widget_designer_company_website":{"type":"string","format":"https://iotflows.com"},"widget_designer_is_verified":{"type":"boolean","format":"true"},"widget_designer_uuid":{"type":"string"},"flow_uuid":{"type":"string"},"flow_name":{"type":"string"},"flow_description":{"type":"string"},"flow_mqtt_subtopic":{"type":"string"},"flow_mqtt_payload_parsing_expression":{"type":"string"}}}}}}},"/v1/assets/{asset_uuid}/widgets/{widget_uuid}/flows_data":{"get":{"summary":"Get widget flow data of asset","description":"Returns the data of widget flows of an asset","tags":["SmartWidgets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token OR Basic base64-encoded string of client_username:password"},{"name":"","in":"query","description":"tags","required":false,"type":"string","format":"comma seperated tags"},{"name":"widget_uuid","in":"path","required":true,"type":"string"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/connections/ip/{current_ip}/port/{current_port}":{"put":{"summary":"Modify remote connection","description":"Changes port number or slug of the remote connection","tags":["Devices","Connections"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"new_port":{"type":"number"},"slug":{"type":"string"},"new_ip":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"current_port","in":"path","required":true,"type":"string"},{"name":"current_ip","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devicesTEST/{device_uuid}":{"delete":{"summary":"Delete a device","description":"Deletes device","tags":["Devices"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/containers":{"get":{"summary":"Get device containers","description":"Returns the containers of a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"container_uuid":{"type":"string"},"container_image":{"type":"string"},"container_kill_before_run":{"type":"boolean"},"container_port_bindings":{"type":"array","items":{"type":"string","format":"[{\"private_port\":\"1880\", \"public_port\":\"1885\"}]"}},"container_environment_variables":{"type":"string","format":"{\"key\":\"value\"}"}}}}}},"post":{"summary":"Create device container","description":"Creates a docker container for a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"container_image":{"type":"string","name":"container_image","propertyRow":true},"container_kill_before_run":{"type":"boolean","name":"container_kill_before_run","propertyRow":true},"container_port_bindings":{"type":"array","items":{"type":"string","format":"[{\"private_port\":\"1880\", \"public_port\":\"1885\"}]","propertyRow":true},"name":"container_port_bindings","propertyRow":true},"container_environment_variables":{"type":"string","format":"{\"key\":\"value\"}","name":"container_environment_variables","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/containers/{container_uuid}":{"delete":{"summary":"Delete device container","description":"Deletes a docker container from a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"container_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Change device container","description":"Changes a docker container of a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"container_image":{"type":"string"},"container_kill_before_run":{"type":"boolean"},"container_port_bindings":{"type":"array","items":{"type":"string","format":"[{\"private_port\":\"1880\", \"public_port\":\"1885\"}]"}},"container_environment_variables":{"type":"string","format":"{\"key\":\"value\"}"}}}},{"name":"container_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/containers/remove":{"post":{"summary":"Remove device container","description":"Kills and removes a docker container of a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"container_id":{"type":"string"}}}},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/containers/redeploy":{"get":{"summary":"Redeploy device containers","description":"Redeploys the docker containers defined for a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/devices/{device_uuid}/containers/fetch":{"get":{"summary":"Fetch device containers","description":"Fetches the running docker containers of a device","tags":["Devices","Container","Containers"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/iotflows/device-management/registration/devices/{device_uuid}/assign/senseai":{"post":{"summary":"Assign SenseAI Gateway","description":"Assigns a SenseAI Gateway to an organization","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_uuid":{"type":"string"},"device_name":{"type":"string"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/devices/senseai":{"get":{"summary":"Get organization SenseAI gateways","description":"Returns the SenseAI gateways of IoTFlows managed projects within an organization","tags":["Devices","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"device_last_heard":{"type":"boolean"},"device_is_private":{"type":"boolean"},"device_created_at":{"type":"string"},"device_type":{"type":"string"},"device_system_information":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/billing/upcoming_invoices":{"get":{"summary":"Get organization upcoming invoices","description":"Retreives the upcoming invoice of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"invoices":{}}}}}}},"/v1/organizations/{organization_uuid}/billing/upcoming_invoices_line_items":{"get":{"summary":"Get organization upcoming invoices","description":"Retreives the upcoming invoice 1000 line items of a customer (organization)","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"upcoming_invoice_line_items":{}}}}}}},"/v1/organizations/{organization_uuid}/nodes/senseai":{"get":{"summary":"Get organization SenseAI nodes","description":"Returns the SenseAI nodes of IoTFlows managed projects within an organization","tags":["Nodes","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"node_uuid":{"type":"string"},"node_name":{"type":"string"},"node_description":{"type":"string"},"node_last_heard":{"type":"boolean"},"node_created_at":{"type":"string"},"node_is_online":{"type":"boolean"},"node_vitals":{"type":"string"},"node_mac":{"type":"string"},"node_last_requested_at":{"type":"string"},"node_firmware_version":{"type":"string"},"subscription_plan_identifier":{"type":"string"},"subscription_plan_name":{"type":"string"},"subscription_plan_description":{"type":"string"},"subscription_plan_period":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/assets-nodes-gateways":{"get":{"summary":"Get asset-node-gateways of SenseAI","description":"Returns the assets and their connected SenseAI nodes and gateways of an organization","tags":["Assets","Nodes","Gateways","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"node_assets":{"type":"array","items":{"type":"string","format":"asset_id: 60 asset_machine_id: 218 asset_custom_name: \"\" asset_custom_description: \"\" asset_custom_identifier: \"\" asset_custom_picture_url: null asset_custom_homepage_url: \"\" asset_uuid: \"as_75102bb757d384d2cd10342e3a090cf9\" asset_selected_machine_dashboard_id: null asset_department_id: 1 asset_current_operation_id: 1 node_id: 23 node_uuid: \"dev_ff6c65d0_0ece_11ed_89e8_860af15e50fe\" node_name: \"dev_ff6c65d0\" node_last_heard: \"2022-10-18T04:17:29.514386\" node_created_at: \"2022-10-14T22:56:06.438655\" node_subscription_plan_id: 2031 node_stripe_subscription_item_id: null node_is_online: false node_vitals: null node_mac: \"84:f7:03:cc:c9:2c\" node_last_requested_at: \"2022-10-17T20:15:45.307597\" node_qr_code_uuid_set: true node_firmware_version: \"1.5\" node_context: object node_asset_id: 60 node_device_id: 644"}}}}}}}},"/v1/nodes/{node_uuid}/asset":{"put":{"summary":"Set asset of node","description":"Set the asset of a node","tags":["Nodes","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/productions":{"post":{"summary":"Creat production project","description":"Creates a production project for an organization","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"production_name":{"type":"string","name":"production_name","propertyRow":true},"production_description":{"type":"string","name":"production_description","propertyRow":true},"production_start_date":{"type":"string","name":"production_start_date","propertyRow":true},"production_end_date":{"name":"production_end_date","propertyRow":true},"operations":{"type":"array","items":{"type":"string","format":"{\"operation_uuid\": \"op_c3f1bf1b7f2809b02e6a326166f4d98d\", \"operation_quantity\": 12}","propertyRow":true},"name":"operations","propertyRow":true}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get production projects","description":"Retrieves the productions of an organization","tags":["Productions","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"production_uuid":{"type":"string"},"production_name":{"type":"string"},"production_description":{"type":"string"},"production_start_date":{"type":"string"},"production_end_date":{"type":"string"},"production_parts":{"type":"array","items":{"type":"string","format":"{\"part_id\":1,\"part_name\":\"\",\"part_description\":\"\",\"part_picture_url\":\"\",\"part_uuid\":\"\",\"part_tags\":\"\"}"}},"production_time_progress_percentage":{"type":"number"}}}}}}},"/v1/organizations/{organization_uuid}/departments":{"get":{"summary":"Get departments","description":"Retrieves the departments of an organization","tags":["Organizations","Departments"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"department_name":{"type":"string"},"department_uuid":{"type":"string"}}}}}},"post":{"summary":"Create department","description":"Creates a department for an organization","tags":["Organizations","Departments"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"department_name":{"type":"string","name":"department_name","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"department_uuid":{"type":"string","format":"dp_xxxxxxxxxxxx","name":"department_uuid","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/organization_assets/tags":{"get":{"summary":"Get asset tags","description":"Returns tags of the assets in an organization","tags":["Organizations","Assets","SenseAI","Tags"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tag_key":{"type":"string"},"tag_value":{"type":"string"}}}}}}},"/v1/departments/{department_uuid}":{"put":{"summary":"Rename department","description":"Renames a department","tags":["Organizations","Departments"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"department_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"department_uuid":{"type":"string","format":"dp_xxxxxxxxxxxx"}}}}}},"delete":{"summary":"Delete department","description":"Deletes a department","tags":["Organizations","Departments"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"department_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"department_uuid":{"type":"string","format":"dp_xxxxxxxxxxxx"}}}}}}},"/v1/iotflows/device-management/registration/nodes/{node_uuid}/assign/senseai":{"post":{"summary":"Assign SenseAI Node","description":"Assigns a SenseAI Node to an organization","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_uuid":{"type":"string","name":"organization_uuid","propertyRow":true},"node_name":{"type":"string","name":"node_name","propertyRow":true},"subscription_plan_identifier":{"type":"string","format":"senseai-node-monthly or senseai-node-yearly","name":"subscription_plan_identifier","propertyRow":true},"device_uuid":{"type":"string","format":"optional","name":"device_uuid","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/iotflows/device-management/registration/nodes/{node_uuid}/assign":{"delete":{"summary":"Unassign SenseAI Node","description":"Unassigns a SenseAI Node from an organization","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/productions/{production_uuid}":{"delete":{"summary":"Delete production project","description":"Deletes a production project","tags":["Productions","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"production_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Edit production project","description":"Edits a production project and its related parts","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"production_name":{"type":"string"},"production_description":{"type":"string"},"production_start_date":{"type":"string"},"production_end_date":{},"operations":{"type":"array","items":{"type":"string","format":"{\"operation_uuid\": \"op_c3f1bf1b7f2809b02e6a326166f4d98d\", \"operation_quantity\": 12}"}}}}},{"name":"production_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/productions/parts-operations-assets-calculations":{"get":{"summary":"Get production parts operations assets calculations","description":"Retrieves the production parts-operations-assets calculations for an organization","tags":["Productions","Parts","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"departments","in":"query","required":false,"type":"string"},{"name":"machine_types","in":"query","required":false,"type":"string"},{"name":"tags","in":"query","required":false,"type":"string"},{"name":"sort_by","in":"query","required":false,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"parts":{"type":"array","items":{"type":"string","format":"{part_uuid, part_name, opereation_cycle_time_s, operation_count, operations: [{operation_uuid, operation_name, opereation_cycle_time_s, operation_count,  assets: [{asset_uuid, asset_name, opereation_cycle_time_s, operation_count, asset_operation_shift_goal_count}]}]}","propertyRow":true},"name":"parts","propertyRow":true},"ontime_part_count":{"type":"number","name":"ontime_part_count","propertyRow":true},"delayed_part_count":{"type":"number","name":"delayed_part_count","propertyRow":true},"ontime_operation_count":{"type":"number","name":"ontime_operation_count","propertyRow":true},"delayed_operation_count":{"type":"number","name":"delayed_operation_count","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/machine_types":{"get":{"summary":"Get machine types","description":"Retrieves the machine types used in an organization","tags":["Organizations","Assets"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"machine_type":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/productions/tags":{"get":{"summary":"Get productions tags","description":"Retrieves the tags of assets and parts in production of an organization","tags":["Organizations","Assets","Productions","Parts","Tags"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tag_value":{"type":"string"}}}}}}},"/v1/users/darkmode":{"put":{"summary":"Change user dark mode preference","description":"Changes the preference of the user for dark mode","tags":["Users"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"user_prefers_dark_mode":{"type":"boolean"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/shifts":{"get":{"summary":"Get shifts","description":"Retrieves the shifts and time zone of an organization","tags":["Organizations","Shifts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"","schema":{"properties":{"shift_name":{"type":"string"},"shift_start_time":{"type":"string"},"shift_end_time":{"type":"string"},"total_shift_s":{"type":"integer","format":"68400"},"shift_days":{"type":"array","items":{"type":"string","format":"'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'"}},"organization_time_zone":{"type":"string","format":"Etc/GMT+12"}}}}}},"put":{"summary":"Set shifts and time zone","description":"Sets the shifts and timezone of the organization","tags":["Organizations","Shifts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"shifts":{"type":"array","items":{"type":"string","format":"{shift_name: \"Second Shift\", shift_start_time: \"17:00:00\", shift_end_time: \"01:00:00\", shift_days: [\"Monday\", \"Tuesday\"]}"}},"organization_time_zone":{"type":"string","format":"Etc/GMT+12"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/shifts/current":{"get":{"summary":"Get shift info","description":"Retrieves the current or other shift's details of an organization","tags":["Organizations","Shifts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"","schema":{"properties":{"shift_name":{"type":"string","format":"First Shift","name":"shift_name","propertyRow":true},"shift_day":{"type":"string","format":"Thursday","name":"shift_day","propertyRow":true},"shift_start_time":{"type":"string","format":"19:00:00","name":"shift_start_time","propertyRow":true},"shift_end_time":{"type":"string","format":"01:00:00","name":"shift_end_time","propertyRow":true},"shift_start_timestamp":{"type":"string","format":"2022-10-27T19:00:00.000Z","name":"shift_start_timestamp","propertyRow":true},"shift_end_timestamp":{"type":"string","format":"2022-10-28T01:00:00.000Z","name":"shift_end_timestamp","propertyRow":true},"passed_shift_s":{"type":"number","format":"11669.480173","name":"passed_shift_s","propertyRow":true},"total_shift_s":{"type":"number","format":"21600","name":"total_shift_s","propertyRow":true},"progress":{"type":"number","format":"0.540253711712963","name":"progress","propertyRow":true},"current_time_tz":{"type":"string","format":"22:14:29.480173-04","name":"current_time_tz","propertyRow":true},"current_timestamp_tz":{"type":"string","format":"2022-10-27T22:14:29.480Z","name":"current_timestamp_tz","propertyRow":true}}},"code":"200"}}}},"/v1/organization_assets/{asset_uuid}":{"delete":{"summary":"Delete organization asset","description":"Deletes an organization asset","tags":["Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Edit organization asset","description":"Edits an organization asset for name, identifier, tags, and department","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_custom_name":{"type":"string"},"asset_custom_identifier":{"type":"string"},"department_uuid":{"type":"string"},"tags":{"type":"string","format":"comma separated tags"},"cascading_group_uuid":{"type":"string"},"asset_cascading_order":{"type":"integer"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get organization asset","description":"Returns an organization_assets information","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"asset_last_activity_finished_at":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"},"organization_uuid":{"type":"string"},"organization_name":{"type":"string"},"organization_description":{"type":"string"},"department_name":{"type":"string"},"node_uuid":{"type":"string"},"node_name":{"type":"string"},"node_last_heard":{"type":"string"},"node_is_online":{"type":"boolean"},"device_is_online":{"type":"boolean"}}}}}}},"/v1/organization_assets/{asset_uuid}/archive":{"put":{"summary":"Archive organization asset","description":"Archives an organization asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_is_archived":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/tvs/{tv_uuid}/url":{"put":{"summary":"Set TV URL","description":"Sets a new url for a TV","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"url":{"type":"string"},"tv_zoom_level":{"type":"number","format":"0.9"}}}},{"name":"tv_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/tvs":{"post":{"summary":"Add TV","description":"Adds a new TV to an organization","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"key":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tv_uuid":{"type":"string"}}}}}},"get":{"summary":"Get TVs","description":"Retrieves the TVs of an organization","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"key":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tv_uuid":{"type":"string"},"tv_name":{"type":"string"},"tv_url":{"type":"string"}}}}}}},"/v1/tvs/{tv_uuid}":{"put":{"summary":"Change TV name","description":"Changes the name of the TV","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"tv_name":{"type":"string"}}}},{"name":"tv_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete TV","description":"Deletes a TV","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"tv_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get TV info","description":"Retrieves the info of a TV","tags":["SenseAI","TV"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"tv_name":{"type":"string"}}}},{"name":"tv_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tv_name":{"type":"string"},"tv_url":{"type":"string"}}}}}}},"/v1/demo/login":{"get":{"summary":"Get device actions","description":"Returns the actions of a device","tags":["Devices","Actions"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"device_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"action_uuid":{"type":"string"},"action_name":{"type":"string"},"action_description":{"type":"string"}}}}}}},"/v1/organization_assets/{asset_uuid}/notifications/down/preference":{"put":{"summary":"Update down notification preference","description":"Updates the notification preference of a user when asset goes down","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_downtime_subscribers_is_email_subscribed":{"type":"boolean","name":"asset_downtime_subscribers_is_email_subscribed","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get down notification preference","description":"Retrieves the downtime notification preferences of a user for an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_downtime_subscribers_is_email_subscribed":{"type":"boolean","name":"asset_downtime_subscribers_is_email_subscribed","propertyRow":true}}},"code":"200"}}}},"/v1/organization_assets/{asset_uuid}/notifications/down/setting":{"put":{"summary":"Update down notification downtime","description":"Updates the downtime period for an asset to publish an alert","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_alert_downtime_after_min":{"type":"number","format":"30","name":"asset_alert_downtime_after_min","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/downtime_categories":{"get":{"summary":"Get downtime categories","description":"Retrieves the downtime categories of an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_id":{"type":"integer","name":"downtime_category_id","propertyRow":true},"downtime_category_name":{"type":"string","name":"downtime_category_name","propertyRow":true},"production_description":{"type":"string","name":"production_description","propertyRow":true},"downtime_category_severity_id":{"type":"integer","name":"downtime_category_severity_id","propertyRow":true},"downtime_severity_name":{"type":"string","name":"downtime_severity_name","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create downtime categories","description":"Creates a downtime category for an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"downtime_category_name":{"type":"string"},"downtime_category_severity_id":{"type":"number"},"downtime_category_tailwind_id":{"type":"integer"},"downtime_category_requires_additional_note":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/downtime_categories/{downtime_category_id}":{"delete":{"summary":"Archive downtime categories","description":"Archives a downtime category of an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"downtime_category_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Update downtime categories","description":"Updates the name of a downtime category","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"downtime_category_id","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"downtime_category_name":{"type":"string"},"downtime_category_tailwind_id":{"type":"integer"},"downtime_category_requires_additional_note":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/downtime/{downtime_id}/classify":{"put":{"summary":"Classify downtime","description":"Classifies a downtime","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"downtime_downtime_category_id":{"type":"integer","name":"downtime_downtime_category_id","propertyRow":true},"downtime_note":{"type":"string","name":"downtime_note","propertyRow":true}}}},{"name":"downtime_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/assets/{asset_uuid}/downtimes":{"get":{"summary":"Get asset unclassified downtimes","description":"Retrieves the downtimes of an asset that havne't been classified","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer","name":"downtime_id","propertyRow":true},"downtime_asset_id":{"type":"integer","name":"downtime_asset_id","propertyRow":true},"downtime_start_timestamp":{"type":"string","name":"downtime_start_timestamp","propertyRow":true},"downtime_end_timestamp":{"type":"string","name":"downtime_end_timestamp","propertyRow":true},"downtime_categorized_by":{"type":"string","name":"downtime_categorized_by","propertyRow":true},"downtime_categorized_at":{"type":"string","name":"downtime_categorized_at","propertyRow":true},"downtime_note":{"type":"string","name":"downtime_note","propertyRow":true},"downtime_category_id":{"type":"integer","name":"downtime_category_id","propertyRow":true},"downtime_category_name":{"type":"string","name":"downtime_category_name","propertyRow":true},"downtime_category_severity_id":{"type":"integer","name":"downtime_category_severity_id","propertyRow":true},"downtime_severity_name":{"type":"string","name":"downtime_severity_name","propertyRow":true},"downtime_category_is_archived":{"type":"boolean","name":"downtime_category_is_archived","propertyRow":true},"downtime_diration_s":{"type":"integer","name":"downtime_diration_s","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/downtimes/summary":{"get":{"summary":"Get asset summary downtimes","description":"Retrieves the summary downtimes of an asset per category or severity for a given period","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"by","required":false,"type":"string","format":"category or severity"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer","name":"downtime_id","propertyRow":true},"downtime_asset_id":{"type":"integer","name":"downtime_asset_id","propertyRow":true},"downtime_start_timestamp":{"type":"string","name":"downtime_start_timestamp","propertyRow":true},"downtime_end_timestamp":{"type":"string","name":"downtime_end_timestamp","propertyRow":true},"downtime_categorized_by":{"type":"string","name":"downtime_categorized_by","propertyRow":true},"downtime_categorized_at":{"type":"string","name":"downtime_categorized_at","propertyRow":true},"downtime_note":{"type":"string","name":"downtime_note","propertyRow":true},"downtime_category_id":{"type":"integer","name":"downtime_category_id","propertyRow":true},"downtime_category_name":{"type":"string","name":"downtime_category_name","propertyRow":true},"downtime_category_severity_id":{"type":"integer","name":"downtime_category_severity_id","propertyRow":true},"downtime_severity_name":{"type":"string","name":"downtime_severity_name","propertyRow":true},"downtime_category_is_archived":{"type":"boolean","name":"downtime_category_is_archived","propertyRow":true},"downtime_diration_s":{"type":"integer","name":"downtime_diration_s","propertyRow":true}}},"code":"200"}}}},"/v1/nodes/{node_uuid}/sensitivity":{"put":{"summary":"Set node sensitivity","description":"Sets the sensitivity value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_sensitivity":{"type":"number","name":"node_sensitivity","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/nodes/{node_uuid}/momentum":{"put":{"summary":"Set node momentum","description":"Sets the momentum value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_momentum":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organization_assets/{asset_uuid}/notifications/up/preference":{"put":{"summary":"Update up notification preference","description":"Updates the notification preference of a user when asset goes back up","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_downtime_subscribers_asset_up_is_email_subscribed":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get up notification preference","description":"Retrieves the up notification preferences of a user for an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_downtime_subscribers_asset_up_is_email_subscribed":{"type":"boolean"}}}}}}},"/v1/organizations/{organization_uuid}/productions/operations-assets":{"get":{"summary":"Get production operations assets","description":"Retrieves the production operations-assets for an organization","tags":["Productions","Parts","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"departments","in":"query","required":false,"type":"string"},{"name":"machine_types","in":"query","required":false,"type":"string"},{"name":"tags","in":"query","required":false,"type":"string"},{"name":"sort_by","in":"query","required":false,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operations":{"type":"array","items":{"type":"string","format":"{operations: [{operation_uuid, operation_name, opereation_cycle_time_s, operation_count,  assets: [{asset_uuid, asset_name, opereation_cycle_time_s, operation_count, asset_operation_shift_goal_count}]}"}},"ontime_operation_count":{"type":"number"},"delayed_operation_count":{"type":"number"}}}}}}},"/v1/organizations/{organization_uuid}/nodes-assets":{"get":{"summary":"Get asset-node of SenseAI","description":"Returns the assets and their connected SenseAI nodes of an organization","tags":["Assets","Nodes","Gateways","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"device_uuid":{"type":"string"},"device_name":{"type":"string"},"asset_id":{"type":"integer"},"asset_custom_name":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"node_id":{"type":"integer"},"node_uuid":{"type":"string"},"node_name":{"type":"string"},"node_last_heard":{"type":"string"},"node_created_at":{"type":"string"},"node_is_online":{"type":"boolean"},"node_vitals":{"type":"string"},"node_mac":{"type":"string"},"node_last_requested_at":{"type":"string"},"node_firmware_version":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/wifis":{"get":{"summary":"Get WiFis","description":"Retrieves the saved WiFis of an organization","tags":["SenseAI","WiFi"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"wifi_uuid":{"type":"string"},"wifi_ssid":{"type":"string"},"wifi_password":{"type":"string"},"wifi_created_at":{"type":"string"}}}}}},"post":{"summary":"Create WiFi","description":"Creates a WiFi credentials record for an organization","tags":["SenseAI","WiFi"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"wifi_ssid":{"type":"string","name":"wifi_ssid","propertyRow":true},"wifi_password":{"type":"string","name":"wifi_password","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/wifis/{wifi_uuid}":{"delete":{"summary":"Delete WiFi credentials","description":"Deletes a WiFi credentials record of an organization","tags":["SenseAI","WiFi"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"wifi_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/iotflows/device-management/registration/nodes/{node_uuid}/assign/senseai-and-asset":{"post":{"summary":"Assign SenseAi and Create Asset","description":"Assigns a SenseAI Node to an organization","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_uuid":{"type":"string"},"node_name":{"type":"string"},"subscription_plan_identifier":{"type":"string","format":"senseai-node-monthly or senseai-node-yearly"},"device_uuid":{"type":"string","format":"optional"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/replace-wifi":{"post":{"summary":"Replace Node WiFi","description":"Replaces the WiFi credentials of a SenseAi node","tags":["SenseAI","WiFi"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"wifi_ssid":{"type":"string","name":"wifi_ssid","propertyRow":true},"wifi_password":{"type":"string","name":"wifi_password","propertyRow":true}}}},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/nodes/{node_uuid}/asset-unassign":{"put":{"summary":"Unassign Node Asset","description":"Unassigns a SenseAI Node from an asset","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/reports":{"get":{"summary":"Get Reports","description":"Retrieves the weekly or yearly reports of an organization","tags":["SenseAI","Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"report_uuid":{"type":"string"},"report_name":{"type":"string"},"report_key":{"type":"string"}}}}}}},"/v1/reports/{report_uuid}":{"get":{"summary":"Get Report Link","description":"Retrieves a temporary authorized link to access a report","tags":["SenseAI","Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"report_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"report_link":{"type":"string","name":"report_link","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/report_subscription":{"put":{"summary":"Change Report Subscription","description":"Subscribe or unsubscribe from receiving weekly reports","tags":["SenseAI","Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"report_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"is_user_subscribed_to_weekly_reports":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/user":{"get":{"summary":"Get organization user","description":"Retreives the user's information in an organization such as first name, last name, email, phone, more","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_phone_number":{"type":"string"},"user_image_url":{"type":"string"},"user_username":{"type":"string"},"user_is_mfa_enabled":{"type":"boolean"}}}}}}},"/v1/users/listview":{"put":{"summary":"Change user list view preference","description":"Changes the preference of the user for list vs card view","tags":["Users"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"user_prefers_list_view":{"type":"boolean","name":"user_prefers_list_view","propertyRow":true}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/nodes/{node_uuid}/shock_threshold":{"put":{"summary":"Set node shock threshold","description":"Sets the shock threshold value (2.0-3.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_shock_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organization_assets/{asset_uuid}/notifications/shock/preference":{"put":{"summary":"Update shock notification preference","description":"Updates the notification preference of a user when asset is shocked","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_shock_subscribers_is_email_subscribed":{"type":"boolean","name":"asset_shock_subscribers_is_email_subscribed","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get shock notification preference","description":"Retrieves the shock notification preferences of a user for an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_shock_subscribers_is_email_subscribed":{"type":"boolean"}}}}}}},"/v1/organizations/{organization_uuid}/webhooks":{"get":{"summary":"Get Webhooks","description":"Retrieves the webhooks of an organization","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"webhook_id":{"type":"number"},"webhook_uuid":{"type":"string"},"webhook_url":{"type":"string"},"webhook_description":{"type":"string"},"webhook_version":{"type":"string"},"webhook_secret":{"type":"string"}}}}}},"post":{"summary":"Create Webhook","description":"Creates a webhook for an organization","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"webhook_url":{"type":"string"},"webhook_description":{"type":"string"},"webhook_version":{"type":"string"},"webhook_secret":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/webhooks/{webhook_uuid}":{"delete":{"summary":"Delete Webhook","description":"Deletes a webhook record from an organization","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"wifi_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Update Webhook","description":"Update the parameters of a webhook","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"webhook_url":{"type":"string"},"webhook_description":{"type":"string"},"webhook_version":{"type":"string"},"webhook_secret":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/webhooks/{webhook_uuid}/subscriptions":{"get":{"summary":"Get Webhook Subscriptions","description":"Retrieves the subscriptions of a webhook","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"webhook_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"webhook_event_id":{"type":"number"},"webhook_event_name":{"type":"string"},"webhook_subscription_is_subscribed":{"type":"boolean"}}}}}},"put":{"summary":"Update Webhook Subscriptions","description":"Update the events subscriptions of a webhook","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"webhook_event_name":{"type":"string","name":"webhook_event_name","propertyRow":true},"webhook_subscription_is_subscribed":{"type":"boolean","name":"webhook_subscription_is_subscribed","propertyRow":true}}}},{"name":"webhook_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/webhooks_events":{"get":{"summary":"Get Webhook Events","description":"Retrieves the supporting webhook events of the platform","tags":["Webhook"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"webhook_event_id":{"type":"number"},"webhook_event_name":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/logs":{"get":{"summary":"Get organization logs","description":"Retrieves the logs of the organization","tags":["Organizations","Logs"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"log_message":{"type":"string"},"log_timestmp":{"type":"string"},"log_http_request_method_name":{"type":"string"},"log_http_request_url":{"type":"string"},"log_http_request_payload":{"type":"string"},"log_resource_uuid":{"type":"string"},"log_resource_before":{"type":"number"},"log_resource_after":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/downtimes":{"get":{"summary":"Get assets downtimes","description":"Retrieves the downtimes of all assets of the organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"downtime_severity_uuids","required":false,"type":"string","format":"sev_none sev_low sev_medium sev_high"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"departments","required":false,"type":"string"},{"name":"","in":"query","description":"only_with_notes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer"},"downtime_asset_id":{"type":"integer"},"downtime_start_timestamp":{"type":"string"},"downtime_end_timestamp":{"type":"string"},"downtime_categorized_by":{"type":"string"},"downtime_categorized_at":{"type":"string"},"downtime_note":{"type":"string"},"downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"downtime_category_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"},"downtime_category_is_archived":{"type":"boolean"},"downtime_diration_s":{"type":"integer"}}}}}}},"/v1/organizations/{organization_uuid}/downtimes/summary":{"get":{"summary":"Get organization assets summary downtimes","description":"Retrieves the summary downtimes of all assets per category or severity for a given period","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"by","required":false,"type":"string","format":"category or severity"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer"},"downtime_asset_id":{"type":"integer"},"downtime_start_timestamp":{"type":"string"},"downtime_end_timestamp":{"type":"string"},"downtime_categorized_by":{"type":"string"},"downtime_categorized_at":{"type":"string"},"downtime_note":{"type":"string"},"downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"downtime_category_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"},"downtime_category_is_archived":{"type":"boolean"},"downtime_diration_s":{"type":"integer"}}}}}}},"/v1/organizations/{organization_uuid}/addresses":{"get":{"summary":"Get addresses","description":"Get the addresses of an organization","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"address_person_name":{"type":"string"},"address_company_name":{"type":"string"},"address_phone_number":{"type":"string"},"address_email":{"type":"string"},"address_country":{"type":"string"},"address_zip_code":{"type":"string"},"address_state":{"type":"string"},"address_city":{"type":"string"},"address_street_line_1":{"type":"string"},"address_street_line_2":{"type":"string"},"address_is_residential":{"type":"boolean"},"address_name":{"type":"string"},"address_created_at":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/advanced_reporting":{"get":{"summary":"Get advanced utilization reports of the organization","description":"Retrieves advanced utilization reports of the organization based on different queries","tags":["SenseAI","Reports"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Shift 1"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"06:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"string","format":"false"},{"name":"shift_by_min","in":"query","required":false,"type":"string","format":"0"},{"name":"from","in":"query","required":false,"type":"string","format":"2024-01-07T05:00:00.000Z"},{"name":"to","in":"query","required":false,"type":"string","format":"2024-01-14T04:59:59.999Z"},{"name":"group_by_advanced","in":"query","required":false,"type":"string","format":"department"},{"name":"machines","in":"query","required":false,"type":"string","format":"asset_uuid"},{"name":"sort_by_advanced","in":"query","required":false,"type":"string","format":"performance_high_low"},{"name":"time_period","in":"query","required":false,"type":"string","format":"yearly"},{"name":"show_percentage","in":"query","required":false,"type":"string","format":"true"},{"name":"shift_entire_day","in":"query","required":false,"type":"string","format":"true"},{"name":"exclude_none_in_oee","in":"query","required":false,"type":"string","format":"true"},{"name":"exclude_unknown_in_oee","in":"query","required":false,"type":"string","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"departments":{"type":"string","format":"{ no_department :  [{department_group: \"no_department\", department_name: \"Production\", asset_id: 3742,…},…]|"},"total_downtime_hours":{"type":"string","format":"675.82"},"total_unknown_hours":{"type":"string","format":"0"},"total_uptime_hours":{"type":"string","format":"1445.30"},"total_utilization_percentage":{"type":"string","format":"68.14"},"total_utilizations":{"type":"string","format":"{   \"periods\": [     \"2025-11-11T05:00:00+00:00\",     \"2025-11-12T05:00:00+00:00\",     \"2025-11-13T05:00:00+00:00\",     \"2025-11-14T05:00:00+00:00\",     \"2025-11-15T05:00:00+00:00\",     \"2025-11-16T05:00:00+00:00\",     \"2025-11-17T05:00:00+00:00\",     \"2025-11-18T05:00:00+00:00\"   ],   \"categories\": [     \"Tue Nov 11\",     \"Wed Nov 12\",     \"Thu Nov 13\",     \"Fri Nov 14\",     \"Sat Nov 15\",     \"Sun Nov 16\",     \"Mon Nov 17\",     \"Tue Nov 18\"   ],   \"uptime_hours\": [     179.31,     180.23,     179.08,     180.66,     180.3,     180.09,     185.26,     180.37   ],   \"unknown_hours\": [     0,     0,     0,     0,     0,     0,     0,     0   ],   \"downtime_hours\": [     84.69,     83.77,     84.92,     83.34,     83.7,     83.91,     87.82,     83.67   ],   \"uptime_percentages\": [     67.92,     68.27,     67.83,     68.43,     68.3,     68.22,     67.84,     68.31   ],   \"unknown_percentages\": [     0,     0,     0,     0,     0,     0,     0,     0   ],   \"downtime_percentages\": [     32.08,     31.73,     32.17,     31.57,     31.7,     31.78,     32.16,     31.69   ] }"}}}}}}},"/v1/organizations/{organization_uuid}/organization_assets_grouped":{"get":{"summary":"Get grouped assets of organization","description":"Returns assets of an organizations grouped by department","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"departments":{"type":"string","format":"[{}]"}}}}}}},"/v1/users/view":{"put":{"summary":"Change user view preference","description":"Changes the view preference of the user (list, card, large card)","tags":["Users"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"view_name":{"type":"string","format":"card_view or list_view or card_large_view or card_oee_large_view"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/vibration_upper_threshold":{"put":{"summary":"Set node vibration_upper_threshold","description":"Sets the vibration_upper_threshold value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_vibration_upper_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/vibration_lower_threshold":{"put":{"summary":"Set node vibration_lower_threshold","description":"Sets the vibration_lower_threshold value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"vibration_lower_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/vibration_momentum":{"put":{"summary":"Set node vibration_momentum","description":"Sets the vibration_momentum value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_vibration_momentum":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/acoustic_upper_threshold":{"put":{"summary":"Set node acoustic_upper_threshold","description":"Sets the acoustic_upper_threshold value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_acoustic_upper_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/acoustic_lower_threshold":{"put":{"summary":"Set node acoustic_lower_threshold","description":"Sets the acoustic_lower_threshold value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_acoustic_lower_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/acoustic_momentum":{"put":{"summary":"Set node acoustic_momentum","description":"Sets the acoustic_momentum value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_acoustic_momentum":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/analysis_mode":{"put":{"summary":"Set node analysis_mode","description":"Sets the analysis_mode value (0.0-1.0) for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_analysis_mode":{"type":"integer","format":"0: VIBRATION, 1: ACOUSTIC, 2: VIBRATION_ACOUSTIC"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/calibration_request":{"post":{"summary":"Request or stop calibration","description":"Requests a SenseAi Node to start or stop publishing for a maximum of 10s","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"should_publish_calibration":{"type":"boolean"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/histocal_production":{"get":{"summary":"Get advanced production reports of the organization","description":"Retrieves advanced production reports of the organization based on different queries","tags":["SenseAI","Reports"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"production_description":{"type":"string"},"downtime_category_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"}}}}}}},"/v1/nodes/{node_uuid}/reset_shock_accel_zero_offset":{"put":{"summary":"Reset node zero offset","description":"Resets the zero offset for the shock monitoring accelerometer for SenseAi","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"reset_shock_accel_zero_offset":{"type":"boolean","format":"true"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/operation":{"put":{"summary":"Set operation of asset","description":"Set the current operation running on an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"operation_uuid":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/operations":{"get":{"summary":"Get operations","description":"Retrieves the operations and parts of an organization","tags":["Operations","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"},"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"operation_cycle_time":{"type":"number"},"operation_stdev":{"type":"number"},"operation_operation_detection_algorithm_id":{"type":"integer"}}}}}}},"/v1/parts/{part_uuid}/operations":{"post":{"summary":"","description":"","tags":[],"consumes":[],"produces":[],"deprecated":true,"parameters":[],"responses":{}},"get":{"summary":"Get part operations","description":"Retrieves the operations of a part","tags":["Operations","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/parts":{"get":{"summary":"Get parts","description":"Retrieves the parts of an organization","tags":["Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","description":"Searching through part_name, operation_name, and operation_description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"part_tags":{"type":"string","format":"comma separated tags"},"part_sky":{},"part_unit":{},"part_type_uuid":{},"part_reorder_point":{},"on_hand_quantity":{"type":"number"},"reserved_quantity":{"type":"number"},"available_quantity":{"type":"number"}}}}}},"post":{"summary":"","description":"","tags":[],"consumes":[],"produces":[],"deprecated":true,"parameters":[],"responses":{}}},"/v1/parts/{part_uuid}":{"delete":{"summary":"Delete part","description":"Deletes a part","tags":["Organizations","Productions","Parts"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"","description":"","tags":[],"consumes":[],"produces":[],"deprecated":true,"parameters":[],"responses":{}}},"/v2/organizations/{organization_uuid}/parts":{"post":{"summary":"Creat part","description":"Creates a part for an organization","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer"}},"part_sku":{"type":"string"},"part_unit":{"type":"string"},"part_reorder_point":{"type":"number"},"part_requires_pieces":{"type":"boolean"},"part_is_a_piece_of_part_uuid":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string"},"operation_uuid":{"type":"string"}}}}}}},"/v2/parts/{part_uuid}":{"put":{"summary":"Edit part","description":"Edits the part and its tags and opereations","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer"}},"part_sku":{"type":"string"},"part_unit":{"type":"string"},"part_reorder_point":{"type":"number"},"part_type_uuid":{"type":"string","format":"PT_MANUFACTURED or PT_PURCHASED"}}}},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get parts","description":"Retrieves the information of a part","tags":["Parts"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","description":"Searching through part_name, operation_name, and operation_description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"part_tags":{"type":"string","format":"comma separated tags"},"part_sky":{},"part_unit":{},"part_type_uuid":{},"part_reorder_point":{},"on_hand_quantity":{"type":"number"},"reserved_quantity":{"type":"number"},"available_quantity":{"type":"number"}}}}}}},"/v2/parts/{part_uuid}/operations":{"post":{"summary":"Creat operation","description":"Creates an operation for a part","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_cycle_time":{"type":"number"},"operation_stdev":{"type":"number"},"operation_operation_detection_algorithm_id":{"type":"integer","format":"100"}}}},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get part operations","description":"Retrieves the operations of a part","tags":["Operations","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"}}}}}}},"/v1/assets/{asset_uuid}/operations/{operation_uuid}/hourly-count":{"get":{"summary":"Get asset-operation hourly counts","description":"Retrieves the hourly operation counts of an asset","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"operation_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{hr: \"2022-10-31T23:00:00.000Z\", operation_process_time_s: 2.91, operation_count: 2, operation_cycle_time_s: 2.5}"}},"asset_operation_count":{"type":"number"},"asset_operation_process_time_s":{"type":"number"},"asset_operation_cycle_time_s":{"type":"number"},"asset_operation_shift_goal_count":{"type":"number"},"asset_operation_cycle_per_hour":{"type":"number"}}}}}}},"/v1/operations/{operation_uuid}/hourly-count":{"get":{"summary":"Get operation hourly counts","description":"Retrieves the hourly operation counts of an operation","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operation_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{hr: \"2022-10-31T23:00:00.000Z\", operation_process_time_s: 2.91, operation_count: 2, operation_cycle_time_s: 2.5}"}},"operation_count":{"type":"number"},"operation_process_time_s":{"type":"number"},"operation_cycle_time_s":{"type":"number"},"operation_shift_goal_count":{"type":"number"},"operation_cycle_per_hour":{"type":"number"}}}}}}},"/v1/parts/{part_uuid}/hourly-count":{"get":{"summary":"Get part hourly counts","description":"Retrieves the hourly operation counts of a part","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"part_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"array","items":{"type":"string","format":"{hr: \"2022-10-31T23:00:00.000Z\", operation_process_time_s: 2.91, operation_count: 2, operation_cycle_time_s: 2.5}"}},"part_made_count":{"type":"number"},"part_made_cycle_time_s":{"type":"number"},"part_shift_goal_count":{"type":"number"},"part_made_cycle_per_hour":{"type":"number"}}}}}}},"/v1/organizations/{organization_uuid}/parts/hourly-count":{"get":{"summary":"Get parts hourly counts","description":"Retrieves the hourly operation counts of all parts in an organization","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"tags","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"parts":{"type":"array","items":{"type":"string","format":"{part_id: \"1\", part_name: \"Part A\", part_description: \"Gear for gearboxA\", part_uuid: \"part_c3f1bf1b7f2809b02e6a326166f4d98d\", hours: { hr: \"2022-10-17T23:00:00.000Z\", part_made_cycle_time_s: 1106.74, part_made_count: 5 }}"}}}}}}}},"/v1/assets/{asset_uuid}/operations/{operation_uuid}/shift_goal":{"post":{"summary":"Set asset-operation goal","description":"Sets the operation count goal of an asset for a given operation","tags":["Productions","Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_operation_shift_goal_count":{"type":"number"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/total-hourly-count":{"get":{"summary":"Get asset total hourly counts","description":"Retrieves the hourly counts of all operations of an asset","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"total_operation_count":{"type":"number","format":"307","name":"total_operation_count","propertyRow":true},"total_asset_shift_goal_count":{"type":"number","format":"75","name":"total_asset_shift_goal_count","propertyRow":true},"total_hourly_count":{"type":"array","items":{"type":"string","format":"hr: \"2022-11-07T22:00:00.000Z\", average_operation_process_time_s: 2.8384370803833, average_operation_cycle_time_s: 90.0058135986328, total_operation_count: 37, total_asset_shift_goal_count: 85","propertyRow":true},"name":"total_hourly_count","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/operations/hourly-count":{"get":{"summary":"Get operations hourly counts","description":"Retrieves the hourly operation counts of all parts in an organization","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":true,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"tags","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operations":{"type":"array","items":{"type":"string","format":"{operation_id: \"1\", operation_name: \"op_123\", part_id: \"1\", part_name: \"Part A\", part_description: \"Gear for gearboxA\", part_uuid: \"part_c3f1bf1b7f2809b02e6a326166f4d98d\", hours: { hr: \"2022-10-17T23:00:00.000Z\", part_made_cycle_time_s: 1106.74, operation_made_count: 5 }}"}}}}}}}},"/v1/organizations/{organization_uuid}/productions-progress":{"get":{"summary":"Get productions progress","description":"Retrieves the counts of parts, operations, and assets of productions in an organization","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"active_projects","in":"query","description":"Only show active projects","required":false,"type":"boolean"},{"name":"products","in":"query","required":false,"type":"string"},{"name":"sort_by","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"productions":{"type":"array","items":{"type":"string","format":"{production_total_part_count_required, sum_part_count, progress, parts:[{part_count, progress, operations: [{operation_count, progress, assets: [{asset_operation_count, progress}]}]}]}","propertyRow":true},"name":"productions","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/assets-insights":{"get":{"summary":"Get assets insights","description":"Retrieves the number of assets producing or down, and the hours of runtime and down time for an organization for a shift","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"total_running_seconds":{"type":"number","name":"total_running_seconds","propertyRow":true},"total_not_running_seconds":{"type":"number","name":"total_not_running_seconds","propertyRow":true},"assets_producting_count":{"type":"number","name":"assets_producting_count","propertyRow":true},"assets_not_producing_count":{"type":"number","name":"assets_not_producing_count","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/current-operation":{"get":{"summary":"Get asset current operation","description":"Retrieves the current operation of an asset with its total count and average cycle time for the current shift","tags":["Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"},"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"operation_count":{"type":"number"},"operation_cycle_time_s":{"type":"number"},"operation_process_time_s":{"type":"number"}}}}}}},"/v1/organizations/{organization_uuid}/daily-oee":{"get":{"summary":"Get daily OEE","description":"Retrieves the OEE of the entire organization for every day for the entire day, for all shifts, or for a given shift","tags":["OEE","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Day Shift"},{"name":"calculate_oee_by","in":"query","required":false,"type":"string","format":"scheduled_shifts or 247"},{"name":"shift_date","in":"query","required":false,"type":"string"},{"name":"shift_start_time","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"today_oee":{"type":"number","format":"0.10837466931216931"},"oee_change":{"type":"number","format":"1.7981180730824096"},"oee_days":{"type":"array","items":{"type":"string","format":"{d: \"2022-11-08T00:00:00.000Z\", date: \"2022-11-08T00:00:00.000Z\", oee: \"0.10837466931216931217\"}"}},"last_oee":{"type":"number","format":"0.10837466931216931"},"oee":{"type":"array","items":{"type":"string","format":"{d: \"2022-11-08T00:00:00.000Z\", date: \"2022-11-08T00:00:00.000Z\", oee: \"0.10837466931216931217\"}"}}}}}}}},"/v1/assets/{asset_uuid}/activity-state":{"get":{"summary":"Get asset activity state","description":"Retrieves the state and last activity finished timestamp of an asset","tags":["Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"state":{"type":"string","format":"running or stopped"},"running_utilization_started_at":{"type":"string","format":"2022-11-09 04:20:31.926232"},"organization_assets_red_threshold_min":{"type":"number"},"organization_assets_orange_threshold_min":{"type":"number"},"asset_last_utilization_down_classified":{"type":"boolean"}}}}}}},"/v1/assets/{asset_uuid}/daily-runtime":{"get":{"summary":"Get asset daily runtime","description":"Retrieves the daily runtimes of an asset in a given/current shift","tags":["Assets","Runtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Day Shift"},{"name":"last_n_days","in":"query","required":false,"type":"integer","format":"7"},{"name":"from","in":"query","required":false,"type":"string"},{"name":"to","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string","format":"{\"d\":\"2023-09-27 06:00:00+00\", \"runtime_s\": 30622.90, \"downtime_s\": 55267.28, \"unknown_s\": 509.81}","name":"data","propertyRow":true},"total_runtime_s":{"type":"number","format":"86400","name":"total_runtime_s","propertyRow":true},"total_downtime_s":{"type":"number","format":"86400","name":"total_downtime_s","propertyRow":true},"total_unknown_s":{"type":"number","format":"0","name":"total_unknown_s","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/operation-activities":{"get":{"summary":"Get asset activities","description":"Retrieves the historical operation activities for an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string","name":"part_uuid","propertyRow":true},"part_name":{"type":"string","name":"part_name","propertyRow":true},"part_description":{"type":"string","name":"part_description","propertyRow":true},"part_picture_url":{"type":"string","name":"part_picture_url","propertyRow":true},"operation_uuid":{"type":"string","name":"operation_uuid","propertyRow":true},"operation_name":{"type":"string","name":"operation_name","propertyRow":true},"operation_description":{"type":"string","name":"operation_description","propertyRow":true},"activity_id":{"type":"number","name":"activity_id","propertyRow":true},"activity_started_at":{"type":"string","name":"activity_started_at","propertyRow":true},"activity_finished_at":{"type":"string","name":"activity_finished_at","propertyRow":true},"activity_count":{"type":"number","name":"activity_count","propertyRow":true}}},"code":"200"}}}},"/v1/utilizations/{utilization_id}":{"delete":{"summary":"Delete utilization","description":"Deletes an utilization for an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"activity_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"Edit operation utilization","description":"Edits an operation utilization of an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"operation_uuid":{"type":"string","format":"\"op_xxx\" or \"unclassified\""}}}},{"name":"utilization_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/search":{"get":{"summary":"Search organization","description":"Returns the url for different pages of the organization","tags":["Organizations","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":true,"type":"string","format":"search keywords"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"assets":{"type":"array","items":{"type":"string","format":"{\"url_path\": \"\", \"name\": \"\",\"description\": \"\",\"image_url\": \"\"}"}}}}}}}},"/v1/nodes/{node_uuid}/data/vibrations":{"get":{"summary":"Get node vibrations data","description":"Retreieves the historical vibrations data of a SenseAi node","tags":["Nodes","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"received_at":{"type":"string","format":"2023-02-03 20:11:42.704769"},"mean":{"type":"number"},"stdev":{"type":"number"},"rms":{"type":"number"},"data":{"type":"array","items":{"type":"number","format":""}},"tfm":{"type":"array","items":{"type":"number","format":"[timestamp, frequency, magnitude]"}}}}}}}},"/v1/nodes/{node_uuid}/data/vibrations_tfm":{"get":{"summary":"Get node vibrations tfm data","description":"Retreieves the time-frequency-magnitude vibrations data of a SenseAi node","tags":["Nodes","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tfm":{"type":"array","items":{"type":"number","format":"[timestamp, frequency, magnitude]"}}}}}}}},"/v1/organizations/{organization_uuid}/weekly-oee":{"get":{"summary":"Get weekly OEE","description":"Retrieves the OEE of the entire organization for every week for the entire day, for all shifts, or for a given shift","tags":["OEE","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Day Shift"},{"name":"calculate_oee_by","in":"query","required":false,"type":"string","format":"scheduled_shifts or 247"},{"name":"shift_date","in":"query","required":false,"type":"string"},{"name":"shift_start_time","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"last_oee":{"type":"number","format":"0.10837466931216931"},"oee_change":{"type":"number","format":"1.7981180730824096"},"oee":{"type":"array","items":{"type":"string","format":"{d: \"2022-11-08T00:00:00.000Z\", date: \"2022-11-08T00:00:00.000Z\", oee: \"0.10837466931216931217\"}"}}}}}}}},"/v1/organizations/{organization_uuid}/monthly-oee":{"get":{"summary":"Get monthly OEE","description":"Retrieves the OEE of the entire organization for every month for the entire day, for all shifts, or for a given shift","tags":["OEE","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Day Shift"},{"name":"calculate_oee_by","in":"query","required":false,"type":"string","format":"scheduled_shifts or 247"},{"name":"shift_date","in":"query","required":false,"type":"string"},{"name":"shift_start_time","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"last_oee":{"type":"number","format":"0.10837466931216931"},"oee_change":{"type":"number","format":"1.7981180730824096"},"oee":{"type":"array","items":{"type":"string","format":"{d: \"2022-11-08T00:00:00.000Z\", date: \"2022-11-08T00:00:00.000Z\", oee: \"0.10837466931216931217\"}"}}}}}}}},"/v1/assets/{asset_uuid}/runtime-comparison":{"get":{"summary":"Get asset runtime comparison","description":"Retrieves the daily or monthly runtimes of two period (two weeks or two years) of an asset in a given/current shift","tags":["Assets","Runtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_name","in":"query","required":false,"type":"string","format":"Day Shift"},{"name":"interval","in":"query","required":true,"type":"string","format":"\"daily\" or \"monthly\""}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string","format":"2023-02-14T00:00:00.000Z"},"categories":{"type":"string","format":"Tuesday"},"runtime_h":{"type":"number","format":"12.9233333333333333"}}}}}}},"/v1/assets/{asset_uuid}/downtime-operation-activities":{"get":{"summary":"Get asset downtime and activities","description":"Retrieves the historical operation activities and downtimes of an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"parameter":{"type":"string","format":"\"activity\" or \"downtime\""},"timestamp":{"type":"string"},"part_uuid":{"type":"string"},"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"operation_uuid":{"type":"string"},"operation_name":{"type":"string"},"operation_description":{"type":"string"},"activity_id":{"type":"number"},"activity_started_at":{"type":"string"},"activity_finished_at":{"type":"integer"},"activity_count":{"type":"number"},"downtime_start_timestamp":{"type":"string"},"downtime_end_timestamp":{"type":"string"},"downtime_categorized_by":{"type":"string"},"downtime_categorized_at":{"type":"string"},"downtime_note":{"type":"string"},"downtime_downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"downtime_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"},"downtime_diration_s":{"type":"number"}}}}}}},"/v1/assets/{asset_uuid}/utilization-operation":{"get":{"summary":"Get asset utilizations downtimes and opeartions","description":"Retrieves the historical utilization, operation, and downtimes of an asset","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"","schema":{"properties":{"utilization_id":{"type":"integer","name":"utilization_id","propertyRow":true},"utilization_state_id_modified":{"type":"integer","name":"utilization_state_id_modified","propertyRow":true},"utilization_start_timestamp":{"type":"string","name":"utilization_start_timestamp","propertyRow":true},"utilization_end_timestamp":{"type":"string","name":"utilization_end_timestamp","propertyRow":true},"downtime_category_id":{"type":"integer","name":"downtime_category_id","propertyRow":true},"downtime_category_name":{"type":"string","name":"downtime_category_name","propertyRow":true},"downtime_severity_id":{"type":"integer","name":"downtime_severity_id","propertyRow":true},"downtime_severity_name":{"type":"string","name":"downtime_severity_name","propertyRow":true},"duration_s":{"type":"number","name":"duration_s","propertyRow":true},"operation_uuid":{"type":"string","name":"operation_uuid","propertyRow":true},"operation_name":{"type":"string","name":"operation_name","propertyRow":true},"operation_description":{"type":"string","name":"operation_description","propertyRow":true},"part_uuid":{"type":"string","name":"part_uuid","propertyRow":true},"part_name":{"type":"string","name":"part_name","propertyRow":true},"part_description":{"type":"string","name":"part_description","propertyRow":true},"part_picture_url":{"type":"string","name":"part_picture_url","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/current-operation2":{"get":{"summary":"Get asset current operation","description":"Retrieves the current operation of an asset with its total count and average cycle time for the current shift","tags":["Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string","name":"operation_name","propertyRow":true},"operation_description":{"type":"string","name":"operation_description","propertyRow":true},"operation_uuid":{"type":"string","name":"operation_uuid","propertyRow":true},"part_name":{"type":"string","name":"part_name","propertyRow":true},"part_description":{"type":"string","name":"part_description","propertyRow":true},"part_picture_url":{"type":"string","name":"part_picture_url","propertyRow":true},"part_uuid":{"type":"string","name":"part_uuid","propertyRow":true},"operation_count":{"type":"number","name":"operation_count","propertyRow":true},"operation_cycle_time_s":{"type":"number","name":"operation_cycle_time_s","propertyRow":true},"operation_process_time_s":{"type":"number","name":"operation_process_time_s","propertyRow":true}}},"code":"200"}}}},"/v1/productions/{production_uuid}/operations-progress":{"get":{"summary":"Get production operations progress","description":"Retrieves the count of operations made for the operations of a production project","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"sort_by","in":"query","required":false,"type":"string"},{"name":"production_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"},"production_has_operation_operation_quantity":{"type":"integer"},"operation_made_count":{"type":"integer"},"progress":{"type":"number"}}}}}}},"/v1/utilizations/{utilization_id}/split":{"put":{"summary":"Split a utilization downtime","description":"Splits an utilization downtime of an asset into two downtimes with the same downtime reason code","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"utilization_split_timestamp":{"type":"string"}}}},{"name":"utilization_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/shift-utilizations-operations":{"get":{"summary":"Get asset utilizations","description":"Retrieves the utilizations of the asset for the current or given shift","tags":["Runtime","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"runtime_shift":{"type":"number","format":"9152.1","name":"runtime_shift","propertyRow":true},"downtime_shift":{"type":"number","format":"19647.8","name":"downtime_shift","propertyRow":true},"shift_states":{"type":"array","items":{"type":"string","format":"{status: \"stopped\", amount: \"0.0934%\"}","propertyRow":true},"name":"shift_states","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/auto-classify-operations":{"get":{"summary":"Get auto-classify operations","description":"Retrieves the operations for this asset that will be auto classified","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"is_auto_classifying":{"type":"boolean"},"operation_uuid":{"type":"string"},"operation_name":{"type":"string"},"part_uuid":{},"part_name":{}}}}}},"put":{"summary":"Set auto-classify operations","description":"Sets the operations for this asset that need to be auto classified","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"operations":{"type":"array","items":{"type":"string","format":"[{\"operation_uuid\": \"op_abc\"}]"}}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string","format":"2023-02-14T00:00:00.000Z"},"categories":{"type":"string","format":"Tuesday"},"runtime_h":{"type":"number","format":"12.9233333333333333"}}}}}}},"/v1/organizations/{organization_uuid}/part_operations_grouped":{"get":{"summary":"Get grouped assets of organization","description":"Returns assets of an organizations grouped by department","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"departments":{"type":"string","format":"[{}]"}}}}}}},"/v2/operations/{operation_uuid}":{"put":{"summary":"Update operation","description":"Updates an operation's parameters and detection algorithm","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_cycle_time":{"type":"number"},"operation_stdev":{"type":"number"},"operation_operation_detection_algorithm_id":{"type":"integer","format":"100"},"operation_continuous_downtime_filter_percentage":{"type":"number","format":".5"},"operation_unit":{"type":"string"},"operation_quantity_per_cycle_unit":{"type":"number"},"operation_sequence":{"type":"integer"},"operation_minimum_quantity_per_workorder":{"type":"integer"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get operation","description":"Retrieves the details of an operation","tags":["Operations","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_name":{"type":"string"},"operation_description":{"type":"string"},"operation_uuid":{"type":"string"},"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"operation_cycle_time":{"type":"number"},"operation_stdev":{"type":"number"},"operation_operation_detection_algorithm_id":{"type":"integer"}}}}}}},"/v2/operation_detection_algorithms":{"get":{"summary":"Get algorithms","description":"Retrieves the operation detection algorithms","tags":["Operations","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_detection_algorithm_id":{"type":"integer"},"operation_detection_algorithm_name":{"type":"string"},"operation_description":{"type":"string"}}}}}}},"/v1/parts/{part_uuid}/archive":{"put":{"summary":"Archive part","description":"Archives a part and its associated operations","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"should_archive":{"type":"boolean"}}}},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/operations/{operation_uuid}/archive":{"put":{"summary":"Archive operation","description":"Archives an operation","tags":["Productions","Parts","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"should_archive":{"type":"boolean","name":"should_archive","propertyRow":true}}}},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/operations/{operation_uuid}":{"delete":{"summary":"Delete operation","description":"Deletes an operation","tags":["Organizations","Productions","Parts"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organization_assets/{asset_uuid}/short_uptime_filter":{"put":{"summary":"Set node asset_uptime_filter_seconds","description":"Sets the uptime filter value (0.0-30.0) for an asset","tags":["Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uptime_filter_seconds":{"type":"number","format":"0.0"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_uptime_filter_seconds":{"type":"number"}}}}}}},"/v1/organizations/{organization_uuid}/chats":{"post":{"summary":"Create chat","description":"Creates a chat","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"chat_name":{},"chat_picture":{"type":"array","items":{"type":"number","format":"Base64 Buffer"}},"chatroom_members":{"type":"array","items":{"type":"string","format":"user_organization_handle:organization_handle"}},"chat_is_direct":{"type":"boolean"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"}}}}}},"get":{"summary":"Get chats","description":"Retrieves the recent direct and group chats of an organization for a user","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string","name":"chat_uuid","propertyRow":true},"chat_name":{"type":"string","name":"chat_name","propertyRow":true},"chat_is_direct":{"type":"boolean","name":"chat_is_direct","propertyRow":true},"chat_picture_url":{"type":"string","name":"chat_picture_url","propertyRow":true}}},"code":"200"}}}},"/v1/chats/{chat_uuid}":{"delete":{"summary":"Delete chat","description":"Deletes a chat","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"Update chat","description":"Updates the name or picture of a group chat","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"chat_name":{"type":"string"},"chat_picture":{"type":"array","items":{"type":"string","format":"Base64 Buffer"}}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"},"chat_name":{},"chat_picture_url":{}}}}}},"get":{"summary":"Get chat info","description":"Retrieves the information of a chat","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"},"chat_name":{"type":"string"},"chat_is_direct":{"type":"boolean"},"chat_picture_url":{"type":"string"}}}}}}},"/v1/users/user_organization_handles":{"get":{"summary":"Get user organization handles ","description":"Retreives the organization handles of a user","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_uuid":{"type":"string"},"organization_handle":{"type":"string"},"user_has_organization_user_handle":{"type":"string"}}}}}},"put":{"summary":"Update user organization handle","description":"Changes an organization handle of a user","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"organization_uuid":{"type":"string","name":"organization_uuid","propertyRow":true},"user_has_organization_user_handle":{"type":"string","name":"user_has_organization_user_handle","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_has_organization_user_handle":{"type":"string","name":"user_has_organization_user_handle","propertyRow":true}}},"code":"200"}}}},"/v1/verify_user_organization_handle":{"get":{"summary":"Verify user organization handle","description":"Verifies if a user handle is available for an organization","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"user_has_organization_user_handle","in":"query","required":true,"type":"string"},{"name":"organization_uuid","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"is_available":{"type":"boolean"}}}}}}},"/v1/verify_organization_handle":{"get":{"summary":"Verify organization handle","description":"Verifies if an organization handle is available","tags":["Organizations"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_handle","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"is_available":{"type":"boolean"}}}}}}},"/v1/organizations/{organization_uuid}/user_contacts":{"get":{"summary":"Get contacts","description":"Retrieves the external and internal contacts (organization members) of a user for an organization","tags":["Chat","Contact"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"is_external":{"type":"boolean"},"user_organization_handle":{"type":"string"},"user_id":{"type":"string"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"organization_id":{"type":"integer"},"organization_name":{"type":"string"}}}}}}},"/v1/chatrooms/{chatroom_uuid}/draft_message":{"get":{"summary":"Get chatroom draft message","description":"Retrieves the draft message of a chatroom","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chatroom_member_is_owner":{"type":"boolean"}}}}}}},"/v1/handles/{user_organization_handle}/exists":{"get":{"summary":"User Organization Handle exists","description":"Verifies if a given user_organization_handle exists.","tags":["Chat","Contact"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"user_organization_handle","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"exists":{"type":"boolean"}}}}}}},"/v1/interaction_default_emojis":{"get":{"summary":"Interactions default emojis","description":"Returns the default list of emojis for interactions","tags":["Chat","Emoji"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"emoji_emoji":{"type":"string","format":"🤝"},"emoji_codepoints":{"type":"string","format":"1F91D"},"emoji_name":{"type":"string","format":"handshake"},"emoji_group":{"type":"string","format":"People & Body"},"emoji_sub_group":{"type":"string","format":"hands"}}}}}}},"/v1/emojis":{"get":{"summary":"Emojis","description":"Returns the emojis list, having the ","tags":["Chat","Emoji"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"emoji_emoji":{"type":"string","format":"🤝"},"emoji_codepoints":{"type":"string","format":"1F91D"},"emoji_name":{"type":"string","format":"handshake"},"emoji_group":{"type":"string","format":"People & Body"},"emoji_sub_group":{"type":"string","format":"hands"}}}}}}},"/v1/assets/{asset_uuid}/operations/{operation_uuid}/override_operation_made":{"put":{"summary":"Override Operation Made Count","description":"Overrides the good and bad/scrap count of operations made with this asset at a given timeslot","tags":["Productions","Parts","Operations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"override_operation_made_good_count":{"type":"integer","name":"override_operation_made_good_count","propertyRow":true},"override_operation_made_bad_count":{"type":"integer","name":"override_operation_made_bad_count","propertyRow":true},"override_operation_made_timestamp":{"type":"string","name":"override_operation_made_timestamp","propertyRow":true}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"override_operation_made_good_count":{"type":"integer","name":"override_operation_made_good_count","propertyRow":true},"override_operation_made_bad_count":{"type":"integer","name":"override_operation_made_bad_count","propertyRow":true},"override_operation_made_timestamp":{"type":"string","name":"override_operation_made_timestamp","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete Override Operation Made Count","description":"Deletes the override counts of operations made with this asset at a given timeslot","tags":["Productions","Parts","Operations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"override_operation_made_timestamp":{"type":"string"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/operations_made_by_interval":{"get":{"summary":"Get Asset Operation Made Count","description":"Retrieves the counts of all operations of an asset, including the bad and good operations made, split by a given time interval","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"},{"name":"time_interval_min","in":"query","required":true,"type":"integer","format":"30 or 60"},{"name":"at_timestamp","in":null,"required":false,"type":"string"},{"name":"for_operation_uuid","in":null,"required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"total_operation_count":{"type":"number","format":"307"},"total_asset_shift_goal_count":{"type":"number","format":"75"},"total_hourly_count":{"type":"array","items":{"type":"string","format":"hr: \"2022-11-07T22:00:00.000Z\", average_operation_process_time_s: 2.8384370803833, average_operation_cycle_time_s: 90.0058135986328, total_operation_count: 37, total_asset_shift_goal_count: 85"}}}}}}}},"/v1/assets/{asset_uuid}/shift-utilizations-operations-svg":{"get":{"summary":"Get asset utilizations","description":"Retrieves the utilizations of the asset for the current or given shift","tags":["Runtime","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"runtime_shift_interval":{"type":"string","format":"00:00:06"},"downtime_shift_interval":{"type":"string","format":"00:02:46"},"runtime_percentage":{"type":"string","format":"3.2"},"downtime_percentage":{"type":"string","format":"96.8"},"shift_states_svg":{"type":"string","format":"<svg width=\"28800.000000\" height=\"100\"  xmlns=\"http://www.w3.org/2000/svg\"> <rect fill=\"#475569\" stroke=\"gray\" stroke-width=\"1\" x=\"0\" y=\"0\" width=\"28800.000000\" height=\"100\" />  <rect fill=\"#dc2626\" stroke=\"gray\" stroke-width=\"1\" x=\"0\" y=\"0\" width=\"166\" height=\"100\" />  <rect fill=\"#28b85d\" stroke=\"gray\" stroke-width=\"1\" x=\"166\" y=\"0\" width=\"6\" height=\"100\" />  </svg>"},"shift_start_timestamp":{"type":"string","format":"2024-06-19T21:00:00.000Z"},"shift_end_timestamp":{"type":"string","format":"2024-06-20T05:00:00.000Z"}}}}}}},"/v1/organizations/{organization_uuid}/shift_productions":{"get":{"summary":"Get shift production hourly","description":"Retrieves the hourly operations made for each asset and operation in a given shift ","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"departments","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false},{"name":"shift_date","in":"query","required":false},{"name":"shift_start_time","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operations":{"type":"array","items":{"type":"string","format":"{\"operation_uuid\":\"op_47f19ce027808753b4a34ae3532b1db5\",\"operation_name\":\"OP100-CUTTING-BLANK\",\"part_uuid\":\"part_b480900e6025964d2bcb2df060eba083\",\"part_name\":\"Aluminum can\",\"part_picture_url\":\"https://iotflows-parts-pictures.s3.amazonaws.com/part_b480900e6025964d2bcb2df060eba083.png\",\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"assets\":[{\"asset_id\":311,\"asset_uuid\":\"as_test_mill\",\"asset_custom_name\":null,\"asset_custom_identifier\":\"TXZ42-MILL\",\"machine_name\":\"Milling Machine\",\"machine_identifier\":\"generic-mill\",\"department_uuid\":\"dp_205013703244ace3a25fbe6ed0da3fd5\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"hourly_operations_made\":[{\"interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"cycle_time\":\"00:00:59.9942\",\"operation_count\":10,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0}]}]}"}},"progress":{"type":"number","format":"0.034"}}}}}}},"/v1/assets/{asset_uuid}/operations/{operation_uuid}/hourly_goal":{"put":{"summary":"Set asset-operation goal","description":"Sets the operation count goal of an asset for a given operation","tags":["Productions","Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_operation_hourly_goal_count":{"type":"number"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/shift_time_intervals":{"get":{"summary":"Get time intervals","description":"Retrieves the timestamps by a given time interval split for a given shift and date","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"},{"name":"time_interval_min","in":"query","required":true,"type":"integer","format":"30 or 60"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"total_operation_count":{"type":"number","format":"307"},"total_asset_shift_goal_count":{"type":"number","format":"75"},"total_hourly_count":{"type":"array","items":{"type":"string","format":"hr: \"2022-11-07T22:00:00.000Z\", average_operation_process_time_s: 2.8384370803833, average_operation_cycle_time_s: 90.0058135986328, total_operation_count: 37, total_asset_shift_goal_count: 85"}}}}}}}},"/v2/organizations/{organization_uuid}/downtimes/summary":{"get":{"summary":"Get organization assets summary downtimes","description":"Retrieves the summary downtimes of all assets per category or severity for a given period","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"by","required":false,"type":"string","format":"category or severity"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer"},"downtime_asset_id":{"type":"integer"},"downtime_start_timestamp":{"type":"string"},"downtime_end_timestamp":{"type":"string"},"downtime_categorized_by":{"type":"string"},"downtime_categorized_at":{"type":"string"},"downtime_note":{"type":"string"},"downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"downtime_category_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"},"downtime_category_is_archived":{"type":"boolean"},"downtime_diration_s":{"type":"integer"}}}}}}},"/v2/organizations/{organization_uuid}/downtimes":{"get":{"summary":"Get assets downtimes","description":"Retrieves the downtimes of all assets of the organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"query","description":"downtime_severity_uuids","required":false,"type":"string","format":"sev_none sev_low sev_medium sev_high"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"departments","required":false,"type":"string"},{"name":"","in":"query","description":"only_with_notes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_id":{"type":"integer"},"downtime_asset_id":{"type":"integer"},"downtime_start_timestamp":{"type":"string"},"downtime_end_timestamp":{"type":"string"},"downtime_categorized_by":{"type":"string"},"downtime_categorized_at":{"type":"string"},"downtime_note":{"type":"string"},"downtime_category_id":{"type":"integer"},"downtime_category_name":{"type":"string"},"downtime_category_severity_id":{"type":"integer"},"downtime_severity_name":{"type":"string"},"downtime_category_is_archived":{"type":"boolean"},"downtime_diration_s":{"type":"integer"}}}}}}},"/v1/assets/{asset_uuid}/hourly-runtime":{"get":{"summary":"Get asset hourly runtime","description":"Retrieves the hourly runtime of the asset for the current or given shift","tags":["Runtime","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"runtime_shift_interval":{"type":"string","format":"00:00:06"},"downtime_shift_interval":{"type":"string","format":"00:02:46"},"runtime_percentage":{"type":"string","format":"3.2"},"downtime_percentage":{"type":"string","format":"96.8"},"shift_states_svg":{"type":"string","format":"<svg width=\"28800.000000\" height=\"100\"  xmlns=\"http://www.w3.org/2000/svg\"> <rect fill=\"#475569\" stroke=\"gray\" stroke-width=\"1\" x=\"0\" y=\"0\" width=\"28800.000000\" height=\"100\" />  <rect fill=\"#dc2626\" stroke=\"gray\" stroke-width=\"1\" x=\"0\" y=\"0\" width=\"166\" height=\"100\" />  <rect fill=\"#28b85d\" stroke=\"gray\" stroke-width=\"1\" x=\"166\" y=\"0\" width=\"6\" height=\"100\" />  </svg>"},"shift_start_timestamp":{"type":"string","format":"2024-06-19T21:00:00.000Z"},"shift_end_timestamp":{"type":"string","format":"2024-06-20T05:00:00.000Z"}}}}}}},"/v1/organizations/{organization_uuid}/file_upload_request":{"get":{"summary":"Request file upload link","description":"Retrieves a signed url for uploading a file to the cloud","tags":["File"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"file_name","in":"query","required":false},{"name":"file_type","in":"query","required":false},{"name":"file_size","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"signed_url":{"type":"string"},"file_uuid":{"type":"string"}}}}}}},"/v1/files/{file_uuid}/download_request":{"get":{"summary":"Request file download link","description":"Retrieves a signed url for download a file from the cloud","tags":["File"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"file_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"signed_url":{"type":"string"}}}}}}},"/v1/chatrooms/{chatroom_uuid}/search_message":{"get":{"summary":"Search Chatroom Message","description":"Searches for messages in a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":true,"type":"string","format":"search keyword"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"message_uuid":{"type":"string"},"message_text":{"type":"string"},"message_created_at":{"type":"string"},"user_username":{"type":"string"},"user_first_name":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/chats/search_message":{"get":{"summary":"Search Chat Message","description":"Searches for messages in all chats of a given organization","tags":["Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":true,"type":"string","format":"Search keyword"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"message_uuid":{"type":"string"},"message_text":{"type":"string"},"message_created_at":{"type":"string"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"chatroom_uuid":{"type":"string"},"chat_uuid":{"type":"string"}}}}}}},"/v1/chatrooms/{chatroom_uuid}/read_until":{"put":{"summary":"Set read until","description":"Sets a timestamp until when the user has read the messages of a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"},{"name":"read_until_timestamp","in":"query","required":true,"type":"string","format":"search keyword"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"unread_count":{"type":"integer"},"chatroom_member_read_until_timestamp":{"type":"string"}}}}}}},"/v1/apn/devices":{"post":{"summary":"Register APN Device","description":"Registeres the device information for Apple Push Notification","tags":["Chat","PushNotification"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"apn_device_token":{"type":"string"},"apn_device_id":{"type":"string"},"apn_device_type":{"type":"string"},"apn_bundle_id":{"type":"string"},"apn_is_production":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"}}}}}}},"/v1/apn/devices/{apn_device_id}":{"delete":{"summary":"Register APN","description":"Registeres the device information for Apple Push Notification","tags":["Chat","PushNotification"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"apn_device_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/conversations":{"post":{"summary":"Create conversation","description":"Creates a conversation","tags":["Conversation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"conversation_subject":{"type":"string"},"chatroom_members":{"type":"array","items":{"type":"string","format":"user_organization_handle:organization_handle"}}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"chat_uuid":{"type":"string"}}}}}},"get":{"summary":"Get conversations","description":"Retrieves the recent conversations of an organization for a user","tags":["Conversations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"conversation_uuid":{"type":"string"},"conversation_subject":{"type":"string"}}}}}}},"/v1/organization_assets/{asset_uuid}/short_downtime_classification":{"put":{"summary":"Set Asset Auto Classify Downtimes Duration","description":"Sets the asset_auto_classify_downtimes_less_than_min for an asset","tags":["Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"asset_auto_classify_downtimes_less_than_min":{"type":"integer","format":"1"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_uptime_filter_seconds":{"type":"number"}}}}}}},"/v2/assets/{asset_uuid}/operations_made_by_interval":{"get":{"summary":"Get Asset Operation Made Count","description":"Retrieves the counts of all operations of an asset, including the bad and good operations made, split by a given time interval","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"},{"name":"time_interval_min","in":"query","required":true,"type":"integer","format":"30 or 60"},{"name":"at_timestamp","in":null,"required":false,"type":"string"},{"name":"for_operation_uuid","in":null,"required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"total_operation_count":{"type":"number","format":"307"},"total_asset_shift_goal_count":{"type":"number","format":"75"},"total_hourly_count":{"type":"array","items":{"type":"string","format":"hr: \"2022-11-07T22:00:00.000Z\", average_operation_process_time_s: 2.8384370803833, average_operation_cycle_time_s: 90.0058135986328, total_operation_count: 37, total_asset_shift_goal_count: 85"}}}}}}}},"/v1/organizations/{organization_uuid}/oee_goal":{"put":{"summary":"Update organization oee goal","description":"Updates the organization's OEE goal for utilization and produciton","tags":["Organizations","OEE"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"organization_oee_goal":{"type":"number","format":"0.60"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_oee_goal":{"type":"number","format":"0.86"}}}}}}},"/v1/organization_assets/{asset_uuid}/oee_goal":{"put":{"summary":"Update asset's custom oee goal","description":"Updates the asset's custom OEE goal for utilization and produciton","tags":["Assets","OEE"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_custom_oee_goal":{"type":"number","format":"0.60"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_oee_goal":{"type":"number","format":"0.86"}}}}}}},"/v2/organizations/{organization_uuid}/shift_productions":{"get":{"summary":"Get shift production hourly","description":"Retrieves the hourly operations made for each asset and operation in a given shift ","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"departments","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false},{"name":"shift_date","in":"query","required":false},{"name":"shift_start_time","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operations":{"type":"array","items":{"type":"string","format":"{\"operation_uuid\":\"op_47f19ce027808753b4a34ae3532b1db5\",\"operation_name\":\"OP100-CUTTING-BLANK\",\"part_uuid\":\"part_b480900e6025964d2bcb2df060eba083\",\"part_name\":\"Aluminum can\",\"part_picture_url\":\"https://iotflows-parts-pictures.s3.amazonaws.com/part_b480900e6025964d2bcb2df060eba083.png\",\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"assets\":[{\"asset_id\":311,\"asset_uuid\":\"as_test_mill\",\"asset_custom_name\":null,\"asset_custom_identifier\":\"TXZ42-MILL\",\"machine_name\":\"Milling Machine\",\"machine_identifier\":\"generic-mill\",\"department_uuid\":\"dp_205013703244ace3a25fbe6ed0da3fd5\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"hourly_operations_made\":[{\"interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"cycle_time\":\"00:00:59.9942\",\"operation_count\":10,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0}]}]}"}},"progress":{"type":"number","format":"0.034"}}}}}}},"/v1/chatrooms/{chatroom_uuid}/messages":{"get":{"summary":"Get chatroom messages","description":"Retrieves the messages of a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"},{"name":"messages_before_timestamp","in":"query","required":false,"type":"string"},{"name":"messages_after_timestamp","in":"query","required":false,"type":"string"},{"name":"messages_around_message_uuid","in":"query","required":false,"type":"string"},{"name":"latest_messages","in":"query","required":false,"type":"boolean","format":"true"},{"name":"only_compressed_images","in":"query","required":false,"type":"boolean"},{"name":"only_files","in":"query","required":false,"type":"boolean"},{"name":"only_voices","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string","format":"{ \"msg_m_1722566174585\" : {\"file_id\": null, \"file_name\": null, \"file_size\": null, \"file_type\": null, \"file_uuid\": null, \"message_id\": 1354, \"message_text\": \"😂\", \"message_uuid\": \"msg_m_1722566174585\", \"file_is_voice\": null, \"user_username\": \"m\", \"user_image_url\": \"https://iotflows-profile-pictures.s3.amazonaws.com/m.jpg\", \"user_last_name\": \"Parto\", \"file_created_at\": null, \"message_file_id\": null, \"message_user_id\": 1, \"user_first_name\": \"m\", \"message_is_edited\": false, \"emoji_interactions\": null, \"file_is_compressed\": null, \"message_created_at\": \"2024-08-02T02:36:14.653004+00:00\", \"message_chatroom_id\": 61, \"message_replied_from\": null, \"emoji_interactions_count\": null, \"file_uploaded_by_user_id\": null, \"message_is_pinned_for_all\": false, \"message_is_only_emoji_count\": 1, \"emoji_interactions_usernames\": null, \"message_is_pinned_for_usernames\": null, \"message_replied_from_message_id\": null, \"file_uploaded_in_organization_id\": null} }","name":"data","propertyRow":true},"has_older_messages":{"type":"boolean","format":"true","name":"has_older_messages","propertyRow":true},"has_newer_messages":{"type":"boolean","format":"false","name":"has_newer_messages","propertyRow":true}}},"code":"200"}}}},"/v1/chatrooms/{chatroom_uuid}/members/{username_or_team_uuid}/roles":{"put":{"summary":"Update chatroom member role","description":"Changes the role of a chatroom user or team to be an owner or a regular member","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"update_to_owner":{"type":"boolean"}}}},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"},{"name":"username_or_team_uuid_to_update_role","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"members":{"type":"string","format":"user_handle:organization_handle"}}}}}}},"/v1/chatrooms/{chatroom_uuid}/members":{"get":{"summary":"Get chatroom members","description":"Retrieves the members of a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"members":{"type":"string","format":"user_handle:organization_handle"}}}}}},"delete":{"summary":"Delete chatroom member","description":"Deletes a user or team from a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"chatroom_member_to_delete_username":{"type":"string","format":"user_username"},"chatroom_member_to_delete_team_uuid":{"type":"string","format":"team_uuid"}}}},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"members":{"type":"string","format":"user_handle:organization_handle"}}}}}},"post":{"summary":"Add chatroom members","description":"Adds an array of users or teams to a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"chatroom_members_to_add":{"type":"array","items":{"type":"string","format":"user_handle:organization_handle"}}}}},{"name":"chat_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"members":{"type":"string","format":"user_handle:organization_handle"}}}}}}},"/v1/conversations/{conversation_uuid}":{"get":{"summary":"Get conversation info","description":"Retrieves the information of a conversation","tags":["Conversation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"conversation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"conversation_uuid":{"type":"string"},"conversation_subject":{"type":"string"},"chatroom_uuid":{}}}}}}},"/v1/organizations/{organization_uuid}/conversations/search_message":{"get":{"summary":"Search Conversation Messages","description":"Searches for messages in all conversations of a given organization","tags":["Conversation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":true,"type":"string","format":"Search keyword"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"message_uuid":{"type":"string"},"message_text":{"type":"string"},"message_created_at":{"type":"string"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"chatroom_uuid":{"type":"string"},"conversation_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/historical_production":{"get":{"summary":"Get advanced production reports of the organization","description":"Retrieves advanced production reports of the organization based on different queries","tags":["SenseAI","Reports"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"from","required":false,"type":"string"},{"name":"","in":"query","description":"to","required":false,"type":"string"},{"name":"","in":"query","description":"time_period","required":false,"type":"string","format":"daily weekly monthly quarterly yearly"},{"name":"","in":"query","description":"shift_entire_day","required":false,"type":"boolean"},{"name":"","in":"query","description":"shift_name","required":false,"type":"string"},{"name":"operations","in":"query","description":"operations","required":false,"type":"string","format":"operation_uuid"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"categories":{"type":"string"},"periods":{"type":"string"},"operations":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/canvas":{"put":{"summary":"Update organization canvas","description":"Updates the organization's canvas map view design","tags":["Organizations","Canvas"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"canvas_state":{"type":"string"},"canvas_asset_state":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_oee_goal":{"type":"number","format":"0.86"}}}}}},"get":{"summary":"Get organization canvas","description":"Retreieves the organization's canvas map view design parameters","tags":["Organizations","Canvas"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_oee_goal":{"type":"number","format":"0.86"}}}}}}},"/v1/organizations/{organization_uuid}/teams":{"post":{"summary":"Create team","description":"Creates a team","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"team_name":{"type":"string"},"team_handle":{"type":"string"},"members":{"type":"array","items":{"type":"string","format":"{\"username\",\"is_owner\"}"}}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"}}}}}},"get":{"summary":"Get teams","description":"Retreieves the teams of an organization","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object"}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"},"team_name":{"type":"string"},"team_organization_handle":{"type":"string"}}}}}}},"/v1/teams/{team_uuid}/members":{"post":{"summary":"Add team member","description":"Adds a user to a team","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"string","format":"{\"username\", \"is_owner\"}"}}}}},{"name":"team_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"}}}}}}},"/v1/teams/{team_uuid}/members/{username}":{"put":{"summary":"Change team member role","description":"Changes a user's role in a team to be an owner or member","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"is_owner":{"type":"boolean"}}}},{"name":"team_uuid","in":"path","required":true,"type":"string"},{"name":"username","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete team member","description":"Removes a user from a team","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"team_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"}}}}}}},"/v1/teams/{team_uuid}":{"get":{"summary":"Get team","description":"Retreieves the team information and its members","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"team_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_name":{"type":"string"},"team_organization_handle":{"type":"string"},"members":{"type":"array","items":{"type":"string","format":"{team_has_user_is_owner, user_username}"}}}}}}},"put":{"summary":"Change team ","description":"Changes the team name and handle","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"team_name":{"type":"string","name":"team_name","propertyRow":true},"team_handle":{"type":"string","name":"team_handle","propertyRow":true}}}},{"name":"team_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string","name":"team_uuid","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete team","description":"Deletes a team","tags":["Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"team_uuid","in":"path","required":true,"type":"string"},{"name":"username","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_uuid":{"type":"string"}}}}}}},"/v1/workorder_priorities":{"get":{"summary":"Get Workorder Priorities","description":"Retreieves the priorities that can be used for workorders","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_priority_name":{"type":"string"},"workorder_priority_uuid":{"type":"string"},"workorder_priority_color_light_mode":{"type":"string"},"workorder_priority_color_dark_mode":{"type":"string"}}}}}}},"/v1/workorder_statuses":{"get":{"summary":"Get Workorders Statuses","description":"Retreieves the statuses that can be used for workorders","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_status_name":{"type":"string"},"workorder_status_uuid":{"type":"string"},"workorder_status_color_light_mode":{"type":"string"},"workorder_status_color_dark_mode":{"type":"string"}}}}}}},"/v1/workorders/{workorder_uuid}":{"put":{"summary":"Update Workorder","description":"Updates a workorder","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"parent_workorder_uuid":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_asset_uuid":{"type":"string"},"workorder_due_date":{"type":"string","format":"2024-11-12"},"workorder_due_time":{"type":"string","format":"09:00:00"},"workorder_start_date":{"type":"string","format":"2024-11-12"},"workorder_start_time":{"type":"string","format":"09:00:00"},"workorder_recurrence_frequency_uuid":{"type":"string","format":"DAILY or WEEKLY or MONTHLY or YEARLY"},"workorder_recurrence_interval":{"type":"number","format":"1"},"workorder_recurrence_days_of_week":{"type":"array","items":{"type":"number","format":"[1,2,3,4,5]"}},"workorder_recurrence_month_order_uuid":{"type":"string","format":"FIRST or SECOND or THIRD or FORTH or LAST"},"workorder_recurrence_end_date":{"type":"string","format":"2024-11-12"},"workorder_recurrence_end_time":{"type":"string","format":"09:00:00"},"workorder_priority_uuid":{"type":"string","format":"WORKORDER_PRIORITY_NONE or WORKORDER_PRIORITY_LOW or WORKORDER_PRIORITY_MEDIUM or WORKORDER_PRIORITY_HIGH"},"add_assignee_handle":{"type":"string","format":"support:company"},"delete_assignee_handle":{"type":"string","format":"support:company"},"add_workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}},"delete_workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}},"workorder_group_uuid":{"type":"string"},"workorder_duration_min":{"type":"integer","format":"60"},"workorder_due_timestamptz":{"type":"string"},"workorder_start_timestamptz":{"type":"string"},"workorder_recurrence_end_timestamptz":{"type":"string"}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"}}}}}},"get":{"summary":"Get Workorder","description":"Retreieves the workorder details","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"},"workorder_created_at":{"type":"string"},"workorder_updated_at":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_start_timestamp":{"type":"string"},"workorder_due_timestamp":{"type":"string"},"parent_workorder":{"type":"string"},"created_by_user":{"type":"string"},"assigned_to_users":{"type":"string"},"assigned_to_teams":{"type":"array","items":{"type":null,"format":""}},"assignees":{"type":"array","items":{"type":null,"format":""}},"assignees_username":{"type":"array","items":{"type":"string","format":""}},"workorder_status":{"type":"string"},"workorder_priority":{"type":"string"},"workorder_asset":{"type":"string"},"workorder_files":{"type":"array","items":{"type":"string","format":"{file_id: 26 file_created_at: \"2024-07-24T04:12:35.507858\" file_name: \"OnPrem.svg\" file_uuid: \"file_353ada6e56032d60f80fb508d374c657\" file_uploaded_by_user_id: 2 file_uploaded_in_organization_id: 2 file_size: 580727 file_type: \"image/svg xml\" file_is_compressed: false file_is_voice: false workorder_has_file_workorder_id: 92 workorder_has_file_file_id: 26 compressed_image_url:\"...\"}"}}}}}}},"delete":{"summary":"Delete Workorder","description":"Marks a workorder for deletion. It'll be placed in trash for 30 days.","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"},{"name":"unmark_for_deletion","in":"body","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/users/workorder_view":{"put":{"summary":"Change user workorder view preference","description":"Changes the workorder view preference of the user (todo, table, calendar, workload)","tags":["Users","Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"workorder_view_name":{"type":"string","format":"todo_view or table_view or calendar_view or workload_view"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/auto_downtime_breaks":{"post":{"summary":"Create auto downtime break","description":"Creates an auto downtime break schdule for an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"auto_downtime_break_downtime_category_id":{"type":"integer","format":"500","name":"auto_downtime_break_downtime_category_id","propertyRow":true},"auto_downtime_break_start_time":{"type":"string","format":"11:00:00","name":"auto_downtime_break_start_time","propertyRow":true},"auto_downtime_break_end_time":{"type":"string","format":"13:00:00","name":"auto_downtime_break_end_time","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}},"get":{"summary":"Get auto downtime break","description":"Retreieves the auto downtime break schdules for an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"auto_downtime_break_downtime_category_id":{"type":"integer","format":"500"},"auto_downtime_break_start_time":{"type":"string","format":"11:00:00"},"auto_downtime_break_end_time":{"type":"string","format":"13:00:00"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/auto_downtime_breaks/{auto_downtime_break_uuid}":{"put":{"summary":"Update auto downtime break","description":"Updates an auto downtime break schdule for an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"auto_downtime_break_downtime_category_id":{"type":"integer","format":"500"},"auto_downtime_break_start_time":{"type":"string","format":"11:00:00"},"auto_downtime_break_end_time":{"type":"string","format":"13:00:00"},"auto_downtime_break_enabled":{"type":"boolean"}}}},{"name":"auto_downtime_break_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete auto downtime break","description":"Deletes an auto downtime break schdule of an organization","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"auto_downtime_break_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/auto_down_classification":{"put":{"summary":"Update organization auto down classification","description":"Updates the organization's auto downtime classification settings","tags":["Organizations","OEE","Downtimes"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"organization_auto_dt_short_downtime_enabled":{"type":"boolean"},"organization_auto_dt_short_downtime_category_id":{"type":"integer"},"organization_auto_dt_start_of_shift_enabled":{"type":"boolean"},"organization_auto_dt_start_of_shift_category_id":{"type":"integer"},"organization_auto_dt_end_of_shift_enabled":{"type":"boolean"},"organization_auto_dt_end_of_shift_category_id":{"type":"integer"},"organization_auto_dt_entire_shift_enabled":{"type":"boolean"},"organization_auto_dt_entire_shift_category_id":{"type":"integer"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/workorders/{workorder_uuid}/read":{"put":{"summary":"Update Workorder Read Status","description":"Updates a workorder read status for a user","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"parent_workorder_uuid":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_asset_uuid":{"type":"string"},"workorder_due_date":{"type":"string","format":"2024-11-12"},"workorder_due_time":{"type":"string","format":"09:00:00"},"workorder_start_date":{"type":"string","format":"2024-11-12"},"workorder_start_time":{"type":"string","format":"09:00:00"},"workorder_recurrence_frequency_uuid":{"type":"string","format":"DAILY or WEEKLY or MONTHLY or YEARLY"},"workorder_recurrence_interval":{"type":"number","format":"1"},"workorder_recurrence_days_of_week":{"type":"array","items":{"type":"number","format":"[1,2,3,4,5]"}},"workorder_recurrence_month_order_uuid":{"type":"string","format":"FIRST or SECOND or THIRD or FORTH or LAST"},"workorder_recurrence_end_date":{"type":"string","format":"2024-11-12"},"workorder_recurrence_end_time":{"type":"string","format":"09:00:00"},"workorder_priority_uuid":{"type":"string","format":"WORKORDER_PRIORITY_NONE or WORKORDER_PRIORITY_LOW or WORKORDER_PRIORITY_MEDIUM or WORKORDER_PRIORITY_HIGH"},"add_assignee_handle":{"type":"string","format":"support:company"},"delete_assignee_handle":{"type":"string","format":"support:company"},"add_workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}},"delete_workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"}}}}}}},"/v1/downtime/{downtime_id}/classifications":{"delete":{"summary":"Delete downtime classification","description":"Deletes a downtime classification","tags":["Downtime","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object"}},{"name":"downtime_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/groups":{"post":{"summary":"Create Group","description":"Creates a group for the organization","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"group_name":{"type":"string"},"group_light_color_tailwind_id":{"type":"integer"},"group_dark_color_tailwind_id":{"type":"integer"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string"}}}}}},"get":{"summary":"Get Groups","description":"Retreieves the groups of an organization","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean","name":"assigned_to_me_only","propertyRow":true},"show_done_only":{"type":"string","name":"show_done_only","propertyRow":true},"q":{"type":"string","format":"search","name":"q","propertyRow":true},"sort_by":{"type":"string","format":"PRIORITY_ASC or PRIORITY_DESC or CREATED_AT_ASC or CREATED_AT_DESC or UPDATED_AT_ASC or UPDATED_AT_DESC or DUE_DATE_ASC or DUE_DATE_DESC","name":"sort_by","propertyRow":true}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string","name":"group_uuid","propertyRow":true},"group_name":{"type":"string","name":"group_name","propertyRow":true},"group_created_at":{"type":"string","name":"group_created_at","propertyRow":true},"group_light_color_hex":{"type":"string","name":"group_light_color_hex","propertyRow":true},"group_dark_color_hex":{"type":"string","name":"group_dark_color_hex","propertyRow":true}}},"code":"200"}}}},"/v1/groups/{group_uuid}":{"put":{"summary":"Update Group","description":"Updates the name or colors of a group","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"group_name":{"type":"string"},"group_light_color_tailwind_id":{"type":"integer"},"group_dark_color_tailwind_id":{"type":"integer"}}}},{"name":"group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string"},"group_name":{"type":"string"},"group_light_color_hex":{"type":"string"},"group_dark_color_hex":{"type":"string"}}}}}},"delete":{"summary":"Delete Group","description":"Deletes a group","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object"}},{"name":"group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/group_colors":{"get":{"summary":"Get Group Colors","description":"Retreieves the allowed light and dark colors for groups in an organization","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tailwind_color_name":{"type":"string"},"tailwind_color_info":{"type":"array","items":{"type":"string","format":"[{\"tailwind_id\":66,\"tailwind_hex\":\"#818cf8\",\"tailwind_intensity\":400,\"tailwind_color_name\":\"Indigo\",\"color_mode\":\"DARK\"},   {\"tailwind_id\":68,\"tailwind_hex\":\"#4f46e5\",\"tailwind_intensity\":600,\"tailwind_color_name\":\"Indigo\",\"color_mode\":\"LIGHT\"}]"}}}}}}}},"/v2/chatrooms/{chatroom_uuid}/members":{"get":{"summary":"Get chatroom members","description":"Retrieves the members of a chatroom","tags":["Chatroom"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"chat_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"members":{"type":"string","format":"user_handle:organization_handle"}}}}}}},"/v2/organizations/{organization_uuid}/user_contacts":{"get":{"summary":"Get contacts","description":"Retrieves the external and internal contacts (organization members) of a user for an organization","tags":["Chat","Contact"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"users":{"type":"array","items":{"type":"string","format":"{is_external: true user_organization_handle: \"google_102758656106472105369:gatech\" user_has_organization_user_id: 719 user_has_organization_organization_id: 512 user_has_organization_organization_member_role_id: 4 user_has_organization_is_user_subscribed_to_weekly_reports: false user_has_organization_user_handle: \"google_102758656106472105369\" user_id: 719 user_email: \"zack.mark.miller@gmail.com\" user_first_name: \"Mark\" user_last_name: \"Miller\" user_phone_number: \"\" user_image_url: \"https://iotflows-profile-pictures.s3.amazonaws.com/google_102758656106472105369.jpg\" user_username: \"google_102758656106472105369\" user_created_at: \"2023-06-28T14:20:50.925431\" user_username_public: \"markmiller2\" user_invite_pending: false user_has_used_free_trial: false user_prefers_dark_mode: false user_is_online: true user_last_heard: \"2023-06-28T14:23:20.997922\" user_peer_host: \"136.55.37.141\" user_signedup_platform: \"https://console.iotflows.com\" user_prefers_list_view: true}"}},"teams":{"type":"array","items":{"type":"string","format":"{is_external: false team_organization_handle: \"maintenance:iotflows\", team_id: 2 team_organization_id: 2 team_uuid: \"tm_a90e1354ec36e88cad888b2690a790e3\" team_handle: \"maintenance\" team_name: \"Maintenance Team\" team_created_at: \"2024-11-13T00:14:54.068455\"}"}}}}}}}},"/v1/chats/{chat_uuid}/messages":{"get":{"summary":"Get chat messages","description":"Retrieves the messages of a chat","tags":["Chatroom","Chat"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"messages_before_timestamp","in":"query","required":false,"type":"string"},{"name":"messages_after_timestamp","in":"query","required":false,"type":"string"},{"name":"messages_around_message_uuid","in":"query","required":false,"type":"string"},{"name":"latest_messages","in":"query","required":false,"type":"boolean","format":"true"},{"name":"only_compressed_images","in":"query","required":false,"type":"boolean"},{"name":"only_files","in":"query","required":false,"type":"boolean"},{"name":"only_voices","in":"query","required":false},{"name":"chatroom_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"data":{"type":"string","format":"{ \"msg_m_1722566174585\" : {\"file_id\": null, \"file_name\": null, \"file_size\": null, \"file_type\": null, \"file_uuid\": null, \"message_id\": 1354, \"message_text\": \"😂\", \"message_uuid\": \"msg_m_1722566174585\", \"file_is_voice\": null, \"user_username\": \"m\", \"user_image_url\": \"https://iotflows-profile-pictures.s3.amazonaws.com/m.jpg\", \"user_last_name\": \"Parto\", \"file_created_at\": null, \"message_file_id\": null, \"message_user_id\": 1, \"user_first_name\": \"m\", \"message_is_edited\": false, \"emoji_interactions\": null, \"file_is_compressed\": null, \"message_created_at\": \"2024-08-02T02:36:14.653004+00:00\", \"message_chatroom_id\": 61, \"message_replied_from\": null, \"emoji_interactions_count\": null, \"file_uploaded_by_user_id\": null, \"message_is_pinned_for_all\": false, \"message_is_only_emoji_count\": 1, \"emoji_interactions_usernames\": null, \"message_is_pinned_for_usernames\": null, \"message_replied_from_message_id\": null, \"file_uploaded_in_organization_id\": null} }"},"has_older_messages":{"type":"boolean","format":"true"},"has_newer_messages":{"type":"boolean","format":"false"}}}}}}},"/v1/organizations/{organization_uuid}/boards":{"post":{"summary":"Create Board","description":"Creates a board for the organization","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"board_name":{"type":"string"},"board_is_private":{"type":"boolean"},"usernames":{"type":"array","items":{"type":"string","format":""}},"team_uuids":{"type":"array","items":{"type":"string","format":""}}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"}}}}}},"get":{"summary":"Get Boards","description":"Retrieves the boards of user in organization that are either organization-wide or private to them","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"show_in_trash_only","in":"header","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string","name":"board_uuid","propertyRow":true},"board_name":{"type":"string","name":"board_name","propertyRow":true},"board_is_private":{"type":"boolean","name":"board_is_private","propertyRow":true},"board_created_at":{"type":"string","name":"board_created_at","propertyRow":true},"board_updated_at":{"type":"string","name":"board_updated_at","propertyRow":true},"board_is_archived":{"type":"boolean","name":"board_is_archived","propertyRow":true},"total_count":{"type":"integer","name":"total_count","propertyRow":true},"unread_count":{"type":"integer","name":"unread_count","propertyRow":true},"all_users":{"type":"array","items":{"type":"string","format":"","propertyRow":true},"name":"all_users","propertyRow":true},"member_users":{"type":"array","items":{"type":"string","format":"","propertyRow":true},"name":"member_users","propertyRow":true},"member_teams":{"type":"array","items":{"type":"string","format":"","propertyRow":true},"name":"member_teams","propertyRow":true},"board_created_by_user":{"type":"string","name":"board_created_by_user","propertyRow":true},"workorder_updated_at":{"type":"string","name":"workorder_updated_at","propertyRow":true},"workorder_updated_by_user":{"type":"string","name":"workorder_updated_by_user","propertyRow":true}}},"code":"200"}}}},"/v1/boards/{board_uuid}/groups":{"post":{"summary":"Create Group","description":"Creates a group for a board","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"group_name":{"type":"string"},"group_light_color_tailwind_id":{"type":"integer"},"group_dark_color_tailwind_id":{"type":"integer"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string"}}}}}},"get":{"summary":"Get Groups","description":"Retreieves the groups of a board","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean"},"show_done_only":{"type":"string"},"q":{"type":"string","format":"search"},"sort_by":{"type":"string","format":"PRIORITY_ASC or PRIORITY_DESC or CREATED_AT_ASC or CREATED_AT_DESC or UPDATED_AT_ASC or UPDATED_AT_DESC or DUE_DATE_ASC or DUE_DATE_DESC"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string"},"group_name":{"type":"string"},"group_created_at":{"type":"string"},"group_light_color_hex":{"type":"string"},"group_dark_color_hex":{"type":"string"}}}}}}},"/v2/groups/{group_uuid}":{"put":{"summary":"Update Group","description":"Updates the name, colors, or privacy of a group","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"group_name":{"type":"string","name":"group_name","propertyRow":true},"group_light_color_tailwind_id":{"type":"integer","name":"group_light_color_tailwind_id","propertyRow":true},"group_dark_color_tailwind_id":{"type":"integer","name":"group_dark_color_tailwind_id","propertyRow":true}}}},{"name":"group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"group_uuid":{"type":"string","name":"group_uuid","propertyRow":true},"group_name":{"type":"string","name":"group_name","propertyRow":true},"group_light_color_hex":{"type":"string","name":"group_light_color_hex","propertyRow":true},"group_dark_color_hex":{"type":"string","name":"group_dark_color_hex","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete Group","description":"Deletes a group","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object"}},{"name":"group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/workorders/{workorder_uuid}/checklist_items":{"post":{"summary":"Create checklist items","description":"Creates a checklist item for a workorder","tags":["Workorder","Checklist Item"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"checklist_item_text":{"type":"string"}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"}}}}}}},"/v1/checklist_items/{checklist_item_uuid}":{"put":{"summary":"Update checklist item","description":"Updates the text or completion of a checklist item","tags":["Workorder","Checklist Item"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"checklist_item_text":{"type":"string"},"checklist_item_is_completed":{"type":"boolean"}}}},{"name":"checklist_item_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"checklist_item_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete checklist item","description":"Deletes a checklist item","tags":["Workorder","Checklist Item"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"checklist_item_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/boards/{board_uuid}":{"put":{"summary":"Update Board","description":"Updates the name and privacy of a board","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"board_name":{"type":"string"},"board_is_private":{"type":"boolean"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete Board","description":"Marks a board for deletion. It'll be placed in trash for 30 days.","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"},{"name":"unmark_for_deletion","in":"body","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/boards/{board_uuid}/archive":{"put":{"summary":"Archive Board","description":"Archives a board","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"archive":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"},"board_is_archived":{"type":"boolean"}}}}}}},"/v1/organizations/{organization_uuid}/red_orange_thresholds":{"put":{"summary":"Update assets red orange thresholds","description":"Updates the organization's thesholds for red and orange regions for all assets","tags":["Organizations","OEE","Assets"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"organization_assets_red_threshold_min":{"type":"integer","format":"5"},"organization_assets_orange_threshold_min":{"type":"integer","format":"1"},"organization_down_color_id":{"type":"integer","format":"1"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_assets_red_threshold_min":{"type":"integer","format":"5"},"organization_assets_orange_threshold_min":{"type":"integer","format":"1"},"organization_down_color_id":{"type":"integer","format":"1"}}}}}}},"/v1/boards/{board_uuid}/members":{"post":{"summary":"Add Board Member","description":"Adds user(s) or a team(s) to a board","tags":["Workorder","Board","User","Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string","format":""}},"team_uuids":{"type":"array","items":{"type":"string","format":""}}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Change Board Member Role","description":"Changes the role of a user or team in a board","tags":["Workorder","Board","User","Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"username":{"type":"string"},"team_uuid":{"type":"string"},"is_owner":{"type":"boolean"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete Board Member","description":"Deletes a user or team from a board","tags":["Workorder","Board","User","Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"username":{"type":"string"},"team_uuid":{"type":"string"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get Board Members","description":"Retrieves user(s) of a board","tags":["Workorder","Board","User","Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_id":{"type":"integer"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"}}}}}}},"/v1/boards/{board_uuid}/workorders":{"get":{"summary":"Get Board Workorders","description":"Retreieves the workorders of all groups of an organization based on the requested paramters","tags":["Workorder","Board","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean"},"show_my_work_only":{"type":"boolean"},"q":{"type":"string","format":"search"},"sort_by":{"type":"string","format":"PRIORITY_ASC or PRIORITY_DESC or CREATED_AT_ASC or CREATED_AT_DESC or UPDATED_AT_ASC or UPDATED_AT_DESC or DUE_DATE_ASC or DUE_DATE_DESC"},"wo_status":{"type":"string","format":"\"WORKORDER_STATUS_IN_PROGRESS\" or \"WORKORDER_STATUS_OPEN\" or \"WORKORDER_STATUS_ON_HOLD\" or \"WORKORDER_STATUS_CLOSED\""},"wo_priority":{"type":"string","format":"\"WORKORDER_PRIORITY_NONE\" or \"WORKORDER_PRIORITY_LOW\" or \"WORKORDER_PRIORITY_MEDIUM\" or \"WORKORDER_PRIORITY_HIGH\""},"group_by":{"type":"string","format":"GROUP or ASSIGNEE or STATUS or PRIORITY or UPDATED_AT"},"require_parts":{"type":"string","format":"part_uuid"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"},"workorder_created_at":{"type":"string"},"workorder_updated_at":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_start_timestamp":{"type":"string"},"workorder_due_timestamp":{"type":"string"},"parent_workorder":{"type":"string"},"created_by_user":{"type":"string"},"assigned_to_users":{"type":"string"},"assigned_to_teams":{"type":"array","items":{"type":null,"format":""}},"assignees":{"type":"array","items":{"type":null,"format":""}},"assignees_username":{"type":"array","items":{"type":"string","format":""}},"workorder_status":{"type":"string"},"workorder_priority":{"type":"string"},"workorder_asset":{"type":"string"},"workorder_files":{"type":"array","items":{"type":"string","format":"{file_id: 26 file_created_at: \"2024-07-24T04:12:35.507858\" file_name: \"OnPrem.svg\" file_uuid: \"file_353ada6e56032d60f80fb508d374c657\" file_uploaded_by_user_id: 2 file_uploaded_in_organization_id: 2 file_size: 580727 file_type: \"image/svg xml\" file_is_compressed: false file_is_voice: false workorder_has_file_workorder_id: 92 workorder_has_file_file_id: 26 compressed_image_url:\"...\"}"}}}}}}},"post":{"summary":"Create Workorder","description":"Creates a workorder","tags":["Workorder","Board","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"parent_workorder_uuid":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_asset_uuid":{"type":"string"},"workorder_due_date":{"type":"string","format":"2024-11-12"},"workorder_due_time":{"type":"string","format":"09:00:00"},"workorder_start_date":{"type":"string","format":"2024-11-12"},"workorder_start_time":{"type":"string","format":"09:00:00"},"workorder_recurrence_frequency_uuid":{"type":"string","format":"DAILY or WEEKLY or MONTHLY or YEARLY"},"workorder_recurrence_interval":{"type":"number","format":"1"},"workorder_recurrence_days_of_week":{"type":"array","items":{"type":"number","format":"[1,2,3,4,5]"}},"workorder_recurrence_month_order_uuid":{"type":"string","format":"FIRST or SECOND or THIRD or FORTH or LAST"},"workorder_recurrence_end_date":{"type":"string","format":"2024-11-12"},"workorder_recurrence_end_time":{"type":"string","format":"09:00:00"},"workorder_priority_uuid":{"type":"string","format":"WORKORDER_PRIORITY_NONE or WORKORDER_PRIORITY_LOW or WORKORDER_PRIORITY_MEDIUM or WORKORDER_PRIORITY_HIGH"},"assignee_handles":{"type":"array","items":{"type":"string","format":"support:company"}},"workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}},"workorder_group_uuid":{"type":"string"},"workorder_duration_min":{"type":"integer","format":"60"},"workorder_due_timestamptz":{"type":"string"},"workorder_start_timestamptz":{"type":"string"},"workorder_recurrence_end_timestamptz":{"type":"string"},"workorder_sessions":{"type":"array","items":{"type":"string","format":"{workorder_session_started_at: '2026-06-24 00:00:00+00', workorder_session_finished_at: '2026-06-24 00:02:00+00', workorder_session_quantity_made: 1: workorder_session_scraps: [{scrap_quantity: int, scrap_reason_code_uuid: string optional, scrap_note: string optional}], workorder_session_note: ''}"}},"workorder_requires_parts":{"type":"array","items":{"type":"string","format":"{part_uuid: 'prt_abcdefgh', quantity: 12.54}"}}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"}}}}}}},"/v1/boards/{board_uuid}/pin":{"put":{"summary":"Pin Board","description":"Updates the pin setting of a board","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"board_is_pinned":{"type":"boolean"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"}}}}}}},"/v1/assets/{asset_uuid}/operator_clocks":{"post":{"summary":"Create Operator Clock In/Out","description":"Creates a new clock in or out record for an asset for an operator","tags":["User","Operator","Asset"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"signed_in":{"type":"boolean"},"operator_clock_timestamp":{"type":"string","format":"optional timestamptz"},"operator_username":{"type":"string","format":"optional username of the operator"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get Operator Clock In/Out","description":"Retrieves a clock in or out records for an asset","tags":["User","Operator","Asset"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"from","in":null,"required":true,"type":"string","format":"2025-01-10T12:30:45.123Z"},{"name":"to","in":null,"required":true,"type":"string","format":"2025-01-20T12:30:45.123Z"},{"name":"operator_username","in":null,"required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operator_clock_uuid":{"type":"string","format":"opcl_5c1e8207483963e09c64c6db30f40e56"},"operator_clock_timestamp":{"type":"string","format":"2025-03-04 08:00:00"},"operator_clock_state":{"type":"boolean"},"user_id":{"type":"integer"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_image_url":{"type":"string"}}}}}}},"/v2/group_colors":{"get":{"summary":"Get Group Colors","description":"Retreieves the allowed light and dark colors for groups in an organization","tags":["Workorder","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tailwind_color_name":{"type":"string","format":"Orange"},"tailwind_light_color_id":{"type":"integer","format":"157"},"tailwind_light_color_hex":{"type":"string","format":"#ea580c"},"tailwind_dark_color_id":{"type":"integer","format":"155"},"tailwind_dark_color_hex":{"type":"string","format":"#fb923c"}}}}}}},"/v1/organizations/{organization_uuid}/member":{"get":{"summary":"Get organization member","description":"Retrieves the user information of the organization with their organization role","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_phone_number":{"type":"string"},"user_image_url":{"type":"string"},"user_username":{"type":"string"},"organization_member_role_id":{"type":"number"},"organization_member_role_name":{"type":"string"},"organization_member_role_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/operators_report":{"get":{"summary":"Get operators report","description":"Returns operators' utilization report for each asset in an organizations based on their clock-in clock-outs","tags":["Organizations","Asset","SenseAI","Operator"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"tags","in":"query","required":false,"type":"string","format":"comma seperated tags"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":false,"type":"string","format":"search keywords"},{"name":"from","in":"query","required":true,"type":"string","format":"2025-03-05 17:28:31.86887+00"},{"name":"to","in":"query","required":true,"type":"string","format":"2025-03-05 17:28:31.86887+00"},{"name":"usernames","in":"query","required":false,"type":"string"},{"name":"machines","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_uuid":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"node_uuid":{"type":"string"},"node_name":{"type":"string"},"shift_states_svg":{"type":"string","format":"<svg width=\"172800.000000\" height=\"100\"  xmlns=..."},"passedtime_hours":{"type":"number"},"runtime_hours":{"type":"number","format":"340.988843"},"downtime_hours":{"type":"number","format":"340.988843"},"runtime_percentage":{"type":"number","format":"0.45"},"downtime_percentage":{"type":"number","format":"0.24"},"clocked_items":{"type":"array","items":{"type":"string","format":"{\"operator_clock_id\":20,\"operator_clock_start_timestamp\":\"2025-03-04T10:58:00+00:00\",\"operator_clock_end_timestamp\":\"2025-03-04T13:00:19+00:00\",\"category\":\"Tue Mar 04, 05:03am\",\"passedtime_hours\":2.0386111111111111,\"runtime_hours\":0.10833888888888888889,\"downtime_hours\":1.9302722222222222,\"runtime_percentage\":0.05314348003815233683,\"downtime_percentage\":0.94685651996184766317}"}}}}}}}},"/v1/operator_clocks/{operator_clock_uuid}":{"put":{"summary":"Update Operator Clock Record","description":"Updates a clock in or out record of an operator for an asset","tags":["User","Operator","Asset"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"operator_clock_timestamp":{"type":"string","format":"2025-01-10T12:30:45.123Z"},"operator_clock_state":{"type":"boolean"}}}},{"name":"operator_clock_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operator_clock_uuid":{"type":"string","format":"opcl_5c1e8207483963e09c64c6db30f40e56"},"operator_clock_timestamp":{"type":"string","format":"2025-03-04 08:00:00"},"operator_clock_state":{"type":"boolean"},"user_id":{"type":"integer"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_image_url":{"type":"string"}}}}}},"delete":{"summary":"Delete Operator Clock Record","description":"Deletes a clock in or out record of an operator for an asset","tags":["User","Operator","Asset"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operator_clock_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operator_clock_uuid":{"type":"string","format":"opcl_5c1e8207483963e09c64c6db30f40e56"},"operator_clock_timestamp":{"type":"string","format":"2025-03-04 08:00:00"},"operator_clock_state":{"type":"boolean"},"user_id":{"type":"integer"},"user_username":{"type":"string"},"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_image_url":{"type":"string"}}}}}}},"/v1/workorders/{workorder_uuid}/pin":{"put":{"summary":"Pin Board","description":"Updates the pin setting of a workorder","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"workorder_is_pinned":{"type":"boolean"}}}},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"}}}}}}},"/v1/boards/{board_uuid}/teams":{"get":{"summary":"Get Board Members","description":"Retrieves team(s) of a board","tags":["Workorder","Board","User","Team"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"team_id":{"type":"integer"},"team_uuid":{"type":"string"},"team_name":{"type":"string"}}}}}}},"/v1/boards/{board_uuid}/permanently":{"delete":{"summary":"Delete Board Permanently","description":"Deletes a board permanently","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"board_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/down_colors":{"get":{"summary":"Get Down Colors","description":"Retreieves the allowed light and dark colors for down colors","tags":["Organizations","OEE"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"down_light_color":{"type":"string","format":"{\"tailwind_id\": 27, \"tailwind_hex\": \"#dc2626\", \"tailwind_intensity\": 600, \"tailwind_color_name\": \"Red\", \"tailwind_color_name_id\": 3, \"tailwind_tailwind_color_id\": 3}"},"down_dark_color":{"type":"string","format":"{\"tailwind_id\": 27, \"tailwind_hex\": \"#dc2626\", \"tailwind_intensity\": 600, \"tailwind_color_name\": \"Red\", \"tailwind_color_name_id\": 3, \"tailwind_tailwind_color_id\": 3}"}}}}}}},"/v1/organizations/{organization_uuid}/organization_down_colors":{"put":{"summary":"Update down color","description":"Updates the organization's down color from default red to a custom color","tags":["Organizations","OEE"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"organization_down_color_id":{"type":"integer","format":"1"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_down_color_id":{"type":"integer","format":"1"}}}}}}},"/v1/assets/{asset_uuid}/last_operation_history":{"get":{"summary":"Get Asset Last Operation History","description":"Retrieves the cycle time of the last operation that was made on this asset","tags":["Productions","Operations","Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"shift_date","in":"query","required":false,"type":"string","format":"2022-11-03"},{"name":"shift_start_time","in":"query","required":false,"type":"string","format":"17:00:00"},{"name":"shift_entire_day","in":"query","required":false,"type":"boolean","format":"true"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_name":{"type":"string"},"operation_name":{"type":"string"},"operation_cycle_time":{},"operation_stdev":{},"operation_made_id":{"type":"integer"},"operation_made_cycle_time":{"type":"string"},"operation_made_cycle_time_s":{"type":"number"}}}}}}},"/v1/organization_assets/{asset_uuid}/short_downtime_function":{"put":{"summary":"Set Asset Short Downtime Function","description":"Sets the short downtime function for an asset to either classify downtimes or convert them to uptimes","tags":["Assets","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"asset_filter_downtime_instead_of_classification":{"type":"boolean","format":"true"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_filter_downtime_instead_of_classification":{"type":"boolean"}}}}}}},"/v1/nodes/{node_uuid}/filter_downtime_seconds":{"put":{"summary":"Set node filter_downtime_seconds","description":"Sets the node_filter_downtime_seconds value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_acoustic_lower_threshold":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/billing/subscriptions":{"get":{"summary":"Get organization subscriptions","description":"Retreives the active subscriptions of an organization","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"subscriptoins":{}}}}}}},"/v1/billing/products/{stripe_product_id}":{"get":{"summary":"Get product info for shop","description":"Retreives the information of a given product for shop","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"stripe_product_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/billing/products/{stripe_product_id}/prices":{"get":{"summary":"Get prices of a given product","description":"Retreives the price list of a given product for shop","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"stripe_product_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/billing/coupons/{coupon_id}":{"get":{"summary":"Get coupon","description":"Retreives the details of a given coupon","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"coupon_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/billing/products/{stripe_product_id}/info":{"get":{"summary":"Get product info","description":"Retreives the product, prices, and coupon info of a product","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"stripe_product_id","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"coupon_code","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/billing/products":{"get":{"summary":"Get products for shop","description":"Retreives the shop products given stripe_product_ids","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"stripe_product_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/initial-free":{"post":{"summary":"Create organization","description":"Creates an organization with \"Organization Owner\" role without payment method requirement","tags":["Organizations"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"organization_name":{"type":"string"},"organization_description":{"type":"string"},"organization_is_private":{"type":"boolean"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"organization_uuid":{"type":"string"},"organization_name":{"type":"string"},"organization_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/update-subscription-order-process":{"post":{"summary":"Update Subscription","description":"Updates subscription and processes payment","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"cart_items":{"type":"array","items":{"type":"string","format":"{'price': 'price_1SFye6KI2r9dYktAMncyZKla',  'quantity': 2}","propertyRow":true},"name":"cart_items","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"subscription":{"type":"string","name":"subscription","propertyRow":true}}},"code":"200"}}}},"/v1/new-customer-subscription":{"post":{"summary":"Create New Customer Subscription","description":"Creates a subscription for new clients to be paid on frontend","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"company":{"type":"string"},"shipping_address":{"type":"string","format":"{name: \"\", address: \"\", address2: \"\",  city: \"\", state: \"\", zipCode: \"required\", country: \"required\"}"},"billing_address":{"type":"string","format":"{name: \"\", address: \"\", address2: \"\",  city: \"\", state: \"\", zipCode: \"required\", country: \"required\"}"},"cart_items":{"type":"string","format":"{'price': 'price_1SFye6KI2r9dYktAMncyZKla',  'quantity': 2}"},"customer_id":{"type":"string","format":"optional customer id"},"first_name":{"type":"string"},"last_name":{"type":"string"},"promotion_code":{"type":"array","items":{"type":"string","format":"optional promotion code"}},"payment_method":{"type":"string","format":"stripe payment method from setup intent"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"payment_intent_id":{"type":"string"},"subscription":{"type":"string","format":"optional subscription object if an actual subscription was created"},"invoice":{"type":"string","format":"optional invoice if no subscription was created"}}}}}}},"/v3/organizations/{organization_uuid}/shift_productions":{"get":{"summary":"Get shift production hourly","description":"Retrieves the hourly operations made for each asset and operation in a given shift ","tags":["Productions","Parts","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"parts","in":"query","required":false,"type":"string"},{"name":"departments","in":"query","required":false,"type":"string"},{"name":"shift_entire_day","in":"query","required":false},{"name":"shift_date","in":"query","required":false},{"name":"shift_start_time","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operations":{"type":"array","items":{"type":"string","format":"{\"operation_uuid\":\"op_47f19ce027808753b4a34ae3532b1db5\",\"operation_name\":\"OP100-CUTTING-BLANK\",\"part_uuid\":\"part_b480900e6025964d2bcb2df060eba083\",\"part_name\":\"Aluminum can\",\"part_picture_url\":\"https://iotflows-parts-pictures.s3.amazonaws.com/part_b480900e6025964d2bcb2df060eba083.png\",\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"assets\":[{\"asset_id\":311,\"asset_uuid\":\"as_test_mill\",\"asset_custom_name\":null,\"asset_custom_identifier\":\"TXZ42-MILL\",\"machine_name\":\"Milling Machine\",\"machine_identifier\":\"generic-mill\",\"department_uuid\":\"dp_205013703244ace3a25fbe6ed0da3fd5\",\"asset_operation_hourly_goal_count\":37.5,\"asset_operation_shift_goal_count\":300,\"operation_id\":37,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0,\"cycle_time\":\"00:00:59.9942\",\"hourly_operations_made\":[{\"interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T21:00:00+00:00\",\"cycle_time\":\"00:00:59.9942\",\"operation_count\":10,\"last_operation_made_timestamp\":\"2024-06-21T21:14:24.356+00:00\",\"overridden_good_count\":10,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T22:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-21T23:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T00:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T01:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T02:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T03:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T04:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0},{\"interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"operation_id\":37,\"asset_id\":311,\"temp_interval_timestamp\":\"2024-06-22T05:00:00+00:00\",\"cycle_time\":null,\"operation_count\":null,\"last_operation_made_timestamp\":null,\"overridden_good_count\":null,\"overridden_bad_count\":0}]}]}"}},"progress":{"type":"number","format":"0.034"}}}}}}},"/v1/organizations/{organization_uuid}/workorders":{"post":{"summary":"Create Workorder","description":"Creates a workorder","tags":["Workorder","Board","Group"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"parent_workorder_uuid":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_asset_uuid":{"type":"string"},"workorder_due_date":{"type":"string","format":"2024-11-12"},"workorder_due_time":{"type":"string","format":"09:00:00"},"workorder_start_date":{"type":"string","format":"2024-11-12"},"workorder_start_time":{"type":"string","format":"09:00:00"},"workorder_recurrence_frequency_uuid":{"type":"string","format":"DAILY or WEEKLY or MONTHLY or YEARLY"},"workorder_recurrence_interval":{"type":"number","format":"1"},"workorder_recurrence_days_of_week":{"type":"array","items":{"type":"number","format":"[1,2,3,4,5]"}},"workorder_recurrence_month_order_uuid":{"type":"string","format":"FIRST or SECOND or THIRD or FORTH or LAST"},"workorder_recurrence_end_date":{"type":"string","format":"2024-11-12"},"workorder_recurrence_end_time":{"type":"string","format":"09:00:00"},"workorder_priority_uuid":{"type":"string","format":"WORKORDER_PRIORITY_NONE or WORKORDER_PRIORITY_LOW or WORKORDER_PRIORITY_MEDIUM or WORKORDER_PRIORITY_HIGH"},"assignee_handles":{"type":"array","items":{"type":"string","format":"support:company"}},"workorder_file_uuids":{"type":"array","items":{"type":"string","format":"file_uuid"}},"workorder_group_uuid":{"type":"string"},"workorder_duration_min":{"type":"integer","format":"60"},"workorder_due_timestamptz":{"type":"string"},"workorder_start_timestamptz":{"type":"string"},"workorder_recurrence_end_timestamptz":{"type":"string"},"workorder_sessions":{"type":"array","items":{"type":"string","format":"{workorder_session_started_at: '2026-06-24 00:00:00+00', workorder_session_finished_at: '2026-06-24 00:02:00+00', workorder_session_quantity_made: 1: workorder_session_scraps: [{scrap_quantity: int, scrap_reason_code_uuid: string optional, scrap_note: string optional}], workorder_session_note: ''}"}},"workorder_requires_parts":{"type":"array","items":{"type":"string","format":"{part_uuid: 'prt_abcdefgh', quantity: 12.54}"}}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"}}}}}},"get":{"summary":"Get Workorders","description":"Retreieves the workorders of an organization based on the requested paramters","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"assigned_to_me_only":{"type":"boolean"},"show_done_only":{"type":"string"},"q":{"type":"string","format":"search"},"sort_by":{"type":"string","format":"PRIORITY_ASC or PRIORITY_DESC or CREATED_AT_ASC or CREATED_AT_DESC or UPDATED_AT_ASC or UPDATED_AT_DESC or DUE_DATE_ASC or DUE_DATE_DESC"},"wo_status":{"type":"string","format":"\"WORKORDER_STATUS_IN_PROGRESS\" or \"WORKORDER_STATUS_OPEN\" or \"WORKORDER_STATUS_ON_HOLD\" or \"WORKORDER_STATUS_CLOSED\""},"wo_priority":{"type":"string","format":"\"WORKORDER_PRIORITY_NONE\" or \"WORKORDER_PRIORITY_LOW\" or \"WORKORDER_PRIORITY_MEDIUM\" or \"WORKORDER_PRIORITY_HIGH\""},"require_parts":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_uuid":{"type":"string"},"workorder_created_at":{"type":"string"},"workorder_updated_at":{"type":"string"},"workorder_title":{"type":"string"},"workorder_description":{"type":"string"},"workorder_start_timestamp":{"type":"string"},"workorder_due_timestamp":{"type":"string"},"parent_workorder":{"type":"string"},"created_by_user":{"type":"string"},"assigned_to_users":{"type":"string"},"assigned_to_teams":{"type":"array","items":{"type":null,"format":""}},"assignees":{"type":"array","items":{"type":null,"format":""}},"assignees_username":{"type":"array","items":{"type":"string","format":""}},"workorder_status":{"type":"string"},"workorder_priority":{"type":"string"},"workorder_asset":{"type":"string"},"workorder_files":{"type":"array","items":{"type":"string","format":"{file_id: 26 file_created_at: \"2024-07-24T04:12:35.507858\" file_name: \"OnPrem.svg\" file_uuid: \"file_353ada6e56032d60f80fb508d374c657\" file_uploaded_by_user_id: 2 file_uploaded_in_organization_id: 2 file_size: 580727 file_type: \"image/svg xml\" file_is_compressed: false file_is_voice: false workorder_has_file_workorder_id: 92 workorder_has_file_file_id: 26 compressed_image_url:\"...\"}"}}}}}}}},"/v1/workorders/{workorder_uuid}/permanently":{"delete":{"summary":"Delete Workorder Permanently","description":"Deletes a workorder permanently.","tags":["Workorder","Group","Board"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/workorders/{workorder_uuid}/workorder_sessions":{"post":{"summary":"Create workorder session","description":"Creates a session for a workorder","tags":["Workorder","Session"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"workorder_session_started_at":{"type":"string"},"workorder_session_finished_at":{"type":"string"},"workorder_session_quantity_made":{"type":"integer"},"workorder_session_note":{"type":"string"}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_session_uuid":{"type":"string"}}}}}},"get":{"summary":"Get workorder sessions","description":"Retreieves sessions of a given workorder","tags":["Workorder","Session"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_session_uuid":{"type":"string"},"workorder_session_workorder_id":{},"workorder_session_started_at":{},"workorder_session_finished_at":{},"workorder_session_quantity_made":{},"workorder_session_note":{},"workorder_session_updated_by_user_id":{},"workorder_session_updated_by_user":{},"workorder_session_workorder":{}}}}}}},"/v1/workorder_sessions/{workorder_session_uuid}":{"put":{"summary":"Update workorder session","description":"Updates a workorder session parameters","tags":["Workorder","Session"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"workorder_session_started_at":{"type":"string"},"workorder_session_finished_at":{"type":"string"},"workorder_session_quantity_made":{"type":"integer"},"workorder_session_note":{"type":"string"}}}},{"name":"workorder_session_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_session_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete workorder session","description":"Deletes a workorder session","tags":["Workorder","Session"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_session_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/address":{"put":{"summary":"Update Organization Address","description":"Updates the shipping and billing address of the organization","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"shipping_address":{"type":"string","format":"{address: '123 Main Street', address2: 'unit 1', city:'Atlanta', state: 'Georgia', zipCode: '30328', country: 'US'}"},"billing_address":{"type":"string","format":"{address: '123 Main Street', address2: 'unit 1', city:'Atlanta', state: 'Georgia', zipCode: '30328', country: 'US'}"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"subscription":{"type":"string"}}}}}}},"/v1/billing/promotion_codes/{promotion_code}":{"get":{"summary":"Get promotion code","description":"Retreives the details of a given promotion code","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"promotion_code","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/billing/preview_upcoming_invoice":{"post":{"summary":"Get organization preview upcoming invoice","description":"Retreives a preview of the upcoming invoice of a customer (organization) given the products and quantities","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"cart_items":{"type":"array","items":{"type":"string","format":"{'price': 'price_1SFye6KI2r9dYktAMncyZKla',  'quantity': 2}"}}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"invoices":{}}}}}}},"/v1/organizations/{organization_uuid}/preview_upcoming_invoice":{"post":{"summary":"Preview Upcoming Invoice","description":"Retrieves a preview of the upcoming invoice based on the new cart items","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"cart_items":{"type":"array","items":{"type":"string","format":"{'price': 'price_1SFye6KI2r9dYktAMncyZKla',  'quantity': 2}","propertyRow":true},"name":"cart_items","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"subscription":{"type":"string","name":"subscription","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/billing/receive_paid_invoices":{"put":{"summary":"Change auto billing email","description":"Changes the organization setting to receive auto emails for invoice/receipts","tags":["Organizations","Billing"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"receive_paid_invoices":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/accel_range":{"put":{"summary":"Set node accel range","description":"Sets the accelerometer range (2, 4, 8, 16)G for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_accel_range":{"type":"integer","format":"2"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/all_metric_data":{"get":{"summary":"Get metric data","description":"Retrieves the data of all metrics of a give asset based on the given filters","tags":["Asset","Metric"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"},"board_name":{"type":"string"},"board_is_private":{"type":"boolean"},"board_created_at":{"type":"string"},"board_updated_at":{"type":"string"},"board_is_archived":{"type":"boolean"},"total_count":{"type":"integer"},"unread_count":{"type":"integer"},"all_users":{"type":"array","items":{"type":"string","format":""}},"member_users":{"type":"array","items":{"type":"string","format":""}},"member_teams":{"type":"array","items":{"type":"string","format":""}},"board_created_by_user":{"type":"string"},"workorder_updated_at":{"type":"string"},"workorder_updated_by_user":{"type":"string"}}}}}}},"/v1/nodes/{node_uuid}/should_publish_raw_and_fft":{"put":{"summary":"Set node should_publish_raw_and_fft","description":"Sets the node_should_publish_raw_and_fft value for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_should_publish_raw_and_fft":{"type":"boolean"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/publish_metrics_interval_min":{"put":{"summary":"Set node publish_metrics_interval_min","description":"Sets the node_publish_metrics_interval_min value for a SenseAi Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_publish_metrics_interval_min":{"type":"integer"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/shock_events":{"get":{"summary":"Get shock event data","description":"Retrieves the shock events of an asset based on the given filters","tags":["Asset","Shock"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"shock_event_timestamp":{"type":"string"},"shock_event_data":{"type":"array","items":{"type":"string","format":""}},"shock_event_max_g":{"type":"number"}}}}}}},"/v1/assets/{asset_uuid}/fft_data":{"get":{"summary":"Get fft metric data","description":"Retrieves the fft spectrum and harmonix of all axis of the last acquisition or at a given timestamp","tags":["Asset","Metric"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"at_timestamp","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"},"board_name":{"type":"string"},"board_is_private":{"type":"boolean"},"board_created_at":{"type":"string"},"board_updated_at":{"type":"string"},"board_is_archived":{"type":"boolean"},"total_count":{"type":"integer"},"unread_count":{"type":"integer"},"all_users":{"type":"array","items":{"type":"string","format":""}},"member_users":{"type":"array","items":{"type":"string","format":""}},"member_teams":{"type":"array","items":{"type":"string","format":""}},"board_created_by_user":{"type":"string"},"workorder_updated_at":{"type":"string"},"workorder_updated_by_user":{"type":"string"}}}}}}},"/v1/assets/{asset_uuid}/events":{"get":{"summary":"Get asset events","description":"Retrieves the asset events based on the given conditions","tags":["Assets","Events"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"query","description":"only_show_dismissed_events","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_event_timestamptz":{"type":"string"},"asset_event_value":{"type":"number"},"asset_event_uuid":{"type":"string"},"asset_event_type_severity":{"type":"string"},"asset_event_type_title":{"type":"string"},"asset_event_type_message":{"type":"string"},"asset_event_type_metric_name":{"type":"string"}}}}}},"put":{"summary":"Dimiss asset events","description":"Dimisses an array of asset events","tags":["Assets","Events"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_event_dismissed":{"type":"boolean"},"asset_event_uuids":{"type":"string","format":"[uuid1, uuid2]"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_event_timestamptz":{"type":"string"},"asset_event_value":{"type":"number"},"asset_event_uuid":{"type":"string"},"asset_event_type_severity":{"type":"string"},"asset_event_type_title":{"type":"string"},"asset_event_type_message":{"type":"string"},"asset_event_type_metric_name":{"type":"string"}}}}}}},"/v1/asset_events/{asset_event_uuid}":{"put":{"summary":"Dimiss asset event","description":"Dimisses an asset event","tags":["Assets","Events"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_event_dismissed":{"type":"boolean","name":"asset_event_dismissed","propertyRow":true}}}},{"name":"asset_event_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_event_timestamptz":{"type":"string","name":"asset_event_timestamptz","propertyRow":true},"asset_event_value":{"type":"number","name":"asset_event_value","propertyRow":true},"asset_event_uuid":{"type":"string","name":"asset_event_uuid","propertyRow":true},"asset_event_type_severity":{"type":"string","name":"asset_event_type_severity","propertyRow":true},"asset_event_type_title":{"type":"string","name":"asset_event_type_title","propertyRow":true},"asset_event_type_message":{"type":"string","name":"asset_event_type_message","propertyRow":true},"asset_event_type_metric_name":{"type":"string","name":"asset_event_type_metric_name","propertyRow":true}}},"code":"200"}}}},"/v1/assets/{asset_uuid}/asset_event_type_settings":{"get":{"summary":"Get asset event type settings","description":"Retrieves the asset event type settings","tags":["Assets","Events"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_event_type_uuid":{"type":"string"},"asset_asset_event_type_setting_threshold":{"type":"number"},"asset_asset_event_type_setting_should_log":{"type":"boolean"},"asset_asset_event_type_setting_should_create_workorder":{"type":"boolean"},"asset_asset_event_type_setting_has_email_subscribed":{"type":"boolean"}}}}}}},"/v1/assets/{asset_uuid}/asset_event_types/{asset_event_type_uuid}":{"put":{"summary":"Update asset event type settings","description":"Updates the asset event type settings for email, log event, and workorder creation","tags":["Assets","Events"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"asset_event_type_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_asset_event_type_setting_threshold":{"type":"number","name":"asset_asset_event_type_setting_threshold","propertyRow":true},"asset_asset_event_type_setting_should_log":{"type":"boolean","name":"asset_asset_event_type_setting_should_log","propertyRow":true},"asset_asset_event_type_setting_should_create_workorder":{"type":"boolean","name":"asset_asset_event_type_setting_should_create_workorder","propertyRow":true},"asset_asset_event_type_setting_has_email_subscribed":{"type":"boolean","name":"asset_asset_event_type_setting_has_email_subscribed","propertyRow":true},"add_asset_event_type_integrations_integration_uuid":{"type":"string","name":"add_asset_event_type_integrations_integration_uuid","propertyRow":true},"delete_asset_event_type_integrations_integration_uuid":{"type":"string","name":"delete_asset_event_type_integrations_integration_uuid","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","code":"200"}}}},"/v1/organizations/{organization_uuid}/scrap_reason_codes":{"get":{"summary":"Get scrap reason codes","description":"Retrieves the scrap reason codes of an organization","tags":["Scrap"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scrap_reason_code_uuid":{"type":"string","name":"scrap_reason_code_uuid","propertyRow":true},"scrap_reason_code_name":{"type":"string","name":"scrap_reason_code_name","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create scrap reasons","description":"Creates a scrap reason code for an organization","tags":["Scrap"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"scrap_reason_code_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scrap_reason_code_uuid":{},"scrap_reason_code_name":{}}}}}}},"/v1/scrap_reason_codes/{scrap_reason_code_uuid}":{"delete":{"summary":"Archive scrap reason codes","description":"Archives a scrap reason code of an organization","tags":["Scrap"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"scrap_reason_code_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","code":"200"}}},"put":{"summary":"Update scrap reason codes","description":"Updates the name of a scrap reason code","tags":["Scrap"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"scrap_reason_code_name":{"type":"string"}}}},{"name":"scrap_reason_code_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scrap_reason_code_uuid":{},"scrap_reason_code_name":{}}}}}}},"/v1/nodes/{node_uuid}/reading_moving_average_count":{"put":{"summary":"Set node reading_moving_average_count","description":"Sets the node_reading_moving_average_count value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_reading_moving_average_count":{"type":"integer"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/calibration_min_object_tickness":{"put":{"summary":"Set node calibration_min_object_tickness","description":"Sets the node_calibration_min_object_tickness value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_calibration_min_object_tickness":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/calibration_gap_from_background":{"put":{"summary":"Set node calibration_gap_from_background","description":"Sets the node_calibration_gap_from_background value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_calibration_gap_from_background":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/calibration_max_distance":{"put":{"summary":"Set node calibration_max_distance","description":"Sets the node_calibration_max_distance value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_calibration_max_distance":{"type":"number"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organization_assets/{asset_uuid}/historical_data":{"delete":{"summary":"Delete historical data","description":"Permanently deletes historical data of an asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/board_info":{"get":{"summary":"Get Board Info","description":"Retreieves the board information of an organization based on the requested workorder type","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"workorder_type":{"type":"string","format":"production, maintenance, etc"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"board_uuid":{"type":"string"},"group_uuid":{"type":"string"}}}}}}},"/v1/assets/{asset_uuid}/notes":{"post":{"summary":"Create asset notes","description":"Creates an asset note","tags":["Assets","Notes"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_note_text":{"type":"string"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_note_uuid":{"type":"string"}}}}}},"get":{"summary":"Get asset notes","description":"Retrieves asset notes","tags":["Assets","Notes"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_note_uuid":{"type":"string"},"asset_note_created_at":{"type":"string"},"asset_note_updated_at":{"type":"string"},"asset_note_created_by_user":{"type":"string","format":"{user object}"},"asset_note_updated_by_user":{"type":"string","format":"{user object}"},"asset_note_text":{"type":"string"}}}}}}},"/v1/asset_notes/{asset_note_uuid}":{"put":{"summary":"Update asset note","description":"Updates an asset note","tags":["Assets","Notes"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_note_text":{"type":"string"}}}},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_note_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete asset note","description":"Deletes an asset note","tags":["Assets","Notes"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_note_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_note_uuid":{"type":"string"}}}}}}},"/v1/organization_assets/{asset_uuid}/baseline_profile":{"put":{"summary":"Update asset baseline profile","description":"Updates the asset baseline profile to dynamic or preset types","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_baseline_profile":{"type":"string","format":"dynamic or iso_class_1 or iso_class_2 or iso_class_3 or iso_class_4 or pump_centrifugal or pump_positive_displacement or motor_electric or fan_blower or compressor_reciprocating or compressor_screw or gearbox or turbine"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/meters":{"get":{"summary":"Get asset meters","description":"Retrieves the meters of an asset that could be based on runtime, production count, and more","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_uuid":{"type":"string"},"meter_created_at":{"type":"string"},"meter_name":{"type":"boolean"},"meter_type_uuid":{"type":"string"},"meter_type_name":{"type":"string"},"meter_threshold":{"type":"integer"},"meter_workorder_creation_enabled":{"type":"boolean"},"meter_early_warning_enabled":{"type":"boolean"}}}}}},"post":{"summary":"Create asset meters","description":"Creates a meter for an asset that could be based on runtime, production count, and more","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"meter_name":{"type":"string"},"meter_type_uuid":{"type":"string","format":"METER_RUNTIME_HOURS or METER_PRODUCTION_COUNT"},"meter_workorder_creation_enabled":{"type":"boolean"},"meter_threshold":{"type":"integer"},"meter_early_warning_enabled":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_uuid":{"type":"string"},"meter_created_at":{"type":"string"},"meter_name":{"type":"boolean"},"meter_type_uuid":{"type":"string"},"meter_type_name":{"type":"string"},"meter_threshold":{"type":"integer"},"meter_workorder_creation_enabled":{"type":"boolean"},"meter_early_warning_enabled":{"type":"boolean"}}}}}}},"/v1/meter_types":{"get":{"summary":"Get meter types","description":"Retrieves the meter types","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_uuid":{"type":"string"},"meter_created_at":{"type":"string"},"meter_name":{"type":"boolean"},"meter_type_uuid":{"type":"string"},"meter_type_name":{"type":"string"},"meter_threshold":{"type":"integer"},"meter_workorder_creation_enabled":{"type":"boolean"},"meter_early_warning_enabled":{"type":"boolean"}}}}}}},"/v1/meters/{meter_uuid}":{"put":{"summary":"Update meter","description":"Updates a meter for an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"meter_name":{"type":"string","name":"meter_name","propertyRow":true},"meter_type_uuid":{"type":"string","format":"METER_RUNTIME_HOURS or METER_PRODUCTION_COUNT","name":"meter_type_uuid","propertyRow":true},"meter_workorder_creation_enabled":{"type":"boolean","name":"meter_workorder_creation_enabled","propertyRow":true},"meter_threshold":{"type":"integer","name":"meter_threshold","propertyRow":true},"meter_early_warning_enabled":{"type":"boolean","name":"meter_early_warning_enabled","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_uuid":{"type":"string","name":"meter_uuid","propertyRow":true},"meter_created_at":{"type":"string","name":"meter_created_at","propertyRow":true},"meter_name":{"type":"boolean","name":"meter_name","propertyRow":true},"meter_type_uuid":{"type":"string","name":"meter_type_uuid","propertyRow":true},"meter_type_name":{"type":"string","name":"meter_type_name","propertyRow":true},"meter_threshold":{"type":"integer","name":"meter_threshold","propertyRow":true},"meter_workorder_creation_enabled":{"type":"boolean","name":"meter_workorder_creation_enabled","propertyRow":true},"meter_early_warning_enabled":{"type":"boolean","name":"meter_early_warning_enabled","propertyRow":true}}},"code":"200"}}},"delete":{"summary":"Delete meter","description":"Deletes a meter for an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get an asset meter","description":"Retrieves the information of a meter of an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_uuid":{"type":"string"},"meter_created_at":{"type":"string"},"meter_name":{"type":"boolean"},"meter_type_uuid":{"type":"string"},"meter_type_name":{"type":"string"},"meter_threshold":{"type":"integer"},"meter_workorder_creation_enabled":{"type":"boolean"},"meter_early_warning_enabled":{"type":"boolean"}}}}}}},"/v1/meters/{meter_uuid}/data":{"get":{"summary":"Get meter data","description":"Retreieves the data of a meter of an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string"},"daily_usage":{"type":"integer"},"segment_id":{"type":"integer"},"cumulative_usage":{"type":"integer"},"is_projection":{"type":"boolean"}}}}}}},"/v1/meters/{meter_uuid}/resets":{"get":{"summary":"Get meter resets","description":"Retreieves the meter resets of a meter of an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_reset_uuid":{"type":"string"},"meter_reset_date":{"type":"string"},"meter_reset_updated_by_user":{"type":"string"},"meter_reset_updated_at":{"type":"string"}}}}}},"post":{"summary":"Create meter resets","description":"Creates a meter reset for a meter of an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"meter_reset_timestamp":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_reset_uuid":{"type":"string"},"meter_reset_date":{"type":"string"},"meter_reset_updated_by_user":{"type":"string"},"meter_reset_updated_at":{"type":"string"}}}}}}},"/v1/meter_resets/{meter_reset_uuid}":{"delete":{"summary":"Delete meter resets","description":"Deletes a meter reset for a meter of an asset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"meter_reset_timestamp":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_reset_uuid":{"type":"string"},"meter_reset_date":{"type":"string"},"meter_reset_updated_by_user":{"type":"string"},"meter_reset_updated_at":{"type":"string"}}}}}},"put":{"summary":"Update meter reset date","description":"Updates the date of a meter reset","tags":["Asset","Meter"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"meter_reset_date":{"type":"string"}}}},{"name":"meter_reset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"meter_reset_uuid":{"type":"string"},"meter_reset_date":{"type":"string"},"meter_reset_updated_by_user":{"type":"string"},"meter_reset_updated_at":{"type":"string"}}}}}}},"/v1/meters/{meter_uuid}/workorders":{"get":{"summary":"Get meter workorders","description":"Retreieves the workorders of a meter of an asset","tags":["Asset","Meter","Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"meter_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"date":{"type":"string","name":"date","propertyRow":true},"incremental_value":{"type":"integer","name":"incremental_value","propertyRow":true},"cumulative_value":{"type":"integer","name":"cumulative_value","propertyRow":true}}},"code":"200"}}}},"/v1/nodes/{node_uuid}/publish_stop_after_running_seconds":{"put":{"summary":"Set node publish_stop_after_running_seconds","description":"Sets the node_publish_stop_after_running_seconds value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_publish_stop_after_running_seconds":{"type":"integer","format":"0 will disable"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/integration_applications":{"get":{"summary":"Get integration applications","description":"Retrieves the list of integration applications","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"integration_application_uuid":{"type":"string"},"integration_application_name":{"type":"string"},"integration_application_icon_url":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/integrations":{"get":{"summary":"Get integrations","description":"Retrieves the integrations of a given organization","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"integration_uuid":{"type":"string","name":"integration_uuid","propertyRow":true},"integration_name":{"type":"string","name":"integration_name","propertyRow":true},"integration_application":{"type":"string","format":"{integration_application_uuid: \"\", integration_aplication_name: \"\", integration_application_icon_url: \"\"}","name":"integration_application","propertyRow":true},"integration_created_at":{"type":"string","name":"integration_created_at","propertyRow":true},"integration_updated_at":{"type":"string","name":"integration_updated_at","propertyRow":true},"integration_created_by_user":{"type":"string","format":"user object","name":"integration_created_by_user","propertyRow":true},"integration_updated_by_user":{"type":"string","format":"user object","name":"integration_updated_by_user","propertyRow":true},"integration_webhook_url":{"type":"string","name":"integration_webhook_url","propertyRow":true},"integration_is_enabled":{"type":"boolean","name":"integration_is_enabled","propertyRow":true}}},"code":"200"}}},"post":{"summary":"Create an integration","description":"Creates an integration for a given organization","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"integration_name ":{"type":"string"},"integration_application_uuid":{"type":"string"},"integration_webhook_url":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"integration_uuid":{"type":"string"},"integration_name":{"type":"string"},"integration_application_uuid":{"type":"string"},"integration_webhook_url":{"type":"string"},"integration_is_enabled":{"type":"boolean"}}}}}}},"/v1/integrations/{integration_uuid}":{"delete":{"summary":"Delete integration","description":"Deletes an integration for an organization","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"put":{"summary":"Update integration","description":"Updates an integration's name, url, status","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"integration_uuid":{"type":"string"},"integration_name":{"type":"string"},"integration_application":{"type":"string","format":"{integration_application_uuid: \"\", integration_aplication_name: \"\", integration_application_icon_url: \"\"}"},"integration_created_at":{"type":"string"},"integration_updated_at":{"type":"string"},"integration_created_by_user":{"type":"string","format":"user object"},"integration_updated_by_user":{"type":"string","format":"user object"},"integration_webhook_url":{"type":"string"},"integration_is_enabled":{"type":"boolean"}}}}}}},"/v1/integrations/{integration_uuid}/test":{"post":{"summary":"Test integration","description":"Posts a test message to an integration","tags":["Integration"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"integration_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/cascading_groups":{"get":{"summary":"Get cascading groups","description":"Returns the list of cascading groups of the organization","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"cascading_group_name":{"type":"string"},"cascading_group_uuid":{"type":"string"}}}}}},"post":{"summary":"Create cascading group","description":"Creates a cascading group for the organization","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"cascading_group_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"cascading_group_name":{"type":"string"},"cascading_group_uuid":{"type":"string"}}}}}}},"/v1/cascading_groups/{cascading_group_uuid}":{"put":{"summary":"Update cascading group","description":"Updates the name of a cascading group","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"cascading_group_name":{"type":"string"}}}},{"name":"cascading_group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"cascading_group_name":{"type":"string"},"cascading_group_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete cascading group","description":"Deletes a cascading group","tags":["Organizations","Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"cascading_group_name":{"type":"string"}}}},{"name":"cascading_group_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"cascading_group_name":{"type":"string"},"cascading_group_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/generate-pdf":{"post":{"summary":"Generate pdf report","description":"Generates a pdf report out of the given url based on user settings","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"report_url":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/scheduled_email_reports":{"get":{"summary":"Get Scheduled Email Reports","description":"Retrieves the scheduled email reports of an organization based on the given type","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"report_type_uuid","in":"query","required":true,"type":"string","format":"rt_advacened_report rt_downtime_report rt_production_report"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_uuid":{"type":"string"},"scheduled_email_report_created_at":{"type":"string"},"scheduled_email_report_updated_at":{"type":"string"},"scheduled_email_report_created_by_user":{"type":"string"},"scheduled_email_report_updated_by_user":{"type":"string"},"report_interval_uuid":{"type":"string"},"report_interval_name":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"},"scheduled_email_report_url":{"type":"string"},"report_type_uuid":{"type":"string"},"report_type_name":{"type":"string"},"scheduled_email_report_is_enabled":{"type":"boolean"},"scheduled_email_report_subscribers":{}}}}}},"post":{"summary":"Create Scheduled Email Reports","description":"Creates the scheduled email reports of an organization based on the given type","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"report_interval_uuid":{"type":"string","format":"day week month quarter year"},"report_type_uuid":{"type":"string","format":"rt_advanced_report rt_downtime_report rt_production_report"},"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_url":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_uuid":{"type":"string"},"scheduled_email_report_created_at":{"type":"string"},"scheduled_email_report_updated_at":{"type":"string"},"scheduled_email_report_created_by_user":{"type":"string"},"scheduled_email_report_updated_by_user":{"type":"string"},"report_interval_uuid":{"type":"string"},"report_interval_name":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"},"scheduled_email_report_url":{"type":"string"},"report_type_uuid":{"type":"string"},"report_type_name":{"type":"string"},"scheduled_email_report_is_enabled":{"type":"boolean"}}}}}}},"/v1/scheduled_email_reports/{scheduled_email_report_uuid}":{"put":{"summary":"Update Scheduled Email Reports","description":"Updates the settings of a given scheduled email report","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"report_interval_uuid":{"type":"string","format":"day week month quarter year"},"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"},"scheduled_email_report_is_enabled":{"type":"boolean"}}}},{"name":"scheduled_email_report_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_uuid":{"type":"string"},"scheduled_email_report_created_at":{"type":"string"},"scheduled_email_report_updated_at":{"type":"string"},"scheduled_email_report_created_by_user":{"type":"string"},"scheduled_email_report_updated_by_user":{"type":"string"},"report_interval_uuid":{"type":"string"},"report_interval_name":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"},"scheduled_email_report_url":{"type":"string"},"report_type_uuid":{"type":"string"},"report_type_name":{"type":"string"},"scheduled_email_report_is_enabled":{"type":"boolean"}}}}}},"delete":{"summary":"Delete Scheduled Email Report","description":"Deletes a given scheduled email report","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"scheduled_email_report_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/scheduled_email_reports/{scheduled_email_report_uuid}/subscribers":{"post":{"summary":"Add Subscriber to Scheduled Email Report","description":"Adds a user subscriber to a given scheduled email report","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"add_username":{"type":"string"}}}},{"name":"scheduled_email_report_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"scheduled_email_report_name":{"type":"string"},"scheduled_email_report_uuid":{"type":"string"},"scheduled_email_report_created_at":{"type":"string"},"scheduled_email_report_updated_at":{"type":"string"},"scheduled_email_report_created_by_user":{"type":"string"},"scheduled_email_report_updated_by_user":{"type":"string"},"report_interval_uuid":{"type":"string"},"report_interval_name":{"type":"string"},"scheduled_email_report_day_of_week":{"type":"integer"},"scheduled_email_report_url":{"type":"string"},"report_type_uuid":{"type":"string"},"report_type_name":{"type":"string"},"scheduled_email_report_is_enabled":{"type":"boolean"}}}}}},"delete":{"summary":"Delete Scheduled Email Report Subscriber","description":"Deletes a given user from a given scheduled email report","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"scheduled_email_report_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"delete_username":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get Subscribers of Scheduled Email Report","description":"Retreieves subscribers of a given scheduled email report","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"add_username":{"type":"string"}}}},{"name":"scheduled_email_report_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_first_name":{"type":"string"},"user_last_name":{"type":"string"},"user_email":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/share-pdf-report":{"post":{"summary":"Share pdf report","description":"Shares a pdf report out of the given url based on user settings","tags":["Report"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"report_url":{"type":"string"},"to_usernames":{"type":"array","items":{"type":"string","format":""}},"sender_message":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/nodes/{node_uuid}/is_laser_on":{"put":{"summary":"Turn node laser on/off","description":"Sets the node_is_laser_on value for a BeamTracker Node","tags":["Organizations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Main Name","in":"body","required":true,"schema":{"type":"object","properties":{"node_publish_stop_after_running_seconds":{"type":"integer","format":"0 will disable"}}}},{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"node_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/assets/{asset_uuid}/operations_auto_made":{"get":{"summary":"Get asset operations auto-detected","description":"Retrieves the operations and their quantity that have been auto-detected in a given duration","tags":["Assets","Operations"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"from":{"type":"string","format":"2026-06-24 19:04:08.125169+00","name":"from","propertyRow":true},"to":{"type":"string","format":"2026-06-24 19:04:08.125169+00","name":"to","propertyRow":true}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"count":{"type":"integer","name":"count","propertyRow":true},"cycle_time":{"type":"string","name":"cycle_time","propertyRow":true},"operation_uuid":{"type":"string","name":"operation_uuid","propertyRow":true},"operation_name":{"type":"string","name":"operation_name","propertyRow":true},"part_uuid":{"type":"string","name":"part_uuid","propertyRow":true},"part_name":{"type":"string","name":"part_name","propertyRow":true}}},"code":"200"}}}},"/v1/latest_ios_version":{"get":{"summary":"Get users","description":"Retreives the users information such as first name, last name, email, phone, more","tags":["Users"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"user_email":{"type":"string","name":"user_email","propertyRow":true},"user_first_name":{"type":"string","name":"user_first_name","propertyRow":true},"user_last_name":{"type":"string","name":"user_last_name","propertyRow":true},"user_phone_number":{"type":"string","name":"user_phone_number","propertyRow":true},"user_image_url":{"type":"string","name":"user_image_url","propertyRow":true},"user_username":{"type":"string","name":"user_username","propertyRow":true},"user_is_mfa_enabled":{"type":"boolean","name":"user_is_mfa_enabled","propertyRow":true}}},"code":"200"}}}},"/v1/organizations/{organization_uuid}/production_insights":{"get":{"summary":"Get Job Production Insights","description":"Retreieves the production job insights of the organization","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/downtime_category_colors":{"get":{"summary":"Get Downtime Category Colors","description":"Retreieves the allowed colors for downtime categories","tags":["Downtime"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"tailwind_color_name":{"type":"string"},"tailwind_color_info":{"type":"array","items":{"type":"string","format":"[{\"tailwind_id\":66,\"tailwind_hex\":\"#818cf8\",\"tailwind_intensity\":400,\"tailwind_color_name\":\"Indigo\",\"color_mode\":\"DARK\"},   {\"tailwind_id\":68,\"tailwind_hex\":\"#4f46e5\",\"tailwind_intensity\":600,\"tailwind_color_name\":\"Indigo\",\"color_mode\":\"LIGHT\"}]"}}}}}}}},"/v1/organizations/{organization_uuid}/organization_assets":{"get":{"summary":"Get assets of organization","description":"Returns assets of an organizations","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"tags","in":"query","required":false,"type":"string","format":"comma seperated tags"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"q","in":"query","required":false,"type":"string","format":"search keywords"},{"name":"only_show_archived","in":"query","required":false}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"asset_last_activity_finished_at":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"},"organization_uuid":{"type":"string"},"organization_name":{"type":"string"},"organization_description":{"type":"string"},"department_name":{"type":"string"},"node_uuid":{"type":"string"},"node_name":{"type":"string"},"node_last_heard":{"type":"string"},"node_is_online":{"type":"boolean"},"device_is_online":{"type":"boolean"},"state":{"type":"string","format":"stopped"},"activity_finished_at":{"type":"string","format":"2024-07-10T01:13:02.105Z"},"is_green":{"type":"boolean","format":"false"},"shift_states_svg":{"type":"string","format":"<svg ... </svg>"},"runtime_shift":{"type":"number"},"downtime_shift":{"type":"number","format":"340.988843"},"runtime_shift_interval":{"type":"string","format":"00:00:00"},"downtime_shift_interval":{"type":"string","format":"00:05:41"},"runtime_percentage":{"type":"number","format":"0"},"downtime_percentage":{"type":"number","format":"100"},"asset_last_utilization_down_classified":{"type":"boolean"}}}}}}},"/v1/organizations/{organization_uuid}/user_allowed_assets":{"post":{"summary":"Add user allowed asset","description":"Adds an asset to the allowed list of assets for a user in an organization","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"},"for_username":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete user allowed asset","description":"Removes an asset from the allowed list of assets for a user in an organization","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"},"for_username":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"get":{"summary":"Get user allowed assets","description":"Returns the list of assets allowed for a user in an organizations","tags":["Organizations","Assets","SenseAI"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"for_username","in":"query","required":false,"type":"string","format":"search keywords"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"asset_custom_name":{"type":"string"},"asset_custom_description":{"type":"string"},"asset_custom_identifier":{"type":"string"},"asset_custom_picture_url":{"type":"string"},"asset_custom_homepage_url":{"type":"string"},"asset_uuid":{"type":"string"},"asset_last_activity_finished_at":{"type":"string"},"machine_name":{"type":"string"},"machine_description":{"type":"string"},"machine_identifier":{"type":"string"},"machine_picture_url":{"type":"string"},"machine_homepage_url":{"type":"string"},"manufacturer_name":{"type":"string"},"manufacturer_description":{"type":"string"},"manufacturer_logo_url":{"type":"string"},"manufacturer_homepage_url":{"type":"string"},"manufacturer_support_homepage_url":{"type":"string"},"manufacturer_support_email":{"type":"string"},"manufacturer_support_phone":{"type":"string"},"manufacturer_is_verified":{"type":"boolean"},"device_uuid":{"type":"string"},"device_name":{"type":"string"},"device_description":{"type":"string"},"project_uuid":{"type":"string"},"project_name":{"type":"string"},"project_description":{"type":"string"},"organization_uuid":{"type":"string"},"organization_name":{"type":"string"},"organization_description":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/locations":{"post":{"summary":"Create location","description":"Creates a location","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"location_name":{"type":"string"},"parent_location_uuid":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"location_uuid":{"type":"string"}}}}}},"get":{"summary":"Get locations","description":"Retreieve locations of an organization","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"location_uuid":{"type":"string"}}}}}}},"/v1/organizations/{organization_uuid}/inventory_transactions":{"post":{"summary":"Create inventory transaction","description":"Creates an inventory transaction record ","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"location_uuid":{"type":"string"},"part_uuid":{"type":"string"},"inventory_transaction_type_uuid":{"type":"string","format":"ITT_ISSUE or ITT_RECEIPT or ITT_ADJUSTMENT"},"quantity_delta":{"type":"number"},"inventory_transaction_note":{"type":"string","format":"optional"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"inventory_transaction_uuid":{"type":"string"}}}}}},"get":{"summary":"Get inventory transactions","description":"Retrieves inventory transaction records","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"filter_parts":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"inventory_transaction_uuid":{"type":"string"},"part_uuid":{"type":"string"},"location_uuid":{"type":"string"},"inventory_transaction_quantity_delta":{"type":"number"},"inventory_transaction_note":{"type":"string"},"location_breadcrumb":{"type":"string"}}}}}}},"/v1/parts/{part_uuid}/inventory":{"get":{"summary":"Get part inventory","description":"Retrieves the part inventory per location","tags":["Parts"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"q","in":"query","description":"Searching through part_name, operation_name, and operation_description","required":false,"type":"string"},{"name":"part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_name":{"type":"string"},"part_description":{"type":"string"},"part_picture_url":{"type":"string"},"part_uuid":{"type":"string"},"part_tags":{"type":"string","format":"comma separated tags"}}}}}}},"/v1/workorders/{workorder_uuid}/workorder_requires_parts":{"post":{"summary":"Create workorder part requirements","description":"Creates a part requirements for a workorder","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"part_uuid":{"type":"string"},"quantity":{"type":"number"}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_requires_part_uuid":{"type":"string"}}}}}},"get":{"summary":"Get workorder part requirements","description":"Retreieves part requirements of a given workorder","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string"},"workorder_requires_part_quantity":{"type":"number"},"workorder_requires_part_uuid":{"type":"string"}}}}}}},"/v1/workorder_requires_parts/{workorder_requires_part_uuid}":{"put":{"summary":"Update workorder part requirement quantity","description":"Updates workorder part requirement quantity","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"quantity":{"type":"number"},"part_uuid":{"type":"string"}}}},{"name":"workorder_requires_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_requires_part_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete workorder part requirement","description":"Deletes a workorder part requirement","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_requires_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/inventory_transaction_types":{"get":{"summary":"Get inventory transaction types","description":"Retrieves inventory transaction types","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object"}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"inventory_transaction_type_name":{"type":"string"},"inventory_transaction_type_uuid":{"type":"string"}}}}}}},"/v1/locations/{location_uuid}":{"put":{"summary":"Update location","description":"Updates the location details","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"location_name":{"type":"string"},"parent_location_uuid":{"type":"string"}}}},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"location_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete location","description":"Deletes a location if it has no dependencies","tags":["Inventory"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"location_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/operations/{operation_uuid}/operation_requires_parts":{"post":{"summary":"Create operation part requirements","description":"Creates a part requirements for a operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"part_uuid":{"type":"string"},"quantity":{"type":"number"},"preferred_location_uuid":{"type":"string"},"per_operation":{"type":"integer","format":"0 (not dependent on operation quantity) or an integer"},"should_round_quantity":{"type":"boolean"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_requires_part_uuid":{"type":"string"}}}}}},"get":{"summary":"Get operation part requirements","description":"Retreieves part requirements of a given operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string"},"operation_requires_part_quantity":{"type":"number"},"operation_requires_part_uuid":{"type":"string"}}}}}}},"/v1/operation_requires_parts/{operation_requires_part_uuid}":{"put":{"summary":"Update operation part requirement quantity","description":"Updates operation part requirement quantity","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"quantity":{"type":"number"},"part_uuid":{"type":"string"},"preferred_location_uuid":{"type":"string"},"per_operation":{"type":"integer","format":"0 (not dependent on operation quantity) or an integer"},"should_round_quantity":{"type":"boolean"}}}},{"name":"operation_requires_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_requires_part_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete operation part requirement","description":"Deletes a operation part requirement","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operation_requires_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/operations/{operation_uuid}/operation_creates_parts":{"post":{"summary":"Create operation part creation","description":"Creates a part creation setting for a operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"part_uuid":{"type":"string"},"quantity":{"type":"number"},"preferred_location_uuid":{"type":"string"},"per_operation":{"type":"integer","format":"0 (not dependent on operation quantity) or an integer"},"should_round_quantity":{"type":"boolean"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_creates_part_uuid":{"type":"string"}}}}}},"get":{"summary":"Get operation part creations","description":"Retreieves part creations of a given operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string"},"operation_creates_part_quantity":{"type":"number"},"operation_creates_part_uuid":{"type":"string"}}}}}}},"/v1/operation_creates_parts/{operation_creates_part_uuid}":{"put":{"summary":"Update operation part creation quantity","description":"Updates operation part creation quantity","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"quantity":{"type":"number"},"part_uuid":{"type":"string"},"preferred_location_uuid":{"type":"string"},"per_operation":{"type":"integer","format":"0 (not dependent on operation quantity) or an integer"},"should_round_quantity":{"type":"boolean"}}}},{"name":"operation_creates_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"operation_creates_part_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete operation part creation","description":"Deletes a operation part creation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"operation_creates_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/workorders/{workorder_uuid}/workorder_creates_parts":{"post":{"summary":"Create workorder part creation","description":"Creates a part creations for a workorder","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"part_uuid":{"type":"string"},"quantity":{"type":"number"}}}},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_creates_part_uuid":{"type":"string"}}}}}},"get":{"summary":"Get workorder part creations","description":"Retreieves part creations of a given workorder","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"part_uuid":{"type":"string"},"workorder_creates_part_quantity":{"type":"number"},"workorder_creates_part_uuid":{"type":"string"}}}}}}},"/v1/workorder_creates_parts/{workorder_creates_part_uuid}":{"put":{"summary":"Update workorder part creation quantity","description":"Updates workorder part creation quantity","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"quantity":{"type":"number"},"part_uuid":{"type":"string"}}}},{"name":"workorder_creates_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"workorder_creates_part_uuid":{"type":"string"}}}}}},"delete":{"summary":"Delete workorder part creation","description":"Deletes a workorder part creation","tags":["Workorder"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"workorder_creates_part_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organization_assets/{asset_uuid}/hide":{"put":{"summary":"Archive organization asset","description":"Archives an organization asset","tags":["Assets"],"consumes":[],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"asset_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":false,"schema":{"type":"object","properties":{"asset_is_hidden":{"type":"boolean"}}}}],"responses":{"200":{"description":"successful operation"}}}},"/v1/operations/{operation_uuid}/operation_preferred_assets":{"post":{"summary":"Create operation asset preference","description":"Creates an asset preference for an operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}},"delete":{"summary":"Delete operation asset preference","description":"Deletes an asset preference for an operation","tags":["Operation"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"asset_uuid":{"type":"string"}}}},{"name":"operation_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}},"/v1/organizations/{organization_uuid}/downtime_category_types":{"post":{"summary":"Create downtime category type","description":"Creates a downtime category type for an organization","tags":["Organizations","Downtimes"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"downtime_category_type_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_type_uuid":{"type":"string","format":"dtct_xxxxxxxxxxxx"}}}}}},"get":{"summary":"Get downtime category types","description":"Retreieves downtime category types of an organization","tags":["Organizations","Downtimes"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_type_uuid":{"type":"string","format":"dtct_xxxxxxxxxxxx"}}}}}}},"/v1/downtime_category_types/{downtime_category_type_uuid}":{"put":{"summary":"Update downtime category type","description":"Updates the name of a downtime category type","tags":["Organizations","Downtimes"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"organization_uuid","in":"path","required":true,"type":"string"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"downtime_category_type_name":{"type":"string"}}}}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_type_uuid":{"type":"string","format":"dtct_xxxxxxxxxxxx"}}}}}},"delete":{"summary":"Delete downtime category type","description":"Deletes a downtime category type","tags":["Organizations","Downtimes"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"downtime_category_type_uuid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"properties":{"downtime_category_type_uuid":{"type":"string","format":"dtct_xxxxxxxxxxxx"}}}}}}},"/v1/utilizations/{utilization_id}/state":{"put":{"summary":"Update utilization state","description":"Updates the state of a utilization","tags":["Assets","Operations","SenseAI"],"consumes":["application/json"],"produces":["application/json"],"deprecated":false,"parameters":[{"name":"Authorization","in":"header","required":true,"type":"string","format":"Bearer access-token"},{"name":"","in":"body","required":true,"schema":{"type":"object","properties":{"utilization_state_identifier":{"type":"string","format":"STOPPED UNKNOWN RUNNING"}}}},{"name":"utilization_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation"}}}}}}