{ "openapi": "3.0.3", "info": { "title": "REDZONE PUBLIC API", "version": "2.0.0", "description": "Redzone Community and Advanced Integration APIs", "contact": { "name": "Redzone Support", "url": "https://rzsoftware.com", "email": "support@rzsoftware.com" }, "termsOfService": "https://rzsoftware.com/privacy" }, "servers": [ { "url": "https://api.rz-ops.com/public", "description": "Redzone Server" } ], "tags": [ { "name": "Assets", "x-displayName": "Assets" }, { "name": "Characteristics", "x-displayName": "Characteristics" }, { "name": "Data Sheets", "x-displayName": "Data Sheets" }, { "name": "Files", "x-displayName": "Files" }, { "name": "Forums", "x-displayName": "Forums" }, { "name": "Labels", "x-displayName": "Labels" }, { "name": "Locations", "x-displayName": "Locations" }, { "name": "Manufacturing Types", "x-displayName": "Manufacturing Types" }, { "name": "Problems", "x-displayName": "Problems" }, { "name": "Product Groups", "x-displayName": "Product Groups" }, { "name": "Product Types", "x-displayName": "Product Types" }, { "name": "Reliability", "x-displayName": "Reliability" }, { "name": "Runs", "x-displayName": "Runs" }, { "name": "Sensor Configurations", "x-displayName": "Sensor Configurations" }, { "name": "Shift Patterns", "x-displayName": "Shift Patterns" }, { "name": "Shift Types", "x-displayName": "Shift Types" }, { "name": "Shifts", "x-displayName": "Shifts" }, { "name": "Unit Of Measures", "x-displayName": "Unit Of Measures" }, { "name": "Users", "x-displayName": "Users" }, { "name": "Authentication", "x-displayName": "Authentication" }, { "name": "Events", "x-displayName": "Events" } ], "paths": { "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-groups": { "get": { "summary": "List Product Groups", "tags": [ "Product Groups" ], "operationId": "list-product-groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProductGroupsResponse" } } } } }, "description": "List product groups", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Product Group", "operationId": "create-product-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductGroup" } } } }, "409": { "description": "Conflict" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductGroupRequest" } } } }, "description": "Create product group", "tags": [ "Product Groups" ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-groups/{productGroupId}": { "parameters": [ { "$ref": "#/components/parameters/ProductGroupId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "put": { "summary": "Update Product Group", "operationId": "update-product-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductGroup" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductGroupRequest" } } } }, "description": "Update product group", "tags": [ "Product Groups" ], "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Product Group", "operationId": "delete-product-group", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Delete product group", "tags": [ "Product Groups" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/product-groups/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Product Group Memberships", "operationId": "import-product-group-memberships", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "tags": [ "Product Types" ], "description": "Import product group memberships", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductGroupMemberImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-groups/{productGroupId}/product-types/{productTypeId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/ProductGroupId" }, { "$ref": "#/components/parameters/ProductTypeId" } ], "post": { "summary": "Add Product Type to Product Group", "operationId": "add-product-type-to-product-group", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Add a product type to a product group", "tags": [ "Product Groups" ], "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Remove Product Type from Product Group", "operationId": "remove-product-type-from-product-group", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Remove a product type from a product group", "tags": [ "Product Groups" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types": { "get": { "summary": "List Product Types", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProductTypesResponse" } } } } }, "operationId": "list-product-types", "description": "List product-types", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Active" }, { "$ref": "#/components/parameters/Search" } ], "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Product Types", "operationId": "create-product-type", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } }, "description": "Create product type", "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductTypeRequest" } } } }, "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}": { "parameters": [ { "$ref": "#/components/parameters/ProductTypeId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Product Type", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-product-type", "description": "Get product type", "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Product Type", "operationId": "update-product-type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Update product type", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProductTypeRequest" } } }, "description": "" }, "tags": [ "Product Types" ], "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Product Type", "operationId": "delete-product-type", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } }, "description": "Delete product type", "tags": [ "Product Types" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/reactivate": { "parameters": [ { "$ref": "#/components/parameters/ProductTypeId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "put": { "summary": "Reactivate Product Type", "operationId": "reactivate-product-type", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Reactivate product type", "tags": [ "Product Types" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Product Types", "operationId": "import-product-types", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "description": "Import product types", "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/product-groups": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/ProductTypeId" } ], "get": { "summary": "List Product Groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProductGroupsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "list-product-groups-for-product-type", "description": "Get product groups for a product type", "tags": [ "Product Types" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/unit-conversions": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/ProductTypeId" } ], "get": { "summary": "List Unit Conversions", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUnitConversionsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "list-unit-conversions-for-product-type", "description": "List unit conversions for product type", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Unit Conversion", "operationId": "add-unit-conversion-to-product-type", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitConversion" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitConversionRequest" } } } }, "tags": [ "Product Types" ], "description": "Add unit conversion to product type", "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/unit-conversions/{unitConversionId}": { "parameters": [ { "$ref": "#/components/parameters/ProductTypeId" }, { "$ref": "#/components/parameters/UnitConversionId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Unit Conversion", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitConversion" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "get-unit-conversion-for-product-type", "description": "Get unit conversion for product type", "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Unit Conversion", "operationId": "update-unit-conversion-for-product-type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitConversion" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitConversionRequest" } } } }, "description": "Update unit conversion for product type", "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Unit Conversion", "operationId": "delete-unit-conversion-for-product-type", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Delete unit conversion for product type", "tags": [ "Product Types" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/unit-conversions/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Product Unit Conversions", "operationId": "import-product-unit-conversions", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "description": "Import product unit conversions", "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitConversionImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/location-configs": { "parameters": [ { "$ref": "#/components/parameters/ProductTypeId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Location Configs", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProductLocationConfigsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "list-location-configs-for-product-type", "description": "List location specific configs for product type", "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Location Config", "operationId": "create-location-config-for-product-type", "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductLocationConfigRequest" } } }, "description": "" }, "description": "Create location specific config for product type", "security": [ { "apiKey": [] } ] }, "put": { "summary": "Set Location Config", "operationId": "set-location-config-for-product-type", "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetProductLocationConfigRequest" } } } } }, "description": "Set location specific configs for product type", "tags": [ "Product Types" ], "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Location Configs", "operationId": "delete-location-configs-for-product-type", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteProductLocationConfigsRequest" } } } } }, "description": "Delete location specific configs for product type", "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/{productTypeId}/cycle-targets": { "parameters": [ { "$ref": "#/components/parameters/ProductTypeId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Cycle Targets", "tags": [ "Product Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCycleTargetsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "list-cycle-targets-for-product-type", "description": "List cycle targets for product type", "security": [ { "apiKey": [] } ] }, "put": { "summary": "Set Cycle Targets", "operationId": "set-cycle-targets-for-product-type", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "tags": [ "Product Types" ], "description": "Set cycle targets for product type", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetCycleTargetsRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/cycle-targets/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Cycle Targets", "operationId": "import-cycle-targets", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "tags": [ "Product Types" ], "description": "Import cycle targets", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CycleTargetImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/unit-of-measures": { "get": { "summary": "List Unit of Measures", "tags": [ "Unit Of Measures" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUnitOfMeasuresResponse" } } } } }, "operationId": "list-unit-of-measures", "description": "List unit of measures", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Unit of Measure", "operationId": "create-unit-of-measure", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "400": { "description": "Bad Request" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "tags": [ "Unit Of Measures" ], "description": "Create unit of measure", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUnitOfMeasureRequest" } } } }, "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/unit-of-measures/{unitOfMeasureId}": { "get": { "summary": "Get Unit of Measure", "tags": [ "Unit Of Measures" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-unit-of-measure", "description": "Get unit of measure", "parameters": [], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/UnitOfMeasureId" } ], "put": { "summary": "Update Unit of Measure", "operationId": "update-unit-of-measure", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "tags": [ "Unit Of Measures" ], "description": "Update unit of measure", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUnitOfMeasureRequest" } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Unit of Measure", "operationId": "delete-unit-of-measure", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Delete unit of measure", "tags": [ "Unit Of Measures" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations": { "get": { "summary": "List Locations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLocationsResponse" } } } } }, "operationId": "list-locations", "description": "List locations", "tags": [ "Locations" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/{locationId}/scheduled-runs": { "parameters": [ { "$ref": "#/components/parameters/LocationId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Scheduled Runs", "tags": [ "Locations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListScheduledRunsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "list-scheduled-runs", "description": "List scheduled runs", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Scheduled Run", "operationId": "create-scheduled-run", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledRun" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduledRunRequest" } } } }, "description": "Create scheduled run", "tags": [ "Locations" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/{locationId}/scheduled-runs/{runId}": { "parameters": [ { "$ref": "#/components/parameters/LocationId" }, { "$ref": "#/components/parameters/RunId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Scheduled Run", "tags": [ "Locations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledRun" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "operationId": "get-scheduled-run", "description": "Get scheduled run", "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Scheduled Run", "operationId": "update-scheduled-run", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListScheduledRunsResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "description": "Update scheduled run", "tags": [ "Locations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduledRunRequest" } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Scheduled Run", "operationId": "delete-scheduled-run", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "description": "Delete scheduled run", "tags": [ "Locations" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/scheduled-runs/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Scheduled Runs", "operationId": "import-scheduled-runs", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledRunImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "description": "Import scheduled runs", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledRunImportRequest" } } } }, "description": "" }, "tags": [ "Locations" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/product-types/location-configs/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Product Location Configs", "operationId": "import-product-location-configs", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } }, "500": { "description": "Internal Server Error" } }, "description": "Import product location configs", "tags": [ "Product Types" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductLocationConfigImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/characteristics": { "get": { "summary": "List Characteristics", "tags": [ "Characteristics" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCharacteristicsResponse" } } } } }, "operationId": "list-characteristics", "description": "List characteristics", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/manufacturing-types": { "get": { "summary": "List Manufacturing Types", "tags": [ "Manufacturing Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListManufacturingTypesResponse" } } } } }, "operationId": "list-manufacturing-types", "description": "List manufacturing types", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Create Manufacturing Type", "operationId": "create-manufacturing-type", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturingType" } } } }, "400": { "description": "Bad Request" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "tags": [ "Manufacturing Types" ], "description": "Create manufacturing type", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManufacturingTypeRequest" } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/manufacturing-types/{manufacturingTypeId}": { "get": { "summary": "Get Manufacturing Type", "tags": [ "Manufacturing Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturingType" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-manufacturing-type", "description": "Get manufacturing type", "parameters": [], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/ManufacturingTypeId" } ], "put": { "summary": "Update Manufacturing Type", "operationId": "update-manufacturing-type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturingType" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "tags": [ "Manufacturing Types" ], "description": "Update manufacturing type", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManufacturingTypeRequest" } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Manufacturing Type", "operationId": "delete-manufacturing-type", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "description": "Delete manufacturing type", "tags": [ "Manufacturing Types" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/meetings": { "get": { "summary": "List Meetings", "tags": [ "Forums" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMeetingsResponse" } } } } }, "operationId": "list-meetings", "description": "List meetings", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/characteristics/values": { "get": { "summary": "List Characteristic Values", "tags": [ "Characteristics" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCharacteristicValuesResponse" } } } } }, "operationId": "list-characteristic-values", "description": "List characteristic values", "parameters": [ { "schema": { "$ref": "#/components/schemas/CharacteristicValueTargetType" }, "in": "query", "name": "targetType", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "targetUUID", "required": true } ], "security": [ { "apiKey": [] } ] }, "put": { "summary": "Set Characteristic Values", "operationId": "set-characteristic-values", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCharacteristicValuesResponse" } } } } }, "description": "Set characteristic values", "tags": [ "Characteristics" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetCharacteristicValuesRequest" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Characteristic Values", "operationId": "delete-characteristic-values", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteCharacteristicValuesRequest" } } } } }, "description": "Delete characteristic values", "tags": [ "Characteristics" ], "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" } }, "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/characteristics/values/import": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Import Characteristic Values", "operationId": "import-characteristic-values", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataImportError" } } } } } }, "description": "Import characteristic values", "tags": [ "Characteristics" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicValueImportRequest" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/shift-types": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Shift Types", "tags": [ "Shift Types" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShiftTypesResponse" } } } } }, "operationId": "list-shift-types", "description": "List shift types", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/shift-patterns": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Shift Patterns", "tags": [ "Shift Patterns" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListShiftPatternsResponse" } } } } }, "operationId": "list-shift-patterns", "description": "List shift patterns and the shift types that belong to each pattern", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "name", "in": "query", "description": "Filter shift patterns by name", "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/{locationId}/runs/current": { "parameters": [ { "$ref": "#/components/parameters/LocationId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Current Runs at Location", "tags": [ "Runs" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCurrentRunsResponse" } } } } }, "operationId": "list-current-runs-at-location", "description": "List current runs at location", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/{locationId}/shifts/current": { "parameters": [ { "$ref": "#/components/parameters/LocationId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Current Shift at Location", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shift" } } } }, "422": { "description": "Unprocessable Entity" } }, "operationId": "get-current-shift-at-location", "description": "Get current shift at location", "tags": [ "Shifts" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/shifts/start": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Start Shift", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shift" } } } }, "422": { "description": "Unprocessable Entity" } }, "operationId": "start-shift", "description": "Start shift", "tags": [ "Shifts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartShiftRequest" } } } }, "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/runs": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Runs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRunsResponse" } } } }, "400": { "description": "Bad Request" } }, "operationId": "list-runs", "description": "List all runs for the enterprise with real-time and historical data", "tags": [ "Runs" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "started-after", "in": "query", "required": false, "description": "Filter runs started after this datetime (ISO 8601 format)", "schema": { "type": "string", "format": "date-time" } }, { "name": "ended-after", "in": "query", "required": false, "description": "Filter runs ended after this datetime (ISO 8601 format)", "schema": { "type": "string", "format": "date-time" } }, { "name": "location-uuids", "in": "query", "required": false, "description": "Filter runs by location UUID(s)", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "style": "form", "explode": true } ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/runs/start": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Start Run", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "422": { "description": "Unprocessable Entity" } }, "operationId": "start-run", "description": "Start run", "tags": [ "Runs" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunRequest" } } } }, "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/shifts/{shiftId}": { "parameters": [ { "$ref": "#/components/parameters/ShiftId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Shift", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shift" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-shift", "description": "Get shift", "tags": [ "Shifts" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/shifts/{shiftId}/stop": { "parameters": [ { "$ref": "#/components/parameters/ShiftId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Stop Shift", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shift" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "operationId": "stop-shift", "description": "Stop shift", "tags": [ "Shifts" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/runs/{runId}": { "parameters": [ { "$ref": "#/components/parameters/RunId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "Get Run", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-run", "description": "Get run", "tags": [ "Runs" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/runs/{runId}/stop": { "parameters": [ { "$ref": "#/components/parameters/RunId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Stop Run", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoppedRun" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "operationId": "stop-run", "description": "Stop run", "tags": [ "Runs" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/runs/{runId}/start": { "parameters": [ { "$ref": "#/components/parameters/RunId" }, { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Start Scheduled Run", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "operationId": "start-scheduled-run", "description": "Start scheduled run", "tags": [ "Runs" ], "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/maintenance/actions": { "get": { "summary": "List Maintenance Actions", "description": "List maintenance actions", "tags": [ "Reliability" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMaintenanceActionsResponse" } } } } }, "operationId": "list-maintenance-actions", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionTargetType" }, "uniqueItems": true }, "in": "query", "name": "types" }, { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionStatus" }, "uniqueItems": true }, "in": "query", "name": "status" }, { "schema": { "$ref": "#/components/schemas/ActionSort" }, "in": "query", "name": "sort" }, { "schema": { "$ref": "#/components/schemas/SortDirection" }, "in": "query", "name": "direction" }, { "schema": { "type": "integer", "format": "int64" }, "in": "query", "name": "updated-after" }, { "schema": { "type": "integer", "format": "int64" }, "in": "query", "name": "updated-before" } ], "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/actions/{actionId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/ActionId" } ], "get": { "summary": "Get Action", "description": "Get action", "tags": [ "Reliability" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceActionListElement" } } } }, "404": { "description": "Not Found" } }, "operationId": "get-action", "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/maintenance/actions/{maintenanceActionId}/status": { "put": { "summary": "Update Maintenance Action Status", "description": "Update maintenance action status", "operationId": "update-maintenance-action-status", "tags": [ "Reliability" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMaintenanceActionStatusRequest" } } } }, "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/MaintenanceActionId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/maintenance/workrequests/{maintenanceActionId}/approve": { "put": { "summary": "Approve Maintenenace Work Request", "description": "Approve maintenance work request", "operationId": "approve-maintenance-work-request", "tags": [ "Reliability" ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/MaintenanceActionId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/maintenance/actions/{maintenanceActionId}/comments": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/MaintenanceActionId" } ], "post": { "summary": "Create Maintenance Action Comment", "description": "Create maintenance action comment", "operationId": "create-maintenance-action-comment", "responses": { "201": { "description": "Created" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "tags": [ "Reliability" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMaintenanceActionCommentRequest" } } }, "description": "" }, "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] }, "get": { "summary": "List Maintenance Action Comments", "description": "List maintenance action comments", "operationId": "list-maintenance-action-comments", "tags": [ "Reliability" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMaintenanceActionCommentsResponse" } } } } }, "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/parts": { "get": { "summary": "List Parts", "description": "List parts with inventory level information", "tags": [ "Reliability" ], "operationId": "list-parts", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPartsResponse" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Part", "description": "Create a new part", "tags": [ "Reliability" ], "operationId": "create-part", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartListElement" } } } }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePartRequest" } } } }, "security": [ { "apiKey": [] } ] }, "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ] }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/parts/{partId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PartId" } ], "get": { "summary": "Get Part", "description": "Get a part with inventory level information", "tags": [ "Reliability" ], "operationId": "get-part", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartWithInventoryListElement" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Part", "description": "Update a part", "tags": [ "Reliability" ], "operationId": "update-part", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartWithInventoryListElement" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePartRequest" } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/parts/{partId}/adjust": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PartId" } ], "put": { "summary": "Adjust Part Quantity", "description": "Adjust the on-hand quantity of a part for inventory reconciliation, independent of a purchase request", "tags": [ "Reliability" ], "operationId": "adjust-part-quantity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustPartQuantityRequest" } } } }, "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-orders": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Purchase Orders", "description": "List purchase orders, including their parts and any linked purchase requests", "tags": [ "Reliability" ], "operationId": "list-purchase-orders", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/PurchaseOrderStatusFilter" }, { "$ref": "#/components/parameters/IncludeParts" }, { "$ref": "#/components/parameters/Thumbnail" }, { "$ref": "#/components/parameters/PartAvailability" }, { "$ref": "#/components/parameters/Search" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPurchaseOrdersResponse" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Purchase Order", "description": "Create a new purchase order", "tags": [ "Reliability" ], "operationId": "create-purchase-order", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderListElement" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-requests": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Purchase Requests", "description": "List purchase requests, including their parts and any linked purchase orders", "tags": [ "Reliability" ], "operationId": "list-purchase-requests", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/PurchaseRequestStatusFilter" }, { "$ref": "#/components/parameters/IncludeParts" }, { "$ref": "#/components/parameters/Thumbnail" }, { "$ref": "#/components/parameters/PartAvailability" }, { "$ref": "#/components/parameters/Search" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPurchaseRequestsResponse" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Purchase Request", "description": "Create a new purchase request", "tags": [ "Reliability" ], "operationId": "create-purchase-request", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseRequestRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseRequestListElement" } } } }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-orders/{purchaseOrderId}/purchase-requests": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PurchaseOrderId" } ], "post": { "summary": "Associate Purchase Order With Purchase Requests", "description": "Link one or more of a purchase order's existing part lines to purchase requests, without disturbing the purchase order's other part lines or their existing associations. Each `partUUID` must already be a part line on this purchase order; associating a part that isn't already on the order fails with 422 rather than adding it.", "tags": [ "Reliability" ], "operationId": "associate-purchase-order-purchase-requests", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatePurchaseOrderPurchaseRequestsRequest" } } } }, "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-orders/{purchaseOrderId}/parts/{partId}/purchase-requests/{purchaseRequestId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PurchaseOrderId" }, { "$ref": "#/components/parameters/PartId" }, { "$ref": "#/components/parameters/PurchaseRequestId" } ], "delete": { "summary": "Unassociate Purchase Order Purchase Request", "description": "Remove a purchase request's link to one of a purchase order's existing part lines, without disturbing the order's other part lines or their other associations. Does not remove the part line itself, and does not change the purchase order's status, even if this was the part's only remaining association.", "tags": [ "Reliability" ], "operationId": "unassociate-purchase-order-purchase-request", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-orders/{purchaseOrderId}/receive": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PurchaseOrderId" } ], "post": { "summary": "Receive Purchase Order Parts", "description": "Record parts received against a purchase order, incrementing the on-hand quantity of each part", "tags": [ "Reliability" ], "operationId": "receive-purchase-order-parts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivePurchaseOrderPartsRequest" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/purchase-requests/{purchaseRequestId}/receive": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PurchaseRequestId" } ], "post": { "summary": "Receive Purchase Request Parts", "description": "Record parts received against a purchase request, incrementing the on-hand quantity of each part", "tags": [ "Reliability" ], "operationId": "receive-purchase-request-parts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivePurchaseRequestPartsRequest" } } } }, "responses": { "204": { "description": "No Content" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/parts/{partId}/change": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/PartId" } ], "put": { "summary": "Change Part Quantity", "description": "Apply a relative change to the on-hand quantity of a part (positive to add stock, negative to remove it), independent of a purchase request", "tags": [ "Reliability" ], "operationId": "change-part-quantity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePartQuantityRequest" } } } }, "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/labels": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Labels", "description": "List labels", "tags": [ "Labels" ], "operationId": "list-labels", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLabelsResponse" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/storerooms": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Storerooms", "description": "List storerooms", "tags": [ "Reliability" ], "operationId": "list-storerooms", "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Search" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListStoreroomsResponse" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/files/{fileId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/FileId" } ], "get": { "summary": "Get File Attachment", "description": "Get file attachment", "operationId": "get-file-attachment", "tags": [ "Files" ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "video/mp4": { "schema": { "type": "string", "format": "binary" } }, "video/quicktime": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found" } }, "x-entitlements": [ "enterprise-integration", "reliability-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/asset-types": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Asset Types", "description": "List asset types", "operationId": "list-asset-types", "tags": [ "Assets" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Active" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetTypesResponse" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Asset Type", "description": "Create asset type", "operationId": "create-asset-type", "tags": [ "Assets" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetType" } } } }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetTypeRequest" } } }, "description": "" }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/asset-types/{assetTypeId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/AssetTypeId" } ], "get": { "summary": "Get Asset Type", "description": "Get asset type", "operationId": "get-asset-type", "tags": [ "Assets" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetType" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Asset Type", "description": "Update asset type", "operationId": "update-asset-type", "tags": [ "Assets" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetType" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetTypeRequest" } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Asset Type", "description": "Delete asset type", "operationId": "delete-asset-type", "tags": [ "Assets" ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/asset-types/{assetTypeId}/reactivate": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/AssetTypeId" } ], "put": { "summary": "Reactivate Asset Type", "description": "Reactivate asset type", "operationId": "reactivate-asset-type", "tags": [ "Assets" ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/assets": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Assets", "description": "List assets", "operationId": "list-assets", "tags": [ "Assets" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAssetsResponse" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "summary": "Create Asset", "description": "Create asset", "operationId": "create-asset", "tags": [ "Assets" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "409": { "description": "Conflict" }, "422": { "description": "Unprocessable Entity" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetRequest" } } }, "description": "" }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/assets/{assetId}": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" }, { "$ref": "#/components/parameters/AssetId" } ], "get": { "summary": "Get Asset", "description": "Get asset", "operationId": "get-asset", "tags": [ "Assets" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "404": { "description": "Not Found" } }, "security": [ { "apiKey": [] } ] }, "put": { "summary": "Update Asset", "description": "Update asset", "operationId": "update-asset", "tags": [ "Assets" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Asset" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetRequest" } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Asset", "description": "Delete asset", "operationId": "delete-asset", "tags": [ "Assets" ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found" } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/data-sheet-templates": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Data Sheet Templates", "description": "List data sheet templates", "operationId": "list-data-sheet-templates", "tags": [ "Data Sheets" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "data-sheet-type", "in": "query", "schema": { "$ref": "#/components/schemas/DataSheetType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDataSheetTemplatesResponse" } } } } }, "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/data-sheets": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "post": { "summary": "Trigger Data Sheet", "description": "Trigger data sheet", "operationId": "trigger-data-sheet", "tags": [ "Data Sheets" ], "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" } }, "x-entitlements": [ "enterprise-integration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerDataSheetRequest" } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/completed-data-sheets": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Completed Data Sheets", "description": "List completed data sheets", "operationId": "list-completed-data-sheets", "tags": [ "Data Sheets" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "data-sheet-template", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "x-go-type": "string" } } }, { "name": "place", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "x-go-type": "string" } } }, { "name": "data-sheet-type", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSheetType" } } }, { "name": "result-type", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSheetResultType" } } }, { "name": "from", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompletedDataSheetResponse" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } }, "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/users": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Users For Enterprise", "description": "List users for enterprise", "operationId": "list-users-for-enterprise", "tags": [ "Users" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/problem-types": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Problem Types", "description": "List problem types", "operationId": "list-problem-types", "tags": [ "Problems" ], "parameters": [ { "$ref": "#/components/parameters/LimitMax20" }, { "$ref": "#/components/parameters/Offset" }, { "name": "location", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "asset-type", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProblemTypesResponse" } } } }, "400": { "description": "Bad Request" } }, "x-entitlements": [ "enterprise-integration" ], "security": [ { "apiKey": [] } ] } }, "/v2/organizations/{organizationId}/enterprises/{enterpriseId}/locations/{locationId}/sensor-configurations": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" }, { "$ref": "#/components/parameters/EnterpriseId" } ], "get": { "summary": "List Sensor Configurations", "description": "List sensor configurations", "operationId": "list-sensor-configurations", "tags": [ "Sensor Configurations" ], "parameters": [ { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/LocationId" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSensorConfigurationsResponse" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v2/oauth/token": { "post": { "summary": "Client", "operationId": "create-oauth-token", "responses": { "200": { "$ref": "#/components/responses/TokenResponse" }, "400": { "$ref": "#/components/responses/StandardErrorResponse" }, "401": { "$ref": "#/components/responses/StandardErrorResponse" }, "403": { "$ref": "#/components/responses/StandardErrorResponse" }, "404": { "$ref": "#/components/responses/StandardErrorResponse" }, "405": { "$ref": "#/components/responses/StandardErrorResponse" }, "429": { "$ref": "#/components/responses/StandardErrorResponse" }, "500": { "description": "Internal Server Error" }, "501": { "$ref": "#/components/responses/StandardErrorResponse" }, "502": { "$ref": "#/components/responses/StandardErrorResponse" }, "503": { "$ref": "#/components/responses/StandardErrorResponse" } }, "description": "Client Credentials Flow for M2M Communication", "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientTokenRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientTokenRequest" } } } } } }, "/v2/organizations/{organizationId}/events": { "parameters": [ { "$ref": "#/components/parameters/OrganizationId" } ], "get": { "summary": "List Events", "description": "List events", "operationId": "list-events", "tags": [ "Events" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventsResponse" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "parameters": [ { "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 43200, "default": 30 }, "in": "query", "name": "visibility-timeout", "description": "The duration (in seconds) that the received events are hidden from subsequent list requests after being retrieved by a list request." }, { "schema": { "type": "integer", "default": 1, "format": "int32", "minimum": 1, "maximum": 10 }, "in": "query", "name": "limit", "description": "The maximum number of events to return." } ], "security": [ { "apiKey": [] } ] }, "delete": { "summary": "Delete Event", "description": "Aknowledge and delete event", "operationId": "delete-event", "tags": [ "Events" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteEventRequest" } } } }, "security": [ { "apiKey": [] } ] } } }, "components": { "schemas": { "CharacteristicValueTargetType": { "type": "string", "title": "CharacteristicValueTargetType", "enum": [ "LOCATION", "MANUFACTURING_TYPE", "PRODUCT_TYPE" ] }, "CharacteristicType": { "type": "string", "title": "CharacteristicType", "enum": [ "STRING", "THRESHOLD", "SPC_THRESHOLD", "DATE_LABEL", "BARCODE_FORMAT" ] }, "SPCTest": { "type": "string", "title": "SPCTest", "enum": [ "_1_POINT_ABOVE_CONTROL", "_1_POINT_BELOW_CONTROL", "_9_CONSECUTIVE_POINTS_ABOVE_CENTER", "_9_CONSECUTIVE_POINTS_BELOW_CENTER", "_6_CONSECUTIVE_POINTS_INCREASING", "_6_CONSECUTIVE_POINTS_DECREASING", "_2_OF_3_CONSECUTIVE_POINTS_ABOVE_2σ", "_2_OF_3_CONSECUTIVE_POINTS_BELOW_2σ", "_4_OF_5_CONSECUTIVE_POINTS_ABOVE_1σ", "_4_OF_5_CONSECUTIVE_POINTS_BELOW_1σ" ], "x-enum-varnames": [ "1_POINT_ABOVE_CONTROL", "1_POINT_BELOW_CONTROL", "9_CONSECUTIVE_POINTS_ABOVE_CENTER", "9_CONSECUTIVE_POINTS_BELOW_CENTER", "6_CONSECUTIVE_POINTS_INCREASING", "6_CONSECUTIVE_POINTS_DECREASING", "2_OF_3_CONSECUTIVE_POINTS_ABOVE_2", "2_OF_3_CONSECUTIVE_POINTS_BELOW_2", "4_OF_5_CONSECUTIVE_POINTS_ABOVE_1", "4_OF_5_CONSECUTIVE_POINTS_BELOW_1" ] }, "DateLabelBase": { "type": "string", "title": "DateLabelBase", "enum": [ "RunStart", "ShiftStart", "Now" ] }, "ProductGroup": { "title": "ProductGroup", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "ListProductGroupsResponse": { "title": "ListProductGroupsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductGroupListElement" } } }, "required": [ "items" ] }, "ProductGroupListElement": { "title": "ProductGroupListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "CreateProductGroupRequest": { "title": "CreateProductGroupRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "UpdateProductGroupRequest": { "title": "UpdateProductGroupRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "ProductType": { "title": "ProductType", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sku": { "type": "string" }, "deactivated": { "type": "boolean" }, "packingEnabled": { "type": "boolean" }, "laborEnabled": { "type": "boolean" }, "cycleEnabled": { "type": "boolean" }, "stepEnabled": { "type": "boolean" }, "manufacturingTypeUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "overheadCost": { "type": "number", "format": "float" }, "materialCost": { "type": "number", "format": "float" }, "labelWeight": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" }, "externalId": { "type": "string" } }, "required": [ "uuid", "name", "deactivated", "packingEnabled", "laborEnabled", "cycleEnabled", "stepEnabled", "unitOfMeasureUUID" ] }, "ListProductTypesResponse": { "title": "ListProductTypesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeListElement" } } }, "required": [ "items" ] }, "ProductTypeListElement": { "title": "ProductTypeListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "sku": { "type": "string" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "manufacturingTypeUUID": { "type": "string", "format": "uuid" }, "packingEnabled": { "type": "boolean" }, "laborEnabled": { "type": "boolean" }, "cycleEnabled": { "type": "boolean" }, "stepEnabled": { "type": "boolean" }, "overheadCost": { "type": "number", "format": "float" }, "materialCost": { "type": "number", "format": "float" }, "labelWeight": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" }, "externalId": { "type": "string" } }, "required": [ "uuid", "name", "unitOfMeasureUUID", "packingEnabled", "laborEnabled", "cycleEnabled", "stepEnabled", "overheadCost", "materialCost", "labelWeight" ] }, "CreateProductTypeRequest": { "title": "CreateProductTypeRequest", "type": "object", "properties": { "name": { "type": "string" }, "sku": { "type": "string" }, "packingEnabled": { "type": "boolean" }, "laborEnabled": { "type": "boolean" }, "cycleEnabled": { "type": "boolean" }, "stepEnabled": { "type": "boolean" }, "manufacturingTypeUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "overheadCost": { "type": "number", "format": "float" }, "materialCost": { "type": "number", "format": "float" }, "labelWeight": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" }, "externalId": { "type": "string" } }, "required": [ "name", "packingEnabled", "laborEnabled", "cycleEnabled", "stepEnabled", "manufacturingTypeUUID", "unitOfMeasureUUID" ] }, "UpdateProductTypeRequest": { "title": "UpdateProductTypeRequest", "type": "object", "properties": { "name": { "type": "string" }, "sku": { "type": "string" }, "packingEnabled": { "type": "boolean" }, "laborEnabled": { "type": "boolean" }, "cycleEnabled": { "type": "boolean" }, "stepEnabled": { "type": "boolean" }, "manufacturingTypeUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "overheadCost": { "type": "number", "format": "float" }, "materialCost": { "type": "number", "format": "float" }, "labelWeight": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" }, "externalId": { "type": "string" } }, "required": [ "name", "packingEnabled", "laborEnabled", "cycleEnabled", "stepEnabled", "manufacturingTypeUUID", "unitOfMeasureUUID" ] }, "UnitConversion": { "title": "UnitConversion", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "fromUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureListElement" }, "fromValue": { "type": "number", "format": "float", "minimum": 0 }, "toUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureListElement" }, "toValue": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "uuid", "fromUnitOfMeasure", "fromValue", "toUnitOfMeasure", "toValue" ] }, "ListUnitConversionsResponse": { "title": "ListUnitConversionsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitConversionListElement" } } }, "required": [ "items" ] }, "UnitConversionListElement": { "title": "UnitConversionListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "fromUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureListElement" }, "fromValue": { "type": "number", "format": "float", "minimum": 0 }, "toUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureListElement" }, "toValue": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "uuid", "fromUnitOfMeasure", "fromValue", "toUnitOfMeasure", "toValue" ] }, "CreateUnitConversionRequest": { "title": "CreateUnitConversionRequest", "type": "object", "properties": { "fromUnitOfMeasureUUID": { "type": "string", "format": "uuid" }, "fromValue": { "type": "number", "format": "float", "minimum": 0 }, "toUnitOfMeasureUUID": { "type": "string", "format": "uuid" }, "toValue": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "fromUnitOfMeasureUUID", "fromValue", "toUnitOfMeasureUUID", "toValue" ] }, "UpdateUnitConversionRequest": { "title": "UpdateUnitConversionRequest", "type": "object", "properties": { "fromUnitOfMeasureUUID": { "type": "string", "format": "uuid" }, "fromValue": { "type": "number", "format": "float", "minimum": 0 }, "toUnitOfMeasureUUID": { "type": "string", "format": "uuid" }, "toValue": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "fromUnitOfMeasureUUID", "fromValue", "toUnitOfMeasureUUID", "toValue" ] }, "ListProductLocationConfigsResponse": { "title": "ListProductLocationConfigsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductLocationConfigListElement" } } }, "required": [ "items" ] }, "ProductLocationConfigListElement": { "title": "ProductLocationConfigListElement", "type": "object", "properties": { "location": { "$ref": "#/components/schemas/ProductLocationConfigLocation" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "targetCrewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "location" ] }, "CreateProductLocationConfigRequest": { "title": "CreateProductLocationConfigRequest", "type": "object", "properties": { "locationUUID": { "type": "string", "format": "uuid" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "targetCrewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "locationUUID" ] }, "SetProductLocationConfigRequest": { "title": "SetProductLocationConfigRequest", "type": "object", "properties": { "locationUUID": { "type": "string", "format": "uuid" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "targetCrewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "locationUUID" ] }, "DeleteProductLocationConfigsRequest": { "title": "DeleteProductLocationConfigsRequest", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "required": [ "uuid" ] }, "ListUnitOfMeasuresResponse": { "title": "ListUnitOfMeasuresResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasureListElement" } } }, "required": [ "items" ] }, "UnitOfMeasureListElement": { "title": "UnitOfMeasureListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "UnitOfMeasure": { "title": "UnitOfMeasure", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "CreateUnitOfMeasureRequest": { "title": "CreateUnitOfMeasureRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "UpdateUnitOfMeasureRequest": { "title": "UpdateUnitOfMeasureRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "ListLocationsResponse": { "title": "ListLocationsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LocationListElement" } } }, "required": [ "items" ] }, "LocationListElement": { "title": "LocationListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "externalId": { "type": "string" }, "shiftPatternUUID": { "type": "string", "format": "uuid" } }, "required": [ "uuid", "name" ] }, "ProductLocationConfigLocation": { "title": "ProductLocationConfigLocation", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "uuid", "name" ] }, "ListCycleTargetsResponse": { "title": "ListCycleTargetsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CycleTargetListElement" } } }, "required": [ "items" ] }, "CycleTargetListElement": { "title": "CycleTargetListElement", "type": "object", "properties": { "productTypeUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "cycleActiveTarget": { "type": "integer", "format": "int64" }, "totalCycleTarget": { "type": "integer", "format": "int64" }, "gracePeriod": { "type": "integer", "format": "int64" } }, "required": [ "productTypeUUID", "cycleActiveTarget", "totalCycleTarget" ] }, "SetCycleTargetsRequest": { "title": "SetCycleTargetsRequest", "type": "object", "properties": { "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "cycleActiveTarget": { "type": "integer", "format": "int64" }, "totalCycleTarget": { "type": "integer", "format": "int64" }, "gracePeriod": { "type": "integer", "format": "int64" } }, "required": [ "cycleActiveTarget", "totalCycleTarget" ] }, "ScheduledRun": { "title": "ScheduledRun", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "uuid", "productTypeUUID", "plannedQuantity" ] }, "ListScheduledRunsResponse": { "title": "ListScheduledRunsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledRunListElement" } } }, "required": [ "items" ] }, "ScheduledRunListElement": { "title": "ScheduledRunListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "uuid", "productTypeUUID", "plannedQuantity" ] }, "CreateScheduledRunRequest": { "title": "CreateScheduledRunRequest", "type": "object", "description": "", "properties": { "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64" }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "sensorConfigurationUUID": { "type": "string", "format": "uuid", "description": "Sensor configuration to assign when the scheduled run starts" }, "changeoverProblemTypeUUID": { "type": "string", "format": "uuid", "description": "Changeover-enabled problem type used to track the run changeover" }, "changeoverAssignedAssetUUID": { "type": "string", "format": "uuid", "description": "Asset on which the changeover problem will be tracked; required when changeoverProblemTypeUUID is set" } }, "required": [ "productTypeUUID", "plannedQuantity", "plannedStartTime" ] }, "UpdateScheduledRunRequest": { "title": "UpdateScheduledRunRequest", "type": "object", "description": "", "properties": { "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64" }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "sensorConfigurationUUID": { "type": "string", "format": "uuid", "description": "Sensor configuration to assign when the scheduled run starts" }, "changeoverProblemTypeUUID": { "type": "string", "format": "uuid", "description": "Changeover-enabled problem type used to track the run changeover" }, "changeoverAssignedAssetUUID": { "type": "string", "format": "uuid", "description": "Asset on which the changeover problem will be tracked; required when changeoverProblemTypeUUID is set" } }, "required": [ "plannedQuantity", "plannedStartTime" ] }, "CurrentRunListElement": { "title": "CurrentRunListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 } }, "required": [ "uuid", "productTypeUUID", "plannedQuantity" ] }, "ListCurrentRunsResponse": { "title": "ListCurrentRunsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentRunListElement" } } }, "required": [ "items" ] }, "RunListElement": { "title": "RunListElement", "type": "object", "properties": { "externalId": { "type": "string", "description": "The unique identifier for the run" }, "uuid": { "type": "string", "format": "uuid", "description": "The universal unique identifier for the run" }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the run in ISO 8601 Z-UTC format" }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the run in ISO 8601 Z-UTC format" }, "locationUUID": { "type": "string", "format": "uuid", "description": "The location's universal unique identifier where the run took place" }, "locationName": { "type": "string", "description": "The name of the location where the run took place" }, "averageStandardRatePerMin": { "type": "number", "format": "float", "minimum": 0, "description": "Average standard rate per minute" }, "customReference": { "type": "string", "description": "Custom reference for the run" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0, "description": "Standard rate per minute (planned/target)" }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0, "description": "Standard rate per man hour" }, "crewSize": { "type": "number", "format": "float", "minimum": 0, "description": "Crew size for the run" }, "plannedQuantity": { "type": "number", "format": "float", "minimum": 0, "description": "Planned quantity for the run" }, "plannedStartTime": { "type": "string", "format": "date-time", "description": "Planned start time of the run in ISO 8601 Z-UTC format" }, "productTypeUUID": { "type": "string", "format": "uuid", "description": "The universal unique identifier for the product type" } }, "required": [ "uuid", "locationUUID", "startTime" ] }, "ListRunsResponse": { "title": "ListRunsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RunListElement" } } }, "required": [ "items" ] }, "Run": { "title": "Run", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "locationUUID": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 }, "endTime": { "type": "integer", "format": "int64", "minimum": 0 }, "sensorConfiguration": { "$ref": "#/components/schemas/SensorConfigurationListElement" } }, "required": [ "uuid", "locationUUID", "productTypeUUID", "plannedQuantity" ] }, "StoppedRun": { "title": "StoppedRun", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "locationUUID": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 }, "endTime": { "type": "integer", "format": "int64", "minimum": 0 }, "sensorConfigurationUUID": { "type": "string", "format": "uuid" } }, "required": [ "uuid", "locationUUID", "productTypeUUID", "plannedQuantity" ] }, "StartRunRequest": { "title": "StartRunRequest", "type": "object", "properties": { "locationUUID": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "plannedQuantity": { "type": "number", "minimum": 0, "format": "float" }, "plannedStartTime": { "type": "integer", "format": "int64" }, "externalId": { "type": "string" }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float", "minimum": 0 }, "standardRatePerManHour": { "type": "number", "format": "float", "minimum": 0 }, "crewSize": { "type": "number", "format": "float", "minimum": 0 }, "sensorConfigurationUUID": { "type": "string", "format": "uuid" }, "changeoverProblemTypeUUID": { "type": "string", "format": "uuid", "description": "Changeover-enabled problem type used to track the run changeover" }, "changeoverAssignedAssetUUID": { "type": "string", "format": "uuid", "description": "Asset on which the changeover problem will be tracked; required when changeoverProblemTypeUUID is set" } }, "required": [ "locationUUID", "productTypeUUID", "plannedQuantity" ] }, "ListManufacturingTypesResponse": { "title": "ListManufacturingTypesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ManufacturingTypeListElement" } } }, "required": [ "items" ] }, "ManufacturingTypeListElement": { "title": "ManufacturingTypeListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "ManufacturingType": { "title": "ManufacturingType", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "deactivated" ] }, "CreateManufacturingTypeRequest": { "title": "CreateManufacturingTypeRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "UpdateManufacturingTypeRequest": { "title": "UpdateManufacturingTypeRequest", "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "ListCharacteristicsResponse": { "title": "ListCharacteristicsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicListElement" } } }, "required": [ "items" ] }, "CharacteristicListElement": { "title": "CharacteristicListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "centerline": { "type": "boolean" }, "characteristicType": { "$ref": "#/components/schemas/CharacteristicType" }, "sampleSize": { "type": "integer", "format": "int32" }, "subrangeSize": { "type": "integer", "format": "int32" }, "enableUpperControlLimit": { "type": "boolean" }, "overrideSpcTests": { "type": "boolean" }, "spcTests": { "type": "array", "items": { "$ref": "#/components/schemas/SPCTest" } }, "enableLowerControlLimit": { "type": "boolean" }, "deactivated": { "type": "boolean" } }, "required": [ "uuid", "name", "centerline", "characteristicType", "sampleSize", "subrangeSize", "enableUpperControlLimit", "overrideSpcTests", "enableLowerControlLimit", "deactivated" ] }, "ListCharacteristicValuesResponse": { "title": "ListCharacteristicValuesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicValueListElement" } } }, "required": [ "items" ] }, "CharacteristicValueListElement": { "title": "CharacteristicValueListElement", "type": "object", "properties": { "characteristicUUID": { "type": "string", "format": "uuid" }, "characteristicType": { "$ref": "#/components/schemas/CharacteristicType" }, "matchValues": { "type": "array", "items": { "type": "string" } }, "upperReasonableLimit": { "type": "number", "format": "float" }, "upperSpecLimit": { "type": "number", "format": "float" }, "upperControlLimit": { "type": "number", "format": "float" }, "specStandard": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "lowerControlLimit": { "type": "number", "format": "float" }, "lowerSpecLimit": { "type": "number", "format": "float" }, "lowerReasonableLimit": { "type": "number", "format": "float" }, "decimalPrecision": { "type": "integer", "format": "int32" }, "expectedDateFormat": { "type": "string" }, "dateLabelBase": { "$ref": "#/components/schemas/DateLabelBase" }, "offsetDays": { "type": "integer", "format": "int32" }, "offsetMonths": { "type": "integer", "format": "int32" }, "offsetYears": { "type": "integer", "format": "int32" }, "requiredApplicationIdentifiers": { "type": "array", "items": { "type": "string" } } }, "required": [ "characteristicUUID", "characteristicType" ] }, "SetCharacteristicValuesRequest": { "title": "SetCharacteristicValuesRequest", "type": "object", "properties": { "characteristicUUID": { "type": "string", "format": "uuid" }, "characteristicType": { "$ref": "#/components/schemas/CharacteristicType" }, "targetType": { "$ref": "#/components/schemas/CharacteristicValueTargetType" }, "targetUUID": { "type": "string", "format": "uuid" }, "matchValues": { "type": "array", "items": { "type": "string" } }, "upperReasonableLimit": { "type": "number", "format": "float" }, "upperSpecLimit": { "type": "number", "format": "float" }, "upperControlLimit": { "type": "number", "format": "float" }, "specStandard": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "lowerControlLimit": { "type": "number", "format": "float" }, "lowerSpecLimit": { "type": "number", "format": "float" }, "lowerReasonableLimit": { "type": "number", "format": "float" }, "decimalPrecision": { "type": "integer", "format": "int32" }, "expectedDateFormat": { "type": "string" }, "dateLabelBase": { "$ref": "#/components/schemas/DateLabelBase" }, "offsetDays": { "type": "integer", "format": "int32" }, "offsetMonths": { "type": "integer", "format": "int32" }, "offsetYears": { "type": "integer", "format": "int32" }, "requiredApplicationIdentifiers": { "type": "array", "items": { "type": "string" } } }, "required": [ "characteristicUUID", "characteristicType", "targetType", "targetUUID" ] }, "DeleteCharacteristicValuesRequest": { "title": "DeleteCharacteristicValuesRequest", "type": "object", "properties": { "characteristicUUID": { "type": "string", "format": "uuid" }, "targetType": { "$ref": "#/components/schemas/CharacteristicValueTargetType" }, "targetUUID": { "type": "string", "format": "uuid" } }, "required": [ "characteristicUUID", "targetType", "targetUUID" ] }, "ScheduledRunImportRequest": { "title": "ScheduledRunImportRequest", "type": "object", "properties": { "locationName": { "type": "string" }, "sku": { "type": "string" }, "runId": { "type": "string" }, "plannedQuantity": { "type": "number", "format": "float" }, "unitOfMeasureName": { "type": "string" }, "plannedStartTime": { "type": "integer", "format": "int64", "minimum": 0 }, "customReference": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "crewSize": { "type": "number", "format": "float" } }, "required": [ "locationName", "sku", "plannedQuantity", "unitOfMeasureName" ] }, "ScheduledRunImportError": { "title": "ScheduledRunImportError", "type": "object", "properties": { "sku": { "type": "string" }, "runId": { "type": "string" }, "customReference": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } }, "required": [ "sku", "errors" ] }, "ProductTypeImportRequest": { "title": "ProductTypeImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "manufacturingTypeName": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string" }, "packingEnabled": { "type": "boolean" }, "laborEnabled": { "type": "boolean" }, "cycleEnabled": { "type": "boolean" }, "unitOfMeasureName": { "type": "string" }, "overheadCost": { "type": "number", "format": "float" }, "materialCost": { "type": "number", "format": "float" }, "labelWeight": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" }, "activeMinutes": { "type": "number", "format": "float" }, "totalMinutes": { "type": "number", "format": "float" }, "externalId": { "type": "string" } }, "required": [ "command", "manufacturingTypeName", "name", "packingEnabled", "laborEnabled", "cycleEnabled", "unitOfMeasureName" ] }, "DataImportCommand": { "type": "string", "title": "DataImportCommand", "enum": [ "ADD", "UPDATE", "DELETE", "SYNC" ], "default": "ADD" }, "DataImportError": { "title": "DataImportError", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "importType": { "type": "string" }, "error": { "type": "string" } }, "required": [ "command", "importType", "error" ] }, "UnitConversionImportRequest": { "title": "UnitConversionImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "productSku": { "type": "string" }, "productName": { "type": "string" }, "fromValue": { "type": "number", "format": "float" }, "fromUnitOfMeasureName": { "type": "string" }, "toValue": { "type": "number", "format": "float" }, "toUnitOfMeasureName": { "type": "string" } }, "required": [ "command", "productName", "fromValue", "fromUnitOfMeasureName", "toValue", "toUnitOfMeasureName" ] }, "ProductLocationConfigImportRequest": { "title": "ProductLocationConfigImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "productSku": { "type": "string" }, "productName": { "type": "string" }, "locationName": { "type": "string" }, "standardRatePerMin": { "type": "number", "format": "float" }, "standardRatePerManHour": { "type": "number", "format": "float" }, "targetCrewSize": { "type": "number", "format": "float" } }, "required": [ "command", "productName", "locationName" ] }, "ProductGroupMemberImportRequest": { "title": "ProductGroupMemberImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "productSku": { "type": "string" }, "productName": { "type": "string" }, "productGroupName": { "type": "string" } }, "required": [ "command", "productName", "productGroupName" ] }, "CharacteristicValueImportRequest": { "title": "CharacteristicValueImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "targetType": { "$ref": "#/components/schemas/CharacteristicValueTargetType" }, "locationName": { "type": "string" }, "manufacturingTypeName": { "type": "string" }, "productSku": { "type": "string" }, "productName": { "type": "string" }, "characteristicName": { "type": "string" }, "matchValues": { "type": "array", "items": { "type": "string" } }, "upperReasonableLimit": { "type": "number", "format": "float" }, "upperSpecLimit": { "type": "number", "format": "float" }, "upperControlLimit": { "type": "number", "format": "float" }, "specStandard": { "type": "number", "format": "float" }, "target": { "type": "number", "format": "float" }, "lowerControlLimit": { "type": "number", "format": "float" }, "lowerSpecLimit": { "type": "number", "format": "float" }, "lowerReasonableLimit": { "type": "number", "format": "float" }, "decimalPrecision": { "type": "integer", "format": "int32" }, "expectedDateFormat": { "type": "string" }, "dateLabelBase": { "$ref": "#/components/schemas/DateLabelBase" }, "offsetDays": { "type": "integer", "format": "int32" }, "offsetMonths": { "type": "integer", "format": "int32" }, "offsetYears": { "type": "integer", "format": "int32" } }, "required": [ "command", "targetType", "characteristicName", "matchValues" ] }, "CycleTargetImportRequest": { "title": "CycleTargetImportRequest", "type": "object", "properties": { "command": { "$ref": "#/components/schemas/DataImportCommand" }, "productSku": { "type": "string" }, "productName": { "type": "string" }, "activeMinutes": { "type": "number", "format": "float" }, "totalMinutes": { "type": "number", "format": "float" }, "unitOfMeasureName": { "type": "string" } }, "required": [ "command", "productName", "activeMinutes", "totalMinutes", "unitOfMeasureName" ] }, "ShiftTypeListElement": { "title": "ShiftTypeListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "plannedStartTime": { "type": "string" }, "plannedEndTime": { "type": "string" }, "runsOnDays": { "type": "array", "items": { "$ref": "#/components/schemas/DayOfWeek" } } }, "required": [ "uuid", "name", "plannedStartTime", "plannedEndTime", "runsOnDays" ] }, "DayOfWeek": { "title": "DayOfWeek", "type": "string", "enum": [ "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" ] }, "ListShiftTypesResponse": { "title": "ListShiftTypesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeListElement" } } }, "required": [ "items" ] }, "ShiftPatternListElement": { "title": "ShiftPatternListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "shiftTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeListElement" } } }, "required": [ "uuid", "name", "shiftTypes" ] }, "ListShiftPatternsResponse": { "title": "ListShiftPatternsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftPatternListElement" } } }, "required": [ "items" ] }, "Shift": { "title": "Shift", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 }, "endTime": { "type": "integer", "format": "int64", "minimum": 0 } }, "required": [ "uuid", "name", "startTime" ] }, "StartShiftRequest": { "title": "StartShiftRequest", "type": "object", "properties": { "locationUUID": { "type": "string", "format": "uuid" }, "shiftTypeUUID": { "type": "string", "format": "uuid" }, "crewSize": { "type": "number", "format": "float", "minimum": 0 } }, "required": [ "locationUUID", "shiftTypeUUID" ] }, "SortDirection": { "type": "string", "title": "SortDirection", "enum": [ "Asc", "Desc" ], "description": "" }, "ActionSort": { "title": "ActionSort", "type": "string", "enum": [ "Created", "Updated" ] }, "ActionStatus": { "title": "ActionStatus", "type": "string", "enum": [ "NEW", "TO_DO", "IN_PROGRESS", "CANCELLED", "MISSED", "DONE", "SKIPPED" ] }, "ActionTargetType": { "type": "string", "title": "ActionTargetType", "description": "The kind of record an action is attached to. Actions reached by UUID from another record, such as the actionUUID of a completed data sheet, may use any of these values.", "enum": [ "NONE", "SOLUTION", "OPEN_DATA_SHEET", "COMPLETED_DATA_SHEET", "ACTION_REVIEW", "ISSUE", "IDEA", "WORK_REQUEST", "WORK_ORDER", "BREAKDOWN", "CENTERLINE_CHECK" ] }, "MaintenanceActionTargetType": { "type": "string", "title": "MaintenanceActionTargetType", "description": "The subset of action target types that represent maintenance activities.", "enum": [ "WORK_ORDER", "WORK_REQUEST", "BREAKDOWN" ] }, "MaintenanceActionListElement": { "title": "MaintenanceActionListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "displayId": { "type": "integer", "format": "int64", "minimum": 0 }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ActionTargetType" }, "status": { "$ref": "#/components/schemas/ActionStatus" }, "subject": { "$ref": "#/components/schemas/ActionSubject" }, "from": { "$ref": "#/components/schemas/UserListElement" }, "to": { "type": "array", "uniqueItems": true, "items": { "$ref": "#/components/schemas/UserListElement" } }, "owner": { "$ref": "#/components/schemas/UserListElement" }, "place": { "$ref": "#/components/schemas/PlaceListElement" }, "meeting": { "$ref": "#/components/schemas/MeetingListElement" }, "asset": { "$ref": "#/components/schemas/MaintenanceActionAsset" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPartListElement" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileListElement" } }, "sense": { "type": "boolean" }, "highPriority": { "type": "boolean" }, "estimatedHoursWork": { "type": "number", "format": "double" }, "totalHoursWorked": { "type": "number", "format": "double", "description": "Total labor hours logged against the action." }, "userHours": { "type": "array", "description": "Labor hours logged against the action, grouped by user.", "items": { "$ref": "#/components/schemas/MaintenanceActionUserHours" } }, "dueDateTime": { "type": "integer", "format": "int64", "minimum": 0 }, "completedDateTime": { "type": "integer", "format": "int64", "minimum": 0 }, "createdDate": { "type": "integer", "format": "int64", "minimum": 0 }, "updatedDate": { "type": "integer", "format": "int64", "minimum": 0 } }, "required": [ "uuid", "displayId", "name", "type", "status", "subject", "from", "to", "sense", "highPriority", "totalHoursWorked", "userHours", "createdDate", "updatedDate" ] }, "MaintenanceActionUserHours": { "title": "MaintenanceActionUserHours", "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserListElement" }, "hoursWorked": { "type": "number", "format": "double" } }, "required": [ "user", "hoursWorked" ] }, "MaintenanceActionAsset": { "title": "MaintenanceActionAsset", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "name": { "type": "string", "default": "" } }, "required": [ "uuid", "name" ] }, "ListMaintenanceActionsResponse": { "title": "ListMaintenanceActionsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionListElement" } } }, "required": [ "items" ] }, "ActionSubject": { "title": "ActionSubject", "type": "string", "enum": [ "PRODUCTION", "KAIZEN", "QUALITY", "MAINTENANCE", "SAFETY" ] }, "UserListElement": { "title": "UserListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "required": [ "uuid", "username", "firstName", "lastName" ] }, "ListUsersResponse": { "title": "ListUsersResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserListElement" } } }, "required": [ "items" ] }, "PartListElement": { "title": "PartListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "barcode": { "type": "string" }, "cost": { "type": "number", "format": "float", "default": 0 }, "unit": { "type": "string" }, "manufacturer": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "requireUsageContext": { "type": "boolean", "default": false }, "findMe": { "type": "string" }, "createdDate": { "type": "integer", "format": "int64", "minimum": 0 }, "updatedDate": { "type": "integer", "format": "int64", "minimum": 0 } }, "required": [ "uuid", "name", "description", "barcode", "cost", "unit", "manufacturer", "manufacturerPartNumber", "requireUsageContext", "findMe", "createdDate", "updatedDate" ] }, "ActionPartListElement": { "required": [ "context", "part", "quantity" ], "type": "object", "properties": { "part": { "$ref": "#/components/schemas/PartListElement" }, "quantity": { "type": "number", "format": "double" }, "context": { "type": "string", "default": "" }, "partInventoryUUID": { "type": "string", "format": "uuid" } } }, "ListPartsResponse": { "title": "ListPartsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PartWithInventoryListElement" } } }, "required": [ "items" ] }, "PartWithInventoryListElement": { "title": "PartWithInventoryListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "barcode": { "type": "string" }, "cost": { "type": "number", "format": "float", "default": 0 }, "unit": { "type": "string" }, "manufacturer": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "requireUsageContext": { "type": "boolean", "default": false }, "findMe": { "type": "string" }, "createdDate": { "type": "integer", "format": "int64", "minimum": 0 }, "updatedDate": { "type": "integer", "format": "int64", "minimum": 0 }, "totalQuantity": { "type": "number", "format": "double" }, "assignedQuantity": { "type": "number", "format": "double" }, "minQuantity": { "type": "number", "format": "double" }, "maxQuantity": { "type": "number", "format": "double" }, "reorderQuantity": { "type": "number", "format": "double" }, "inventory": { "type": "array", "items": { "$ref": "#/components/schemas/PartInventoryListElement" } } }, "required": [ "uuid", "name", "description", "barcode", "cost", "unit", "manufacturer", "manufacturerPartNumber", "requireUsageContext", "findMe", "createdDate", "updatedDate" ] }, "PartInventoryListElement": { "title": "PartInventoryListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "actualQuantity": { "type": "number", "format": "double" }, "assignedQuantity": { "type": "number", "format": "double" }, "findMe": { "type": "string" }, "default": { "type": "boolean", "default": false }, "storeRoom": { "$ref": "#/components/schemas/StoreRoomListElement" } }, "required": [ "uuid", "findMe", "default" ] }, "StoreRoomListElement": { "title": "StoreRoomListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "uuid", "name", "description" ] }, "ListStoreroomsResponse": { "title": "ListStoreroomsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/StoreRoomListElement" } } }, "required": [ "items" ] }, "LabelListElement": { "title": "LabelListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": [ "uuid", "name", "color" ] }, "ListLabelsResponse": { "title": "ListLabelsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LabelListElement" } } }, "required": [ "items" ] }, "CreatePartRequest": { "title": "CreatePartRequest", "type": "object", "properties": { "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "externalId": { "type": "string" }, "barcode": { "type": "string", "default": "" }, "cost": { "type": "number", "format": "float", "default": 0 }, "unit": { "type": "string", "default": "" }, "manufacturer": { "type": "string", "default": "" }, "manufacturerPartNumber": { "type": "string", "default": "" }, "requireUsageContext": { "type": "boolean", "default": false }, "findMe": { "type": "string", "default": "" }, "labelUUIDs": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "name", "description" ] }, "UpdatePartRequest": { "title": "UpdatePartRequest", "type": "object", "properties": { "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "externalId": { "type": "string" }, "barcode": { "type": "string", "default": "" }, "cost": { "type": "number", "format": "float", "default": 0 }, "unit": { "type": "string", "default": "" }, "manufacturer": { "type": "string", "default": "" }, "manufacturerPartNumber": { "type": "string", "default": "" }, "requireUsageContext": { "type": "boolean", "default": false }, "findMe": { "type": "string", "default": "" }, "labelUUIDs": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "name", "description" ] }, "AdjustPartQuantityRequest": { "title": "AdjustPartQuantityRequest", "type": "object", "properties": { "adjustedQuantity": { "type": "number", "format": "double", "minimum": 0 }, "comment": { "type": "string", "default": "" }, "partInventoryUUID": { "type": "string", "format": "uuid", "description": "Identifies the part inventory row (and therefore the storeroom) to adjust. Use one of the `inventory[].uuid` values returned by Get Part or List Parts. When omitted, the part's primary storeroom is used." } }, "required": [ "adjustedQuantity" ] }, "PurchaseOrderStatus": { "title": "PurchaseOrderStatus", "type": "string", "enum": [ "OPEN", "PARTIALLY_FULFILLED", "FULFILLED", "CLOSED" ] }, "PurchaseRequestStatus": { "title": "PurchaseRequestStatus", "type": "string", "enum": [ "DRAFT", "PENDING", "OPEN", "CLOSED" ] }, "ListPurchaseOrdersResponse": { "title": "ListPurchaseOrdersResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderListElement" } } }, "required": [ "items" ] }, "PurchaseOrderListElement": { "title": "PurchaseOrderListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatus" }, "description": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderPartListElement" } }, "purchaseRequests": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderPurchaseRequestListElement" } }, "vendor": { "type": "string" }, "estimatedCost": { "type": "number", "format": "double" } }, "required": [ "uuid", "title", "createdDate", "updatedDate", "status", "description" ] }, "PurchaseOrderPartListElement": { "title": "PurchaseOrderPartListElement", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "partName": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "trackingNumber": { "type": "string" }, "expectedDate": { "type": "string", "format": "date-time" }, "receivedDate": { "type": "string", "format": "date-time" }, "purchaseRequests": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderPartPurchaseRequestListElement" } }, "receivedBy": { "$ref": "#/components/schemas/UserListElement" }, "part": { "$ref": "#/components/schemas/PartListElement" }, "estimatedCost": { "type": "number", "format": "double" } }, "required": [ "partUUID", "partName", "quantity", "unit" ] }, "PurchaseOrderPartPurchaseRequestListElement": { "title": "PurchaseOrderPartPurchaseRequestListElement", "type": "object", "properties": { "purchaseRequestUUID": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "receivedQuantity": { "type": "number", "format": "double" } }, "required": [ "purchaseRequestUUID", "quantity", "receivedQuantity" ] }, "PurchaseOrderPurchaseRequestListElement": { "title": "PurchaseOrderPurchaseRequestListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "requestedDate": { "type": "string", "format": "date-time" }, "displayId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "status": { "$ref": "#/components/schemas/PurchaseRequestStatus" } }, "required": [ "uuid", "title", "createdDate", "updatedDate", "displayId", "description", "status" ] }, "CreatePurchaseOrderRequest": { "title": "CreatePurchaseOrderRequest", "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePurchaseOrderPart" } }, "vendor": { "type": "string" } }, "required": [ "title", "description", "parts" ] }, "CreatePurchaseOrderPart": { "title": "CreatePurchaseOrderPart", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double", "minimum": 0 }, "trackingNumber": { "type": "string" }, "expectedDate": { "type": "string", "format": "date-time" }, "receivedDate": { "type": "string", "format": "date-time" }, "purchaseRequests": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePurchaseOrderPartPurchaseRequest" } } }, "required": [ "partUUID", "quantity" ] }, "CreatePurchaseOrderPartPurchaseRequest": { "title": "CreatePurchaseOrderPartPurchaseRequest", "type": "object", "properties": { "purchaseRequestUUID": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double", "minimum": 0 } }, "required": [ "purchaseRequestUUID", "quantity" ] }, "AssociatePurchaseOrderPurchaseRequestsRequest": { "title": "AssociatePurchaseOrderPurchaseRequestsRequest", "type": "object", "properties": { "associations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatePurchaseOrderPurchaseRequestsAssociation" } } }, "required": [ "associations" ] }, "AssociatePurchaseOrderPurchaseRequestsAssociation": { "title": "AssociatePurchaseOrderPurchaseRequestsAssociation", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "purchaseRequestUUID": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double", "minimum": 0 } }, "required": [ "partUUID", "purchaseRequestUUID", "quantity" ] }, "ListPurchaseRequestsResponse": { "title": "ListPurchaseRequestsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseRequestListElement" } } }, "required": [ "items" ] }, "PurchaseRequestListElement": { "title": "PurchaseRequestListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "requestedDate": { "type": "string", "format": "date-time" }, "requestedBy": { "$ref": "#/components/schemas/UserListElement" }, "approvedBy": { "$ref": "#/components/schemas/UserListElement" }, "displayId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "status": { "$ref": "#/components/schemas/PurchaseRequestStatus" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseRequestPartListElement" } }, "purchaseOrders": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseRequestPurchaseOrderListElement" } }, "estimatedCost": { "type": "number", "format": "double" } }, "required": [ "uuid", "title", "createdDate", "updatedDate", "displayId", "description", "status" ] }, "PurchaseRequestPartListElement": { "title": "PurchaseRequestPartListElement", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "partName": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "estimatedCost": { "type": "number", "format": "double" }, "part": { "$ref": "#/components/schemas/PartListElement" } }, "required": [ "partUUID", "partName", "quantity", "unit" ] }, "PurchaseRequestPurchaseOrderListElement": { "title": "PurchaseRequestPurchaseOrderListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatus" }, "description": { "type": "string" }, "vendor": { "type": "string" } }, "required": [ "uuid", "title", "createdDate", "updatedDate", "status", "description" ] }, "CreatePurchaseRequestRequest": { "title": "CreatePurchaseRequestRequest", "type": "object", "properties": { "description": { "type": "string" }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePurchaseRequestPart" } }, "costCenters": { "type": "array", "items": { "type": "string" } }, "places": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePurchaseRequestPlace" } }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/CreatePurchaseRequestAsset" } }, "action": { "$ref": "#/components/schemas/CreatePurchaseRequestAction" } }, "required": [ "description", "parts" ] }, "CreatePurchaseRequestPart": { "title": "CreatePurchaseRequestPart", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double", "minimum": 0 } }, "required": [ "partUUID", "quantity" ] }, "CreatePurchaseRequestPlace": { "title": "CreatePurchaseRequestPlace", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "required": [ "uuid" ] }, "CreatePurchaseRequestAsset": { "title": "CreatePurchaseRequestAsset", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "required": [ "uuid" ] }, "CreatePurchaseRequestAction": { "title": "CreatePurchaseRequestAction", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "required": [ "uuid" ] }, "ReceivePurchaseOrderPartsRequest": { "title": "ReceivePurchaseOrderPartsRequest", "type": "object", "properties": { "parts": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivePurchaseOrderPart" } } }, "required": [ "parts" ] }, "ReceivePurchaseOrderPart": { "title": "ReceivePurchaseOrderPart", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "purchaseRequestUUID": { "type": "string", "format": "uuid" }, "receivedQuantity": { "type": "number", "format": "double", "minimum": 0 }, "partInventoryUUID": { "type": "string", "format": "uuid" } }, "required": [ "partUUID", "purchaseRequestUUID", "receivedQuantity" ] }, "ReceivePurchaseRequestPartsRequest": { "title": "ReceivePurchaseRequestPartsRequest", "type": "object", "properties": { "parts": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivePurchaseRequestPart" } } }, "required": [ "parts" ] }, "ReceivePurchaseRequestPart": { "title": "ReceivePurchaseRequestPart", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "purchaseOrderUUID": { "type": "string", "format": "uuid" }, "receivedQuantity": { "type": "number", "format": "double", "minimum": 0 }, "partInventoryUUID": { "type": "string", "format": "uuid" } }, "required": [ "partUUID", "purchaseOrderUUID", "receivedQuantity" ] }, "ChangePartQuantityRequest": { "title": "ChangePartQuantityRequest", "type": "object", "properties": { "changeQuantity": { "type": "number", "format": "double", "description": "Relative change to apply to the current on-hand quantity. Use a positive value to add stock and a negative value to remove it." }, "comment": { "type": "string", "default": "" }, "partInventoryUUID": { "type": "string", "format": "uuid", "description": "Identifies the part inventory row (and therefore the storeroom) to adjust. Use one of the `inventory[].uuid` values returned by Get Part or List Parts. When omitted, the part's primary storeroom is used." } }, "required": [ "changeQuantity" ] }, "PlaceListElement": { "title": "PlaceListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "placeType": { "type": "string" } }, "required": [ "uuid", "name", "placeType" ] }, "MeetingListElement": { "title": "MeetingListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "prompts": { "type": "array", "items": { "$ref": "#/components/schemas/PromptListElement" } } }, "required": [ "uuid", "name" ] }, "ListMeetingsResponse": { "title": "ListMeetingsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MeetingListElement" } } }, "required": [ "items" ] }, "PromptListElement": { "title": "PromptListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "uuid", "name", "description" ] }, "ListAssetsResponse": { "title": "ListAssetsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AssetListElement" } } }, "required": [ "items" ] }, "AssetListElement": { "title": "AssetListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "modelNumber": { "type": "string", "default": "" }, "serialNumber": { "type": "string", "default": "" }, "deactivated": { "type": "boolean", "default": false }, "locationUUID": { "type": "string", "format": "uuid" }, "assetTypeUUID": { "type": "string", "format": "uuid" }, "configuration": { "$ref": "#/components/schemas/AssetConfiguration" } }, "required": [ "uuid", "name", "description", "modelNumber", "serialNumber", "deactivated", "locationUUID", "assetTypeUUID", "configuration" ] }, "Asset": { "title": "Asset", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "modelNumber": { "type": "string", "default": "" }, "serialNumber": { "type": "string", "default": "" }, "deactivated": { "type": "boolean", "default": false }, "location": { "$ref": "#/components/schemas/LocationListElement" }, "assetType": { "$ref": "#/components/schemas/AssetTypeListElement" }, "configuration": { "$ref": "#/components/schemas/AssetConfiguration" } }, "required": [ "uuid", "name", "description", "modelNumber", "serialNumber", "deactivated", "location", "assetType", "configuration" ] }, "CreateAssetRequest": { "title": "CreateAssetRequest", "type": "object", "properties": { "externalId": { "type": "string" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "modelNumber": { "type": "string", "default": "" }, "serialNumber": { "type": "string", "default": "" }, "assetTypeUUID": { "type": "string", "format": "uuid" }, "locationUUID": { "type": "string", "format": "uuid" }, "configuration": { "$ref": "#/components/schemas/AssetConfiguration" } }, "required": [ "name", "description", "modelNumber", "serialNumber", "assetTypeUUID", "locationUUID", "configuration" ] }, "UpdateAssetRequest": { "title": "UpdateAssetRequest", "type": "object", "properties": { "externalId": { "type": "string" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "modelNumber": { "type": "string", "default": "" }, "serialNumber": { "type": "string", "default": "" }, "assetTypeUUID": { "type": "string", "format": "uuid" }, "locationUUID": { "type": "string", "format": "uuid" }, "configuration": { "$ref": "#/components/schemas/AssetConfiguration" } }, "required": [ "name", "description", "modelNumber", "serialNumber", "assetTypeUUID", "locationUUID", "configuration" ] }, "AssetConfiguration": { "title": "AssetConfiguration", "type": "string", "enum": [ "NONE", "COUNTS", "PROBLEMS" ] }, "AssetType": { "title": "AssetType", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "deactivated": { "type": "boolean", "default": false }, "name": { "type": "string" }, "modelNumber": { "type": "string", "default": "" }, "cycleCountsEnabled": { "type": "boolean", "default": true }, "refreshInterval": { "type": "integer", "format": "int32" }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureListElement" } }, "required": [ "uuid", "deactivated", "name", "modelNumber", "cycleCountsEnabled" ] }, "ListAssetTypesResponse": { "title": "ListAssetTypesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AssetTypeListElement" } } }, "required": [ "items" ] }, "AssetTypeListElement": { "title": "AssetTypeListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "deactivated": { "type": "boolean", "default": false }, "name": { "type": "string" }, "modelNumber": { "type": "string", "default": "" }, "cycleCountsEnabled": { "type": "boolean", "default": true }, "refreshInterval": { "type": "integer", "format": "int32" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" } }, "required": [ "uuid", "deactivated", "name", "modelNumber", "cycleCountsEnabled" ] }, "CreateAssetTypeRequest": { "title": "CreateAssetTypeRequest", "type": "object", "properties": { "name": { "type": "string" }, "modelNumber": { "type": "string", "default": "" }, "cycleCountsEnabled": { "type": "boolean", "default": true }, "refreshInterval": { "type": "integer", "format": "int32" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" } }, "required": [ "name", "cycleCountsEnabled" ] }, "UpdateAssetTypeRequest": { "title": "UpdateAssetTypeRequest", "type": "object", "properties": { "name": { "type": "string" }, "modelNumber": { "type": "string", "default": "" }, "cycleCountsEnabled": { "type": "boolean", "default": true }, "refreshInterval": { "type": "integer", "format": "int32" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" } }, "required": [ "name", "cycleCountsEnabled" ] }, "FileListElement": { "title": "FileListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "externalId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "uuid", "name" ] }, "UpdateMaintenanceActionStatusRequest": { "title": "UpdateMaintenanceActionStatusRequest", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ActionStatus" } }, "required": [ "status" ] }, "CreateMaintenanceActionCommentRequest": { "title": "CreateMaintenanceActionCommentRequest", "type": "object", "properties": { "description": { "type": "string" } }, "required": [ "description" ] }, "MaintenanceActionCommentListElement": { "title": "MaintenanceActionCommentListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "createdDate": { "type": "integer", "format": "int64", "minimum": 0 }, "updatedDate": { "type": "integer", "format": "int64", "minimum": 0 }, "owner": { "$ref": "#/components/schemas/UserListElement" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileListElement" } } }, "required": [ "uuid", "description", "createdDate", "updatedDate", "owner", "files" ] }, "ListMaintenanceActionCommentsResponse": { "title": "ListMaintenanceActionCommentsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceActionCommentListElement" } } }, "required": [ "items" ] }, "DataSheetType": { "title": "DataSheetType", "type": "string", "enum": [ "AUDIT", "MAINTENANCE_CHECK", "PRODUCTION_CHECK", "QUALITY_CHECK" ] }, "DataSheetTemplateListElement": { "title": "DataSheetTemplateListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "dataSheetType": { "$ref": "#/components/schemas/DataSheetType" } }, "required": [ "uuid", "name", "description", "dataSheetType" ] }, "ListDataSheetTemplatesResponse": { "title": "ListDataSheetTemplatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataSheetTemplateListElement" } } }, "required": [ "items" ] }, "TriggerDataSheetRequest": { "title": "TriggerDataSheetRequest", "type": "object", "properties": { "dataSheetTemplateUUID": { "type": "string", "format": "uuid" }, "placeUUID": { "type": "string", "format": "uuid" }, "toUserUUIDs": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "dataSheetTemplateUUID", "placeUUID", "toUserUUIDs" ] }, "ProblemCategory": { "title": "ProblemCategory", "type": "string", "enum": [ "AVAILABILITY", "QUALITY", "AVAILABILITY_AND_QUALITY", "PERFORMANCE" ] }, "ProblemCountRelationship": { "title": "ProblemCountRelationship", "type": "string", "enum": [ "BEFORE_IN_COUNT", "BETWEEN_COUNTS_OR_BEFORE", "BETWEEN_COUNTS_OR_AFTER", "AFTER_OUT_COUNT" ] }, "ProblemClockType": { "title": "ProblemClockType", "type": "string", "enum": [ "NONE", "CLOCK", "CHANGEOVER" ] }, "ProblemTypeListElement": { "title": "ProblemTypeListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "problemCategory": { "$ref": "#/components/schemas/ProblemCategory" }, "problemCountRelationship": { "$ref": "#/components/schemas/ProblemCountRelationship" }, "clockType": { "$ref": "#/components/schemas/ProblemClockType" }, "planned": { "type": "boolean", "default": false }, "breakdown": { "type": "boolean", "default": false }, "problemGroupUUID": { "type": "string", "format": "uuid" }, "locationUUID": { "type": "string", "format": "uuid" }, "assetTypeUUID": { "type": "string", "format": "uuid" }, "stepTypeUUID": { "type": "string", "format": "uuid" } }, "required": [ "uuid", "name", "problemCategory", "problemCountRelationship", "clockType", "planned", "breakdown" ], "description": "" }, "ListProblemTypesResponse": { "title": "ListProblemTypesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProblemTypeListElement" } } }, "required": [ "items" ] }, "SensorConfigurationListElement": { "title": "SensorConfigurationListElement", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "uuid", "name" ] }, "ListSensorConfigurationsResponse": { "title": "ListSensorConfigurationsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SensorConfigurationListElement" } } }, "required": [ "items" ] }, "DataSheetResultType": { "title": "DataSheetResultType", "type": "string", "enum": [ "PASS", "WARN", "FAIL", "MISSING", "CANCELLED", "SKIPPED", "HIDDEN" ] }, "CompletedDataItemListElement": { "title": "CompletedDataItemListElement", "required": [ "resultType", "dataItemTemplateUUID", "name", "description", "values" ], "type": "object", "properties": { "resultType": { "$ref": "#/components/schemas/DataSheetResultType" }, "dataItemTemplateUUID": { "type": "string", "format": "uuid" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "values": { "type": "array", "items": { "type": "string" }, "default": [] } } }, "CompletedDataSheetSectionListElement": { "title": "CompletedDataSheetSectionListElement", "required": [ "name", "resultType", "items" ], "type": "object", "properties": { "name": { "type": "string", "default": "" }, "resultType": { "$ref": "#/components/schemas/DataSheetResultType" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompletedDataItemListElement" }, "default": [] } } }, "CompletedDataSheetListElement": { "title": "CompletedDataSheetListElement", "required": [ "uuid", "actionUUID", "deactivated", "ccp", "completeTime", "dataSheetTemplateUUID", "dataSheetType", "description", "name", "resultType", "sections" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "actionUUID": { "type": "string", "format": "uuid" }, "deactivated": { "type": "boolean", "default": false }, "resultType": { "$ref": "#/components/schemas/DataSheetResultType" }, "dataSheetTemplateUUID": { "type": "string", "format": "uuid" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "dataSheetType": { "$ref": "#/components/schemas/DataSheetType" }, "ccp": { "type": "boolean", "default": false }, "completeTime": { "type": "integer", "format": "int64" }, "deactivatedTime": { "type": "integer", "format": "int64" }, "approvalTime": { "type": "integer", "format": "int64" }, "placeUUID": { "type": "string", "format": "uuid" }, "assetUUID": { "type": "string", "format": "uuid" }, "assetName": { "type": "string" }, "runUUID": { "type": "string", "format": "uuid" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/CompletedDataSheetSectionListElement" }, "default": [] } } }, "ListCompletedDataSheetResponse": { "title": "ListCompletedDataSheetResponse", "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompletedDataSheetListElement" } } } }, "ClientTokenRequest": { "type": "object", "properties": { "client_id": { "type": "string", "x-oapi-codegen-extra-tags": { "form": "client_id" } }, "client_secret": { "type": "string", "x-oapi-codegen-extra-tags": { "form": "client_secret" } } }, "required": [ "client_id", "client_secret" ] }, "ListEventsResponse": { "title": "ListEventsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ShiftStartedEvent" }, { "$ref": "#/components/schemas/ShiftStoppedEvent" }, { "$ref": "#/components/schemas/RunStartedEvent" }, { "$ref": "#/components/schemas/RunStoppedEvent" }, { "$ref": "#/components/schemas/RunCountUpdatedEvent" }, { "$ref": "#/components/schemas/PurchaseRequestApprovalEvent" }, { "$ref": "#/components/schemas/NcrCreatedEvent" } ], "discriminator": { "propertyName": "eventType", "mapping": { "ShiftStarted": "#/components/schemas/ShiftStartedEvent", "ShiftStopped": "#/components/schemas/ShiftStoppedEvent", "RunStarted": "#/components/schemas/RunStartedEvent", "RunStopped": "#/components/schemas/RunStoppedEvent", "RunCountUpdated": "#/components/schemas/RunCountUpdatedEvent", "PurchaseRequestApproval": "#/components/schemas/PurchaseRequestApprovalEvent", "NcrCreated": "#/components/schemas/NcrCreatedEvent" } } } } }, "required": [ "items" ] }, "Event": { "title": "Event", "type": "object", "discriminator": { "propertyName": "eventType", "mapping": { "ShiftStarted": "#/components/schemas/ShiftStartedEvent", "ShiftStopped": "#/components/schemas/ShiftStoppedEvent", "RunStarted": "#/components/schemas/RunStartedEvent", "RunStopped": "#/components/schemas/RunStoppedEvent", "RunCountUpdated": "#/components/schemas/RunCountUpdatedEvent", "PurchaseRequestApproval": "#/components/schemas/PurchaseRequestApprovalEvent", "NcrCreated": "#/components/schemas/NcrCreatedEvent" } }, "properties": { "eventId": { "type": "string" }, "receiptHandle": { "type": "string" }, "eventType": { "type": "string" }, "eventTimestamp": { "type": "string", "format": "date-time" } }, "required": [ "eventId", "receiptHandle", "eventType", "eventTimestamp" ] }, "PurchaseRequestApprovalEvent": { "title": "PurchaseRequestApprovalEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "enterpriseUUID": { "type": "string", "format": "uuid" }, "description": { "type": "string" }, "createdDate": { "type": "integer", "format": "int64", "minimum": 0 }, "requestedDate": { "type": "integer", "format": "int64", "minimum": 0 }, "requestedByUsername": { "type": "string" }, "requestedByOidcSub": { "type": "string" }, "requestedByFirstName": { "type": "string" }, "requestedByLastName": { "type": "string" }, "displayId": { "type": "integer", "format": "int64", "minimum": 0 }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseRequestPart" } }, "approvedByUsername": { "type": "string" }, "approvedByOidcSub": { "type": "string" }, "approvedByFirstName": { "type": "string" }, "approvedByLastName": { "type": "string" } }, "required": [ "uuid", "description", "createdDate", "requestedDate", "requestedByUsername", "requestedByOidcSub", "requestedByFirstName", "requestedByLastName", "displayId", "parts", "approvedByUsername", "approvedByOidcSub", "approvedByFirstName", "approvedByLastName" ] } ] }, "PurchaseRequestPart": { "title": "PurchaseRequestPart", "type": "object", "properties": { "partUUID": { "type": "string", "format": "uuid" }, "partName": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "externalId": { "type": "string" }, "manufacturer": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "cost": { "type": "number", "format": "float" }, "barcode": { "type": "string" }, "reorderQuantity": { "type": "number", "format": "double" }, "partDescription": { "type": "string" } }, "required": [ "partUUID", "partName", "unit", "quantity", "manufacturer", "manufacturerPartNumber", "cost", "barcode", "partDescription" ] }, "RunCountUpdatedEvent": { "title": "RunCountUpdatedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "runUUID": { "type": "string", "format": "uuid" }, "runId": { "type": "string" }, "shiftUUIDs": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "customReference": { "type": "string" }, "productTypeUUID": { "type": "string", "format": "uuid" }, "productTypeExternalId": { "type": "string" }, "productTypeName": { "type": "string" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureName": { "type": "string" }, "count": { "type": "number", "format": "double" }, "userOIDC": { "type": "string" } }, "required": [ "enterpriseUUID", "runUUID", "runId", "shiftUUIDs", "customReference", "productTypeUUID", "productTypeExternalId", "productTypeName", "unitOfMeasureUUID", "unitOfMeasureName", "count", "userOIDC" ] } ] }, "ShiftStartedEvent": { "title": "ShiftStartedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "shift": { "$ref": "#/components/schemas/ShiftStatus" }, "run": { "$ref": "#/components/schemas/RunStatus" }, "location": { "$ref": "#/components/schemas/LocationStatus" } }, "required": [ "shift", "location" ] } ] }, "ShiftStoppedEvent": { "title": "ShiftStoppedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "shift": { "$ref": "#/components/schemas/ShiftStatus" }, "run": { "$ref": "#/components/schemas/RunStatus" }, "location": { "$ref": "#/components/schemas/LocationStatus" } }, "required": [ "shift", "location" ] } ] }, "RunStartedEvent": { "title": "RunStartedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "run": { "$ref": "#/components/schemas/RunStatus" }, "location": { "$ref": "#/components/schemas/LocationStatus" } }, "required": [ "run", "location" ] } ] }, "RunStoppedEvent": { "title": "RunStoppedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "run": { "$ref": "#/components/schemas/RunStatus" }, "location": { "$ref": "#/components/schemas/LocationStatus" } }, "required": [ "run", "location" ] } ] }, "NcrCreatedEvent": { "title": "NcrCreatedEvent", "allOf": [ { "$ref": "#/components/schemas/Event" }, { "type": "object", "properties": { "enterpriseUUID": { "type": "string", "format": "uuid" }, "completedDataSheetUUID": { "type": "string", "format": "uuid" }, "actionUUID": { "type": "string", "format": "uuid" }, "resultType": { "type": "string" }, "completedTime": { "type": "string" }, "name": { "type": "string" }, "completedDataSheetName": { "type": "string" }, "runUUID": { "type": "string", "format": "uuid" }, "displayId": { "type": "integer", "format": "int64" } }, "required": [ "completedDataSheetUUID", "actionUUID", "resultType", "completedTime", "name", "completedDataSheetName", "displayId" ] } ] }, "RunStatus": { "title": "RunStatus", "type": "object", "properties": { "runUUID": { "type": "string", "format": "uuid" }, "runId": { "type": "string" }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 }, "endTime": { "type": "integer", "format": "int64", "minimum": 0 }, "inCount": { "type": "number", "format": "float" }, "outCount": { "type": "number", "format": "float" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureName": { "type": "string" }, "standardRatePerMinute": { "type": "number", "format": "float", "minimum": 0 }, "plannedQuantity": { "type": "number", "format": "float", "minimum": 0 }, "productName": { "type": "string" }, "sku": { "type": "string" }, "customReference": { "type": "string" }, "manHours": { "type": "number", "format": "float" }, "totalUnitsLost": { "type": "number", "format": "float" } }, "required": [ "runUUID", "runId", "startTime", "inCount", "outCount", "unitOfMeasureUUID", "unitOfMeasureName", "standardRatePerMinute", "plannedQuantity", "productName", "sku", "customReference" ] }, "LocationStatus": { "title": "LocationStatus", "type": "object", "properties": { "locationUUID": { "type": "string", "format": "uuid" }, "locationName": { "type": "string" }, "currentStatus": { "type": "string" }, "productionType": { "type": "string" } }, "required": [ "locationUUID", "locationName", "currentStatus", "productionType" ] }, "ShiftStatus": { "title": "ShiftStatus", "type": "object", "properties": { "shiftUUID": { "type": "string", "format": "uuid" }, "startTime": { "type": "integer", "format": "int64", "minimum": 0 }, "endTime": { "type": "integer", "format": "int64", "minimum": 0 }, "inCount": { "type": "number", "format": "float" }, "outCount": { "type": "number", "format": "float" }, "unitOfMeasureUUID": { "type": "string", "format": "uuid" }, "unitOfMeasureName": { "type": "string" }, "totalUnitsLost": { "type": "number", "format": "float" } }, "required": [ "shiftUUID", "startTime", "inCount", "outCount", "unitOfMeasureUUID", "unitOfMeasureName" ] }, "DeleteEventRequest": { "title": "DeleteEventRequest", "type": "object", "properties": { "receiptHandle": { "type": "string" } }, "required": [ "receiptHandle" ] } }, "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer" } }, "parameters": { "OrganizationId": { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, "EnterpriseId": { "name": "enterpriseId", "in": "path", "required": true, "schema": { "type": "string" } }, "ProductTypeId": { "name": "productTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "ProductGroupId": { "name": "productGroupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "LocationId": { "name": "locationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "UnitConversionId": { "name": "unitConversionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "UnitOfMeasureId": { "name": "unitOfMeasureId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "ManufacturingTypeId": { "name": "manufacturingTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "RunId": { "name": "runId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "ShiftId": { "name": "shiftId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "FileId": { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "PartId": { "name": "partId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "PurchaseOrderId": { "name": "purchaseOrderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "PurchaseRequestId": { "name": "purchaseRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "MaintenanceActionId": { "name": "maintenanceActionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "ActionId": { "name": "actionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "AssetId": { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "AssetTypeId": { "name": "assetTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "Search": { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, "Limit": { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, "LimitMax20": { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 20, "default": 20 } }, "Offset": { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "required": true }, "PurchaseOrderStatusFilter": { "name": "status", "in": "query", "required": false, "style": "form", "explode": false, "description": "Filter for only the provided statuses; returns all statuses when omitted", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } }, "PurchaseRequestStatusFilter": { "name": "status", "in": "query", "required": false, "style": "form", "explode": false, "description": "Filter for only the provided statuses; returns all statuses when omitted", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseRequestStatus" } } }, "IncludeParts": { "name": "include-parts", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, "Thumbnail": { "name": "thumbnail", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, "PartAvailability": { "name": "part-availability", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, "Active": { "name": "active", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "If false, only deactivated entities will be returned." } }, "responses": { "StandardErrorResponse": { "description": "Example response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "error_description": { "type": "string" } } } } } }, "TokenResponse": { "description": "Example response", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "string" } } } } } } } } }