{ "openapi": "3.0.4", "info": { "title": "Kelowna Production API", "version": "v1" }, "paths": { "/Credentials/AuthTest": { "post": { "tags": [ "-AuthTest-" ], "summary": "This endpoint doesn't do anything, it's just used to check auth and health.", "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Cellular/ReclaimedWater/Data/InflowOutflowReadings": { "post": { "tags": [ "Cellular - Reclaimed Water" ], "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InflowOutflowDeviceReadings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InflowOutflowDeviceReadings" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InflowOutflowDeviceReadings" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { }, { "OrcaAuth": [ "applicationId", "roles" ] } ] } }, "/Cellular/ReclaimedWater/Data/CO2InjectionReadings": { "post": { "tags": [ "Cellular - Reclaimed Water" ], "summary": "Uploads new CO2 injection readings for a reclaimed water unit", "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "description": "The readings to save", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2Readings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2Readings" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2Readings" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { }, { "OrcaAuth": [ "applicationId", "roles" ] } ] } }, "/Cellular/ReclaimedWater/Data/Statuses": { "post": { "tags": [ "Cellular - Reclaimed Water" ], "summary": "Uploads new system status readings for a reclaimed water unit", "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "description": "The readings to save", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReadings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReadings" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReadings" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { }, { "OrcaAuth": [ "applicationId", "roles" ] } ] } }, "/Cellular/ReclaimedWater/Data/MassReadings": { "post": { "tags": [ "Cellular - Reclaimed Water" ], "summary": "Uploads new mass readings for a reclaimed water unit", "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "description": "The readings to save", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MassReadings" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MassReadings" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MassReadings" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { }, { "OrcaAuth": [ "applicationId", "roles" ] } ] } }, "/Cellular/ReclaimedWater/Data/Alarm": { "post": { "tags": [ "Cellular - Reclaimed Water" ], "summary": "Adds an alarm to the DB and sends an email notification to the RW team.", "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlarmArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlarmArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlarmArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { }, { "OrcaAuth": [ "applicationId", "roles" ] } ] } }, "/Cellular/RCA/Data/Readings": { "post": { "tags": [ "Cellular - Recycled Concrete Aggregates" ], "parameters": [ { "name": "x-soracom-imsi", "in": "header", "required": true, "example": "310170845466094" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RcaReadingInput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RcaReadingInput" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RcaReadingInput" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReadingsProcessedResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Credentials/CommandConnex": { "post": { "tags": [ "Credentials" ], "summary": "Add credentials for a new Command Connex API customer", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division ID of the customer", "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "query", "description": "The client ID for the API (provided by the customer)", "schema": { "type": "string" } }, { "name": "apiKey", "in": "query", "description": "The API key (provided by the customer) which will be stored encrypted", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "What date (in the past) to start pulling batching data from", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Credentials/SysdyneWebcrete": { "post": { "tags": [ "Credentials" ], "summary": "Add credentials for a new Sysdyne Webcrete API customer", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division ID of the customer", "schema": { "type": "integer", "format": "int32" } }, { "name": "companyName", "in": "query", "description": "The name of the company as used in the API (provided by the customer)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username (provided by the customer)", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password (provided by the customer) which will be stored encrypted", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "What date (in the past) to start pulling batching data from", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Credentials/Marcotte": { "post": { "tags": [ "Credentials" ], "summary": "Add credentials for a new Marcotte API customer", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division ID of the customer", "schema": { "type": "integer", "format": "int32" } }, { "name": "subdomain", "in": "query", "description": "The name of the company as used as a subdomain in the API (provided by the customer)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username (provided by the customer)", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password (provided by the customer) which will be stored encrypted", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "What date (in the past) to start pulling batching data from", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Credentials/Jonel": { "post": { "tags": [ "Credentials" ], "summary": "Add credentials for a new Jonel API customer", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division ID of the customer", "schema": { "type": "integer", "format": "int32" } }, { "name": "domain", "in": "query", "description": "The domain of the customer's API (example: api.customer.com:500)", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password (provided by the customer) which will be stored encrypted", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "What date (in the past) to start pulling batching data from", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Credentials/Azure": { "post": { "tags": [ "Credentials" ], "summary": "Add credentials for an Azure-based API.", "description": "Currently, this only applies to Magno Concretos and Cayco, which happen to use the exact same API.", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division ID of the customer", "schema": { "type": "integer", "format": "int32" } }, { "name": "subdomain", "in": "query", "description": "The name of the company as used as a subdomain in the API (provided by the customer)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username (provided by the customer)", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The password (provided by the customer) which will be stored encrypted", "schema": { "type": "string" } }, { "name": "subscriptionKey", "in": "query", "description": "Azure API subscription key (provided by the customer)", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "What date (in the past) to start pulling batching data from", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditFiles/UploadCementEPD": { "put": { "tags": [ "CreditFiles" ], "summary": "Uploads an EPD for a particular cement", "parameters": [ { "name": "materialId", "in": "query", "description": "The ID of the cement material which the EPD applies to.", "schema": { "type": "integer", "format": "int32" } }, { "name": "publishDate", "in": "query", "description": "The publication date of the EPD / when its validity period starts.", "schema": { "type": "string", "format": "date" } }, { "name": "expirationDate", "in": "query", "description": "When the EPD expires / when its validity period ends.", "schema": { "type": "string", "format": "date" } }, { "name": "emissionsFactorTCO2PerTCement", "in": "query", "description": "The emissions factor of the cement (measured in tonnes of CO2\n per tonne of cement).", "schema": { "type": "number", "format": "double" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The EPD file.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditFiles/UploadNationalAverageEPD": { "put": { "tags": [ "CreditFiles" ], "summary": "Uploads an industry average EPD for a particular country", "parameters": [ { "name": "country", "in": "query", "description": "The country which the EPD applies to.", "schema": { "type": "string" } }, { "name": "cementType", "in": "query", "description": "The type of cement which the EPD applies to.", "schema": { "$ref": "#/components/schemas/MaterialType" } }, { "name": "publishDate", "in": "query", "description": "The publication date of the EPD / when its validity period starts.", "schema": { "type": "string", "format": "date" } }, { "name": "expirationDate", "in": "query", "description": "When the EPD expires / when its validity period ends.", "schema": { "type": "string", "format": "date" } }, { "name": "emissionsFactorTCO2PerTCement", "in": "query", "description": "The emissions factor of the cement (measured in tonnes of CO2\n per tonne of cement).", "schema": { "type": "number", "format": "double" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The EPD file.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditFiles/UploadProducerAttestation": { "put": { "tags": [ "CreditFiles" ], "summary": "Uploads a producer attestation file for a myCC account", "parameters": [ { "name": "accountId", "in": "query", "description": "The ID of the myCC account.", "schema": { "type": "integer", "format": "int32" } }, { "name": "attestationDate", "in": "query", "description": "The date when the producer made the attestation.", "schema": { "type": "string", "format": "date" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The producer attestation file.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditFiles/ProducerAttestation/{accountId}": { "get": { "tags": [ "CreditFiles" ], "summary": "Gets a producer attestation file", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account to get the attestation for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditFiles/UploadEgridSourceFile": { "put": { "tags": [ "CreditFiles" ], "summary": "Uploads a source file for an egrid efficiency value", "parameters": [ { "name": "egridRegionId", "in": "query", "description": "The ID of the egrid region which the file applies to.", "schema": { "type": "integer", "format": "int32" } }, { "name": "publishDate", "in": "query", "description": "When the validity period for the file starts.", "schema": { "type": "string", "format": "date" } }, { "name": "expirationDate", "in": "query", "description": "When the validity period for the file ends.", "schema": { "type": "string", "format": "date" } }, { "name": "emissionsFactorTCO2ePerMwh", "in": "query", "description": "The emissions factor of the grid (measured in tonnes of CO2 equivalent\n per megawatt-hour).", "schema": { "type": "number", "format": "double" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "The source file.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditSales/DownloadTemplate": { "get": { "tags": [ "CreditSales" ], "summary": "Downloads template for entering credit sale details.", "description": "Only includes rows for sales where data is missing by default.", "parameters": [ { "name": "includeAll", "in": "query", "description": "Whether data for all details should be included, even if no information is missing.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/CreditSales/UploadTemplate": { "put": { "tags": [ "CreditSales" ], "summary": "Uploads template for credit sale details.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "CSV file containing sale data.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/GraphData": { "get": { "tags": [ "Dorsal" ], "summary": "Retrieves graphs for Dorsal with downsampled data.", "description": "The data is downsampled into up to 500 buckets, and the averages are returned.", "parameters": [ { "name": "startTime", "in": "query", "description": "The start date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "The end date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "readyMixUnitId", "in": "query", "description": "ID of the RM unit to fetch telemetry data for.", "schema": { "type": "integer", "format": "int32" } }, { "name": "runConcurrently", "in": "query", "description": "If the queries should run concurrently. On by default, disabled only for testing.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DorsalGraphs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DorsalGraphs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DorsalGraphs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/Table": { "get": { "tags": [ "Dorsal" ], "summary": "Returns raw, unsampled data from the specified tables combined into a single list, sorted by timestamp.", "parameters": [ { "name": "startTime", "in": "query", "description": "The start date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "The end date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "readyMixUnitId", "in": "query", "description": "ID of the RM unit to fetch telemetry data for.", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeInjections", "in": "query", "description": "Include injection data.", "schema": { "type": "boolean", "default": true } }, { "name": "includeReadings", "in": "query", "description": "Include injection reading data. Referred to as \"MMD Logs\" in the UI.", "schema": { "type": "boolean", "default": true } }, { "name": "includeStatuses", "in": "query", "description": "Include status data. Referred to as \"Inlet Logs\" in the UI.", "schema": { "type": "boolean", "default": true } }, { "name": "includeAlarms", "in": "query", "description": "Include alarm data.", "schema": { "type": "boolean", "default": true } }, { "name": "limit", "in": "query", "description": "Maximum number of rows to return. If not specified, a maximum of 100,000 rows are returned.", "schema": { "type": "integer", "format": "int32" } }, { "name": "fromTime", "in": "query", "description": "Lastest timestamp from the previous response. Used for pagination.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fromTable", "in": "query", "description": "Latest source table from the previous response. Used for pagination.", "schema": { "$ref": "#/components/schemas/TableRanking" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DorsalTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DorsalTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DorsalTable" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/Table/Download": { "get": { "tags": [ "Dorsal" ], "summary": "Downloads raw data from the specified tables, within selected time range, up to 100,000 rows.", "parameters": [ { "name": "startTime", "in": "query", "description": "The start date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "The end date and time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "readyMixUnitId", "in": "query", "description": "ID of the RM unit to fetch telemetry data for.", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeInjections", "in": "query", "description": "Include injection data.", "schema": { "type": "boolean", "default": true } }, { "name": "includeReadings", "in": "query", "description": "Include injection reading data. Referred to as \"MMD Logs\" in the UI.", "schema": { "type": "boolean", "default": true } }, { "name": "includeAlarms", "in": "query", "description": "Include alarm data.", "schema": { "type": "boolean", "default": true } }, { "name": "includeStatuses", "in": "query", "description": "Include status data. Referred to as \"Inlet Logs\" in the UI.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/SystemInfo/{readyMixUnitId}": { "get": { "tags": [ "Dorsal" ], "summary": "Fetches general info for a ready mix unit, along with the start and end time of the latest injection.", "parameters": [ { "name": "readyMixUnitId", "in": "path", "description": "ID of the ready mix unit.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DorsalSystemInfoArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DorsalSystemInfoArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DorsalSystemInfoArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/Connectivity/{readyMixUnitId}": { "get": { "tags": [ "Dorsal" ], "summary": "Fetches connectivity info for a ready mix unit - whether it's online or not, and for how long.", "parameters": [ { "name": "readyMixUnitId", "in": "path", "description": "ID of the ready mix unit.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DorsalSystemConnectivity" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DorsalSystemConnectivity" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DorsalSystemConnectivity" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Dorsal/Watch/{readyMixUnitId}": { "get": { "tags": [ "Dorsal" ], "summary": "Checks whether the current user is \"watching\" a ready mix unit.", "parameters": [ { "name": "readyMixUnitId", "in": "path", "description": "ID of the ready mix unit.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WatchDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WatchDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WatchDetails" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "Dorsal" ], "summary": "Updates whether the current user is \"watching\" a ready mix unit.", "parameters": [ { "name": "readyMixUnitId", "in": "path", "description": "ID of the ready mix unit.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isWatching", "in": "query", "description": "Whether the current user should be set as watching the ready mix unit.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WatchDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WatchDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WatchDetails" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Sales/Opportunities": { "get": { "tags": [ "Echo" ], "summary": "Gets a list of sales opportunities", "parameters": [ { "name": "limit", "in": "query", "description": "Results limit. Prevents swagger from breaking.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOpportunityResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOpportunityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOpportunityResponse" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations/SalesOverview": { "get": { "tags": [ "Echo" ], "summary": "Returns sales information pertinent to the RMPD dashboard.", "description": "Does not return masonry plants.", "parameters": [ { "name": "limit", "in": "query", "description": "The number of corporations to return (mostly so swagger doesn't break)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationSalesOverview" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationSalesOverview" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationSalesOverview" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/ConstructionProjects": { "get": { "tags": [ "Echo" ], "summary": "Gets a list of upcoming construction projects for map display", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructionProject" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructionProject" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructionProject" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/ConstructionProjects/Historical": { "get": { "tags": [ "Echo" ], "summary": "Gets historical customer projects for map display", "parameters": [ { "name": "limit", "in": "query", "description": "The number of projects to return (mostly so swagger doesn't break)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProject" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProject" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerProject" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/CO2Supplier/MapLayer": { "get": { "tags": [ "Echo" ], "summary": "Gets a list of CO2 depots and their locations.", "parameters": [ { "name": "limit", "in": "query", "description": "Numbers of results to include. Mostly so swagger doesn't crash.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2SupplierMapPoint" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2SupplierMapPoint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2SupplierMapPoint" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/CO2Supplier/Table": { "get": { "tags": [ "Echo" ], "summary": "Gets a table of CO2 depots, grouped by vendor and state", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Co2VendorTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Co2VendorTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Co2VendorTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Cements/Map": { "get": { "tags": [ "Echo" ], "summary": "Gets cement plant info for display on a map", "parameters": [ { "name": "limit", "in": "query", "description": "Numbers of results to include. Mostly so swagger doesn't crash.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantMapPoint" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantMapPoint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantMapPoint" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Cements/Table": { "get": { "tags": [ "Echo" ], "summary": "Gets a table of cements along with their lab test results", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "CementTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementType" } } }, { "name": "LabResults", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LabResult" } } }, { "name": "Longitude", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "Latitude", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "RadiusKm", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "Suppliers", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EchoCementTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EchoCementTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EchoCementTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets a list of the ready-mix units", "description": "Used for a dropdown on Orca", "parameters": [ { "name": "limit", "in": "query", "description": "Results limit so swagger doesn't break.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/Injections": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets CO2 injections recorded by a ready-mix unit", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The maximum number of injections to return", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "startTime", "in": "query", "description": "Filter for earliest injection start time", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "Filter for latest injection start time", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Injection" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Injection" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Injection" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/InjectionsTableResults": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets CO2 injections recorded by a ready-mix unit (with pagination)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "startTime", "in": "query", "description": "Filter for earliest injection start time", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "Filter for latest injection start time", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InjectionTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InjectionTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InjectionTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/InjectionReadings": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets detailed readings surrounding injections", "description": "Note that the startTime is a required parameter for performance reasons. For big enough time ranges,\nthis endpoint will become unusably slow.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "startTime", "in": "query", "description": "Filter for earliest reading timestamp", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "Filter for latest reading timestamp", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InjectionReadingTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InjectionReadingTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InjectionReadingTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/StatusesTableResults": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets status readings recorded by a ready-mix unit (with pagination)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "startTime", "in": "query", "description": "Filter for earliest status time stamp", "schema": { "type": "string", "format": "date-time" } }, { "name": "endTime", "in": "query", "description": "Filter for latest status time stamp", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StatusTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatusTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/Alarms": { "get": { "tags": [ "Engineering (Orca)" ], "summary": "Gets alarms raised by a ready-mix unit", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The maximum number of alarms to return", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/RemoteUnits/{id}/Watchlist": { "put": { "tags": [ "Engineering (Orca)" ], "summary": "Updates the watchlist status for a ready mix unit.", "description": "The watchlist is used to keep track of mixer units that should not be sending data.\nhttps://carboncure.atlassian.net/browse/KEL-658", "parameters": [ { "name": "id", "in": "path", "description": "Id of the mixer unit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isOnWatchlist", "in": "query", "description": "Whether or not to include the ready mix unit in the watchlist", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/InjMapping/MapInjections": { "post": { "tags": [ "InjMapping" ], "summary": "Maps injections to tickets for the given corporation", "description": "The algorithm groups injections and tickets into 1-day buckets where it tries to map the two linearly.\nDays that have tickets associated with credits are skipped.\nDays on which the algorithm previously ran on have the mappings cleared before being remapped.", "parameters": [ { "name": "corporationId", "in": "query", "description": "The ID of the corporation to map injections for", "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "description": "The ID of the division to map injections for", "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "The ID of the plant to map injections for", "schema": { "type": "integer", "format": "int32" } }, { "name": "minTime", "in": "query", "description": "Map tickets and injections after this timestamp.\nNote that the algorithm pulls data from the start of the previous day relative to this timestamp.", "schema": { "type": "string", "format": "date-time" } }, { "name": "maxTime", "in": "query", "description": "Map tickets and injections before this timestamp.\nNote that the algorithm pulls data from the end of the following day relative to this timestamp.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Krill/Configs": { "get": { "tags": [ "Krill" ], "summary": "Gets the list of Krill configs to render", "description": "Each config represents one tab in the Krill interface, complete with a table and filters", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KrillConfig" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KrillConfig" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KrillConfig" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Krill/MixStrengths": { "get": { "tags": [ "Krill" ], "parameters": [ { "name": "Division", "in": "query", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EndDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "MissingInfo", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "Krill" ], "parameters": [ { "name": "isMetric", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixStrengthsRow" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Krill/CreditSales": { "get": { "tags": [ "Krill" ], "parameters": [ { "name": "MissingDetailsFilter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "Krill" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSaleRow" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Krill/CustomerFeedback": { "get": { "tags": [ "Krill" ], "parameters": [ { "name": "Quarter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "Krill" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerFeedbackRow" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/MixDesigns/UploadStrengthFile": { "put": { "tags": [ "MixDesign" ], "summary": "Uploads mix design strengths for a specific customer.", "parameters": [ { "name": "corporationId", "in": "query", "description": "The ID of the corporation to upload the strengths to.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "CSV file containing strength data.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/CorrectClockShift": { "post": { "tags": [ "Mixer" ], "summary": "Correct HMI data that was reported to be from 2006 or 2012 due to a clock reset", "description": "This should be run after the HMI clock has been fixed, and requires you to know what the clock was reading\nbefore it was changed and what it was reading after it was changed", "parameters": [ { "name": "hmiId", "in": "query", "description": "The HMI ID", "schema": { "type": "integer", "format": "int32" } }, { "name": "timeBeforeChange", "in": "query", "description": "The time the HMI clock was showing before it was changed", "schema": { "type": "string", "format": "date-time" } }, { "name": "timeAfterChange", "in": "query", "description": "The time the HMI clock was showing immediately after it was changed", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Mixer/ClearOldDebugTelemetry": { "post": { "tags": [ "Mixer" ], "summary": "Endpoint deletes all statuses and injection readings that are older than two years.\nThis endpoint is meant to be executed in January, as part of our process to reduce disk space.\nThe deleted telemetry data was used for debug purposes, not for credits, and was approved for deletion by hardware.", "description": "This endpoint does not delete data beyond January 2014, sometimes HMIs revert their clocks to\n2006 or 2012, meaning that the data from that time is most likely recent data that needs to be corrected.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/MixerData/HmiAlarm": { "post": { "tags": [ "MixerData" ], "summary": "Creates alarms based on hmi issued error messages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HmiIssuedErrorPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HmiIssuedErrorPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HmiIssuedErrorPayload" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Hardware/MixerData/HmiDataTransferAlarm": { "post": { "tags": [ "MixerData" ], "summary": "Creates alarms based on data transfer issues from an HMI.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HmiDataTransferAlarmPayload" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HmiDataTransferAlarmPayload" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HmiDataTransferAlarmPayload" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Hardware/MixerData/Injections": { "post": { "tags": [ "MixerData" ], "summary": "Adds injection to the database.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InjectionBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InjectionBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InjectionBody" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Hardware/MixerData/InjectionReadings": { "post": { "tags": [ "MixerData" ], "summary": "Adds injection readings to an injection in the database.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InjectionReadingBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InjectionReadingBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InjectionReadingBody" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Hardware/MixerData/Statuses": { "post": { "tags": [ "MixerData" ], "summary": "Adds statuses to the database", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatusBody" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Hardware/MixerData/NetworkStatuses": { "post": { "tags": [ "MixerData" ], "summary": "Adds a CSV of ping results to the database", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Accounts": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Get a list of the myCC accounts", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountArgsTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Accounts" ], "summary": "Create a new myCC account", "requestBody": { "description": "Details of the new account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Get the details of a single myCC account", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Accounts" ], "summary": "Update a myCC account (by CarbonCure staff)", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The new details for the account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountCreationArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "delete": { "tags": [ "myCC - Accounts" ], "summary": "Archive a myCC account", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to archive", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Update": { "post": { "tags": [ "myCC - Accounts" ], "summary": "Update a myCC account (by client)", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The new details for the account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientAccountUpdateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientAccountUpdateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClientAccountUpdateArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/EnableTicker": { "post": { "tags": [ "myCC - Accounts" ], "summary": "Enable the option of a website ticker for this account", "description": "Having the ticker be enabled means that anyone on the internet has access to the customer's production, so\nwe prefer to have it be disabled until the user enables it.\nThe permissions are minimal because we don't want to add friction to the ticker user flow. However, if this\nendpoint is hit by a CCT staff user (email ending in carboncure.com) then it will do nothing.", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/Icon/{accountId}": { "post": { "tags": [ "myCC - Accounts" ], "summary": "Uploads an image to be used as an account icon.\nIf an icon is already associated with the account, it is overwritten.", "parameters": [ { "name": "accountId", "in": "path", "description": "Account to add icon for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "The image file to upload", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/Names": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Gets a list of myCC account names + IDs", "description": "For use in dropdowns. Is sorted by name.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDropdown" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/CorporationNames": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Gets a list of corporation names + IDs", "description": "For use in dropdowns. Is sorted by name.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationDropdown" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/DivisionNames": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Gets a list of division names + IDs", "description": "For use in dropdowns. Is sorted by name.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionDropdown" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/CorporationStaff": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Gets the CarbonCure staff members assigned to a given corporation in Salesforce", "parameters": [ { "name": "corporationId", "in": "query", "description": "The ID of the corporation to get staff members for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StaffMembers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StaffMembers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StaffMembers" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/CorporationLanes": { "get": { "tags": [ "myCC - Accounts" ], "summary": "Gets the lanes of a given corporation", "parameters": [ { "name": "corporationId", "in": "query", "description": "The ID of the corporation to get lane details for", "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "description": "The ID of the division to get lane details for", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeDecommissioned", "in": "query", "description": "Whether decommissioned lanes should be included in the response", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets": { "get": { "tags": [ "myCC - Assets" ], "summary": "Gets the assets that the customer is allowed to see", "parameters": [ { "name": "accountId", "in": "query", "description": "The ID of the user's myCC account", "schema": { "type": "integer", "format": "int32" } }, { "name": "assetId", "in": "query", "description": "Specify the assetID to return a single asset with the matching ID.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAsset" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAsset" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAsset" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets/{assetId}": { "delete": { "tags": [ "myCC - Assets" ], "summary": "Deletes an asset", "parameters": [ { "name": "assetId", "in": "path", "description": "The ID of the asset to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deleteFromS3", "in": "query", "description": "If true, deletes the asset from S3 in addition to the DB record.\n False by default.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "put": { "tags": [ "myCC - Assets" ], "summary": "Updates an asset record. Updates S3 only if filename or MyCC account have changed,\nor if a new file is included with the update.", "description": "If there are no changes to the file itself,\nthe `File` arg can be left null to avoid overwriting the existing upload in S3.", "parameters": [ { "name": "assetId", "in": "path", "description": "The ID of the asset to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "FileExtension", "in": "query", "schema": { "type": "string" } }, { "name": "Description", "in": "query", "schema": { "type": "string" } }, { "name": "Link", "in": "query", "description": "URL pointing to location of the asset.\nOnly required if asset is an external link.", "schema": { "type": "string" } }, { "name": "Path", "in": "query", "description": "Asset path displayed in the UI.\nNot required for Folder or Icon AssetTypes", "schema": { "type": "string" } }, { "name": "MyCCAccountId", "in": "query", "description": "ID of MyCC account associated with the asset.\nShould be null if asset is \"shared\" or associated with a staff user.", "schema": { "type": "integer", "format": "int32" } }, { "name": "StaffUserId", "in": "query", "description": "Only Icon asset types can be associated with StaffUsers.", "schema": { "type": "integer", "format": "int32" } }, { "name": "AssetType", "in": "query", "schema": { "$ref": "#/components/schemas/AssetType" } }, { "name": "IsKeyResource", "in": "query", "schema": { "type": "boolean" } }, { "name": "ThumbnailLink", "in": "query", "description": "Deprecated. Public URL pointing asset location.\nUse `GET Assets/AssetUrl/{assetId}?isThumbnail=true` to get a pre-signed URL providing access to the asset thumbnail.\nUse `POST Assets/Thumbnail/{assetId}` to upload a new thumbnail for an asset.", "schema": { "type": "string" } }, { "name": "LastUpdatedTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets/AddAsset": { "post": { "tags": [ "myCC - Assets" ], "summary": "Adds a new asset record and uploads the attached file to S3", "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "FileExtension", "in": "query", "schema": { "type": "string" } }, { "name": "Description", "in": "query", "schema": { "type": "string" } }, { "name": "Link", "in": "query", "description": "URL pointing to location of the asset.\nOnly required if asset is an external link.", "schema": { "type": "string" } }, { "name": "Path", "in": "query", "description": "Asset path displayed in the UI.\nNot required for Folder or Icon AssetTypes", "schema": { "type": "string" } }, { "name": "MyCCAccountId", "in": "query", "description": "ID of MyCC account associated with the asset.\nShould be null if asset is \"shared\" or associated with a staff user.", "schema": { "type": "integer", "format": "int32" } }, { "name": "StaffUserId", "in": "query", "description": "Only Icon asset types can be associated with StaffUsers.", "schema": { "type": "integer", "format": "int32" } }, { "name": "AssetType", "in": "query", "schema": { "$ref": "#/components/schemas/AssetType" } }, { "name": "IsKeyResource", "in": "query", "schema": { "type": "boolean" } }, { "name": "ThumbnailLink", "in": "query", "description": "Deprecated. Public URL pointing asset location.\nUse `GET Assets/AssetUrl/{assetId}?isThumbnail=true` to get a pre-signed URL providing access to the asset thumbnail.\nUse `POST Assets/Thumbnail/{assetId}` to upload a new thumbnail for an asset.", "schema": { "type": "string" } }, { "name": "LastUpdatedTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCAsset" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets/Thumbnail/{assetId}": { "post": { "tags": [ "myCC - Assets" ], "summary": "Uploads a thumbnail for an asset to S3", "description": "The corresponding asset must already exist in the DB in order to upload a thumbnail for it.", "parameters": [ { "name": "assetId", "in": "path", "description": "ID of existing asset for which thumbnail is being uploaded.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "File to be used as the asset thumbnail.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets/Url/{assetId}": { "get": { "tags": [ "myCC - Assets" ], "summary": "Returns a URL pointing to the asset. Can either be a pre-signed S3 URL or the external link.", "parameters": [ { "name": "assetId", "in": "path", "description": "ID of asset to fetch URL for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isThumbnail", "in": "query", "description": "Boolean indicating whether a link to an asset or it's thumbnail is required. False by default.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Assets/Zip": { "get": { "tags": [ "myCC - Assets" ], "summary": "Generates a zip file with multiple assets enclosed.", "parameters": [ { "name": "assetIds", "in": "query", "description": "IDs of assets to be included in zip file.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CreditTable": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a table of credits", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to get credits for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreditTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/BatchingTable": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a table of batching file uploads", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to get batching file uploads for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Search key that filters table results.", "schema": { "type": "string" } }, { "name": "shouldIncludeErrors", "in": "query", "description": "Toggles ingestion errors. No errors is default.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchingTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchingTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchingTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CO2Suppliers/{plantId}": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a list of co2 depots nearest to a plant", "description": "Used for dropdowns.", "parameters": [ { "name": "plantId", "in": "path", "description": "The plant to get the nearest co2 depots for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The number of co2 depots to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/GhgEmitters/{plantId}": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a list of co2 capture facilities nearest to a plant", "description": "Used for dropdowns.", "parameters": [ { "name": "plantId", "in": "path", "description": "The plant to get the nearest co2 capture facilities for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The number of co2 capture facilities to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/Breakdown": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a breakdown of the credits for an account", "description": "Credits are broken down into:\n\n \"No Data\" - estimated credits we could make from injections that we have no batching data for\n\n \"Unvalidated\" - we've gotten batching data but haven't aggregated the data into credits\n\n \"Validated\" - credits that have been created but haven't been sold yet\n\n \"Sold\" - credits that have been sold to a buyer", "parameters": [ { "name": "accountId", "in": "path", "description": "The myCC account ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditBreakdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditBreakdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditBreakdown" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/ActionItems": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a list of action items for an account to obtain more credits", "parameters": [ { "name": "accountId", "in": "path", "description": "The myCC account ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActionItems" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/BatchingActionItems": { "get": { "tags": [ "myCC - Credits" ], "summary": "Get a list of batching action items for an account to obtain more credits", "parameters": [ { "name": "accountId", "in": "path", "description": "The myCC account ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchingActionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchingActionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchingActionItem" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/QcActionItems": { "get": { "tags": [ "myCC - Credits" ], "summary": "Gets a list of QC action items for an account to obtain more credits", "parameters": [ { "name": "accountId", "in": "path", "description": "The myCC account ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QcActionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QcActionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QcActionItem" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/LynxInformationRequest": { "post": { "tags": [ "myCC - Credits" ], "summary": "Sends lynx information request email the customer data project manager.", "parameters": [ { "name": "accountId", "in": "path", "description": "The account for the which the support request is being sent.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CreditSummary": { "get": { "tags": [ "myCC - Credits" ], "summary": "Summary of a customer's credit portfolio.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreditSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditSummary" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CreditUpdate": { "get": { "tags": [ "myCC - Credits" ], "summary": "Credit update for a specific user.\nThe number of credits sold and the number of credits validated\nsince they last viewed the credit dashbaord.", "description": "Only meant for MyCC users, updates for staff users are always 0.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreditUpdate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditUpdate" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CreditSalesTable": { "get": { "tags": [ "myCC - Credits" ], "summary": "Credit sale details table.", "parameters": [ { "name": "accountId", "in": "path", "description": "Id of the mycc account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreditSalesTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreditSalesTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditSalesTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/CreditTransactionReceipt": { "get": { "tags": [ "myCC - Credits" ], "summary": "Credit Transaction Receipt Pdf", "parameters": [ { "name": "accountId", "in": "path", "description": "id of the mycc account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "creditTransactionId", "in": "query", "description": "id of the credit transaction", "schema": { "type": "integer", "format": "int32" } }, { "name": "languageStr", "in": "query", "description": "language the receipt should be in", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Credits/EligibleLynxPlants": { "get": { "tags": [ "myCC - Credits" ], "summary": "Returns list of plants eligible for Lynx that have not yet installed.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of MyCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantNames" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantNames" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantNames" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Dropdowns/CementPlants": { "get": { "tags": [ "myCC - Dropdowns" ], "summary": "Gets a list of all available cement plants", "parameters": [ { "name": "country", "in": "query", "description": "Which country to get cement plants for. Optional.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Dropdowns/CementTypes": { "get": { "tags": [ "myCC - Dropdowns" ], "summary": "Gets a list of all supported cement types", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementTypeArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementTypeArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementTypeArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Dropdowns/CO2Suppliers": { "get": { "tags": [ "myCC - Dropdowns" ], "summary": "Gets a list of CO2 supplier company names", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Emails": { "post": { "tags": [ "myCC - Email" ], "summary": "Sends an email, specified by the caller", "description": "The email will be sent \"from\" the logged-in user.", "parameters": [ { "name": "targetAddresses", "in": "query", "description": "The addresses to send the email to", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ccAddresses", "in": "query", "description": "The addresses to send the email to as a CC", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "subject", "in": "query", "description": "The subject of the email", "schema": { "type": "string" } } ], "requestBody": { "description": "The body of the email", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/MyCCE2E/TestStructure": { "post": { "tags": [ "myCC - End To End Testing" ], "summary": "Creates a MyCC account with the associated structure.", "description": "VALIDATION\n \nThis endpoint handles the setup for all testing cases. There is parameter validation\nin place to avoid conflicting configuration choices.\n- Onboarding enabled account cannot have more than 3 lanes.\n- For upload log based data integration, there has to be at least 1 lane with a timestamp 3 months in the past.\n- Each lane must have an installation timestamp\n- Non 'Command Alkon' lanes cannot have lynx timestamps.\n- The installed timestamp for lynx, when set, needs to be before the last file received timestamp.\n- Lanes with production data must have a timestamp at least 4 months in the past.\n- A mix design's compressive strength must be greater than 0 or null.\n- For any given mix design, the design strength must be defined unless the QC scenario is NoData\n- For any given mix design, the mix must have a baseline when the QC scenario is Sufficient.\n \nFUNCTIONALITY\n \nInsights\n- Can create a myCC account with an arbitrary number of lanes, each with an installation timestamp less than 6 months ago or older than 7 months ago.\n- By the setting the `ExceededProductionGoal` production data scenario, the corresponding lane has data available for more than 1 month.\n- For any of the production scenarios, except for `NoData`, lanes have data available in the Insights report.\n- For any of the production scenarios, except for `NoData`, there is data available in the Environmental report.\n- For any of the production scenarios, except for `NoData`, there is daily summary data available.\n- A lane using the Lagging scenario, is returned by the `/Accounts/{myCCId}/Lanes/Lagging`\n- A lane using `ExceededProductionGoal` will be marked as `ExceedingProductionGoal` by the `/Accounts/{myCCId}/Lanes/RecentProduction` endpoint.\n- A lane using the `Lagging` scenario is marked as not ExceedingProductionGoal by the `/Accounts/{myCCId}/Lanes/RecentProduction` endpoint.\n- A lane using the `SuggestionActions` scenario is returned by the `/Accounts/{myCCId}/Lanes/SuggestedActions` endpoint.\n- For any of the production scenarios, except for `NoData` the production report will be populated with the lane's injections.\n \nMyData\n- Lanes with a Command batching software are eligible for lynx.\n- Lanes with a lynx installation timestamp are considered installed.\n- Lanes without a Command batching software are not considered eligible.\n- For eligible lanes, a lynx installation package can be downloaded. Note: The zip is fake, and does not actually generate the api key, configuration file, etc.\n \nBatching Data\n- Accounts can be created with a specified data integration type.\n- The lynx data integration type can be set on a per lane basis, using the lynx timestamps.\n- For the `FileUpload` data integration type, action items are available only when the `IncludeError` flag is set to true.\n- When the `LastLynxFileSeenTimestamp` is set to more than 14 days in the past, the lynx batching table will show an error for this lane.\n \nQcData\n- For mix designs with the `Limited` qc data scenario, the there will be action items associated with them.\n- Each qc data scenario directly corresponds to the mix design status in the `/Accounts/{myCCId}/MyData/Qc/Table` endpoint.\n \nMix Design Manager\n- Each lane can be created with an arbitrary number of mix designs.\n- For each, a mix strength can be specified.\n- Each mix can be created with or without a baseline mix.\n- Each mix can or cannot be user created.", "requestBody": { "description": "Test account data arguments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestStructureArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestStructureArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestStructureArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } } } } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/MyCCE2E/CreateUser/{myCCAccountId}": { "post": { "tags": [ "myCC - End To End Testing" ], "summary": "Adds a new MyCC user to an existing MyCC account associated with a TestClient corporation.", "parameters": [ { "name": "myCCAccountId", "in": "path", "description": "MyCC account Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "Email used to create user with. If no email is provided, a random one is generated.", "schema": { "type": "string" } }, { "name": "permissionGroup", "in": "query", "description": "The user's intended permissions", "schema": { "$ref": "#/components/schemas/PermissionGroup" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewMyCCTestUserResponse" } } } } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/MyCCE2E/RemoveUser/{myCCAccountId}": { "delete": { "tags": [ "myCC - End To End Testing" ], "summary": "Deletes a user from an existing MyCC account associated with a TestClient corporation.", "parameters": [ { "name": "myCCAccountId", "in": "path", "description": "MyCC account Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "The user's email", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/MyCCE2E/OnboardingStaffTasks": { "put": { "tags": [ "myCC - End To End Testing" ], "summary": "Writes staff task values to salesforce.", "parameters": [ { "name": "myCCAccountId", "in": "query", "description": "Id of testing account.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "List of staff tasks to update", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { "M2MAuth": [ "applicationId", "roles" ] } ] } }, "/Accounts/{accountId}/Estimates": { "get": { "tags": [ "myCC - Estimates" ], "summary": "Gets the estimates for a myCC account", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the user's myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "estimateId", "in": "query", "description": "The ID of the estimate to retrieve. Used for bookmarking on frontend.", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchKey", "in": "query", "description": "Search key (optional)", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EstimateArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EstimateArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EstimateArgsTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Estimates" ], "summary": "Adds a new estimate", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the user's myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The details of the estimate to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EstimateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EstimateArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Estimates/MixDesigns": { "get": { "tags": [ "myCC - Estimates" ], "summary": "Gets a list of a the mix designs which are tied to a baseline", "description": "Only includes mixes for which we know the baseline cement and the project cement", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OldStyleMixDesignArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OldStyleMixDesignArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OldStyleMixDesignArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/FeatureFlags/IsEnabled/{name}/{accountId}": { "get": { "tags": [ "myCC - FeatureFlags" ], "summary": "Fetches existing feature flags.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/FeatureFlags": { "get": { "tags": [ "myCC - FeatureFlags" ], "summary": "Fetches existing feature flags.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlagArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlagArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlagArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - FeatureFlags" ], "summary": "Adds a new feature flag", "requestBody": { "description": "Details for the new feature flag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "put": { "tags": [ "myCC - FeatureFlags" ], "summary": "Updates an existing feature flag", "requestBody": { "description": "Details for the updated feature flag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/FeatureFlags/{id}": { "delete": { "tags": [ "myCC - FeatureFlags" ], "summary": "Deletes an existing feature flag", "parameters": [ { "name": "id", "in": "path", "description": "ID of the feature flag being deleted.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/GoalProgress": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Gets the progress being made by a list of lanes towards their production goals", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitIds", "in": "query", "description": "The ready mix units to get data for.\n OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "startDate", "in": "query", "description": "Start of the custom timerange to get production data for", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "End of the custom timerange to get production data for", "schema": { "type": "string", "format": "date" } }, { "name": "rmIds", "in": "query", "description": "IDs of ready mix units to fetch data for.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VolumeGoalProgress" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGoalProgress" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VolumeGoalProgress" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/Lagging": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Gets lanes and groups that are lagging behind their production goals", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaggingPlantOrGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaggingPlantOrGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaggingPlantOrGroup" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/SuggestedActions": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Gets monthly production with suggested mix designs to improve it", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitIds", "in": "query", "description": "The ready mix units to get data for.\n OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "rmIds", "in": "query", "description": "IDs of ready mix units to fetch data for.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteUnitProduction" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteUnitProduction" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteUnitProduction" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Returns lanes under an account", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeDecommissioned", "in": "query", "description": "Whether decommissioned lanes should be included in the response", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Lanes" ], "summary": "Updates a lane", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated attributes for the lane", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaneArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LaneArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LaneArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LaneArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LaneArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LaneArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/Paginated": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Returns lanes under an account", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Search key (optional)", "schema": { "type": "string" } }, { "name": "includeDecommissioned", "in": "query", "description": "Whether decommissioned lanes should be included in the response", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LaneArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LaneArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LaneArgsTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/RecentProduction": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Returns data about the last 6 months of production for lanes", "description": "Used in the myCC production page to render the map", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneProductionArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneProductionArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneProductionArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/UpdateMany": { "post": { "tags": [ "myCC - Lanes" ], "summary": "Updates multiple lanes", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated attributes for the lanes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Lanes/DailySummary": { "get": { "tags": [ "myCC - Lanes" ], "summary": "Gets a daily summary of production and co2 savings", "description": "The production values are summed together over all of the given lanes.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitIds", "in": "query", "description": "The ready mix units to get the summary for.\n OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "rmIds", "in": "query", "description": "IDs of ready mix units to fetch summary data for.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DailySummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DailySummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DailySummary" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/BaselineMixes": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a list of baseline mixes", "description": "Mostly for use in dropdowns. Is sorted by mix code.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "The ID of the plant to get mixes for", "schema": { "type": "integer", "format": "int32" } }, { "name": "projectMixDesignId", "in": "query", "description": "ID of CO2 mix that baselines must be included for, regardless of plant or cement content.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/ProjectMixes": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a list of project mixes", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "The ID of the plant to get mixes for", "schema": { "type": "integer", "format": "int32" } }, { "name": "baselineMixDesignId", "in": "query", "description": "ID of non-CO2 mix that project mixes must be included for, regardless of plant or cement content.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/Mixes": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets list of all mixes associated with a plant or MyCC account", "description": "Mostly for use in dropdowns. Is sorted by mix code.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "The ID of the plant to get mixes for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/QcMixCodes": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a list of unique mix codes at the corporation level.\nMeant to be used for MyData's QC data section.", "description": "Without a search key, an empty list is returned", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchKey", "in": "query", "description": "Search key for mix codes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a table of a the mix designs", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "includeBaselineMixes", "in": "query", "description": "Whether to include baseline mix designs in the results", "schema": { "type": "boolean", "default": true } }, { "name": "includeProjectMixes", "in": "query", "description": "Whether to include CO2 mix designs in the results", "schema": { "type": "boolean", "default": true } }, { "name": "searchKey", "in": "query", "description": "Get only mix designs that contain this string somewhere", "schema": { "type": "string" } }, { "name": "groupName", "in": "query", "description": "Get only mix designs from this group of lanes", "schema": { "type": "string" } }, { "name": "getUserMixes", "in": "query", "description": "Whether to get user mix designs or system ones", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixDesignsTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignsTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignsTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Mix Designs" ], "summary": "Adds a new user mix design", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The details of the mix design", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/{mixDesignId}": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a single mix design", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mixDesignId", "in": "path", "description": "The ID of the mix design to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixDesignsTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignsTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignsTable" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Mix Designs" ], "summary": "Modifies an existing user mix design", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mixDesignId", "in": "path", "description": "The ID of the mix design to modify", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The details of the mix design", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/NoBaseline": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets project mixes without a baseline", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The number of mixes to return", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsQueryModelTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsQueryModelTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsQueryModelTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/NoDesignStrength": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets project mixes without a compressive strength", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The number of mixes to return", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SimpleMixArgsTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/Commissioning": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets details of mix design testing from commissioning", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The max number of mix designs to return (so swagger doesn't crash)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningMixDesignArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningMixDesignArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningMixDesignArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/ActionItems": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets mix design action items", "description": "There are currently two types of actions: Shift (add CO2 to a non-CarbonCure mix design)\nand Optimize (reduce cement from a CarbonCure mix design)", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "Get action items only for this plant", "schema": { "type": "integer", "format": "int32" } }, { "name": "highRisk", "in": "query", "description": "Whether to be risky when calculating required strength (10% risk of strength\n in the failure zone vs 1%)", "schema": { "type": "boolean", "default": true } }, { "name": "limit", "in": "query", "description": "The max number of action items to return (for pagination)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of action items to skip (for pagination)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignActionItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignActionItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignActionItem" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/{mixDesignId}/ActionItems": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets action item for a specific mix design", "description": "This is meant for use on the production page for linkage to the mix optimization module.\nFor that reason, this endpoint ONLY SUPPORTS SHIFT ACTION ITEMS! Meaning, it will never return\nan action item for a CO2 mix design.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mixDesignId", "in": "path", "description": "The ID of the mix design to get the action item for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "highRisk", "in": "query", "description": "Whether to be risky when calculating required strength (10% risk of strength\n in the failure zone vs 1%)", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/{mixDesignId}/ActionItems/Accept": { "post": { "tags": [ "myCC - Mix Designs" ], "summary": "Accepts the change proposed by a mix design action item", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mixDesignId", "in": "path", "description": "The ID of the mix design whose action item we want to accept", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "newMixCode", "in": "query", "description": "The new mix code for the changed mix design, if applicable", "schema": { "type": "string" } }, { "name": "highRisk", "in": "query", "description": "Whether to be risky when calculating required strength (10% risk of strength\n in the failure zone vs 1%)", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/{mixDesignId}/ActionItems/Dismiss": { "post": { "tags": [ "myCC - Mix Designs" ], "summary": "Dismisses a mix design action item so it doesn't appear for a month", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mixDesignId", "in": "path", "description": "The ID of the mix design whose action item we want to dismiss", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reason", "in": "query", "description": "The reason for dismissing the action item", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/Sandbox": { "post": { "tags": [ "myCC - Mix Designs" ], "summary": "Makes suggestions based on inputted mix design", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The details of the mix design", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MixDesignArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MixDesigns/PlantNames": { "get": { "tags": [ "myCC - Mix Designs" ], "summary": "Gets a list of installed plant names + IDs", "description": "For use in dropdowns. Is sorted by name.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantDropdown" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/SourcesTable": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets a table of material sources for all of myCC account's plants", "parameters": [ { "name": "accountId", "in": "path", "description": "The account who's material sources will be returned.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Optional search filter for all returned string values", "schema": { "type": "string" } }, { "name": "plantId", "in": "query", "description": "Optionally restrict material sources to a single plant.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Qc/Table": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets a table of qc data per mix design for the given myCC account.", "parameters": [ { "name": "accountId", "in": "path", "description": "The account who's material sources will be returned.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Optional search filter for all returned values", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyDataQcTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyDataQcTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyDataQcTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Qc/BulkUpload": { "post": { "tags": [ "myCC - MyData" ], "summary": "Bulk uploads QC data files.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account Id for the QC data belongs to", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "QC data files to upload" } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Qc/MetaData": { "post": { "tags": [ "myCC - MyData" ], "summary": "Sets/Updates the meta data associated with a QC file upload", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account Id for the QC data belongs to", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "QC meta data for the QC data upload(s)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QCFileMetaDataArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QCFileMetaDataArgs" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QCFileMetaDataArgs" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Qc/PendingData": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets a list of QC data files uploaded that are still pending ingestion.", "parameters": [ { "name": "accountId", "in": "path", "description": "Id of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QcDataPendingApprovalTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QcDataPendingApprovalTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QcDataPendingApprovalTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/MaterialSources/{plantId}": { "post": { "tags": [ "myCC - MyData" ], "summary": "Updates a plant's material sources", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to update.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "path", "description": "Id of the target plant.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "New material sources for the plant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourceArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourceArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourceArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTable" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTable" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyDataMaterialSourcesTable" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/BatchingData/LatestIngestion": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets the timestamp of the latest ingestion of batching data", "description": "Returns 204 status code if there is no ingestion data available", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LatestIngestionInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LatestIngestionInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LatestIngestionInfo" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/BatchingData/LynxBatchingTable": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets a table of lynx batching file uploads", "parameters": [ { "name": "accountId", "in": "path", "description": "The account to get lynx batching file uploads for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Search key that filters table results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LynxBatchingTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LynxBatchingTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LynxBatchingTableTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/QcData/AdditionalTestingRequest": { "post": { "tags": [ "myCC - MyData" ], "summary": "Sends additional testing email to SAM.", "parameters": [ { "name": "accountId", "in": "path", "description": "The account for the which the support request is being sent.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Argument with the support request information for SAM.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamAdditionalTestingEmailArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamAdditionalTestingEmailArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamAdditionalTestingEmailArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Lynx": { "get": { "tags": [ "myCC - MyData" ], "summary": "Creates an installation package for lynx.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "ID of the plant", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Lynx/PlantStatus": { "get": { "tags": [ "myCC - MyData" ], "summary": "Gets the lynx eligibility status for an account's plants with pagination", "parameters": [ { "name": "accountId", "in": "path", "description": "Id of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "schema": { "type": "string" } }, { "name": "IdColumn", "in": "query", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "searchKey", "in": "query", "description": "Search key filter (optional)", "schema": { "type": "string" } }, { "name": "useLegacyStatuses", "in": "query", "description": "Optional flag to enable newer labels (defaults to true - legacy labels only)", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantLynxStatusTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantLynxStatusTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantLynxStatusTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/MyData/Batching/BulkUpload": { "post": { "tags": [ "myCC - MyData" ], "summary": "Bulk uploads batching data files.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID to upload batching files to", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "Notes": { "type": "array", "items": { "type": "string" } } } }, "encoding": { "Files": { "style": "form" }, "Notes": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UploadLog" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Onboarding": { "get": { "tags": [ "myCC - Onboarding" ], "summary": "Gets the onboarding details for the account's plants", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Onboarding" ], "summary": "Updates the onboarding details for the account's plants", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The updated details to save", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingPlantArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingPlantArgs" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingPlantArgs" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Onboarding/AccountTasks": { "get": { "tags": [ "myCC - Onboarding" ], "summary": "Gets a list of account tasks and their completion state for the myCC account.", "description": "If the account doesn't have any tasks for it in the db, this endpoint will add available tasks\nto the account's tasks.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Onboarding" ], "summary": "Updates the completion state of a task for a myCC account", "description": "This is intended to be called after GET /Accounts/{accountId}/Onboarding/AccountTasks,\nwhich populates the tasks in the database (if necessary) for the myCC account.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID>", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskType", "in": "query", "description": "The type of task that should be updated", "schema": { "$ref": "#/components/schemas/MyCCAccountTaskType" } }, { "name": "isCompleted", "in": "query", "description": "The new value of the task", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCAccountTaskResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Onboarding/StaffTasks": { "get": { "tags": [ "myCC - Onboarding" ], "summary": "Gets a list of staff tasks from sales force", "description": "When a plant has more than one installation lane, only the tasks associated with the\nlane marked as #1 in the installation order are returned. If the first installation lane has\nnot yet been defined, an empty list is returned.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffTask" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Onboarding/BusinessRegistration": { "post": { "tags": [ "myCC - Onboarding" ], "summary": "Uploads the attached business registration file to S3 and emails it to our Logistics Manager.\nIf successful, this endpoint also marks the business registration task as completed in Salesforce.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "File containing business registration info.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants": { "get": { "tags": [ "myCC - Plants" ], "summary": "Fetches a list of plants for the primary plant settings table.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plants.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchKey", "in": "query", "description": "Key used to filter plants based on display name, city, state, grouping, or manager", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantsTableArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantsTableArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantsTableArgsTableResults" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "put": { "tags": [ "myCC - Plants" ], "summary": "Updates a plant and system production percentages. Pushes data to Salesforce.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plant.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Arguments for updating the plant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlantUpdateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantUpdateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlantUpdateArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/MissingDetails": { "get": { "tags": [ "myCC - Plants" ], "summary": "Fetches list of plant systems that are missing information either in Salesforce of the database.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plants.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MissingSystemInfoArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MissingSystemInfoArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MissingSystemInfoArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/Groups": { "get": { "tags": [ "myCC - Plants" ], "summary": "Fetches a list of plant groups. Includes simple plant args for editing functionality.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plants.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantGroupArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantGroupArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantGroupArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "put": { "tags": [ "myCC - Plants" ], "summary": "Updates plant groups", "description": "- To add a plant to a group, include all plant IDs (including the one to add) in the `PlantIds` array. Set `PreviousGroupName` as null.\n- To remove a plant from a group, set `GroupName` to the relevant group and exclude the plant ID from the plantIds array. Include the plant IDs of plants that need to remain in the group.\n- To rename a group, set `PreviousGroupName` to the old name, `GroupName` to the new name, and include all Plants that should retain the new name in the `PlantIds` array.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plants.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Args used to update the groups.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlantGroupUpdateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantGroupUpdateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlantGroupUpdateArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/{plantId}": { "get": { "tags": [ "myCC - Plants" ], "summary": "Fetches plant details, including a list of systems.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with plant.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "path", "description": "ID of plant to fetch details for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantDetailsArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantDetailsArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantDetailsArgs" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/System/{remoteUnitId}": { "get": { "tags": [ "myCC - Plants" ], "summary": "Fetches system details.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with system.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitId", "in": "path", "description": "ID of ready mix unit to fetch details for.\n Refers to the ReadyMixUnitId, but the frontend requires this outdated name.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemArgsFull" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemArgsFull" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemArgsFull" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/System": { "put": { "tags": [ "myCC - Plants" ], "summary": "Updates system information. Pushes data to Salesforce.", "parameters": [ { "name": "accountId", "in": "path", "description": "MyCC account ID associated with system.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Args used to update system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SystemUpdateArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/Dropdown": { "get": { "tags": [ "myCC - Plants" ], "summary": "Gets a list of installed plants for group selection dropdown. Includes manager and location details.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsShort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsShort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsShort" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/Image": { "get": { "tags": [ "myCC - Plants" ], "summary": "Gets list of customer plant image upload records.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the myCC account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "ID of the plant associated with the image.", "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitId", "in": "query", "description": "ID of the ready mix unit (lane) associated with the image.\n Refers to the ReadyMixUnitId, but the frontend requires this outdated name.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageUploadArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageUploadArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImageUploadArgs" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Plants" ], "summary": "Uploads a list of images to S3 and creates corresponding DB records.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the myCC account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitId", "in": "query", "description": "ID of the ready mix unit (lane) associated with the image.\n Refers to the ReadyMixUnitId, but the frontend requires this outdated name.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "List of files to be uploaded." } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "delete": { "tags": [ "myCC - Plants" ], "summary": "Deletes a list of images from the DB and S3.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the myCC account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "imageIds", "in": "query", "description": "IDs of the images to delete.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Plants/Image/Url/{imageId}": { "get": { "tags": [ "myCC - Plants" ], "summary": "Gets a presigned URL to download an image file.", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the myCC account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "imageId", "in": "path", "description": "ID of the image record to fetch a link for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/ProgressWidget": { "get": { "tags": [ "myCC - ProgessBanner" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "progressWidget", "in": "query", "schema": { "$ref": "#/components/schemas/ProgressWidgetType" } }, { "name": "timeframe", "in": "query", "schema": { "$ref": "#/components/schemas/ProgressWidgetTimeframe" } }, { "name": "units", "in": "query", "schema": { "$ref": "#/components/schemas/ProgressWidgetUnits" } }, { "name": "environmentEquivalence", "in": "query", "schema": { "$ref": "#/components/schemas/ProgressWidgetEnvironmentEquivalence" } }, { "name": "production", "in": "query", "schema": { "$ref": "#/components/schemas/ProgressWidgetProduction" } }, { "name": "language", "in": "query", "schema": { "$ref": "#/components/schemas/LocalizationLanguage" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Reports/Insights": { "get": { "tags": [ "myCC - Reports" ], "summary": "Generates an Insights Report PDF", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitIds", "in": "query", "description": "The ready mix units to include in the report.\n OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "startDate", "in": "query", "description": "Include data only from this date onwards", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Include data only up until this date", "schema": { "type": "string", "format": "date" } }, { "name": "language", "in": "query", "description": "Language for the pdf", "schema": { "type": "string" } }, { "name": "rmIds", "in": "query", "description": "IDs of ready mix units to include in the report.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Reports/Environmental": { "get": { "tags": [ "myCC - Reports" ], "summary": "Generates an Environmental Report PDF", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Include data only from this date onwards", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Include data only up until this date", "schema": { "type": "string", "format": "date" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "schema": { "type": "string" } }, { "name": "Website", "in": "query", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language for the pdf", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Reports/Estimate": { "get": { "tags": [ "myCC - Reports" ], "summary": "Generates an Estimate Report PDF", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reportId", "in": "query", "description": "The ID of the estimate", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language for the pdf", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Reports/Production": { "get": { "tags": [ "myCC - Reports" ], "summary": "Generates a Production Report PDF", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "remoteUnitIds", "in": "query", "description": "The ready mix units to include in the report.\n OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "groups", "in": "query", "description": "The groups of ready mix units to include in the report", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "startDate", "in": "query", "description": "Include data only from this date onwards", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Include data only up until this date", "schema": { "type": "string", "format": "date" } }, { "name": "productionGraphType", "in": "query", "description": "Which metric should be displayed in the charts", "schema": { "$ref": "#/components/schemas/ProductionGraphType" } }, { "name": "timeZoneId", "in": "query", "description": "The user's timezone (used to display the current date)", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language for the pdf", "schema": { "type": "string" } }, { "name": "rmIds", "in": "query", "description": "IDs of ready mix units to include in the report.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/ForgotPassword": { "get": { "tags": [ "myCC - Users" ], "summary": "Sends a password reset link to the email provided", "description": "The endpoint returns a 200 regardless of whether or not there is an account by that email, and regardless of\nwhether or not we were able to send the email. This prevents attackers from gaining any information.", "parameters": [ { "name": "email", "in": "query", "description": "The email of the user account we forgot the password to", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { } ] } }, "/CheckChangePasswordId": { "post": { "tags": [ "myCC - Users" ], "summary": "Check if a Change Password Id is valid", "description": "This returns true if a user exists with the given Change Password ID, and False if no user exists", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } }, "security": [ { }, { }, { } ] } }, "/Users/ChangePasswordLoggedOut": { "post": { "tags": [ "myCC - Users" ], "summary": "Changes the password of a myCC user when given the Change Password Id", "requestBody": { "description": "The current password, and the password id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedOutArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedOutArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedOutArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { }, { } ] } }, "/Users/CarbonCureStaff": { "get": { "tags": [ "myCC - Users" ], "summary": "Gets the CarbonCure users registered in the system", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffUserResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffUserResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaffUserResponse" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Users" ], "summary": "Adds a new CarbonCure staff user to the myCC system", "requestBody": { "description": "The details of the new user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/CarbonCureStaff/{userId}": { "post": { "tags": [ "myCC - Users" ], "summary": "Updates a CarbonCure staff user", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The new details for the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StaffUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "delete": { "tags": [ "myCC - Users" ], "summary": "Deletes a CarbonCure staff user", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/CarbonCureStaff/{userId}/ResendInvite": { "post": { "tags": [ "myCC - Users" ], "summary": "Resends the invitation email to a CarbonCure staff user", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Users": { "get": { "tags": [ "myCC - Users" ], "summary": "Gets the users associated with a myCC account", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCUserResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCUserResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyCCUserResponse" } } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "post": { "tags": [ "myCC - Users" ], "summary": "Adds a new user to a myCC account", "description": "When a user is excluded from receiving an email invite, the user is registered in Kelowna, but not externally.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "shouldExcludeFromInvite", "in": "query", "description": "Indicates whether the user should be invited to set a password.", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The details of the new user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/InviteUser/{userId}": { "post": { "tags": [ "myCC - Users" ], "summary": "Sends invite email to a user for the first time.\nThe user must have been added to a myCC account without an original invite being sent.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Users/{userId}": { "post": { "tags": [ "myCC - Users" ], "summary": "Updates a myCC user", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The new details for the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] }, "delete": { "tags": [ "myCC - Users" ], "summary": "Deletes a myCC user", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Accounts/{accountId}/Users/{userId}/ResendInvite": { "post": { "tags": [ "myCC - Users" ], "summary": "Resends the invitation email to a myCC user", "description": "Note: This endpoint will invalidate previously-sent invite emails!", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/Me": { "get": { "tags": [ "myCC - Users" ], "summary": "Gets the details of the current user", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserResponse" }, { "$ref": "#/components/schemas/StaffUserResponse" }, { "$ref": "#/components/schemas/MyCCUserResponse" } ] } }, "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserResponse" }, { "$ref": "#/components/schemas/StaffUserResponse" }, { "$ref": "#/components/schemas/MyCCUserResponse" } ] } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UserResponse" }, { "$ref": "#/components/schemas/StaffUserResponse" }, { "$ref": "#/components/schemas/MyCCUserResponse" } ] } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/Me/BasicInfo": { "put": { "tags": [ "myCC - Users" ], "summary": "Updates basic information for the currently logged in user.", "description": "This endpoint only updates the name, job, and phone number fields.\nIt is meant to be used by customer staff and manager users.\nAdmin users should use `POST /Accounts/{accountId}/Users/{userId}`.", "requestBody": { "description": "The new details for the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserResponse" } } } } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/ChangePasswordLoggedIn": { "post": { "tags": [ "myCC - Users" ], "summary": "Changes the password of a myCC user when given the Current Password", "requestBody": { "description": "The current password, and new password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedInArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedInArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordLoggedInArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/Settings": { "post": { "tags": [ "myCC - Users" ], "summary": "Changes the settings of a myCC user", "requestBody": { "description": "The new settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyCCUserSettingArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyCCUserSettingArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyCCUserSettingArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/Users/AcceptPolicies": { "post": { "tags": [ "myCC - Users" ], "summary": "Accepts the myCC privacy policy for the current user", "responses": { "200": { "description": "OK" } }, "security": [ { }, { "MyCCAuth": [ "applicationId", "roles" ] }, { } ] } }, "/OrcaFeatureFlags/IsEnabled/{name}": { "get": { "tags": [ "Orca - FeatureFlags" ], "summary": "Gets the value of a feature flag.", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/OrcaFeatureFlags": { "get": { "tags": [ "Orca - FeatureFlags" ], "summary": "Fetches existing feature flags.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrcaFeatureFlag" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrcaFeatureFlag" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrcaFeatureFlag" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "Orca - FeatureFlags" ], "summary": "Adds a new feature flag", "requestBody": { "description": "Details for the new feature flag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/OrcaFeatureFlags/{id}": { "put": { "tags": [ "Orca - FeatureFlags" ], "summary": "Updates an existing feature flag", "parameters": [ { "name": "id", "in": "path", "description": "Id of the feature flag to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the updated feature flag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlagArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrcaFeatureFlag" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "delete": { "tags": [ "Orca - FeatureFlags" ], "summary": "Deletes an existing feature flag", "parameters": [ { "name": "id", "in": "path", "description": "ID of the feature flag being deleted.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Profitability/SetPricesMetric": { "post": { "tags": [ "Profitability" ], "summary": "Updates material (and tank) prices using metric units", "description": "Please fill in ONLY division name or ONLY country (with optional state) but not both.\n \nLeaving a price blank means it will be unchanged in the DB. This interface does not support clearing out data.", "parameters": [ { "name": "DivisionName", "in": "query", "description": "The division to set prices for", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "description": "The country to set prices for", "schema": { "type": "string" } }, { "name": "State", "in": "query", "description": "The state to set prices for (optional addition to country)", "schema": { "type": "string" } }, { "name": "EffectiveDate", "in": "query", "description": "The date (YYYY-MM-DD) these prices took effect (note that later prices in the database will be overridden!)", "schema": { "type": "string", "format": "date" } }, { "name": "CementPriceUsdPerTonne", "in": "query", "description": "Cement price (USD/metric ton)", "schema": { "type": "number", "format": "double" } }, { "name": "SandPriceUsdPerTonne", "in": "query", "description": "Sand price (USD/metric ton)", "schema": { "type": "number", "format": "double" } }, { "name": "SlagPriceUsdPerTonne", "in": "query", "description": "Slag price (USD/metric ton)", "schema": { "type": "number", "format": "double" } }, { "name": "FlyAshPriceUsdPerTonne", "in": "query", "description": "Fly ash price (USD/metric ton)", "schema": { "type": "number", "format": "double" } }, { "name": "CO2PriceUsdPerKg", "in": "query", "description": "CO2 price (USD/kg)", "schema": { "type": "number", "format": "double" } }, { "name": "TankRentalPriceUsdPerMonth", "in": "query", "description": "Tank rental price (USD per system per month)", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Profitability/SetPricesImperial": { "post": { "tags": [ "Profitability" ], "summary": "Updates material (and tank) prices using imperial units", "description": "Please fill in ONLY division name or ONLY country (with optional state) but not both.\n \nLeaving a price blank means it will be unchanged in the DB. This interface does not support clearing out data.", "parameters": [ { "name": "DivisionName", "in": "query", "description": "The division to set prices for", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "description": "The country to set prices for", "schema": { "type": "string" } }, { "name": "State", "in": "query", "description": "The state to set prices for (optional addition to country)", "schema": { "type": "string" } }, { "name": "EffectiveDate", "in": "query", "description": "The date (YYYY-MM-DD) these prices took effect (note that later prices in the database will be overridden!)", "schema": { "type": "string", "format": "date" } }, { "name": "CementPriceUsdPerTon", "in": "query", "description": "Cement price (USD/ton)", "schema": { "type": "number", "format": "double" } }, { "name": "SandPriceUsdPerTon", "in": "query", "description": "Sand price (USD/ton)", "schema": { "type": "number", "format": "double" } }, { "name": "SlagPriceUsdPerTon", "in": "query", "description": "Slag price (USD/ton)", "schema": { "type": "number", "format": "double" } }, { "name": "FlyAshPriceUsdPerTon", "in": "query", "description": "Fly ash price (USD/ton)", "schema": { "type": "number", "format": "double" } }, { "name": "CO2PriceUsdPerLb", "in": "query", "description": "CO2 price (USD/lb)", "schema": { "type": "number", "format": "double" } }, { "name": "TankRentalPriceUsdPerMonth", "in": "query", "description": "Tank rental price (USD per system per month)", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Profitability/DivisionNames": { "get": { "tags": [ "Profitability" ], "summary": "Gets list of division names", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Public/Counter/{corporationId}": { "get": { "tags": [ "Public" ], "summary": "Gets a summary of a corporation's stats for a given timerange", "description": "Used for tickers on customer websites. Ideally, we should restrict this endpoint to customers who have\nopted to use such a ticker, so that the info isn't publicly accessible if they don't want it to be.", "parameters": [ { "name": "corporationId", "in": "path", "description": "The ID of the corporation to get data for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "description": "The ID of the division to get data for", "schema": { "type": "integer", "format": "int32" } }, { "name": "range", "in": "query", "description": "The range of data to include", "schema": { "$ref": "#/components/schemas/CustomerCounterTimerange" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } } } } }, "deprecated": true, "security": [ { }, { }, { } ] } }, "/Public/Counter/Account/{accountId}": { "get": { "tags": [ "Public" ], "summary": "Gets a summary of a myCC account's stats for a given timerange", "description": "Used for tickers on customer websites. Ideally, we should restrict this endpoint to customers who have\nopted to use such a ticker, so that the info isn't publicly accessible if they don't want it to be.", "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the myCC account to get data for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "range", "in": "query", "description": "The range of data to include", "schema": { "$ref": "#/components/schemas/CustomerCounterTimerange" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCounterResponse" } } } } }, "security": [ { }, { }, { } ] } }, "/Public/Counter": { "get": { "tags": [ "Public" ], "summary": "Gets a production counter since a year ago and for all time based on daily customer production summaries.", "description": "Used for Carbon Cure's counter on the main site.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CounterResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CounterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CounterResponse" } } } } }, "security": [ { }, { }, { } ] } }, "/Hardware/RcaData/ReadingsCsv": { "get": { "tags": [ "RcaData" ], "summary": "Returns a CSV of readings for a given RCA unit.", "parameters": [ { "name": "rcaUnitId", "in": "query", "description": "The ID of the RCA unit to return readings for.", "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "description": "Return only data for this date (in the local timezone)", "schema": { "type": "string", "format": "date" } }, { "name": "batchNumber", "in": "query", "description": "Return only data for this batch number", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ReclaimedWaterData/Status": { "get": { "tags": [ "ReclaimedWaterData" ], "summary": "Returns recent statuses for a given reclaimed water unit ID.", "parameters": [ { "name": "reclaimedWaterUnitId", "in": "query", "description": "The ID of the reclaimed water unit whose statuses to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxResults", "in": "query", "description": "Maximum number of results to return. Defaults to 10.", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReclaimedWaterStatus" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReclaimedWaterStatus" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReclaimedWaterStatus" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ReclaimedWaterData/CO2InjectionReadings": { "get": { "tags": [ "ReclaimedWaterData" ], "summary": "Returns recent CO2 injection readings for a given reclaimed water unit ID.", "description": "Readings are translated back into the input format defined by the RW team.", "parameters": [ { "name": "reclaimedWaterUnitId", "in": "query", "description": "The ID of the reclaimed water unit whose data to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxResults", "in": "query", "description": "Maximum number of results to return. Defaults to 10.", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2ReadingResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2ReadingResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CO2ReadingResponse" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Table": { "get": { "tags": [ "ServiceCases" ], "summary": "A paginated and filterable endpoint that fetches a list of service cases.", "parameters": [ { "name": "MinInitialIndicationDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "MinLastUpdatedDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "MinTimeElapsedDays", "in": "query", "schema": { "type": "integer", "format": "int32", "deprecated": true } }, { "name": "MaxTimeElapsedDays", "in": "query", "schema": { "type": "integer", "format": "int32", "deprecated": true } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EndDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "IsOperational", "in": "query", "schema": { "type": "boolean" } }, { "name": "ResolutionStatus", "in": "query", "schema": { "$ref": "#/components/schemas/ResolutionStatus" } }, { "name": "TagsToInclude", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "TagsToExclude", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ServiceCaseId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReadyMixUnitId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "HardwareSpecialistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IsOpen", "in": "query", "schema": { "type": "boolean" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceCasesTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCasesTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCasesTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/HardwareSpecialists": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches a list of CC Staff marked as Hardware Specialists. Used in dropdowns.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/AllCarbonCureStaff": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches a list of all active CC Staff. Used in action selection dropdown.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Systems": { "get": { "tags": [ "ServiceCases" ], "summary": "Returns a list of systems with customer info. Used in create service case dropdowns.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemInfoArgsShort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemInfoArgsShort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemInfoArgsShort" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Tags": { "get": { "tags": [ "ServiceCases" ], "summary": "Returns a list of all service case tags used to date. Used in service case tag dropdowns/autofills.", "description": "Tags are sorted by frequency of use.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/SystemInfo/{readyMixUnitId}": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches general info for a ready mix unit. Used in service case creation.", "parameters": [ { "name": "readyMixUnitId", "in": "path", "description": "ID of the ready mix unit.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemInfoArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemInfoArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemInfoArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/FilterOptions": { "get": { "tags": [ "ServiceCases" ], "summary": "Retrieves data required for filtering dropdowns.", "parameters": [ { "name": "ServiceCaseId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReadyMixUnitId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "HardwareSpecialistId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IsOpen", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceCasesFilterOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCasesFilterOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCasesFilterOptions" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases": { "post": { "tags": [ "ServiceCases" ], "summary": "Creates a new service case", "requestBody": { "description": "Arguments required to create new service case.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseCreationResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}": { "put": { "tags": [ "ServiceCases" ], "summary": "Updates an existing service case", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Arguments required to update a service case.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseUpdateArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseUpdateArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceCaseUpdateArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "get": { "tags": [ "ServiceCases" ], "summary": "Returns details of an existing service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case to fetch.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceCaseInfoArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseInfoArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseInfoArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "delete": { "tags": [ "ServiceCases" ], "summary": "Deletes a service case.", "description": "This endpoint was made for use in system tests, and is not used anywhere in the actual Orca application.", "parameters": [ { "name": "serviceCaseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Resolve": { "put": { "tags": [ "ServiceCases" ], "summary": "Resolves an existing service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case to resolve.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Arguments required to resolve a service case.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResolutionArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResolutionArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResolutionArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Resources": { "get": { "tags": [ "ServiceCases" ], "summary": "Retrieves a list of resources attached to a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case to fetch resources for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseResourceArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseResourceArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseResourceArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "ServiceCases" ], "summary": "Uploads and attaches a resource to a service case. The resource can be an external link or file.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service to upload resource to.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "Notes": { "type": "string" }, "Link": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "Notes": { "style": "form" }, "Link": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Resources/Upload": { "post": { "tags": [ "ServiceCases" ], "summary": "Creates a record for a resource. Returns a pre-signed URL to upload the resource file if it is not a link.", "description": "Uploads through the S3 pre-signed URL are subject to the standard size limit of a single S3 request (5 GB).", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case to upload the resource for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resource metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResourceCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResourceCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceCaseResourceCreationArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Resources/Upload/{resourceId}": { "put": { "tags": [ "ServiceCases" ], "summary": "Confirms that a resource upload via pre-signed URL succeeded.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the associated service case.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceId", "in": "path", "description": "ID of the resource to confirm a successful upload for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Resources/{resourceId}": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches a resource link or generates a pre-signed URL to access the S3 file.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case associated with the resource.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceId", "in": "path", "description": "ID of the resource to be deleted.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "delete": { "tags": [ "ServiceCases" ], "summary": "Deletes a service case resource.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of the service case associated with the resource.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceId", "in": "path", "description": "ID of the resource to be deleted.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/FollowUp": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches list of all follow-ups associated with a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to retrieve follow-up items for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FollowUpArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FollowUpArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FollowUpArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "ServiceCases" ], "summary": "Adds a new follow-up item to a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to create a follow-up item for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Follow-up creation arguments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/FollowUp/{followUpId}": { "put": { "tags": [ "ServiceCases" ], "summary": "Updated an existing follow-up item.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to update a follow-up item for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "followUpId", "in": "path", "description": "ID of the follow-up item to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Follow-up update arguments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FollowUpCreationArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/History": { "get": { "tags": [ "ServiceCases" ], "summary": "Gets a list of historical actions tied to a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to fetch history for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryItem" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Action": { "post": { "tags": [ "ServiceCases" ], "summary": "Adds a new action item to a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to create action item for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Arguments used to create action item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/{serviceCaseId}/Action/{actionId}": { "put": { "tags": [ "ServiceCases" ], "summary": "Updates an existing service case action item.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to update action item for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "actionId", "in": "path", "description": "ID of action item to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Arguments used to update action item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActionCreationArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Parts": { "get": { "tags": [ "ServiceCases" ], "summary": "Gets a list of all available parts.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitPart" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitPart" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitPart" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Parts/{serviceCaseId}": { "get": { "tags": [ "ServiceCases" ], "summary": "Gets a list of parts associated with a service case.", "parameters": [ { "name": "serviceCaseId", "in": "path", "description": "ID of service case to get parts for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPartArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPartArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActionPartArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/Parts/{actionPartId}": { "put": { "tags": [ "ServiceCases" ], "summary": "Updates a part associated with a service case.", "parameters": [ { "name": "actionPartId", "in": "path", "description": "ID of part to update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Args to update par", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PartArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "delete": { "tags": [ "ServiceCases" ], "summary": "Deletes a part associated with a service case.", "parameters": [ { "name": "actionPartId", "in": "path", "description": "ID of part to update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/SlackChannelNames": { "get": { "tags": [ "ServiceCases" ], "summary": "Fetches a list of public customer success Slack channels.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/HistoricalContacts": { "get": { "tags": [ "ServiceCases" ], "summary": "Gets a list of customer contacts which were previously inputted in service cases.", "description": "Response will have only one record per name. Duplicate contacts are condensed together as best as we can.", "parameters": [ { "name": "divisionId", "in": "query", "description": "The ID of the division to get contacts for.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContact" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContact" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContact" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/ServiceCases/OpenCases/{plantId}": { "get": { "tags": [ "ServiceCases" ], "summary": "Gets a list of open service cases for a given plant.", "parameters": [ { "name": "plantId", "in": "path", "description": "The ID of the plant to get cases for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseInfoArgsShort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseInfoArgsShort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseInfoArgsShort" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Overview/FilterData": { "get": { "tags": [ "Sonar" ], "summary": "Get data necessary for the overview filter.", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types to include.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarCustomerFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarCustomerFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarCustomerFilter" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Overview/SystemSummary": { "get": { "tags": [ "Sonar" ], "summary": "Gets a summary of operation, downed and snoozed systems.", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types to include.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarSystemSummaryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSummaryResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Overview/TotalAlarms": { "get": { "tags": [ "Sonar" ], "summary": "Gets the overview of alarms", "parameters": [ { "name": "technologyTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarTotalAlarmsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarTotalAlarmsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarTotalAlarmsResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Overview/AlarmsBreakdown": { "get": { "tags": [ "Sonar" ], "summary": "Get Alarms breakdown", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmBreakdownResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmBreakdownResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmBreakdownResponse" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Overview/SystemUpTimeVsDownTime": { "get": { "tags": [ "Sonar" ], "summary": "System up time vs down time", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarUptimeVsDowntimeResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarUptimeVsDowntimeResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarUptimeVsDowntimeResponse" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/DownSystems/TimeRanges": { "get": { "tags": [ "Sonar" ], "summary": "Get a list of down time ranges for down systems.", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types to include.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarSystemDownTimeRange" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarSystemDownTimeRange" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarSystemDownTimeRange" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Alarms/FilterData": { "get": { "tags": [ "Sonar" ], "summary": "Get data necessary for the alarms system's view filter.", "parameters": [ { "name": "technology", "in": "query", "description": "Technology types to include.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "alarmSeverity", "in": "query", "description": "Severity of the alarm to include.", "schema": { "$ref": "#/components/schemas/AlarmSeverity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmType" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Alarms/Table": { "get": { "tags": [ "Sonar" ], "summary": "Gets the alarm table data.", "parameters": [ { "name": "technologyTypes", "in": "query", "description": "Technology types to include.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "StartTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time", "deprecated": true } }, { "name": "EndTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time", "deprecated": true } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EndDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "AlarmSeverity", "in": "query", "schema": { "$ref": "#/components/schemas/AlarmSeverity" } }, { "name": "AlarmCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "shouldShowSnoozed", "in": "query", "description": "Optional parameter include snoozed alarms", "schema": { "type": "boolean", "default": false } }, { "name": "shouldShowActive", "in": "query", "description": "Parameter to include active alarms. True by default.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarAlarmsTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmsTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmsTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/SnoozeAlarm/{alarmId}": { "post": { "tags": [ "Sonar" ], "summary": "Create an alarm snooze.\nThe alarm type is snoozed for the associated system\nstarting at the time of snooze creation.", "parameters": [ { "name": "alarmId", "in": "path", "description": "Id of the alarm to snooze.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "systemType", "in": "query", "description": "Type of system the alarm belongs to. Defaults to Mixer.", "schema": { "$ref": "#/components/schemas/SonarSystemType" } } ], "requestBody": { "description": "Parameters for the snooze.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/SnoozeSystem": { "post": { "tags": [ "Sonar" ], "summary": "Creates a system snooze.", "description": "Only one system type can be snoozed at a time.", "parameters": [ { "name": "remoteUnitId", "in": "query", "description": "ID of a mixer system to snooze.\n Refers to the ReadyMixUnitId, but the frontend requires this outdated name.", "schema": { "type": "integer", "format": "int32" } }, { "name": "reclaimedWaterUnitId", "in": "query", "description": "ID of a reclaimed water system to snooze.", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Parameters for the snooze.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Snooze/{snoozeId}": { "get": { "tags": [ "Sonar" ], "summary": "Gets the information of a given snooze.", "parameters": [ { "name": "snoozeId", "in": "path", "description": "Id of the snooze.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarSnoozeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarSnoozeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarSnoozeResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/Snooze/Resolve/{snoozeId}": { "put": { "tags": [ "Sonar" ], "summary": "Resolves a snooze.", "parameters": [ { "name": "snoozeId", "in": "path", "description": "Id of the snooze.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/SnoozeAlarm/{snoozeId}": { "put": { "tags": [ "Sonar" ], "summary": "Updates an alarm snooze.", "parameters": [ { "name": "snoozeId", "in": "path", "description": "Id of the alarm snooze.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Snooze information to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SonarAlarmSnoozeArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/SnoozeSystem/{snoozeId}": { "put": { "tags": [ "Sonar" ], "summary": "Updates a system snooze.", "parameters": [ { "name": "snoozeId", "in": "path", "description": "Id of the system snooze.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Snooze information to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Hardware/Sonar/DownSystems/Table": { "get": { "tags": [ "Sonar" ], "summary": "Get system down table.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "DivisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SystemId", "in": "query", "schema": { "type": "string" } }, { "name": "StartLastSeenTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time", "deprecated": true } }, { "name": "EndLastSeenTimestamp", "in": "query", "schema": { "type": "string", "format": "date-time", "deprecated": true } }, { "name": "StartLastSeenDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "EndLastSeenDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "Region", "in": "query", "schema": { "type": "string" } }, { "name": "Country", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "TechnologyTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareType" } } }, { "name": "ShouldShowSnoozed", "in": "query", "schema": { "type": "boolean" } }, { "name": "ShouldShowUnsnoozed", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SonarDownSystemTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SonarDownSystemTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SonarDownSystemTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CementPlants": { "get": { "tags": [ "TSS - Cement Plants" ], "summary": "Gets a list of cement plants", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlant" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlant" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlant" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CementPlants/Names": { "get": { "tags": [ "TSS - Cement Plants" ], "summary": "The name and id of every cement plant, for use in a dropdown", "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets a list of the corporations", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Corporation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Corporation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Corporation" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations/{id}": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets the details of a corporation", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the corporation to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Corporation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Corporation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Corporation" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations/WithoutMixerUnits": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Returns a list of corporations with plants that do not have mixer units.", "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations/TssReps": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets a list of TSS representatives", "description": "Mostly for use in dropdowns. Is sorted.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Corporations/Names": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets a list of corporation names + IDs", "description": "Mostly for use in dropdowns. Is sorted by name.", "parameters": [ { "name": "clientsOnly", "in": "query", "description": "Whether to return only corporations who are CarbonCure clients", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationName" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationName" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporationName" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets a list of the plants", "parameters": [ { "name": "corporationId", "in": "query", "description": "Get only plants for this corporation", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "TSS - Customer Management" ], "summary": "Updates a plant", "description": "Because we track history for some plant fields, we include a timestamp for each of them, representing\nsince when this was the value. Null timestamp values indicate \"always\", like\naverageCementCutTimestamp=null means \"the average cement cut was always this value\"", "requestBody": { "description": "Updated attributes for the plant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlantArgsInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantArgsInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlantArgsInput" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantArgsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantArgsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantArgsResponse" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/{id}": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets the details of a plant", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the plant to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantArgsDropdown" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantArgsDropdown" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantArgsDropdown" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/Overview": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Returns an overview of all the plants with mixer units.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "plantsWithAlarms", "in": "query", "description": "Only include plants possessing a mixer unit with an active alarm.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantOverviewTable" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantOverviewTable" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantOverviewTable" } } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/OverviewRowCount": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Returns an overview of all the plants with mixer units.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "plantsWithAlarms", "in": "query", "description": "Only include plants possessing a mixer unit with an active alarm.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantOverviewTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantOverviewTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantOverviewTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/Production": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Gets the production volumes of a plant over time", "description": "Uses customer data where it can, and estimates where it can't. Does not include non-CarbonCure volumes.", "parameters": [ { "name": "plantId", "in": "query", "description": "The ID of the plant to get data for", "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "Get data only after this datetime", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "Get data only before this datetime", "schema": { "type": "string", "format": "date-time" } }, { "name": "bucketSize", "in": "query", "description": "The size of the time bucket", "schema": { "$ref": "#/components/schemas/TimestampPrecision" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/ByDivision/{id}": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Returns plants under a division", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the division you'd like to filter by", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsDropdown" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/FilterOptions": { "get": { "tags": [ "TSS - Customer Management" ], "summary": "Retrieves filtering options used in the Editable Plants Table.", "description": "Includes list of divisions, TSEs, and plant states.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EditablePlantsFilterOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditablePlantsFilterOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditablePlantsFilterOptions" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Plants/Table": { "post": { "tags": [ "TSS - Customer Management" ], "summary": "Get filterable plant data for \"editable plants table\" feature.", "requestBody": { "description": "Table args and filter settings for table data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePlantsTableFilterArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditablePlantsTableFilterArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditablePlantsTableFilterArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlantArgsResponseTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlantArgsResponseTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlantArgsResponseTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions": { "get": { "tags": [ "TSS - Divisions" ], "summary": "Gets a list of the divisions", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Division" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Division" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Division" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions/{id}": { "get": { "tags": [ "TSS - Divisions" ], "summary": "Gets the details of a division", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the division to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Division" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Division" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions/Names": { "get": { "tags": [ "TSS - Divisions" ], "summary": "Returns division names and ids, mostly used for dropdowns", "description": "Used by both Orca and myCC", "parameters": [ { "name": "clientsOnly", "in": "query", "description": "Whether the divisions have ever been clients of CarbonCure", "schema": { "type": "boolean" } }, { "name": "skipMasonry", "in": "query", "description": "Whether to ignore divisions with only masonry plants", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionNameAndUnits" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionNameAndUnits" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionNameAndUnits" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions/Overview": { "get": { "tags": [ "TSS - Divisions" ], "summary": "Returns an overview of customers (divisions) for TSS", "description": "Still requires: list of alarms/alerts", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionOverviewArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionOverviewArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionOverviewArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions/Commissioning/{id}": { "put": { "tags": [ "TSS - Divisions" ], "summary": "Marks a division's InCommissioning property as false.", "parameters": [ { "name": "id", "in": "path", "description": "ID of division to update.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Divisions/Commissioning/{id}/{inCommissioning}": { "put": { "tags": [ "TSS - Divisions" ], "summary": "Used to toggle a division's InCommissioning property for development.", "parameters": [ { "name": "id", "in": "path", "description": "ID of division to update.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "inCommissioning", "in": "path", "description": "Whether division is currently in commissioning stage.", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/Customers/Management/Divisions/{id}": { "get": { "tags": [ "TSS - Divisions" ], "summary": "Gets the details of a division", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the division to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Division" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Division" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Division" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/Table": { "get": { "tags": [ "TSS - Material Manager" ], "summary": "Gets a list of mappings and materials for display in Material Manager.", "description": "Can also be used to pull data for a single material to be used in editing.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "divisionId", "in": "query", "description": "Division ID to filter table by.", "schema": { "type": "integer", "format": "int32" } }, { "name": "primaryMaterialType", "in": "query", "description": "Primary material type to filter table by. Names \"Material Type\" in UI", "schema": { "$ref": "#/components/schemas/PrimaryMaterialType" } }, { "name": "materialType", "in": "query", "description": "Material type to filter by (\"Material Subtype\" in UI).", "schema": { "$ref": "#/components/schemas/MaterialType" } }, { "name": "admixtureMaterialSubType", "in": "query", "description": "Admixture material type to filter by (\"Secondary Material Subtype\" in UI).", "schema": { "$ref": "#/components/schemas/AdmixtureMaterialSubType" } }, { "name": "supplierCompany", "in": "query", "description": "Supplier company name to filter by. This is the cement plant company name in the case of cements.", "schema": { "type": "string" } }, { "name": "supplierPlant", "in": "query", "description": "Supplier plant name to filter by. This is the cement plant plant name in the case of cements.", "schema": { "type": "string" } }, { "name": "alias", "in": "query", "description": "Alias to filter table by.", "schema": { "type": "string" } }, { "name": "isOrcaUpdated", "in": "query", "description": "Only return materials updated via Orca if true; only return materials updated via digital integration if false.\n All materials returned if no value is specified.", "schema": { "type": "boolean" } }, { "name": "materialMappingId", "in": "query", "description": "Specific ID of mapping to return. Used in edit material feature.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MaterialManagerTableTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MaterialManagerTableTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaterialManagerTableTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/Metadata": { "get": { "tags": [ "TSS - Material Manager" ], "summary": "Returns the metadata used in material manager filter dropdowns and add/edit material feature.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MaterialManagerMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MaterialManagerMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaterialManagerMetadata" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/ByDivision/{divisionId}": { "get": { "tags": [ "TSS - Material Manager" ], "summary": "Returns a list of material mappings for a division.", "description": "It does not include all of the details as the main table endpoint, nor can it be paginated.\n\nUsed for dropdown selection on add batch/mix pages.", "parameters": [ { "name": "divisionId", "in": "path", "description": "ID of division to fetch mappings for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialArgsShort" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialArgsShort" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialArgsShort" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/Material": { "post": { "tags": [ "TSS - Material Manager" ], "summary": "Creates a new material mapping for a division.", "description": " If material defined in the args does not exist, it is also created.\n \n This endpoint can optionally also add an alias to another material mapping, as sometimes we need to do these\n two operations together.\n\n If plant compositions are being defined, the cement component `materialId` for the material being added must be null. \n \n This endpoint can throw one of four custom exceptions depending on user input.\n All exceptions have an \"exceptionType\" field (unique identifier for each exception) and an \"error\" field (short helpful message for developers).\n Exceptions can have additional fields, documented below.\n\n `InvalidFieldValue`:\n Thrown when any specific field fails validation (e.g. specific gravity is negative, mapping cannot be found by a specified ID, etc.).\n Includes additional field \"fieldName\" indicating which input failed validation. \n Sample response:\n ```\n {\n \"exceptionType\": \"InvalidFieldValue\",\n \"error\": \"Primary material type cannot be updated.\",\n \"fieldName\": \"PrimaryMaterialType\"\n }\n ```\n\n `DuplicateMapping`:\n Thrown when a material exactly matches an existing material.\n Includes additional field \"existingMapping\" of type MaterialArgs for comparison on the frontend.\n Sample response:\n ```\n {\n \"exceptionType\": \"DuplicateMapping\",\n \"error\": \"Mapping already exists.\",\n \"existingMapping\": {\n \"materialMappingId\": 0,\n \"divisionId\": 0,\n \"divisionName\": \"string\",\n \"isIngested\": true,\n \"primaryMaterialType\": \"Admixture\",\n \"materialType\": \"Cement\",\n \"specificGravity\": 0,\n \"supplierCompany\": \"string\",\n \"supplierPlant\": \"string\",\n \"cementSupplier\": {\n \"cementPlantId\": 0,\n \"plantName\": \"string\",\n \"companyName\": \"string\"\n },\n ...\n }\n }\n```\n \n `SimilarMapping`:\n Thrown when a material's MaterialType and supplier information (plant and company names or cement plant for cements) match an existing material.\n Similar materials are permitted, so this check can be skipped by setting OverrideSimilarCheck=true in the input args.\n Includes additional field \"existingMapping\" of type MaterialArgs for comparison on the frontend.\n Sample response:\n ```\n {\n \"exceptionType\": \"SimilarMapping\",\n \"error\": \"Similar material found.\",\n \"existingMapping\": {\n \"materialMappingId\": 0,\n \"divisionId\": 0,\n \"divisionName\": \"string\",\n \"isIngested\": true,\n \"primaryMaterialType\": \"Admixture\",\n ...\n }\n }\n ```\n\n `DuplicateAlias`:\n Thrown when an alias is trying to be added to a material but it already exists and is associated with another material mapping.\n Includes additional field \"existingMapping\" of type MaterialArgs for comparison on the frontend.\n Sample response:\n ```\n {\n \"exceptionType\": \"DuplicateAlias\",\n \"error\": \"Alias already exists.\",\n \"existingMapping\": {\n \"materialMappingId\": 0,\n \"divisionId\": 0,\n \"divisionName\": \"string\",\n \"isIngested\": true,\n \"primaryMaterialType\": \"Admixture\",\n ...\n }\n }\n ```", "parameters": [ { "name": "materialMappingId", "in": "query", "description": "Optional - mapping to add an alias to.", "schema": { "type": "integer", "format": "int32" } }, { "name": "aliasName", "in": "query", "description": "Optional - the alias to add to the mapping.", "schema": { "type": "string" } } ], "requestBody": { "description": "Material manager args representing one row in the table.\n Contains information on both the mapping and the material.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "put": { "tags": [ "TSS - Material Manager" ], "summary": "Updates a material mapping for a division, as well as plant cement compositions for cement materials.", "description": "If material defined in the args does not exist, it is also created.\n\nThis endpoint can optionally also add an alias to another material mapping, as sometimes we need to do these\ntwo operations together.\n \nIf plant compositions are being defined, the cement component `materialId` for the material being edited must be null.\n\nThis endpoint can throw one of four custom exceptions depending on user input.\nRefer to the exception definitions in `POST /TSS/MaterialManager/Material` for information on each exception.", "parameters": [ { "name": "materialMappingId", "in": "query", "description": "Optional - mapping to add an alias to.", "schema": { "type": "integer", "format": "int32" } }, { "name": "aliasName", "in": "query", "description": "Optional - the alias to add to the mapping.", "schema": { "type": "string" } } ], "requestBody": { "description": "Material manager args representing one row in the table.\n Contains information on both the mapping and the material.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/Alias": { "put": { "tags": [ "TSS - Material Manager" ], "summary": "Adds a new alias to a material mapping's alias list for one or more mappings.", "requestBody": { "description": "List of material mapping IDs and aliases to add.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAliasArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddAliasArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddAliasArgs" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/Merge": { "put": { "tags": [ "TSS - Material Manager" ], "summary": "Merges two material mappings, combining their alias arrays.\nOnly the target mapping will remain following a successful merge.", "parameters": [ { "name": "sourceMappingId", "in": "query", "description": "ID of the material mapping that is being absorbed by the target mapping.", "schema": { "type": "integer", "format": "int32" } }, { "name": "targetMappingId", "in": "query", "description": "ID of the material mapping that is the intended recipient of the merge.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaterialArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MaterialManager/PlantCements": { "get": { "tags": [ "TSS - Material Manager" ], "summary": "Gets the current and historical cement silo composition for all plants in a division", "description": "Note - the history returned for each plant will be sorted by date, starting from the newest revision. Thus,\nto show the current composition, simply look at the first value in the CementCompositions list.", "parameters": [ { "name": "divisionId", "in": "query", "description": "The division to get cement compositions for", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantCementComposition" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantCementComposition" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlantCementComposition" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a list of the mix designs", "parameters": [ { "name": "plantId", "in": "query", "description": "Get only mix designs for this plant", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "post": { "tags": [ "TSS - Mix Designs" ], "summary": "Creates a new mix design", "description": "Sample request:\n \n POST /TSS/MixDesigns\n {\n \"plantId\": 31,\n \"mixCode\": \"411KH\",\n \"preCCMixDesignId\": 23,\n \"description\": \"This is a really special mix design yo\",\n \"isCO2Design\": true,\n \"waterCementRatio\": 0.34,\n \"compressiveStrength\": 311.2,\n \"compressiveStrengthHours\": 672,\n \"strippingStrength\": 286.4,\n \"strippingStrengthHours\": 672,\n \"strengthUnit\": \"PSI\",\n \"exposureClass\": \"C-1\",\n \"airContentPctMin\": 3.1,\n \"airContentPctMax\": 5.0,\n \"slumpMin\": 3.8,\n \"slumpMax\": 5,\n \"slumpUnit\": \"In\",\n \"ingredients\": [\n {\n \"materialName\": \"Cement GUL\",\n \"materialId\": 2,\n \"unit\": \"lbPerYd3\",\n \"amount\": 613.7\n }\n ]\n }", "requestBody": { "description": "The details of the mix design to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "put": { "tags": [ "TSS - Mix Designs" ], "summary": "Updates an existing mix design.", "requestBody": { "description": "The details of the mix design to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MixDesignInput" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixCodesByDivisionId/{divisionId}": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a list of a division's mix codes, including IDs and conditions.", "parameters": [ { "name": "divisionId", "in": "path", "description": "DivisionID used to isolate mix designs", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeAndPlantName" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeAndPlantName" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeAndPlantName" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixGroupDetails/{id}": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a single mix design with all data required for editing on the frontend.", "parameters": [ { "name": "id", "in": "path", "description": "Mix Design ID used to find the design", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixDesignOutput" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignOutput" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/id": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets the mix design details matching with the id", "parameters": [ { "name": "id", "in": "query", "description": "Mix design id to find details in database", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixDesign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixDesign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesign" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixGroup": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a table of mix designs and variations on those mix designs", "parameters": [ { "name": "CementPlantIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "DivisionIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "PlantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MixCode", "in": "query", "schema": { "type": "string" } }, { "name": "DesignStrengthMinMpa", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "DesignStrengthMaxMpa", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "CementLoadingMin", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "CementLoadingMax", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "IncludeOnlyMissingDesignStrength", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeOnlyMissingMixAssociation", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsCO2Design", "in": "query", "schema": { "type": "boolean" } }, { "name": "OnlyInCommissioning", "in": "query", "schema": { "type": "boolean" } }, { "name": "MinNumSamples", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "MaxNumSamples", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "OnlyOrcaMixes", "in": "query", "schema": { "type": "boolean" } }, { "name": "LastModifiedSamplesUserId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixGroupTableFullResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixGroupTableFullResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixGroupTableFullResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixVariationSamples": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets samples for a specified mix group", "parameters": [ { "name": "mixDesignId", "in": "query", "description": "ID of group's mix design.", "schema": { "type": "integer", "format": "int32" } }, { "name": "CO2Dosage", "in": "query", "description": "CO2 dosage amount for the mix variation.", "schema": { "type": "number", "format": "double" } }, { "name": "CO2DosageUnit", "in": "query", "description": "Dosage unit for mix variation. Either a Percentage or LitrePerM3.\n Must be provided if a CO2 dosage is specified.", "schema": { "$ref": "#/components/schemas/CO2DosageUnitAdjusted" } }, { "name": "cementReduction", "in": "query", "description": "Cement reduction percentage for the mix variation.", "schema": { "type": "number", "format": "double" } }, { "name": "includeAll", "in": "query", "description": "Whether all samples of the mix group should be included, regardless of variation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupBatchSampleArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupBatchSampleArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupBatchSampleArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/AssociatedMixes": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a table of associated mixes for a mix design, identified by its ID.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "mixDesignId", "in": "query", "description": "ID specifying the design to fetch associated mixes for.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixGroupArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixGroupArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixGroupArgsTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixGroupsByPlant/{plantId}": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a list of all mix groups associated with a plant.", "parameters": [ { "name": "plantId", "in": "path", "description": "Plant to fetch mix groups for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeWithBaselines" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeWithBaselines" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MixCodeWithBaselines" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/MixGroupWithSamples/{mixDesignId}": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Fetches mix group and samples for analysis in Baleen.", "parameters": [ { "name": "mixDesignId", "in": "path", "description": "Mix design ID of the mix group to fetch data for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixGroupArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixGroupArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixGroupArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/LastModifiedSamplesUsers": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a list of all users that are the last to modify any batch test sample.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LastModifiedUser" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LastModifiedUser" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LastModifiedUser" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/MixDesigns/BulkUpdateSheet/{divisionId}": { "get": { "tags": [ "TSS - Mix Designs" ], "summary": "Gets a spreadsheet of mix designs to bulk-update.", "parameters": [ { "name": "divisionId", "in": "path", "description": "The division to get mix designs for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "MinVolume", "in": "query", "description": "The minimum volume required for a mix to be included", "schema": { "type": "number", "format": "double" } }, { "name": "StartDate", "in": "query", "description": "The start of the daterange to take into account", "schema": { "type": "string", "format": "date" } }, { "name": "EndDate", "in": "query", "description": "The end of the daterange to take into account", "schema": { "type": "string", "format": "date" } }, { "name": "Limit", "in": "query", "description": "How many mixes at most should be included in the spreadsheet", "schema": { "type": "integer", "format": "int32" } }, { "name": "CO2Status", "in": "query", "description": "Whether to include only mixes with/without CO2 in them", "schema": { "$ref": "#/components/schemas/CO2Status" } }, { "name": "WithoutStrengthOnly", "in": "query", "description": "Whether to include only mixes without design strengths", "schema": { "type": "boolean" } }, { "name": "WithoutAddressabilityOnly", "in": "query", "description": "Whether to include only mixes without addressability details", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "put": { "tags": [ "TSS - Mix Designs" ], "summary": "Uploads a spreadsheet of mix designs to bulk-update.", "description": "The endpoint returns a list of issues. If the upload is fully successful, the output will be empty.", "parameters": [ { "name": "divisionId", "in": "path", "description": "The division to update mix designs for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "CSV file containing mix design data.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/BatchTestSamples/AddBatchData": { "post": { "tags": [ "TSS - QC Data" ], "summary": "Upload a set of batch test samples and strength readings", "description": "Sample request:\n \n POST /TSS/BatchTestSamples/AddBatchData\n {\n \"plantId\": 1,\n \"divisionId\": 1,\n \"isMetric\": true,\n \"batchTestSamples\":\n [\n {\n \"ticketId\": \"120\",\n \"mixCode\": \"GK42\",\n \"productionDate\": \"2021-03-01\",\n \"isCO2Design\": true,\n \"testCategory\": \"DosageRamp\",\n \"testingCondition\": false,\n \"curingCondition\": true,\n \"weatherCondition\": \"Windy\",\n \"loadSize\": 4.5,\n \"batchIngredients\":\n [\n {\n \"amount\": 321.56,\n \"materialId\": 1,\n \"unit\": \"Kg\"\n },\n {\n \"amount\": 24,\n \"materialId\": 2,\n \"unit\": \"OzPerYd3\"\n }\n ],\n \"batchStrengthReadings\":\n [\n {\n \"compressiveStrength\": 3.94,\n \"intervalDuration\": 3,\n \"intervalType\": \"Day Intervals\",\n \"testNumber\": 1\n },\n {\n \"compressiveStrength\": 4.05,\n \"intervalDuration\": 3,\n \"intervalType\": \"Day Intervals\",\n \"testNumber\": 2\n },\n {\n \"compressiveStrength\": 20,\n \"intervalDuration\": 7,\n \"intervalType\": \"Day Intervals\",\n \"testNumber\": 1\n },\n {\n \"compressiveStrength\": 35,\n \"intervalDuration\": 28,\n \"intervalType\": \"Day Intervals\",\n \"testNumber\": 1\n }\n ]\n }\n ]\n }", "requestBody": { "description": "The batch test samples", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/BatchTestSamples/Outliers": { "put": { "tags": [ "TSS - QC Data" ], "summary": "Endpoint for marking batch test samples as outliers.", "requestBody": { "description": "List of batch sample IDs and outlier reasons.\n A null reason marks samples as non outliers.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OutlierArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OutlierArgs" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OutlierArgs" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/BatchTestSamples/EditBatchData": { "put": { "tags": [ "TSS - QC Data" ], "summary": "Update a set of batch test samples and strength readings", "description": "Sample request:\n \n PUT /TSS/BatchTestSamples/EditBatchData\n {\n \"plantId\": 1,\n \"divisionId\": 1,\n \"isMetric\": true,\n \"batchTestSampleIds\": [100, 124],\n \"batchTestSamples\":\n [\n {\n \"ticketId\": \"5\",\n \"mixCode\": \"GK42\",\n \"productionDate\": \"2021-03-01\",\n \"isCO2Design\": true,\n \"testCategory\": \"DosageRamp\",\n \"testingCondition\": false,\n \"curingCondition\": true,\n \"weatherCondition\": \"Windy\",\n \"loadSize\": 4.5,\n \"batchIngredients\":\n [\n {\n \"amount\": 321.56,\n \"materialId\": 1,\n \"unit\": \"Kg\"\n },\n {\n \"amount\": 24,\n \"materialId\": 2,\n \"unit\": \"OzPerYd3\"\n }\n ],\n \"batchStrengthReadings\":\n [\n {\n \"compressiveStrength\": 3.94,\n \"intervalDuration\": 3,\n \"intervalType\": \"Days\",\n \"testNumber\": 1\n },\n {\n \"compressiveStrength\": 4.05,\n \"intervalDuration\": 3,\n \"intervalType\": \"Days\",\n \"testNumber\": 2\n },\n {\n \"compressiveStrength\": 20,\n \"intervalDuration\": 7,\n \"intervalType\": \"Days\",\n \"testNumber\": 1\n },\n {\n \"compressiveStrength\": 35,\n \"intervalDuration\": 28,\n \"intervalType\": \"Days\",\n \"testNumber\": 1\n }\n ]\n },\n {\n \"ticketId\": \"6\",\n \"mixCode\": \"GK42\",\n \"productionDate\": \"2021-03-08\",\n \"isCO2Design\": true,\n \"testCategory\": \"DosageRamp\",\n \"testingCondition\": false,\n \"curingCondition\": true,\n \"weatherCondition\": \"Windy\",\n \"loadSize\": 4.5,\n \"batchIngredients\": [],\n \"batchStrengthReadings\":\n [\n {\n \"compressiveStrength\": 20,\n \"intervalDuration\": 7,\n \"intervalType\": \"Days\",\n \"testNumber\": 1\n },\n {\n \"compressiveStrength\": 35,\n \"intervalDuration\": 28,\n \"intervalType\": \"Days\",\n \"testNumber\": 1\n }\n ]\n }\n ]\n }", "requestBody": { "description": "The batch test samples", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BatchDataInput" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/BatchTestSamples/BatchTestSamplesByIds": { "post": { "tags": [ "TSS - QC Data" ], "summary": "Returns list of batches as specified by their IDs.", "requestBody": { "description": "List of BatchTestSampleIds to fetch batches for", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ByBatchTestSampleIdsArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ByBatchTestSampleIdsArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ByBatchTestSampleIdsArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchTestSamplesArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchTestSamplesArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchTestSamplesArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/BatchTestSamples/BatchTestsOverviewRowCount": { "get": { "tags": [ "TSS - QC Data" ], "summary": "An overview of batch tests, sorted by default by timestamp.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BatchTestOverviewArgsTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BatchTestOverviewArgsTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BatchTestOverviewArgsTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Library": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets the library of reports. This includes both commissioning and implementation reports.", "description": "Depending on permissions, not all reports will be available.", "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "mixDesignId", "in": "query", "description": "Optionally filter by mix design id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "description": "Optionally filter by division id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "createdByUserId", "in": "query", "description": "Optionally filter by report creation user.", "schema": { "type": "integer", "format": "int32" } }, { "name": "reportStatus", "in": "query", "description": "Optionally filter a report's status.", "schema": { "$ref": "#/components/schemas/ReportStatus" } }, { "name": "reportType", "in": "query", "description": "Optionally filter the type of report.", "schema": { "$ref": "#/components/schemas/ReportType" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/ReportLibrary": { "get": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "Limit", "in": "query", "description": "Limit number of responses. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Skip this many rows in the query. Used for pagination.", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortColumn", "in": "query", "description": "The name of the column to sort by.", "schema": { "type": "string" } }, { "name": "SortOrder", "in": "query", "description": "The order with which to sort the table by the sort column.", "schema": { "$ref": "#/components/schemas/SortOrder" } }, { "name": "mixDesignId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "divisionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "createdByUserId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "reportStatus", "in": "query", "schema": { "$ref": "#/components/schemas/ReportStatus" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportLibraryItemTableResults" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Commissioning/MixGroups/{divisionId}": { "get": { "tags": [ "TSS - Reports" ], "summary": "Get all mix group variations for a given division.", "parameters": [ { "name": "divisionId", "in": "path", "description": "A division's id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "description": "A plant's id (optional)", "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyIncludeReportMixGroups", "in": "query", "description": "Flag to restrict results to only mix groups that have been used in reports", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/MixGroups/{divisionId}": { "get": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "plantId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyIncludeReportMixGroups", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixGroup" } } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/DuplicateReport/{reportId}": { "post": { "tags": [ "TSS - Reports" ], "summary": "Duplicates a reviewed report.", "parameters": [ { "name": "reportId", "in": "path", "description": "The report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/DuplicateReport/{reportId}": { "post": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasicReportArgs" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Creators": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets a list of users who have created reports.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/Creators": { "get": { "tags": [ "TSS - Reports" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserArgs" } } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/CustomerLogo/{divisionId}": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets a company logo for the given division.", "description": "If no logo is found for the division, then the corporation logo is returned.\nIf the corporation logo is not found either, then it will be a 404.", "parameters": [ { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/CustomerLogo/{divisionId}": { "get": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "divisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Pdf/{reportId}": { "post": { "tags": [ "TSS - Reports" ], "summary": "Saves a report PDF, and sets the report as reviewed.", "description": "Once a pdf is uploaded, the report is marked reviewed and cannot be updated.", "parameters": [ { "name": "reportId", "in": "path", "description": "The report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "The report PDF.", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "get": { "tags": [ "TSS - Reports" ], "summary": "Downloads the PDF of a reviewed report.", "description": "", "parameters": [ { "name": "reportId", "in": "path", "description": "The ID of the report", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/Pdf/{reportId}": { "post": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "get": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/{reportId}": { "delete": { "tags": [ "TSS - Reports" ], "summary": "Deletes a report", "description": "", "parameters": [ { "name": "reportId", "in": "path", "description": "The report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/{reportId}": { "delete": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "get": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Commissioning/{reportId}": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets a commissioning report.", "description": "Regarding permissions:\n- All orca users can see reviewed reports.\n- TSS_Review users can see both reviewed reports and reports pending reviews.\n- Only users with TSS_W permissions can see draft reports.", "parameters": [ { "name": "reportId", "in": "path", "description": "The commissioning report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Commissioning": { "post": { "tags": [ "TSS - Reports" ], "summary": "Creates a new commissioning report.", "description": "The following fields are ignored:\n- commissioningReportId\n- divisionId\n- isMetric\n- lastEditedTimestamp\n- createdTimestamp\n- plantType\n- createdBy\n- lastEditedBy", "requestBody": { "description": "The commissioning reports arguments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports": { "post": { "tags": [ "TSS - Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Commissioning/{commissioningReportId}": { "put": { "tags": [ "TSS - Reports" ], "summary": "Updates a commissioning report.", "description": "The following fields are ignored:\n- divisionId\n- isMetric\n- lastEditedTimestamp\n- createdTimestamp\n- plantType\n- createdBy\n- lastEditedBy", "parameters": [ { "name": "commissioningReportId", "in": "path", "description": "Id of the commissioning report", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The arguments for the commissioning report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/CommissioningReports/{commissioningReportId}": { "put": { "tags": [ "TSS - Reports" ], "parameters": [ { "name": "commissioningReportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommissioningReportArgs" } } } } }, "deprecated": true, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Implementation/{reportId}": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets an implementation report.", "description": "Regarding permissions:\n- All orca users can see reviewed reports.\n- TSS_Review users can see both reviewed reports and reports pending reviews.\n- Only users with TSS_W permissions can see draft reports.", "parameters": [ { "name": "reportId", "in": "path", "description": "The implementation report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] }, "put": { "tags": [ "TSS - Reports" ], "summary": "Updates an implementation report.", "parameters": [ { "name": "reportId", "in": "path", "description": "The implementation report's ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The arguments for the implementation report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Implementation/MixDesignDetails": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets mix details for displaying implementation report before it's initially submitted", "parameters": [ { "name": "mixDesignIds", "in": "query", "description": "The IDs of the selected mixes", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImplementationReportMixDetails" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImplementationReportMixDetails" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImplementationReportMixDetails" } } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Implementation": { "post": { "tags": [ "TSS - Reports" ], "summary": "Creates a new implementation report.", "requestBody": { "description": "The implementation report arguments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImplementationReportArgs" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } }, "/TSS/Reports/Implementation/MixDesigns/{plantId}": { "get": { "tags": [ "TSS - Reports" ], "summary": "Gets a list of mixes that can be used for implementation reports.", "description": "Output mixes are sorted by volume.", "parameters": [ { "name": "plantId", "in": "path", "description": "The ID of the plant to get mixes for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MixDesignOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MixDesignOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MixDesignOptions" } } } } }, "security": [ { "OrcaAuth": [ "applicationId", "roles" ] }, { }, { } ] } } }, "components": { "schemas": { "AccountArgs": { "type": "object", "properties": { "myCCAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isPartner": { "type": "boolean" }, "corporationId": { "type": "integer", "format": "int32", "nullable": true }, "corporationName": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "divisionName": { "type": "string", "nullable": true }, "isMetric": { "type": "boolean" }, "startDate": { "type": "string", "format": "date" }, "parentAccountId": { "type": "integer", "format": "int32", "nullable": true }, "parentAccountName": { "type": "string", "nullable": true }, "lastActivityTimestamp": { "type": "string", "format": "date-time" }, "language": { "$ref": "#/components/schemas/Language" }, "technicalRep": { "$ref": "#/components/schemas/RepresentativeArgs" }, "salesRep": { "$ref": "#/components/schemas/RepresentativeArgs" }, "strategicAccountManager": { "$ref": "#/components/schemas/RepresentativeArgs" }, "installEquipmentRep": { "$ref": "#/components/schemas/RepresentativeArgs" }, "iconLocation": { "type": "string", "nullable": true }, "isTickerEnabled": { "type": "boolean" }, "plantCount": { "type": "integer", "format": "int32" }, "userCount": { "type": "integer", "format": "int32" }, "technologies": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasCreditsDashboard": { "type": "boolean" }, "hasOnboardingPortal": { "type": "boolean" }, "childAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ChildAccountArgs" }, "nullable": true } }, "additionalProperties": false }, "AccountArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AccountArgs" }, "nullable": true } }, "additionalProperties": false }, "AccountCreationArgs": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isPartner": { "type": "boolean" }, "corporationId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "parentAccountId": { "type": "integer", "format": "int32", "nullable": true }, "isMetric": { "type": "boolean" }, "hasCreditsDashboard": { "type": "boolean" }, "hasOnboardingPortal": { "type": "boolean" }, "startDate": { "type": "string", "format": "date" }, "language": { "$ref": "#/components/schemas/Language" }, "technicalRepId": { "type": "integer", "format": "int32", "nullable": true }, "salesRepId": { "type": "integer", "format": "int32", "nullable": true }, "strategicAccountManagerId": { "type": "integer", "format": "int32", "nullable": true }, "installEquipmentRepId": { "type": "integer", "format": "int32", "nullable": true }, "iconLocation": { "type": "string", "nullable": true }, "childAccountIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AccountDropdown": { "type": "object", "properties": { "myCCAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ActionCreationArgs": { "type": "object", "properties": { "actionTimestamp": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "actionTakenByUserId": { "type": "integer", "format": "int32", "nullable": true }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PartArgs" }, "nullable": true }, "specifiedActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "results": { "type": "array", "items": { "type": "string" }, "nullable": true }, "communicationMethod": { "$ref": "#/components/schemas/CommunicationMethod" }, "customerCommunicator": { "type": "string", "nullable": true }, "actionType": { "$ref": "#/components/schemas/ActionType" }, "staffCommunicators": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ActionItems": { "type": "object", "properties": { "batchingActions": { "type": "array", "items": { "$ref": "#/components/schemas/BatchingActionItem" }, "nullable": true }, "qcActions": { "type": "array", "items": { "$ref": "#/components/schemas/QcActionItem" }, "nullable": true }, "showSourcesAction": { "type": "boolean" } }, "additionalProperties": false }, "ActionPartArgs": { "type": "object", "properties": { "partId": { "type": "integer", "format": "int32" }, "actionReason": { "$ref": "#/components/schemas/ActionReason" }, "actionStatus": { "$ref": "#/components/schemas/ActionStatus" }, "notes": { "type": "string", "nullable": true }, "actionPartId": { "type": "integer", "format": "int32" }, "actionId": { "type": "integer", "format": "int32" }, "actionTakenByUserName": { "type": "string", "nullable": true }, "specifiedActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "partName": { "type": "string", "nullable": true }, "partNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ActionReason": { "enum": [ "Failure", "Preventative", "Spare", "Upgrade", "Historic" ], "type": "string" }, "ActionStatus": { "enum": [ "Identified", "ReplacedImprovement", "ReplacedNoChange", "Replacing", "Unused", "Unknown" ], "type": "string" }, "ActionType": { "enum": [ "RemoteTroubleshoot", "OnsiteTroubleshoot", "CustomerCommunication", "InternalCommunication", "GeneralNote" ], "type": "string" }, "AddAliasArgs": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "materialMappingId": { "type": "integer", "format": "int32" }, "aliasName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdmixtureMaterialSubType": { "enum": [ "AirEntrainer", "Retarder", "SuperPlasticizer", "WaterReducer", "HighRangeWaterReducer", "MidRangeWaterReducer", "LowRangeWaterReducer", "ViscosityModifier", "HydrationStabilizer", "CorrosionInhibitor", "ShrinkageReducer", "Accelerator", "NonChlorideAccelerator", "ChlorideAccelerator", "AntiWashout", "Waterproofer" ], "type": "string" }, "AggregateManufacturing": { "enum": [ "Manufactured", "Natural" ], "type": "string" }, "AggregateRockType": { "enum": [ "Granite", "Limestone", "Silica" ], "type": "string" }, "AggregateSize": { "enum": [ "_1", "_2", "_3", "_357", "_4", "_467", "_5", "_56", "_57", "_6", "_67", "_7", "_8", "_89" ], "type": "string" }, "Alarm": { "type": "object", "properties": { "alarmId": { "type": "integer", "format": "int64" }, "code": { "type": "integer", "format": "int32" }, "alarmCodeDetailsId": { "type": "integer", "format": "int32", "nullable": true }, "alarmCodeDetails": { "$ref": "#/components/schemas/MixerAlarmCodeDetails" }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "injectionId": { "type": "integer", "format": "int64", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "resolvedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "resolved": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AlarmArgs": { "type": "object", "properties": { "status_ALARM": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AlarmDataPoint": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "count": { "type": "number", "format": "double" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlarmSeverity": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "AssetType": { "enum": [ "File", "Folder", "ExternalLink", "Icon" ], "type": "string" }, "AssistanceRequestType": { "enum": [ "Yes", "No", "MoreInformation" ], "type": "string" }, "BasicReportArgs": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatchDataInput": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "isMetric": { "type": "boolean" }, "previousBatchTestSampleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "batchTestSamples": { "type": "array", "items": { "$ref": "#/components/schemas/BatchTestSampleInput" }, "nullable": true } }, "additionalProperties": false }, "BatchIngredientArgs": { "type": "object", "properties": { "batchIngredientId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "materialName": { "type": "string", "nullable": true }, "unit": { "$ref": "#/components/schemas/BatchUnit" }, "type": { "$ref": "#/components/schemas/MaterialType" }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "supplier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchIngredientInput": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "unit": { "$ref": "#/components/schemas/BatchIngredientUnitInput" }, "materialSource": { "type": "string", "nullable": true }, "materialName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchIngredientUnitInput": { "enum": [ "Kg", "Lb", "KgPerM3", "LbPerYd3", "L", "Ml", "Oz", "Gal", "LPerM3", "MlPerM3", "MlPerHundredWeight", "OzPerYd3", "OzPerHundredWeight", "GalPerYd3" ], "type": "string" }, "BatchPropertiesArgs": { "type": "object", "properties": { "ticketId": { "type": "string", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "isCO2Design": { "type": "string", "nullable": true }, "plant": { "type": "string", "nullable": true }, "productionDate": { "type": "string", "format": "date" }, "testCategory": { "$ref": "#/components/schemas/ConcreteTestCategory" }, "testingCompany": { "type": "string", "nullable": true }, "testingCondition": { "type": "boolean", "nullable": true }, "weatherCondition": { "type": "string", "nullable": true }, "curingConditions": { "type": "boolean", "nullable": true }, "cementReduction": { "type": "number", "format": "double", "nullable": true }, "loadSize": { "type": "number", "format": "double", "nullable": true }, "concreteTemp": { "type": "number", "format": "double", "nullable": true }, "ambientTemp": { "type": "number", "format": "double", "nullable": true }, "airContent": { "type": "number", "format": "double", "nullable": true }, "slump": { "type": "number", "format": "double", "nullable": true }, "unitWeight": { "type": "number", "format": "double", "nullable": true }, "wcRatio": { "type": "number", "format": "double", "nullable": true }, "cO2Dosage": { "type": "number", "format": "double", "nullable": true }, "cO2DosageUnit": { "$ref": "#/components/schemas/CO2DosageUnit" }, "truckNumber": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "orcaOutlierReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchSampleStrengthReading": { "type": "object", "properties": { "batchStrength": { "type": "number", "format": "double" }, "batchInterval": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatchStrengthReadingInput": { "type": "object", "properties": { "compressiveStrength": { "type": "number", "format": "double" }, "intervalDuration": { "type": "integer", "format": "int32" }, "intervalType": { "$ref": "#/components/schemas/StrengthReadingIntervalType" }, "testNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BatchTestOverviewArgs": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "mixDesignId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BatchTestOverviewArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BatchTestOverviewArgs" }, "nullable": true } }, "additionalProperties": false }, "BatchTestSampleArgs": { "type": "object", "properties": { "batchTestSampleId": { "type": "integer", "format": "int32" }, "batchProperties": { "$ref": "#/components/schemas/BatchPropertiesArgs" }, "strengthReadings": { "type": "array", "items": { "$ref": "#/components/schemas/StrengthReadingArgs" }, "nullable": true }, "batchIngredients": { "type": "array", "items": { "$ref": "#/components/schemas/BatchIngredientArgs" }, "nullable": true } }, "additionalProperties": false }, "BatchTestSampleInput": { "type": "object", "properties": { "batchTestSampleId": { "type": "integer", "format": "int32", "nullable": true }, "ticketId": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "productionDate": { "type": "string", "format": "date" }, "testCategory": { "$ref": "#/components/schemas/ConcreteTestCategory" }, "batchIngredients": { "type": "array", "items": { "$ref": "#/components/schemas/BatchIngredientInput" }, "nullable": true }, "batchStrengthReadings": { "type": "array", "items": { "$ref": "#/components/schemas/BatchStrengthReadingInput" }, "nullable": true }, "wasTestedInField": { "type": "boolean", "nullable": true }, "wasCuredInField": { "type": "boolean", "nullable": true }, "cO2Dose": { "type": "number", "format": "double", "nullable": true }, "cO2DoseAbsolute": { "type": "number", "format": "double", "nullable": true }, "airContent": { "type": "number", "format": "double", "nullable": true }, "wcRatio": { "type": "number", "format": "double", "nullable": true }, "ambientTemp": { "type": "number", "format": "double", "nullable": true }, "cementReduction": { "type": "number", "format": "double", "nullable": true }, "concreteTemp": { "type": "number", "format": "double", "nullable": true }, "loadSize": { "type": "number", "format": "double", "nullable": true }, "slump": { "type": "number", "format": "double", "nullable": true }, "unitWeight": { "type": "number", "format": "double", "nullable": true }, "parentMixCode": { "type": "string", "nullable": true }, "testingCompany": { "type": "string", "nullable": true }, "truckNumber": { "type": "string", "nullable": true }, "weatherCondition": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchTestSamplesArgs": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "isImperial": { "type": "boolean" }, "batchTestSamples": { "type": "array", "items": { "$ref": "#/components/schemas/BatchTestSampleArgs" }, "nullable": true } }, "additionalProperties": false }, "BatchUnit": { "enum": [ "Kg", "Litre", "Package" ], "type": "string" }, "BatchingActionItem": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "estimatedCredits": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BatchingDataStatus": { "enum": [ "Successful", "MissingData", "Error" ], "type": "string" }, "BatchingTable": { "type": "object", "properties": { "uploadLogId": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/BatchingDataStatus" }, "source": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "uploadTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "timeframe": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchingTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BatchingTable" }, "nullable": true } }, "additionalProperties": false }, "ByBatchTestSampleIdsArgs": { "type": "object", "properties": { "batchTestSampleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "CO2DosageUnit": { "enum": [ "Litre", "PercentOfCement" ], "type": "string" }, "CO2DosageUnitAdjusted": { "enum": [ "LitrePerM3", "PercentOfCement" ], "type": "string" }, "CO2ReadingResponse": { "type": "object", "properties": { "reclaimedWaterCO2ReadingId": { "type": "integer", "format": "int32" }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "pT_101": { "type": "number", "format": "float", "nullable": true }, "pT_201": { "type": "number", "format": "float", "nullable": true }, "pT_202": { "type": "number", "format": "float", "nullable": true }, "tT_101": { "type": "number", "format": "float", "nullable": true }, "dT_101": { "type": "number", "format": "float", "nullable": true }, "iT_101": { "type": "number", "format": "float", "nullable": true }, "cO2_Flowrate": { "type": "number", "format": "float", "nullable": true }, "cO2_Temp": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "CO2Readings": { "type": "object", "properties": { "datetime": { "type": "string", "format": "date-time" }, "pT_101": { "type": "number", "format": "float" }, "pT_201": { "type": "number", "format": "float" }, "pT_202": { "type": "number", "format": "float" }, "tT_101": { "type": "number", "format": "float" }, "cO2_Flowrate": { "type": "number", "format": "float" }, "cO2_Temp": { "type": "number", "format": "float" }, "dT_101": { "type": "number", "format": "float" }, "iT_101": { "type": "number", "format": "float" } }, "additionalProperties": false }, "CO2Status": { "enum": [ "CO2Mixes", "NonCO2Mixes", "AllMixes" ], "type": "string" }, "CO2SupplierMapPoint": { "type": "object", "properties": { "cO2SupplierId": { "type": "integer", "format": "int32" }, "companyName": { "type": "string", "nullable": true }, "depotName": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "monthlyTankRentalFeeUsd": { "type": "number", "format": "double", "nullable": true }, "deliveryFeeUsd": { "type": "number", "format": "double", "nullable": true }, "cO2PriceUsdPerKg": { "type": "number", "format": "double", "nullable": true }, "tankLeadTimeWeeks": { "type": "number", "format": "double", "nullable": true }, "customerServiceRating": { "type": "number", "format": "double", "nullable": true }, "contact": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CementArgs": { "type": "object", "properties": { "cementId": { "type": "integer", "format": "int32" }, "cementType": { "$ref": "#/components/schemas/MaterialType" }, "name": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double", "nullable": true }, "labResult": { "$ref": "#/components/schemas/LabResult" } }, "additionalProperties": false }, "CementComponent": { "type": "object", "properties": { "materialId": { "type": "integer", "format": "int32", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cementType": { "$ref": "#/components/schemas/CementType" }, "cementPlantName": { "type": "string", "nullable": true }, "cementPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CementComposition": { "type": "object", "properties": { "effectiveDate": { "type": "string", "format": "date" }, "cementComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CementComponent" }, "nullable": true } }, "additionalProperties": false }, "CementPlant": { "required": [ "city", "country" ], "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "state": { "type": "string", "nullable": true }, "country": { "minLength": 1, "type": "string" }, "longitude": { "type": "number", "format": "double", "readOnly": true }, "latitude": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "CementPlantArgs": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CementPlantMapPoint": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "cements": { "type": "array", "items": { "$ref": "#/components/schemas/CementArgs" }, "nullable": true } }, "additionalProperties": false }, "CementPlantName": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CementSalesOverview": { "type": "object", "properties": { "cementId": { "type": "integer", "format": "int32" }, "cementPlantName": { "type": "string", "nullable": true }, "cementType": { "$ref": "#/components/schemas/MaterialType" }, "cementName": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CementSource": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "cementType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CementSupplierArgs": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CementType": { "enum": [ "CementTypeI", "CementTypeIS", "CementTypeIP", "CementTypeIL", "CementTypeII", "CementTypeI_II", "CementTypeI_IIMH", "CementTypeI_II_LA", "CementTypeIII", "CementTypeIV", "CementTypeII_V", "CementTypeN", "CementTypeS", "CementCemI", "CementCemII", "CementCemIII", "CementCemIV", "CementCemV", "CementCemVI", "CementBlendedHydraulic" ], "type": "string" }, "CementTypeArgs": { "type": "object", "properties": { "cementType": { "$ref": "#/components/schemas/CementType" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangePasswordLoggedInArgs": { "type": "object", "properties": { "currentPassword": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangePasswordLoggedOutArgs": { "type": "object", "properties": { "changePasswordId": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChildAccountArgs": { "type": "object", "properties": { "myCCAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "plantCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ClientAccountUpdateArgs": { "type": "object", "properties": { "isMetric": { "type": "boolean" }, "iconLocation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientStatus": { "enum": [ "CurrentClient", "PotentialClient", "FormerClient", "TestClient" ], "type": "string" }, "Co2VendorTable": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "depotCount": { "type": "integer", "format": "int32" }, "avgCO2PriceUsdPerKg": { "type": "number", "format": "double", "nullable": true }, "tankLeadTimeWeeks": { "type": "number", "format": "double", "nullable": true }, "customerServiceRating": { "type": "number", "format": "double", "nullable": true }, "contact": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Co2VendorTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Co2VendorTable" }, "nullable": true } }, "additionalProperties": false }, "CommissioningMixDesignArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "isCO2Design": { "type": "boolean" }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthDays": { "type": "integer", "format": "int32", "nullable": true }, "originalWaterCementRatio": { "type": "number", "format": "double", "nullable": true }, "originalAirContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "originalAirContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "originalYieldUnitless": { "type": "number", "format": "double", "nullable": true }, "optimizedWaterCementRatio": { "type": "number", "format": "double", "nullable": true }, "optimizedAirContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "optimizedAirContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "optimizedYieldUnitless": { "type": "number", "format": "double", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignIngredientArgs" }, "nullable": true }, "testDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningTestDetailArgs" }, "nullable": true } }, "additionalProperties": false }, "CommissioningMixProperties": { "type": "object", "properties": { "includeDesignStrength": { "type": "boolean" }, "includeWaterCementRatio": { "type": "boolean" }, "includeAirContentRange": { "type": "boolean" }, "includeSlump": { "type": "boolean" }, "includeScmPercent": { "type": "boolean" }, "includeCementType": { "type": "boolean" }, "includeScmTypes": { "type": "boolean" }, "includeCementContent": { "type": "boolean" } }, "additionalProperties": false }, "CommissioningMixSettings": { "type": "object", "properties": { "showOutliers": { "type": "boolean" }, "showOutlierReason": { "type": "boolean" }, "showDifference": { "type": "boolean" }, "propertiesToInclude": { "$ref": "#/components/schemas/CommissioningMixProperties" }, "frequencyGraphSettings": { "$ref": "#/components/schemas/ReportFrequencyGraphSettings" }, "avgStrengthGraphSettings": { "$ref": "#/components/schemas/ReportAvgStrengthGraphSettings" } }, "additionalProperties": false }, "CommissioningReportArgs": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32" }, "isMetric": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ReportStatus" }, "createdTimestamp": { "type": "string", "format": "date-time" }, "lastEditedTimestamp": { "type": "string", "format": "date-time" }, "plantType": { "$ref": "#/components/schemas/PlantType" }, "createdBy": { "type": "string", "nullable": true }, "createdByUserId": { "type": "integer", "format": "int32" }, "createdByUserEmail": { "type": "string", "nullable": true }, "lastEditedBy": { "type": "string", "nullable": true }, "lastEditedByUserId": { "type": "integer", "format": "int32" }, "lastEditedByUserEmail": { "type": "string", "nullable": true }, "reviewedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "commissioningReportId": { "type": "integer", "format": "int32", "deprecated": true }, "testingStage": { "$ref": "#/components/schemas/CommissioningTestingStage" }, "testingSummary": { "type": "string", "nullable": true }, "conclusionParagraph": { "type": "string", "nullable": true }, "mixSelection": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportMixArgs" }, "nullable": true } }, "additionalProperties": false }, "CommissioningReportMixArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "testResultProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CommissioningReportTestResultProperty" }, "nullable": true }, "selectedStrengthHours": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "selectedStrengthStDevHours": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "baselineVariation": { "$ref": "#/components/schemas/ReportMixVariation" }, "carbonCureVariation": { "$ref": "#/components/schemas/ReportMixVariation" }, "settings": { "$ref": "#/components/schemas/CommissioningMixSettings" } }, "additionalProperties": false }, "CommissioningReportMixGroup": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "baselineCO2Dosage": { "type": "number", "format": "double", "nullable": true }, "baselineCementReductionPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CommissioningReportTestResultProperty": { "enum": [ "AverageSlump", "UnitWeight", "AverageAir", "ConcreteTemperature", "CementEfficiency", "CO2Dose", "AirStandardDeviation", "SlumpStandardDeviation", "AvgCementLoading", "SampleCount", "ScmLoading" ], "type": "string" }, "CommissioningTestDetailArgs": { "type": "object", "properties": { "intervalDays": { "type": "integer", "format": "int32" }, "cO2DosagePercent": { "type": "number", "format": "double" }, "cementReductionPercent": { "type": "number", "format": "double" }, "averageStrengthMPa": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CommissioningTestingStage": { "enum": [ "TestingComplete", "NeedsMoreTesting" ], "type": "string" }, "CommunicationMethod": { "enum": [ "PhoneCall", "Email", "InPerson", "Text" ], "type": "string" }, "ConcreteTestCategory": { "enum": [ "HistoricalData", "FieldData", "CommissioningTrial", "ThreePointCurves", "CarbonCureResearch", "ExternalLab", "Regulatory" ], "type": "string" }, "ConstructionProject": { "required": [ "externalConstructionProjectId" ], "type": "object", "properties": { "constructionProjectId": { "type": "integer", "format": "int32" }, "organization": { "type": "string", "nullable": true }, "targetStartDate": { "type": "string", "format": "date", "nullable": true }, "targetEndDate": { "type": "string", "format": "date", "nullable": true }, "description": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "double", "readOnly": true }, "latitude": { "type": "number", "format": "double", "readOnly": true }, "projectType": { "type": "string", "nullable": true }, "isCcSpecified": { "type": "boolean", "readOnly": true }, "areaM2": { "type": "number", "format": "double", "nullable": true }, "monetaryValue": { "type": "number", "format": "double", "nullable": true }, "currencyCode": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "externalConstructionProjectId": { "minLength": 1, "type": "string" }, "externalOwnerId": { "type": "string", "nullable": true }, "ownerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Corporation": { "required": [ "name" ], "type": "object", "properties": { "corporationId": { "type": "integer", "format": "int32" }, "name": { "minLength": 1, "type": "string" }, "sfAccountId": { "type": "string", "nullable": true }, "creationTimestamp": { "type": "string", "format": "date-time" }, "clientStatus": { "$ref": "#/components/schemas/ClientStatus" }, "currency": { "type": "string", "nullable": true }, "isVerticallyIntegrated": { "type": "boolean" }, "greyWaterRecyclingSolution": { "$ref": "#/components/schemas/GreyWaterRecyclingSolution" }, "mixFamiliesAtCorpLevel": { "type": "boolean" }, "churnDate": { "type": "string", "format": "date", "nullable": true }, "creditExclusionReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CorporationDropdown": { "type": "object", "properties": { "corporationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CorporationName": { "type": "object", "properties": { "corporationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CorporationSalesOverview": { "type": "object", "properties": { "corporationId": { "type": "integer", "format": "int32" }, "plantCount": { "type": "integer", "format": "int32" }, "corporationName": { "type": "string", "nullable": true }, "divisions": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionSalesOverview" }, "nullable": true }, "isVerticallyIntegrated": { "type": "boolean" } }, "additionalProperties": false }, "CounterResponse": { "type": "object", "properties": { "all": { "$ref": "#/components/schemas/CounterResponseEntry" }, "sinceYearAgo": { "$ref": "#/components/schemas/CounterResponseEntry" } }, "additionalProperties": false }, "CounterResponseEntry": { "type": "object", "properties": { "cO2AvoidedTonnes": { "type": "number", "format": "double" }, "ticketCount": { "type": "integer", "format": "int32" }, "creditRevenueSharedUsd": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreditBreakdown": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "totalCredits": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CreditSaleRow": { "type": "object", "properties": { "saleId": { "type": "integer", "format": "int32" }, "buyer": { "type": "string", "nullable": true }, "dateOfSale": { "type": "string", "format": "date", "nullable": true }, "corporationId": { "type": "integer", "format": "int32" }, "corporationName": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "divisionName": { "type": "string", "nullable": true }, "numberOfCredits": { "type": "integer", "format": "int32" }, "pricePerCreditUsd": { "type": "number", "format": "double", "nullable": true }, "totalSaleValueUsd": { "type": "number", "format": "double", "nullable": true }, "netValueUsd": { "type": "number", "format": "double", "nullable": true }, "applicableCostPoolUsd": { "type": "number", "format": "double", "nullable": true }, "applicableRevenueSharePercent": { "type": "number", "format": "double", "nullable": true }, "prepaymentsUsd": { "type": "number", "format": "double", "nullable": true }, "paymentDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "CreditSalesTable": { "type": "object", "properties": { "creditTransactionId": { "type": "integer", "format": "int32" }, "creditAmount": { "type": "integer", "format": "int32" }, "hasDetailsAvailable": { "type": "boolean" }, "date": { "type": "string", "format": "date" } }, "additionalProperties": false }, "CreditSalesTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CreditSalesTable" }, "nullable": true } }, "additionalProperties": false }, "CreditSummary": { "type": "object", "properties": { "creditsToValidate": { "type": "number", "format": "double" }, "validatedCredits": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreditTable": { "type": "object", "properties": { "creditId": { "type": "integer", "format": "int32" }, "creditUniqueId": { "type": "string", "nullable": true }, "creationTimestamp": { "type": "string", "format": "date-time" }, "soldTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "isSold": { "type": "boolean" } }, "additionalProperties": false }, "CreditTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CreditTable" }, "nullable": true } }, "additionalProperties": false }, "CreditUpdate": { "type": "object", "properties": { "validatedCredits": { "type": "integer", "format": "int32" }, "soldCredits": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CurrentPlantComposition": { "type": "object", "properties": { "effectiveDate": { "type": "string", "format": "date" }, "cementComponents": { "type": "array", "items": { "$ref": "#/components/schemas/CementComponent" }, "nullable": true }, "plantId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerContact": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "lastUsedTimestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CustomerCounterResponse": { "type": "object", "properties": { "totalConcreteM3": { "type": "number", "format": "double", "nullable": true }, "cO2AvoidedTonnes": { "type": "number", "format": "double", "nullable": true }, "ticketCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CustomerCounterTimerange": { "enum": [ "AllTime", "LastYear" ], "type": "string" }, "CustomerFeedbackRow": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "quarterDate": { "type": "string", "format": "date" }, "quarterStr": { "type": "string", "nullable": true }, "churnScore": { "type": "number", "format": "double", "nullable": true }, "concerns": { "type": "string", "nullable": true }, "meetingCadence": { "type": "string", "nullable": true }, "sentiments": { "type": "string", "nullable": true }, "lastUpdatedDate": { "type": "string", "format": "date", "nullable": true }, "lastUpdater": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerProject": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "lon": { "type": "number", "format": "double" }, "lat": { "type": "number", "format": "double" }, "volumeM3": { "type": "number", "format": "double", "nullable": true }, "startDate": { "type": "string", "format": "date" }, "isOngoing": { "type": "boolean" } }, "additionalProperties": false }, "DailySummary": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "injectionCount": { "type": "integer", "format": "int32" }, "truckloadCount": { "type": "integer", "format": "int32" }, "totalConcreteM3": { "type": "number", "format": "double" }, "injectedCO2Kg": { "type": "number", "format": "double" }, "cementAvoidedTonnes": { "type": "number", "format": "double" }, "avoidedCO2Tonnes": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DataIntegrationType": { "enum": [ "Customer", "Lynx", "Connex", "WebCrete", "Marcotte", "Jonel", "CustomIntegration" ], "type": "string" }, "DataType": { "enum": [ "Enum", "Numeric", "Object", "String", "StringArray" ], "type": "string" }, "Division": { "required": [ "name" ], "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "name": { "minLength": 1, "type": "string" }, "corporationId": { "type": "integer", "format": "int32" }, "sfAccountId": { "type": "string", "nullable": true }, "sfCustomerSuccessId": { "type": "string", "nullable": true }, "creationTimestamp": { "type": "string", "format": "date-time" }, "isImperial": { "type": "boolean" }, "isRequiredStrengthRisky": { "type": "boolean" }, "inCommissioning": { "type": "boolean" }, "efTCO2EqPerTClinker": { "type": "number", "format": "double", "nullable": true }, "clinkerToCementRatio": { "type": "number", "format": "double", "nullable": true }, "stage": { "type": "string", "nullable": true }, "churnRiskReason": { "type": "string", "nullable": true }, "operationallyChurnedDate": { "type": "string", "format": "date", "nullable": true }, "tier": { "type": "string", "nullable": true }, "arContactEmail": { "type": "string", "nullable": true }, "tssRepId": { "type": "integer", "format": "int32", "nullable": true }, "tssRep": { "$ref": "#/components/schemas/StaffUser" }, "tpmRepId": { "type": "integer", "format": "int32", "nullable": true }, "tpmRep": { "$ref": "#/components/schemas/StaffUser" }, "amRepId": { "type": "integer", "format": "int32", "nullable": true }, "amRep": { "$ref": "#/components/schemas/StaffUser" }, "hardwareRepId": { "type": "integer", "format": "int32", "nullable": true }, "hardwareRep": { "$ref": "#/components/schemas/StaffUser" }, "website": { "type": "string", "nullable": true }, "customerSuccessName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DivisionCountry": { "type": "object", "properties": { "country": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "latitude": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Returns a list of countries grouped by division, where the division operates a plant in those countries." }, "DivisionDropdown": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "corporationId": { "type": "integer", "format": "int32" }, "isImperial": { "type": "boolean" } }, "additionalProperties": false }, "DivisionName": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DivisionNameAndUnits": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "corporationId": { "type": "integer", "format": "int32" }, "corporationName": { "type": "string", "nullable": true }, "isImperial": { "type": "boolean" } }, "additionalProperties": false }, "DivisionOverviewArgs": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "tssRep": { "type": "string", "nullable": true }, "divisionName": { "type": "string", "nullable": true }, "numMixDesigns": { "type": "integer", "format": "int32" }, "numControlDesigns": { "type": "integer", "format": "int32" }, "numCO2Designs": { "type": "integer", "format": "int32" }, "mostRecentInstall": { "type": "string", "format": "date-time", "nullable": true }, "avgVolumePerPlantLastMonthM3": { "type": "number", "format": "double" }, "priority": { "type": "integer", "format": "int32" }, "inCommissioning": { "type": "boolean" }, "designsOver15Samples": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DivisionSalesOverview": { "type": "object", "properties": { "divisionName": { "type": "string", "nullable": true }, "plants": { "type": "array", "items": { "$ref": "#/components/schemas/PlantSalesOverview" }, "nullable": true }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionState" }, "nullable": true }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionCountry" }, "nullable": true } }, "additionalProperties": false }, "DivisionState": { "type": "object", "properties": { "state": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "latitude": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Returns a list of states grouped by division, where the division operates a plant in those states." }, "DorsalDataPoint": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "DorsalGraphs": { "type": "object", "properties": { "intervalSeconds": { "type": "integer", "format": "int64" }, "injectedCO2Kg": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "inletLiquidPressurePsi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "downstreamPressure0Psi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "downstreamPressure1Psi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "downstreamPressure2Psi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "upstreamPressurePsi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "inletGasPressurePsi": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "flowRateKgPerSec": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "temperatureC": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalDataPoint" }, "nullable": true }, "alarms": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmDataPoint" }, "nullable": true } }, "additionalProperties": false }, "DorsalSystemConnectivity": { "type": "object", "properties": { "airlinkConnectivity": { "$ref": "#/components/schemas/IpConnectivity" }, "hmiConnectivity": { "$ref": "#/components/schemas/IpConnectivity" }, "plcConnectivity": { "$ref": "#/components/schemas/IpConnectivity" } }, "additionalProperties": false }, "DorsalSystemInfoArgs": { "type": "object", "properties": { "system": { "$ref": "#/components/schemas/SystemInfoArgs" }, "suggestedStartTime": { "type": "string", "format": "date-time", "nullable": true }, "suggestedEndTime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DorsalTable": { "type": "object", "properties": { "fromTime": { "type": "string", "format": "date-time", "nullable": true }, "fromTable": { "$ref": "#/components/schemas/TableRanking" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DorsalTableRow" }, "nullable": true } }, "additionalProperties": false }, "DorsalTableRow": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "inletLiquidPressurePsi": { "type": "number", "format": "double", "nullable": true }, "inletGasPressurePsi": { "type": "number", "format": "double", "nullable": true }, "upstreamTemperatureC": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure0Psi": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure1Psi": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure2Psi": { "type": "number", "format": "double", "nullable": true }, "upstreamPressurePsi": { "type": "number", "format": "double", "nullable": true }, "flowRateKgPerSec": { "type": "number", "format": "double", "nullable": true }, "injectedCO2Kg": { "type": "number", "format": "double", "nullable": true }, "mixTimeSeconds": { "type": "integer", "format": "int32", "nullable": true }, "alarmCode": { "type": "integer", "format": "int32", "nullable": true }, "alarmMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "E2EDataIntegrationType": { "enum": [ "FileUpload", "ApiIntegration", "NoData" ], "type": "string" }, "E2EProjectMixArgs": { "type": "object", "properties": { "mixCode": { "type": "string", "nullable": true }, "qcScenario": { "$ref": "#/components/schemas/QcDataScenario" }, "isUserCreated": { "type": "boolean" }, "compressiveStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "hasBaseline": { "type": "boolean" }, "isBaselinePaired": { "type": "boolean" } }, "additionalProperties": false }, "EchoCementTable": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "cementPlantName": { "type": "string", "nullable": true }, "supplier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "cementType": { "$ref": "#/components/schemas/MaterialType" }, "cementName": { "type": "string", "nullable": true }, "cementId": { "type": "integer", "format": "int32" }, "averageCementReductionPercent": { "type": "number", "format": "double", "nullable": true }, "averageCO2DosageLitresPerM3": { "type": "number", "format": "double", "nullable": true }, "dateTested": { "type": "string", "format": "date", "nullable": true }, "testSamples": { "type": "array", "items": { "$ref": "#/components/schemas/EchoCementTestSample" }, "nullable": true } }, "additionalProperties": false }, "EchoCementTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EchoCementTable" }, "nullable": true } }, "additionalProperties": false }, "EchoCementTestSample": { "type": "object", "properties": { "cementReductionPercent": { "type": "number", "format": "double", "nullable": true }, "cO2DosageLitresPerM3": { "type": "number", "format": "double", "nullable": true }, "designStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "cementLoadingKgPerM3": { "type": "number", "format": "double", "nullable": true }, "slumpMm": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "scmTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" }, "nullable": true }, "scmPercentage": { "type": "number", "format": "double", "nullable": true }, "testDate": { "type": "string", "format": "date", "nullable": true }, "result": { "$ref": "#/components/schemas/LabResult" } }, "additionalProperties": false }, "EditablePlantsFilterOptions": { "type": "object", "properties": { "divisions": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionName" }, "nullable": true }, "cementPlants": { "type": "array", "items": { "$ref": "#/components/schemas/CementPlantName" }, "nullable": true }, "tseList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "plantStates": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EditablePlantsFilterSettings": { "type": "object", "properties": { "divisionIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tseList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cementTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" }, "nullable": true }, "missingColumns": { "$ref": "#/components/schemas/MissingDataColumnName" }, "onlyPlantsWithInstalls": { "type": "boolean" } }, "additionalProperties": false }, "EditablePlantsTableFilterArgs": { "type": "object", "properties": { "tableArgs": { "$ref": "#/components/schemas/TableArgs" }, "filterSettings": { "$ref": "#/components/schemas/EditablePlantsFilterSettings" } }, "additionalProperties": false }, "EmailFrequency": { "enum": [ "Daily", "Weekly", "Biweekly", "OnResolution" ], "type": "string" }, "EnumValue": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EstimateArgs": { "type": "object", "properties": { "myCCEstimateId": { "type": "integer", "format": "int32", "nullable": true }, "company": { "type": "string", "nullable": true }, "creator": { "type": "string", "nullable": true }, "reportID": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "projectName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "isMetric": { "type": "boolean", "nullable": true }, "concreteVolume": { "type": "array", "items": { }, "nullable": true }, "mixes": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateMixOuterArgs" }, "nullable": true } }, "additionalProperties": false }, "EstimateArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateArgs" }, "nullable": true } }, "additionalProperties": false }, "EstimateMixInnerArgs": { "type": "object", "properties": { "mixID": { "type": "string", "nullable": true }, "mixName": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "designStrength": { "type": "array", "items": { }, "nullable": true }, "portlandQuantity": { "$ref": "#/components/schemas/EstimateQuantityArgs" }, "slagQuantity": { "$ref": "#/components/schemas/EstimateQuantityArgs" }, "flyAshQuantity": { "$ref": "#/components/schemas/EstimateQuantityArgs" } }, "additionalProperties": false }, "EstimateMixOuterArgs": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "quantity": { "type": "array", "items": { }, "nullable": true }, "mixDesign": { "$ref": "#/components/schemas/EstimateMixInnerArgs" } }, "additionalProperties": false }, "EstimateQuantityArgs": { "type": "object", "properties": { "before": { "type": "array", "items": { }, "nullable": true }, "after": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "FeatureFlagArgs": { "type": "object", "properties": { "featureFlagId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true }, "myCCAccountIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "FiberManufacturing": { "enum": [ "Natural", "Synthetic", "Steel", "Glass" ], "type": "string" }, "FiberSize": { "enum": [ "Micro", "Macro" ], "type": "string" }, "FollowUpArgs": { "type": "object", "properties": { "serviceCaseFollowUpId": { "type": "integer", "format": "int32" }, "serviceCaseId": { "type": "integer", "format": "int32" }, "assignedUserId": { "type": "integer", "format": "int32" }, "assignedUserName": { "type": "string", "nullable": true }, "lastUpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "lastUpdatedByUserName": { "type": "string", "nullable": true }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "scheduledForTimestamp": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/FollowUpStatus" }, "followUpType": { "$ref": "#/components/schemas/FollowUpType" }, "comments": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FollowUpCreationArgs": { "type": "object", "properties": { "assignedUserId": { "type": "integer", "format": "int32" }, "scheduledForTimestamp": { "type": "string", "format": "date-time" }, "followUpType": { "$ref": "#/components/schemas/FollowUpType" }, "status": { "$ref": "#/components/schemas/FollowUpStatus" }, "comments": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FollowUpStatus": { "enum": [ "Scheduled", "AwaitingInternalResponse", "AwaitingExternalResponse", "Completed", "Canceled" ], "type": "string" }, "FollowUpType": { "enum": [ "Meeting", "Call" ], "type": "string" }, "GreyWaterRecyclingSolution": { "enum": [ "Pit", "Pond", "AgitatedTank", "ValidatedNone" ], "type": "string" }, "HardwareType": { "enum": [ "Plc", "ReclaimedWater" ], "type": "string" }, "HistoryItem": { "type": "object", "properties": { "actionTimestamp": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "actionTakenByUserId": { "type": "integer", "format": "int32", "nullable": true }, "parts": { "type": "array", "items": { "$ref": "#/components/schemas/PartArgs" }, "nullable": true }, "specifiedActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "results": { "type": "array", "items": { "type": "string" }, "nullable": true }, "communicationMethod": { "$ref": "#/components/schemas/CommunicationMethod" }, "customerCommunicator": { "type": "string", "nullable": true }, "actionType": { "type": "string", "nullable": true }, "staffCommunicators": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serviceCaseActionId": { "type": "integer", "format": "int32", "nullable": true }, "actionTakenByUserName": { "type": "string", "nullable": true }, "creationTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedByUserName": { "type": "string", "nullable": true }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "partNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "HmiDataTransferAlarmCode": { "enum": [ "AlarmFileCorrupted", "AlarmFileInvalidHeader", "AlarmFileFormatMismatch", "AlarmFileInvalidData", "AlarmFileHmiIdMismatch", "AlarmFileHmiIdMissing", "InjectionFileCorrupted", "InjectionFileInvalidHeader", "InjectionFileFormatMismatch", "InjectionFileInvalidData", "InjectionFileHmiIdMismatch", "InjectionFileHmiIdMissing", "InletPressureFileInvalidHeader", "InletPressureFileCorrupted", "InletPressureFileFormatMismatch", "InletPressureFileInvalidData", "InletPressureFileMissingTimestamp", "InletPressureFileHmiIdMismatch", "InletPressureFileHmiIdMissing", "MixerManifoldFileCorrupted", "MixerManifoldFileInvalidHeader", "MixerManifoldFileFormatMismatch", "MixerManifoldFileInvalidData", "MixerManifoldFileHmiIdMismatch", "MixerManifoldFileHmiIdMissing" ], "type": "string" }, "HmiDataTransferAlarmPayload": { "type": "object", "properties": { "hmiId": { "type": "integer", "format": "int32" }, "errorCode": { "$ref": "#/components/schemas/HmiDataTransferAlarmCode" } }, "additionalProperties": false }, "HmiIssuedError": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "HmiIssuedErrorPayload": { "type": "object", "properties": { "hmiId": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/HmiIssuedError" }, "nullable": true } }, "additionalProperties": false }, "ImageUploadArgs": { "type": "object", "properties": { "imageId": { "type": "integer", "format": "int32" }, "myCCAccountId": { "type": "integer", "format": "int32" }, "remoteUnitId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "fileExtension": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImplementationReportArgs": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32" }, "isMetric": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ReportStatus" }, "createdTimestamp": { "type": "string", "format": "date-time" }, "lastEditedTimestamp": { "type": "string", "format": "date-time" }, "plantType": { "$ref": "#/components/schemas/PlantType" }, "createdBy": { "type": "string", "nullable": true }, "createdByUserId": { "type": "integer", "format": "int32" }, "createdByUserEmail": { "type": "string", "nullable": true }, "lastEditedBy": { "type": "string", "nullable": true }, "lastEditedByUserId": { "type": "integer", "format": "int32" }, "lastEditedByUserEmail": { "type": "string", "nullable": true }, "reviewedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "technician": { "type": "string", "nullable": true }, "technicianId": { "type": "integer", "format": "int32" }, "technicianEmail": { "type": "string", "nullable": true }, "createdByUserPhoneNumber": { "type": "string", "nullable": true }, "createdByUserJobTitle": { "type": "string", "nullable": true }, "lastEditedByUserPhoneNumber": { "type": "string", "nullable": true }, "lastEditedByUserJobTitle": { "type": "string", "nullable": true }, "additionalPersonnel": { "type": "string", "nullable": true }, "additionalPersonnelId": { "type": "integer", "format": "int32", "nullable": true }, "additionalPersonnelEmail": { "type": "string", "nullable": true }, "onsiteStatus": { "$ref": "#/components/schemas/OnsiteStatus" }, "onsiteDates": { "type": "array", "items": { "type": "string", "format": "date" }, "nullable": true }, "onsiteMonth": { "type": "string", "format": "date", "nullable": true }, "onsiteMonthPart": { "$ref": "#/components/schemas/MonthPart" }, "samplesRequired": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string", "nullable": true }, "sampleRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/SampleRequirementArgs" }, "nullable": true }, "mixSelection": { "type": "array", "items": { "$ref": "#/components/schemas/ImplementationReportMixArgs" }, "nullable": true } }, "additionalProperties": false }, "ImplementationReportMixArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "designStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "strengthIntervalDays": { "type": "integer", "format": "int32", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "fineAggWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "cementWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "scmWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "totalWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "cementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scmTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "materialNames": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialNameArgs" }, "nullable": true }, "cementCut": { "type": "number", "format": "double" }, "cO2Dosage": { "type": "number", "format": "double" }, "waterCementRatioOverride": { "type": "number", "format": "double", "nullable": true }, "fineAggContentOverride": { "type": "number", "format": "double", "nullable": true }, "cementContentOverride": { "type": "number", "format": "double", "nullable": true }, "scmContentOverride": { "type": "number", "format": "double", "nullable": true }, "includeTotalWeight": { "type": "boolean" }, "includeWaterCementRatio": { "type": "boolean" }, "includeFineAggContent": { "type": "boolean" }, "includeSlump": { "type": "boolean" }, "includeCementType": { "type": "boolean" }, "includeCementContent": { "type": "boolean" }, "includeScmTypes": { "type": "boolean" }, "includeScmContent": { "type": "boolean" } }, "additionalProperties": false }, "ImplementationReportMixDetails": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "designStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "strengthIntervalDays": { "type": "integer", "format": "int32", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "fineAggWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "cementWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "scmWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "totalWeightKgPerM3": { "type": "number", "format": "double", "nullable": true }, "cementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scmTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "materialNames": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialNameArgs" }, "nullable": true } }, "additionalProperties": false, "description": "The part of the ImplementationReportMixArgs that's defined by the mix and not by the user" }, "IndicationSource": { "enum": [ "Quicksight", "Sonar", "Colleague", "CustomerEmail", "CustomerText", "CustomerPhone", "SystemTelemetry", "Onsite" ], "type": "string" }, "InflowOutflowDeviceReadings": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "pump_Code": { "type": "integer", "format": "int32" }, "pump_Runtime": { "type": "number", "format": "double" }, "pump_Volume": { "type": "number", "format": "double" } }, "additionalProperties": false }, "IngredientArgs": { "type": "object", "properties": { "quantity": { "type": "number", "format": "double" }, "materialName": { "type": "string", "nullable": true }, "unit": { "$ref": "#/components/schemas/MixUnit" }, "type": { "$ref": "#/components/schemas/MaterialType" }, "specificGravity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Injection": { "type": "object", "properties": { "injectionId": { "type": "integer", "format": "int64" }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "createdTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "ambientTemperature": { "type": "number", "format": "float", "nullable": true }, "readings": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionReading" }, "nullable": true }, "alarms": { "type": "array", "items": { "$ref": "#/components/schemas/Alarm" }, "nullable": true }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "injectedCO2Kg": { "type": "number", "format": "float", "nullable": true }, "isReconstructed": { "type": "boolean" } }, "additionalProperties": false }, "InjectionBody": { "type": "object", "properties": { "hmiId": { "type": "integer", "format": "int32" }, "injections": { "type": "array", "items": { "$ref": "#/components/schemas/MixerInjection" }, "nullable": true } }, "additionalProperties": false }, "InjectionReading": { "type": "object", "properties": { "injectionReadingId": { "type": "integer", "format": "int64" }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "injectionId": { "type": "integer", "format": "int64", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "createdTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "inletLiquidPressureKPa": { "type": "number", "format": "float", "nullable": true }, "inletGasPressureKPa": { "type": "number", "format": "float", "nullable": true }, "upstreamPressureKPa": { "type": "number", "format": "float", "nullable": true }, "downstreamPressure0KPa": { "type": "number", "format": "float", "nullable": true }, "downstreamPressure1KPa": { "type": "number", "format": "float", "nullable": true }, "downstreamPressure2KPa": { "type": "number", "format": "float", "nullable": true }, "upstreamTemperatureC": { "type": "number", "format": "float", "nullable": true }, "flowRateKgPerSec": { "type": "number", "format": "float", "nullable": true }, "injectedCO2Kg": { "type": "number", "format": "float" }, "liquidValveOpen": { "type": "boolean", "nullable": true }, "gasValveOpen": { "type": "boolean", "nullable": true }, "equation1": { "type": "boolean", "nullable": true }, "equation2": { "type": "boolean", "nullable": true }, "equation3": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "InjectionReadingBody": { "type": "object", "properties": { "hmiId": { "type": "integer", "format": "int32" }, "injectionReadings": { "type": "array", "items": { "$ref": "#/components/schemas/MixerInjectionReading" }, "nullable": true } }, "additionalProperties": false }, "InjectionReadingTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InjectionReading" }, "nullable": true } }, "additionalProperties": false }, "InjectionTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Injection" }, "nullable": true } }, "additionalProperties": false }, "InternalTeamArgs": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "designation": { "$ref": "#/components/schemas/InternalTeamDesignation" } }, "additionalProperties": false }, "InternalTeamArgsShort": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InternalTeamDesignation": { "enum": [ "Hardware", "AccountManager", "Tss", "Tpm" ], "type": "string" }, "InternalTimeSpent": { "enum": [ "LessThan1Hour", "Between1And3Hours", "Between3And12Hours", "Between1And5Days", "MoreThan1Week" ], "type": "string" }, "IpConnectivity": { "type": "object", "properties": { "isAccessible": { "type": "boolean" }, "statusValidSince": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "KrillColumn": { "type": "object", "properties": { "columnId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/KrillType" }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "minValue": { "type": "number", "format": "double", "nullable": true }, "maxValue": { "type": "number", "format": "double", "nullable": true }, "isInclusive": { "type": "boolean" }, "units": { "$ref": "#/components/schemas/UnitSystem" }, "isHidden": { "type": "boolean" }, "isLocked": { "type": "boolean", "description": "Locked columns may not be edited in the frontend." }, "isRequired": { "type": "boolean" }, "disableColumnFilter": { "type": "boolean" } }, "additionalProperties": false }, "KrillConfig": { "type": "object", "properties": { "tabId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "permission": { "type": "string", "nullable": true }, "getEndpoint": { "type": "string", "nullable": true }, "postEndpoint": { "type": "string", "nullable": true }, "canAddRows": { "type": "boolean" }, "needsUnitsToggle": { "type": "boolean" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/KrillColumn" }, "nullable": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/KrillFilter" }, "nullable": true } }, "additionalProperties": false }, "KrillFilter": { "type": "object", "properties": { "filterId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/KrillType" }, "isRequired": { "type": "boolean" }, "defaultValue": { "type": "string", "nullable": true }, "dropdownValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "KrillType": { "enum": [ "String", "Int", "Float", "Date", "Bool", "Percentage" ], "type": "string" }, "LabResult": { "enum": [ "NotTested", "Positive", "Negative" ], "type": "string" }, "LaggingPlantOrGroup": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32", "nullable": true }, "group": { "type": "string", "nullable": true }, "lagBehindTargetPercent": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LaneArgs": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32" }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "grouping": { "type": "array", "items": { "type": "string" }, "nullable": true }, "manager": { "type": "string", "nullable": true }, "annualProductionM3": { "type": "number", "format": "double", "nullable": true }, "targetProjectPercent": { "type": "integer", "format": "int32", "nullable": true }, "monthlyProductionGoal": { "type": "number", "format": "double", "nullable": true }, "weeklyProductionGoal": { "type": "number", "format": "double", "nullable": true }, "dailyProductionGoal": { "type": "number", "format": "double", "nullable": true }, "plantType": { "$ref": "#/components/schemas/PlantType" }, "installedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "isDecommissioned": { "type": "boolean" } }, "additionalProperties": false }, "LaneArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LaneArgs" }, "nullable": true } }, "additionalProperties": false }, "LaneProductionArgs": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "averageDailyProductionM3": { "type": "number", "format": "double", "nullable": true }, "isExceedingGoal": { "type": "boolean" } }, "additionalProperties": false }, "Language": { "enum": [ "English", "Spanish", "NL", "FR", "DE", "IT", "ES", "ES_MX", "PT", "PT_BR", "JP", "ZH_TW", "ZH_CN", "KO", "ID", "EN_GB", "EN_US", "EN_CA", "TL", "TH" ], "type": "string" }, "LastModifiedUser": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LatestIngestionInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "dataIntegrationType": { "$ref": "#/components/schemas/DataIntegrationType" }, "isSuccessful": { "type": "boolean" }, "plantsWithErrors": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "LocalizationLanguage": { "enum": [ "En", "Es" ], "type": "string" }, "LynxBatchingTable": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "lastUploadTimestamp": { "type": "string", "format": "date-time" }, "nextUploadTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/LynxIngestionStatus" } }, "additionalProperties": false }, "LynxBatchingTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LynxBatchingTable" }, "nullable": true } }, "additionalProperties": false }, "LynxIngestionStatus": { "enum": [ "Successful", "Error" ], "type": "string" }, "LynxStatus": { "enum": [ "Error", "Eligible", "Downloaded", "Installed", "NotEligible" ], "type": "string", "description": "Represents a plant's current status in regards to Lynx." }, "MassReadings": { "type": "object", "properties": { "datetime": { "type": "string", "format": "date-time" }, "rW_SG": { "type": "number", "format": "float" }, "rW_USED": { "type": "number", "format": "float" }, "voL_UNTRTD_ENTERING": { "type": "number", "format": "float" }, "sG_SOLIDS": { "type": "number", "format": "float" }, "neW_RW_SOLIDS_FRCTNS": { "type": "number", "format": "float" }, "neW_RW_SOLIDS": { "type": "number", "format": "float" }, "trgT_CO2_MASS": { "type": "number", "format": "float" }, "trgT_CO2_VOL": { "type": "number", "format": "float" }, "density_Sensor_1": { "type": "number", "format": "float" }, "density_Sensor_2": { "type": "number", "format": "float" }, "cO2_Daily_SP": { "type": "number", "format": "float" }, "cO2_Added_Kg": { "type": "number", "format": "float" }, "cO2_Added_Litres": { "type": "number", "format": "float" } }, "additionalProperties": false }, "MaterialArgs": { "type": "object", "properties": { "materialMappingId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "isIngested": { "type": "boolean" }, "primaryMaterialType": { "$ref": "#/components/schemas/PrimaryMaterialType" }, "admixtureMaterialSubType": { "$ref": "#/components/schemas/AdmixtureMaterialSubType" }, "specificGravity": { "type": "number", "format": "double", "nullable": true }, "supplierCompany": { "type": "string", "nullable": true }, "supplierPlant": { "type": "string", "nullable": true }, "cementSupplier": { "$ref": "#/components/schemas/CementSupplierArgs" }, "admixtureSolidsContentPercent": { "type": "number", "format": "double", "nullable": true }, "aggregateManufacturing": { "$ref": "#/components/schemas/AggregateManufacturing" }, "aggregatePitId": { "type": "string", "nullable": true }, "aggregateRockType": { "$ref": "#/components/schemas/AggregateRockType" }, "aggregateSize": { "$ref": "#/components/schemas/AggregateSize" }, "fiberManufacturing": { "$ref": "#/components/schemas/FiberManufacturing" }, "fiberSize": { "$ref": "#/components/schemas/FiberSize" }, "fiberDiameterMm": { "type": "number", "format": "double", "nullable": true }, "fiberLengthMm": { "type": "number", "format": "double", "nullable": true }, "flyAshLossOfIgnitionPercent": { "type": "number", "format": "double", "nullable": true }, "silicaFumeGrade": { "$ref": "#/components/schemas/SilicaFumeGrade" }, "slagGrade": { "$ref": "#/components/schemas/SlagGrade" }, "slagProcessing": { "$ref": "#/components/schemas/SlagProcessing" }, "waterTemperature": { "$ref": "#/components/schemas/WaterTemperature" }, "modeOfTransportation": { "$ref": "#/components/schemas/TransportMode" }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "overrideSimilarCheck": { "type": "boolean", "description": "Used to skip the similar material check, since we do support similar materials\nits purpose is to warn the user that a similar material already exists." }, "currentPlantCompositions": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentPlantComposition" }, "nullable": true }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" } }, "additionalProperties": false }, "MaterialArgsShort": { "type": "object", "properties": { "materialMappingId": { "type": "integer", "format": "int32" }, "materialId": { "type": "integer", "format": "int32" }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isIngested": { "type": "boolean" }, "primaryMaterialType": { "$ref": "#/components/schemas/PrimaryMaterialType" }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "specificGravity": { "type": "number", "format": "double", "nullable": true }, "supplierCompany": { "type": "string", "nullable": true }, "supplierPlant": { "type": "string", "nullable": true }, "cementSupplier": { "$ref": "#/components/schemas/CementSupplierArgs" } }, "additionalProperties": false }, "MaterialManagerMetadata": { "type": "object", "properties": { "materialTypeMapping": { "type": "object", "properties": { "Admixture": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Aggregate": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Cement": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "CO2": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Fiber": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "FlyAsh": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "ReclaimedWater": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Slag": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "SilicaFume": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "SCM": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Water": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } }, "Filler": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" } } }, "additionalProperties": false, "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialManagerProperty" }, "nullable": true } }, "additionalProperties": false }, "MaterialManagerProperty": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/DataType" }, "applicableValues": { "type": "array", "items": { "type": "string" }, "nullable": true }, "applicablePrimaryMaterialType": { "$ref": "#/components/schemas/PrimaryMaterialType" }, "cementPlants": { "type": "array", "items": { "$ref": "#/components/schemas/CementSupplierArgs" }, "nullable": true } }, "additionalProperties": false }, "MaterialManagerTable": { "type": "object", "properties": { "materialMappingId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "isIngested": { "type": "boolean" }, "primaryMaterialType": { "$ref": "#/components/schemas/PrimaryMaterialType" }, "admixtureMaterialSubType": { "$ref": "#/components/schemas/AdmixtureMaterialSubType" }, "specificGravity": { "type": "number", "format": "double", "nullable": true }, "supplierCompany": { "type": "string", "nullable": true }, "supplierPlant": { "type": "string", "nullable": true }, "cementSupplier": { "$ref": "#/components/schemas/CementSupplierArgs" }, "admixtureSolidsContentPercent": { "type": "number", "format": "double", "nullable": true }, "aggregateManufacturing": { "$ref": "#/components/schemas/AggregateManufacturing" }, "aggregatePitId": { "type": "string", "nullable": true }, "aggregateRockType": { "$ref": "#/components/schemas/AggregateRockType" }, "aggregateSize": { "$ref": "#/components/schemas/AggregateSize" }, "fiberManufacturing": { "$ref": "#/components/schemas/FiberManufacturing" }, "fiberSize": { "$ref": "#/components/schemas/FiberSize" }, "fiberDiameterMm": { "type": "number", "format": "double", "nullable": true }, "fiberLengthMm": { "type": "number", "format": "double", "nullable": true }, "flyAshLossOfIgnitionPercent": { "type": "number", "format": "double", "nullable": true }, "silicaFumeGrade": { "$ref": "#/components/schemas/SilicaFumeGrade" }, "slagGrade": { "$ref": "#/components/schemas/SlagGrade" }, "slagProcessing": { "$ref": "#/components/schemas/SlagProcessing" }, "waterTemperature": { "$ref": "#/components/schemas/WaterTemperature" }, "modeOfTransportation": { "$ref": "#/components/schemas/TransportMode" }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "overrideSimilarCheck": { "type": "boolean", "description": "Used to skip the similar material check, since we do support similar materials\nits purpose is to warn the user that a similar material already exists." }, "currentPlantCompositions": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentPlantComposition" }, "nullable": true }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" } }, "additionalProperties": false }, "MaterialManagerTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialManagerTable" }, "nullable": true } }, "additionalProperties": false }, "MaterialNameArgs": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/PrimaryMaterialType" } }, "additionalProperties": false }, "MaterialType": { "enum": [ "Cement", "CementTypeI", "CementTypeIS", "CementTypeIP", "CementTypeIL", "CementTypeII", "CementTypeI_II", "CementTypeI_IIMH", "CementTypeI_II_LA", "CementTypeIII", "CementTypeIV", "CementTypeII_V", "CementTypeN", "CementTypeS", "CementCemI", "CementCemII", "CementCemIII", "CementCemIV", "CementCemV", "CementCemVI", "CementBlendedHydraulic", "CoarseAggregate", "IntermediateAggregate", "FineAggregate", "Fiber", "FiberTypeI", "FiberTypeII", "FiberTypeIII", "FiberTypeIV", "Water", "CO2", "SCM", "Slag", "SlagFerrous", "SlagNonFerrous", "SlagFerroalloy", "FlyAsh", "FlyAshC", "FlyAshF", "FlyAshN", "SilicaFume", "ReclaimedWater", "Admixture", "AirEntrainer", "Retarder", "SuperPlasticizer", "WaterReducer", "HighRangeWaterReducer", "MidRangeWaterReducer", "LowRangeWaterReducer", "ViscosityModifier", "HydrationStabilizer", "CorrosionInhibitor", "ShrinkageReducer", "Accelerator", "NonChlorideAccelerator", "ChlorideAccelerator", "StrengthEnhancer", "AntiWashout", "Waterproofer", "Filler" ], "type": "string" }, "MissingDataColumnName": { "type": "object", "properties": { "cO2Dosage": { "type": "boolean" }, "cementReduction": { "type": "boolean" }, "avgCementLoading": { "type": "boolean" }, "avgYardsPerTruck": { "type": "boolean" }, "tankRentalFee": { "type": "boolean" }, "cementSupply": { "type": "boolean" }, "residentialPercent": { "type": "boolean" }, "commercialPercent": { "type": "boolean" }, "dotPercent": { "type": "boolean" }, "tse": { "type": "boolean" }, "isActive": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MissingSystemInfoArgs": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "remoteUnitId": { "type": "integer", "format": "int32" }, "systemDisplayName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "groupNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "manager": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MixArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "compressiveStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "isCO2Design": { "type": "boolean" }, "airContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "exposureClass": { "type": "string", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "strippingStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "strippingStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "mixIngredients": { "type": "array", "items": { "$ref": "#/components/schemas/IngredientArgs" }, "nullable": true } }, "additionalProperties": false }, "MixCodeAndPlantName": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "plantName": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "baseLineCO2": { "type": "number", "format": "double", "nullable": true }, "baseLineCementReduction": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixCodeWithBaselines": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "baseLineCO2": { "type": "number", "format": "double", "nullable": true }, "baseLineCementReduction": { "type": "number", "format": "double", "nullable": true }, "isActiveMixGroup": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "MixDesign": { "required": [ "mixCode", "tags" ], "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "minLength": 1, "type": "string" }, "isCO2Design": { "type": "boolean" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "preCCMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "preCCMixDesign": { "$ref": "#/components/schemas/MixDesign" }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "strippingStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "strippingStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "exposureClass": { "type": "string", "nullable": true }, "airContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "isUserCreated": { "type": "boolean" }, "dismissalTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "dismissalReason": { "type": "string", "nullable": true }, "parentMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "parentMixDesign": { "$ref": "#/components/schemas/MixDesign" }, "isLatestVersion": { "type": "boolean" }, "isActiveMixGroup": { "type": "boolean", "nullable": true }, "cementReductionPercent": { "type": "number", "format": "double", "nullable": true }, "cO2DosagePercent": { "type": "number", "format": "double", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignTag" } }, "addressableStatus": { "type": "string", "nullable": true }, "blockers": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MixDesignActionItem": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "isCO2Design": { "type": "boolean" }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthDays": { "type": "integer", "format": "int32", "nullable": true }, "originalWaterCementRatio": { "type": "number", "format": "double", "nullable": true }, "originalAirContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "originalAirContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "originalYieldUnitless": { "type": "number", "format": "double", "nullable": true }, "optimizedWaterCementRatio": { "type": "number", "format": "double", "nullable": true }, "optimizedAirContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "optimizedAirContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "optimizedYieldUnitless": { "type": "number", "format": "double", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignIngredientArgs" }, "nullable": true }, "type": { "$ref": "#/components/schemas/MixDesignActionItemType" }, "originalCostUsdPerM3": { "type": "number", "format": "double", "nullable": true }, "savingsLocalCurrencyPerM3": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "originalGwpKgCO2EqPerM3": { "type": "number", "format": "double", "nullable": true }, "gwpSavingsKgCO2EqPerM3": { "type": "number", "format": "double", "nullable": true }, "averageStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "requiredStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "strengthStandardDeviation": { "type": "number", "format": "double", "nullable": true }, "overDesign": { "type": "number", "format": "double", "nullable": true }, "optimizedStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "samples": { "type": "array", "items": { "$ref": "#/components/schemas/TestSampleArgs" }, "nullable": true } }, "additionalProperties": false }, "MixDesignActionItemType": { "enum": [ "Optimize", "Shift" ], "type": "string" }, "MixDesignArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "isCO2Design": { "type": "boolean" }, "baselineMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "projectMixIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthDays": { "type": "integer", "format": "int32", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixIngredientArgs" }, "nullable": true } }, "additionalProperties": false }, "MixDesignIngredientArgs": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "originalWeight": { "type": "number", "format": "double", "nullable": true }, "originalVolumeUnitless": { "type": "number", "format": "double", "nullable": true }, "optimizedWeight": { "type": "number", "format": "double", "nullable": true }, "optimizedVolumeUnitless": { "type": "number", "format": "double", "nullable": true }, "weightUnit": { "$ref": "#/components/schemas/MixUnit" } }, "additionalProperties": false }, "MixDesignInput": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "baseLineCO2": { "type": "number", "format": "double", "nullable": true }, "baseLineCementReduction": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "exposureClass": { "type": "string", "nullable": true }, "airContentPctMin": { "type": "number", "format": "double", "nullable": true }, "airContentPctMax": { "type": "number", "format": "double", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "parentMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "isActiveMixGroup": { "type": "boolean", "nullable": true }, "activeMixGroupId": { "type": "integer", "format": "int32", "nullable": true }, "compressiveStrength": { "type": "number", "format": "double", "nullable": true }, "compressiveStrengthHours": { "type": "integer", "format": "int32", "nullable": true }, "strippingStrength": { "type": "number", "format": "double", "nullable": true }, "strippingStrengthHours": { "type": "integer", "format": "int32", "nullable": true }, "strengthUnit": { "$ref": "#/components/schemas/StrengthUnitInput" }, "slumpMin": { "type": "number", "format": "double", "nullable": true }, "slumpMax": { "type": "number", "format": "double", "nullable": true }, "slumpUnit": { "$ref": "#/components/schemas/SlumpUnitInput" }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixIngredientInput" }, "nullable": true } }, "additionalProperties": false, "description": "Input args. Used for adding/updating mixes." }, "MixDesignOptions": { "type": "object", "properties": { "minDate": { "type": "string", "format": "date", "nullable": true }, "maxDate": { "type": "string", "format": "date", "nullable": true }, "mixDesigns": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignVolume" }, "nullable": true } }, "additionalProperties": false }, "MixDesignOutput": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "baseLineCO2": { "type": "number", "format": "double", "nullable": true }, "baseLineCementReduction": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "exposureClass": { "type": "string", "nullable": true }, "airContentPctMin": { "type": "number", "format": "double", "nullable": true }, "airContentPctMax": { "type": "number", "format": "double", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "isImperial": { "type": "boolean" }, "divisionId": { "type": "integer", "format": "int32" }, "compressiveStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "strippingStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "strippingStrengthInterval": { "type": "string", "format": "date-span", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixIngredientOutput" }, "nullable": true }, "parentMixGroup": { "$ref": "#/components/schemas/MixCodeWithBaselines" }, "isActiveMixGroup": { "type": "boolean" } }, "additionalProperties": false, "description": "Output args. Used for editing mixes." }, "MixDesignProduction": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "mixProduction": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionPoint" }, "nullable": true } }, "additionalProperties": false }, "MixDesignTag": { "enum": [ "Commercial", "Residential", "DOT" ], "type": "string" }, "MixDesignVolume": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "volumeM3": { "type": "number", "format": "double" }, "volumePct": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixDesignsTable": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "baselineMixCode": { "type": "string", "nullable": true }, "baselineMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "isUserCreated": { "type": "boolean" }, "designStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "designIntervalDays": { "type": "integer", "format": "int32", "nullable": true }, "cementitiousContentKg": { "type": "number", "format": "double", "nullable": true }, "scmPercentage": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMin": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/MixIngredient" }, "nullable": true } }, "additionalProperties": false }, "MixDesignsTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignsTable" }, "nullable": true } }, "additionalProperties": false }, "MixGroupArgs": { "type": "object", "properties": { "averageStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "requiredStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "overDesign": { "type": "number", "format": "double", "nullable": true }, "cementitiousEfficiency": { "type": "number", "format": "double", "nullable": true }, "mixDesignId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "isInCommissioning": { "type": "boolean" }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "preCCMixCode": { "type": "string", "nullable": true }, "isCO2Design": { "type": "boolean" }, "isActiveMixGroup": { "type": "boolean" }, "parentMixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "cementReductionPercent": { "type": "number", "format": "double", "nullable": true }, "cO2Dosage": { "type": "number", "format": "double", "nullable": true }, "waterCementRatio": { "type": "number", "format": "double", "nullable": true }, "designStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "strengthIntervalDays": { "type": "integer", "format": "int32", "nullable": true }, "cementitiousContentKgPerM3": { "type": "number", "format": "double", "nullable": true }, "scmContentKgPerM3": { "type": "number", "format": "double", "nullable": true }, "slumpMmMin": { "type": "number", "format": "double", "nullable": true }, "slumpMmMax": { "type": "number", "format": "double", "nullable": true }, "cementTypes": { "type": "array", "items": { "$ref": "#/components/schemas/CementType" }, "nullable": true }, "scmTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MaterialType" }, "nullable": true }, "scmPercent": { "type": "number", "description": "The percentage of SCMs out of the total cementitious content", "format": "double", "nullable": true }, "yieldUnitless": { "type": "number", "format": "double", "nullable": true }, "mixVariations": { "type": "array", "items": { "$ref": "#/components/schemas/MixVariation" }, "nullable": true }, "airContentPercentageMax": { "type": "number", "format": "double", "nullable": true }, "airContentPercentageMin": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixGroupArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupArgs" }, "nullable": true } }, "additionalProperties": false }, "MixGroupBatchSampleArgs": { "type": "object", "properties": { "batchSampleId": { "type": "integer", "format": "int32" }, "externalTicketId": { "type": "string", "nullable": true }, "airContent": { "type": "number", "format": "double", "nullable": true }, "slumpMm": { "type": "number", "format": "double", "nullable": true }, "concreteTemperature": { "type": "number", "format": "double", "nullable": true }, "ambientTemperature": { "type": "number", "format": "double", "nullable": true }, "batchWaterCementRatio": { "type": "number", "format": "double", "nullable": true }, "productionDate": { "type": "string", "format": "date" }, "cO2Dosage": { "type": "number", "format": "double", "nullable": true }, "cO2DosageUnit": { "$ref": "#/components/schemas/CO2DosageUnit" }, "cementReduction": { "type": "number", "format": "double", "nullable": true }, "averageStrength7Days": { "type": "number", "format": "double", "nullable": true }, "averageStrength28Days": { "type": "number", "format": "double", "nullable": true }, "densityKgPerM3": { "type": "number", "format": "double", "nullable": true }, "cementContent": { "type": "number", "description": "Though the name is lacking in units, this field is measured in kg", "format": "double", "nullable": true }, "cementContentKgPerM3": { "type": "number", "format": "double", "nullable": true }, "scmPercent": { "type": "number", "description": "The percentage of SCMs out of the total cementitious content", "format": "double", "nullable": true }, "strengthReadings": { "type": "array", "items": { "$ref": "#/components/schemas/BatchSampleStrengthReading" }, "nullable": true }, "notes": { "type": "string", "nullable": true }, "testCategory": { "$ref": "#/components/schemas/ConcreteTestCategory" }, "hourlyStrengthAvg": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/StrengthAverage" }, "nullable": true }, "outlierType": { "$ref": "#/components/schemas/OutlierType" }, "outlierReason": { "type": "string", "nullable": true }, "cementitiousEfficiency": { "type": "number", "format": "double", "nullable": true }, "cementSupplier": { "type": "string", "nullable": true }, "cementType": { "$ref": "#/components/schemas/CementType" }, "cementitiousContentKg": { "type": "number", "format": "double", "nullable": true }, "cementitiousContentKgPerM3": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixGroupTableFullResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupArgs" }, "nullable": true }, "numCO2Samples": { "type": "integer", "format": "int32" }, "numNonCO2Samples": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MixIngredient": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "amount": { "type": "number", "format": "double" }, "unit": { "$ref": "#/components/schemas/MixUnit" }, "specificGravity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixIngredientArgs": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "amount": { "type": "number", "format": "double" }, "unit": { "$ref": "#/components/schemas/MixUnit" }, "specificGravity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixIngredientInput": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "amount": { "type": "number", "format": "double" }, "specificGravity": { "type": "number", "format": "double", "nullable": true }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "unit": { "$ref": "#/components/schemas/MixUnitInput" } }, "additionalProperties": false }, "MixIngredientOutput": { "type": "object", "properties": { "materialName": { "type": "string", "nullable": true }, "materialType": { "$ref": "#/components/schemas/MaterialType" }, "amount": { "type": "number", "format": "double" }, "specificGravity": { "type": "number", "format": "double", "nullable": true }, "materialId": { "type": "integer", "format": "int32", "nullable": true }, "unit": { "$ref": "#/components/schemas/MixUnit" } }, "additionalProperties": false }, "MixStrengthsRow": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "division": { "type": "string", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "condition": { "type": "string", "nullable": true }, "volumeM3": { "type": "number", "format": "double" }, "volumeYd3": { "type": "number", "format": "double" }, "volumePercentage": { "type": "number", "format": "double" }, "strengthMpa": { "type": "number", "format": "double", "nullable": true }, "strengthPsi": { "type": "number", "format": "double", "nullable": true }, "addressableStatus": { "type": "string", "nullable": true }, "blockers": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "cementKgPerM3": { "type": "integer", "format": "int32", "nullable": true }, "cementLbPerYd3": { "type": "integer", "format": "int32", "nullable": true }, "minCementKgPerM3": { "type": "integer", "format": "int32", "nullable": true }, "minCementLbPerYd3": { "type": "integer", "format": "int32", "nullable": true }, "maxCementKgPerM3": { "type": "integer", "format": "int32", "nullable": true }, "maxCementLbPerYd3": { "type": "integer", "format": "int32", "nullable": true }, "scmKgPerM3": { "type": "integer", "format": "int32", "nullable": true }, "scmLbPerYd3": { "type": "integer", "format": "int32", "nullable": true }, "scmPercentage": { "type": "number", "format": "double", "nullable": true }, "cO2KgPerM3": { "type": "number", "format": "double", "nullable": true }, "cO2LbPerYd3": { "type": "number", "format": "double", "nullable": true }, "cO2DosePercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixUnit": { "enum": [ "KgPerM3", "LitrePerM3", "PercentOfCementitious", "PackagePerM3" ], "type": "string" }, "MixUnitInput": { "enum": [ "KgPerM3", "LitrePerM3", "MlPerM3", "LbPerYd3", "OzPerYd3", "GallonPerYd3", "MlPerHundredWeight", "OzPerHundredWeight", "PercentOfCementitious", "PackagePerM3", "PackagePerYd3" ], "type": "string" }, "MixVariation": { "type": "object", "properties": { "averageStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "requiredStrengthMpa": { "type": "number", "format": "double", "nullable": true }, "overDesign": { "type": "number", "format": "double", "nullable": true }, "cementitiousEfficiency": { "type": "number", "format": "double", "nullable": true }, "cementReductionPercent": { "type": "number", "format": "double", "nullable": true }, "cO2Dosage": { "type": "number", "format": "double", "nullable": true }, "cO2DosageUnit": { "$ref": "#/components/schemas/CO2DosageUnitAdjusted" }, "variationType": { "$ref": "#/components/schemas/VariationType" }, "sampleCount": { "type": "integer", "format": "int32" }, "cylinderCount": { "type": "integer", "format": "int32" }, "samples": { "type": "array", "items": { "$ref": "#/components/schemas/MixGroupBatchSampleArgs" }, "nullable": true } }, "additionalProperties": false }, "MixerAlarmCodeDetails": { "type": "object", "properties": { "alarmCodeDetailsId": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "severity": { "$ref": "#/components/schemas/AlarmSeverity" } }, "additionalProperties": false }, "MixerInjection": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "mixTimeSeconds": { "type": "integer", "format": "int32" }, "injectedCO2Kg": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MixerInjectionReading": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "temperatureC": { "type": "number", "format": "double", "nullable": true }, "flowRateKgPerSec": { "type": "number", "format": "double", "nullable": true }, "upstreamPressurePsi": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure0Psi": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure1Psi": { "type": "number", "format": "double", "nullable": true }, "downstreamPressure2Psi": { "type": "number", "format": "double", "nullable": true }, "inletLiquidPressurePsi": { "type": "number", "format": "double", "nullable": true }, "inletGasPressurePsi": { "type": "number", "format": "double", "nullable": true }, "injectedCO2Kg": { "type": "number", "format": "double", "nullable": true }, "liquidValveOpen": { "type": "boolean", "nullable": true }, "gasValveOpen": { "type": "boolean", "nullable": true }, "equation1": { "type": "boolean", "nullable": true }, "equation2": { "type": "boolean", "nullable": true }, "equation3": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "MixerStatus": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "inletLiquidPressurePsi": { "type": "number", "format": "double", "nullable": true }, "inletGasPressurePsi": { "type": "number", "format": "double", "nullable": true }, "temperatureC": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MonthPart": { "enum": [ "Early", "Mid", "Late", "NotApplicable" ], "type": "string" }, "MyCCAccountTaskResponse": { "type": "object", "properties": { "taskType": { "$ref": "#/components/schemas/MyCCAccountTaskType" }, "isCompleted": { "type": "boolean" } }, "additionalProperties": false }, "MyCCAccountTaskType": { "enum": [ "SendMixPortifolio", "InitiateCO2SupplierMeeting", "SignCO2SupplyAgreement", "ProvideCementMillCert", "SendBusinessRegistrationNumber", "ProvideHistoricalMixData", "ProvideMixNaming", "CompleteMaterialSources", "ImplementBatchingDataTransfer", "CompletePreInstallQuestions", "ConfirmCO2Install", "SendBaselineQCData", "SendTestResults", "LynxDownloadTask", "AttestationRequest" ], "type": "string" }, "MyCCAsset": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "fileExtension": { "type": "string", "nullable": true }, "sizeBytes": { "type": "number", "format": "double", "nullable": true }, "myCCAssetId": { "type": "integer", "format": "int32" }, "mongoId": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "assetType": { "$ref": "#/components/schemas/AssetType" }, "description": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "thumbnailLink": { "type": "string", "nullable": true }, "isKeyResource": { "type": "boolean", "nullable": true }, "thumbnailS3BucketPath": { "type": "string", "nullable": true }, "hasThumbnail": { "type": "boolean", "readOnly": true }, "myCCAccountId": { "type": "integer", "format": "int32", "nullable": true }, "myCCAccountName": { "type": "string", "nullable": true, "readOnly": true }, "isHidden": { "type": "boolean" } }, "additionalProperties": false }, "MyCCNotificationSubscriptions": { "type": "object", "properties": { "myCCNotificationSubscriptionsId": { "type": "integer", "format": "int32" }, "user": { "$ref": "#/components/schemas/User" }, "sendGridContactId": { "type": "string", "nullable": true }, "hasNewFeatureSub": { "type": "boolean" }, "hasPositionSub": { "type": "boolean" }, "hasTestingSub": { "type": "boolean" }, "hasActionItemsSub": { "type": "boolean" }, "hasPlantUpdatesSub": { "type": "boolean" }, "hasCreditUpdatesSub": { "type": "boolean" }, "hasNewOnboardingTaskSub": { "type": "boolean" }, "hasOngoingTasksSub": { "type": "boolean" }, "subscriptionsChangedTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MyCCNotificationsResponse": { "type": "object", "properties": { "hasNewFeatureSub": { "type": "boolean" }, "hasPositionSub": { "type": "boolean" }, "hasTestingSub": { "type": "boolean" }, "hasActionItemsSub": { "type": "boolean" }, "hasPlantUpdatesSub": { "type": "boolean" }, "hasNewOnboardingTaskSub": { "type": "boolean" }, "hasOngoingTasksSub": { "type": "boolean" }, "hasCreditUpdatesSub": { "type": "boolean" }, "subscriptionsChangedTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "MyCCUserArgs": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "permissionGroup": { "$ref": "#/components/schemas/PermissionGroup" }, "jobTitle": { "type": "string", "nullable": true }, "jobField": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phone": { "type": "string", "nullable": true }, "primaryContactType": { "$ref": "#/components/schemas/PrimaryContactType" }, "isPrimaryContact": { "type": "boolean", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "repType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MyCCUserNotificationSettingsArgs": { "type": "object", "properties": { "hasNewFeatureSub": { "type": "boolean" }, "hasPositionSub": { "type": "boolean" }, "hasTestingSub": { "type": "boolean" }, "hasActionItemsSub": { "type": "boolean" }, "hasPlantUpdatesSub": { "type": "boolean" }, "hasCreditUpdatesSub": { "type": "boolean" }, "hasNewOnboardingTaskSub": { "type": "boolean" }, "hasOngoingTasksSub": { "type": "boolean" } }, "additionalProperties": false }, "MyCCUserResponse": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" }, { "type": "object", "properties": { "permissionGroup": { "$ref": "#/components/schemas/PermissionGroup" }, "primaryContactType": { "$ref": "#/components/schemas/PrimaryContactType" }, "isPrimaryContact": { "type": "boolean" }, "myCCAccountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "MyCCUserSettingArgs": { "type": "object", "properties": { "language": { "$ref": "#/components/schemas/Language" }, "numericFormat": { "type": "string", "nullable": true }, "wantsNewFeatureEmail": { "type": "boolean" }, "wantsPositionEmail": { "type": "boolean" }, "wantsTestingEmail": { "type": "boolean" }, "allowsCookies": { "type": "boolean", "nullable": true }, "allowsFunctionalCookies": { "type": "boolean", "nullable": true }, "allowsAnalyticsCookies": { "type": "boolean", "nullable": true }, "enviroContactName": { "type": "string", "nullable": true }, "enviroContactPhone": { "type": "string", "nullable": true }, "enviroContactEmail": { "type": "string", "nullable": true }, "enviroContactWebsite": { "type": "string", "nullable": true }, "subscriptionSettings": { "$ref": "#/components/schemas/MyCCUserNotificationSettingsArgs" } }, "additionalProperties": false }, "MyDataCementSource": { "type": "object", "properties": { "cementPlantId": { "type": "integer", "format": "int32" }, "cementPlantName": { "type": "string", "nullable": true }, "cementName": { "type": "string", "nullable": true }, "cementType": { "$ref": "#/components/schemas/CementType" }, "cementPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "MyDataMaterialSourceArgs": { "type": "object", "properties": { "providedCO2SupplierName": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "cementSources": { "type": "array", "items": { "$ref": "#/components/schemas/MyDataCementSource" }, "nullable": true } }, "additionalProperties": false }, "MyDataMaterialSourcesTable": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "cO2SupplierName": { "type": "string", "nullable": true }, "cementSources": { "type": "array", "items": { "$ref": "#/components/schemas/MyDataCementSource" }, "nullable": true } }, "additionalProperties": false }, "MyDataMaterialSourcesTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MyDataMaterialSourcesTable" }, "nullable": true } }, "additionalProperties": false }, "MyDataQcTable": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "concreteVolumeM3": { "type": "number", "format": "double", "nullable": true }, "sampleCount": { "type": "integer", "format": "int32" }, "baselineSampleCount": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MyDataQcTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MyDataQcTable" }, "nullable": true } }, "additionalProperties": false }, "NewMyCCTestUserResponse": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "myCCAccountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OldStyleMixDesignArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32", "nullable": true }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "divisionName": { "type": "string", "nullable": true }, "isImperial": { "type": "boolean", "nullable": true }, "compressiveStrengthMPa": { "type": "number", "format": "double", "nullable": true }, "cementKgPerM3After": { "type": "number", "format": "double", "nullable": true }, "cementKgPerM3Before": { "type": "number", "format": "double", "nullable": true }, "slagKgPerM3After": { "type": "number", "format": "double", "nullable": true }, "slagKgPerM3Before": { "type": "number", "format": "double", "nullable": true }, "flyAshKgPerM3After": { "type": "number", "format": "double", "nullable": true }, "flyAshKgPerM3Before": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "OnboardingPlantArgs": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isImperial": { "type": "boolean" }, "annualPlantVolume": { "type": "number", "format": "double", "nullable": true }, "residentialPercent": { "type": "number", "format": "double", "nullable": true }, "commercialPercent": { "type": "number", "format": "double", "nullable": true }, "publicSectorPercent": { "type": "number", "format": "double", "nullable": true }, "annualCctVolumeTarget": { "type": "number", "format": "double", "nullable": true }, "monthlyCctProductionGoal": { "type": "number", "format": "double", "nullable": true }, "isHistoricalDataAvailable": { "type": "string", "nullable": true }, "isVolumeBreakdownAvailable": { "type": "string", "nullable": true }, "qcFieldLabTechCount": { "type": "number", "format": "double", "nullable": true }, "hasBreakMachine": { "type": "string", "nullable": true }, "mixerType": { "type": "string", "nullable": true }, "avgDischargeTimeSeconds": { "type": "number", "format": "double", "nullable": true }, "batchingSoftware": { "type": "string", "nullable": true }, "wasBusinessRegistrationNumberSent": { "type": "string", "nullable": true }, "co2Supplier": { "type": "string", "nullable": true }, "carbonCreditStatus": { "type": "string", "nullable": true }, "epdStatus": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isCementSupplyConsistent": { "type": "boolean", "nullable": true }, "cementSources": { "type": "array", "items": { "$ref": "#/components/schemas/CementSource" }, "nullable": true }, "uniqueInstallCriteria": { "type": "string", "nullable": true }, "plantInstallOrder": { "type": "integer", "format": "int32", "nullable": true }, "preliminaryInstallDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "OnboardingResponse": { "type": "object", "properties": { "plants": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingPlantArgs" }, "nullable": true }, "enums": { "$ref": "#/components/schemas/PlantOnboardingEnums" } }, "additionalProperties": false }, "OnsiteStatus": { "enum": [ "Confirmed", "Tentative", "GeneralTimeframe", "AfterInstallation" ], "type": "string" }, "OrcaFeatureFlag": { "required": [ "name" ], "type": "object", "properties": { "featureFlagId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OrcaFeatureFlagArgs": { "type": "object", "properties": { "featureFlagId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "OrificeType": { "enum": [ "Single", "Dual", "Triple" ], "type": "string" }, "OutlierArgs": { "type": "object", "properties": { "batchTestSampleId": { "type": "integer", "format": "int32" }, "outlierReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OutlierType": { "enum": [ "Orca" ], "type": "string" }, "PartArgs": { "type": "object", "properties": { "partId": { "type": "integer", "format": "int32" }, "actionReason": { "$ref": "#/components/schemas/ActionReason" }, "actionStatus": { "$ref": "#/components/schemas/ActionStatus" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PermissionGroup": { "enum": [ "Staff", "Manager", "Admin" ], "type": "string" }, "PlantArgsDropdown": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "plantType": { "$ref": "#/components/schemas/PlantType" } }, "additionalProperties": false }, "PlantArgsInput": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "plantType": { "$ref": "#/components/schemas/PlantType" }, "divisionName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "averageLoadSizeM3": { "type": "number", "format": "double", "nullable": true }, "averageCementLoadingKgPerM3": { "type": "number", "format": "double", "nullable": true }, "averageCementLoadingKgPerM3Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "residentialPercent": { "type": "number", "format": "double", "nullable": true }, "commercialPercent": { "type": "number", "format": "double", "nullable": true }, "dotPercent": { "type": "number", "format": "double", "nullable": true }, "installDate": { "type": "string", "format": "date-time", "nullable": true }, "averageCementCut": { "type": "number", "format": "double", "nullable": true }, "averageCementCutTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "cO2DosePercent": { "type": "number", "format": "double", "nullable": true }, "cO2DosePercentTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "cementPlantId": { "type": "integer", "format": "int32", "nullable": true }, "cementPlantIdTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "tse": { "type": "string", "nullable": true }, "tssNote": { "type": "string", "nullable": true }, "rwCementCompensationPercent": { "type": "number", "format": "double", "nullable": true }, "rwCementCompensationPercentTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "tankRentalFee": { "type": "number", "format": "double", "nullable": true }, "tankRentalFeeTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "plantEditNote": { "$ref": "#/components/schemas/PlantEditNoteArgs" } }, "additionalProperties": false }, "PlantArgsResponse": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "plantType": { "$ref": "#/components/schemas/PlantType" }, "divisionName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "averageLoadSizeM3": { "type": "number", "format": "double", "nullable": true }, "averageCementLoadingKgPerM3": { "type": "number", "format": "double", "nullable": true }, "averageCementLoadingKgPerM3Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "residentialPercent": { "type": "number", "format": "double", "nullable": true }, "commercialPercent": { "type": "number", "format": "double", "nullable": true }, "dotPercent": { "type": "number", "format": "double", "nullable": true }, "installDate": { "type": "string", "format": "date-time", "nullable": true }, "averageCementCut": { "type": "number", "format": "double", "nullable": true }, "averageCementCutTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "cO2DosePercent": { "type": "number", "format": "double", "nullable": true }, "cO2DosePercentTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "cementPlantId": { "type": "integer", "format": "int32", "nullable": true }, "cementPlantIdTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "tse": { "type": "string", "nullable": true }, "tssNote": { "type": "string", "nullable": true }, "rwCementCompensationPercent": { "type": "number", "format": "double", "nullable": true }, "rwCementCompensationPercentTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "tankRentalFee": { "type": "number", "format": "double", "nullable": true }, "tankRentalFeeTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "plantTemporals": { "type": "array", "items": { "$ref": "#/components/schemas/PlantTemporalArgs" }, "nullable": true } }, "additionalProperties": false }, "PlantArgsResponseTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsResponse" }, "nullable": true } }, "additionalProperties": false }, "PlantArgsShort": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "manager": { "type": "string", "nullable": true }, "systemCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlantCementComposition": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "cementCompositions": { "type": "array", "items": { "$ref": "#/components/schemas/CementComposition" }, "nullable": true } }, "additionalProperties": false }, "PlantDetailsArgs": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "groupNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "manager": { "type": "string", "nullable": true }, "reportedAnnualProductionM3": { "type": "number", "format": "double", "nullable": true }, "goalAddressablePercentage": { "type": "integer", "format": "int32", "nullable": true }, "residentialPercent": { "type": "number", "format": "double", "nullable": true }, "commercialPercent": { "type": "number", "format": "double", "nullable": true }, "dotPercent": { "type": "number", "format": "double", "nullable": true }, "lastSavedTimestamp": { "type": "string", "description": "Timestamp of last time changes were made to the plant or any of its associated systems.", "format": "date-time", "nullable": true }, "lastSavedUserFullName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "previousYearProductionCctM3": { "type": "number", "format": "double" }, "defaultCementCut": { "type": "number", "format": "double", "nullable": true }, "defaultCO2DosePercent": { "type": "number", "format": "double", "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SystemArgsPartial" }, "nullable": true } }, "additionalProperties": false }, "PlantDropdown": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlantEditNoteArgs": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "previousValue": { "type": "string", "nullable": true }, "updatedValue": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlantGroupArgs": { "type": "object", "properties": { "groupName": { "type": "string", "nullable": true }, "systemCount": { "type": "integer", "format": "int32" }, "plants": { "type": "array", "items": { "$ref": "#/components/schemas/PlantArgsShort" }, "nullable": true } }, "additionalProperties": false }, "PlantGroupUpdateArgs": { "type": "object", "properties": { "groupName": { "type": "string", "nullable": true }, "previousGroupName": { "type": "string", "nullable": true }, "plantIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "PlantLynxStatus": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "batchingSoftware": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/LynxStatus" }, "lynxDownloadedTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PlantLynxStatusTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PlantLynxStatus" }, "nullable": true } }, "additionalProperties": false }, "PlantNames": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlantOnboardingEnums": { "type": "object", "properties": { "isHistoricalDataAvailable": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "isVolumeBreakdownAvailable": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "hasBreakMachine": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "mixerType": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "batchingSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "wasBusinessRegistrationNumberSent": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "co2Supplier": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "carbonCreditStatus": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "epdStatus": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "uniqueInstallCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true } }, "additionalProperties": false }, "PlantOverviewTable": { "type": "object", "properties": { "corporationId": { "type": "integer", "format": "int32" }, "corporationName": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time" }, "activeAlarms": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "remotes": { "type": "array", "items": { "$ref": "#/components/schemas/ReadyMixUnitRow" }, "nullable": true }, "activeAlarmCount": { "type": "integer", "format": "int32" }, "remoteUnitCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlantOverviewTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PlantOverviewTable" }, "nullable": true } }, "additionalProperties": false }, "PlantSalesOverview": { "type": "object", "properties": { "state": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "longLat": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "hasSystem": { "type": "boolean" }, "isPrecast": { "type": "boolean" }, "salesperson": { "type": "string", "nullable": true }, "cO2SupplierId": { "type": "integer", "format": "int32", "nullable": true }, "cements": { "type": "array", "items": { "$ref": "#/components/schemas/CementSalesOverview" }, "nullable": true } }, "additionalProperties": false }, "PlantTemporalArgs": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "cementPlantId": { "type": "integer", "format": "int32", "nullable": true }, "cementPlantName": { "type": "string", "nullable": true }, "averageCementCut": { "type": "number", "format": "double", "nullable": true }, "cO2DosePercent": { "type": "number", "format": "double", "nullable": true }, "averageCementLoadingKgPerM3": { "type": "number", "format": "double", "nullable": true }, "rwCementCompensationPercent": { "type": "number", "format": "double", "nullable": true }, "tankRentalFeeUsd": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "PlantType": { "enum": [ "ReadyMix", "Masonry", "Precast" ], "type": "string" }, "PlantUpdateArgs": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "groupNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "manager": { "type": "string", "nullable": true }, "reportedAnnualProductionM3": { "type": "number", "format": "double", "nullable": true }, "goalAddressablePercentage": { "type": "integer", "format": "int32", "nullable": true }, "residentialPercent": { "type": "number", "format": "double", "nullable": true }, "commercialPercent": { "type": "number", "format": "double", "nullable": true }, "dotPercent": { "type": "number", "format": "double", "nullable": true }, "lastSavedTimestamp": { "type": "string", "description": "Timestamp of last time changes were made to the plant or any of its associated systems.", "format": "date-time", "nullable": true }, "lastSavedUserFullName": { "type": "string", "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SystemArgsShort" }, "nullable": true } }, "additionalProperties": false }, "PlantsTableArgs": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "groupNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "systemCount": { "type": "integer", "format": "int32" }, "manager": { "type": "string", "nullable": true }, "reportedAnnualProductionM3": { "type": "number", "format": "double" }, "goalAddressablePercentage": { "type": "number", "format": "double" }, "previousYearProductionCctM3": { "type": "number", "format": "double" }, "hasMissingInfo": { "type": "boolean" } }, "additionalProperties": false }, "PlantsTableArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PlantsTableArgs" }, "nullable": true } }, "additionalProperties": false }, "PrimaryContactType": { "enum": [ "Owner", "QcManager", "Operations", "ItContact", "Other" ], "type": "string" }, "PrimaryMaterialType": { "enum": [ "Admixture", "Aggregate", "Cement", "CO2", "Fiber", "FlyAsh", "ReclaimedWater", "Slag", "SilicaFume", "SCM", "Water", "Filler" ], "type": "string" }, "ProductionGraphType": { "enum": [ "ConcreteProduction", "CO2Injections", "CO2Avoided", "CO2Injected" ], "type": "string" }, "ProductionPoint": { "type": "object", "properties": { "month": { "type": "string", "format": "date" }, "volumeM3": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ProductionScenario": { "enum": [ "NoData", "Lagging", "ExceededProductionGoal", "SuggestedActions" ], "type": "string" }, "ProgressWidgetEnvironmentEquivalence": { "enum": [ "Cars", "Forestland", "Electricity" ], "type": "string" }, "ProgressWidgetProduction": { "enum": [ "Truckloads", "Volume" ], "type": "string" }, "ProgressWidgetTimeframe": { "enum": [ "AllTime", "Year" ], "type": "string" }, "ProgressWidgetType": { "enum": [ "EmbeddedTicker", "SocialPost" ], "type": "string" }, "ProgressWidgetUnits": { "enum": [ "Metric", "Imperial" ], "type": "string" }, "QCFileMetaDataArgs": { "type": "object", "properties": { "uploadLogId": { "type": "integer", "format": "int32" }, "notes": { "type": "string", "nullable": true }, "mixCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "QcActionItem": { "type": "object", "properties": { "mixCode": { "type": "string", "nullable": true }, "estimatedCredits": { "type": "number", "format": "double" } }, "additionalProperties": false }, "QcDataPendingApprovalTable": { "type": "object", "properties": { "uploadLogId": { "type": "integer", "format": "int32" }, "mixCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fileName": { "type": "string", "nullable": true }, "submissionDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "userFullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "QcDataPendingApprovalTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/QcDataPendingApprovalTable" }, "nullable": true } }, "additionalProperties": false }, "QcDataScenario": { "enum": [ "Sufficient", "Submitted", "Limited", "NoData" ], "type": "string" }, "RcaReadingInput": { "type": "object", "properties": { "batch_number": { "type": "integer", "format": "int32" }, "aiT_100_raw": { "type": "number", "format": "float", "nullable": true }, "aiT_100_filtered": { "type": "number", "format": "float", "nullable": true }, "aiT_100_scaled": { "type": "number", "format": "float", "nullable": true }, "aiT_101_raw": { "type": "number", "format": "float", "nullable": true }, "aiT_101_scaled": { "type": "number", "format": "float", "nullable": true }, "pT1_raw": { "type": "number", "format": "float", "nullable": true }, "pT1_filtered_psi": { "type": "number", "format": "float", "nullable": true }, "pT1_scaled_psi": { "type": "number", "format": "float", "nullable": true }, "pT2_raw": { "type": "number", "format": "float", "nullable": true }, "pT2_filtered_psi": { "type": "number", "format": "float", "nullable": true }, "pT2_scaled_psi": { "type": "number", "format": "float", "nullable": true }, "pT3_raw": { "type": "number", "format": "float", "nullable": true }, "pT3_filtered_psi": { "type": "number", "format": "float", "nullable": true }, "pT3_scaled_psi": { "type": "number", "format": "float", "nullable": true }, "pT4_raw": { "type": "number", "format": "float", "nullable": true }, "pT4_filtered_psi": { "type": "number", "format": "float", "nullable": true }, "pT4_scaled_psi": { "type": "number", "format": "float", "nullable": true }, "tT1_raw": { "type": "number", "format": "float", "nullable": true }, "tT1_filtered_C": { "type": "number", "format": "float", "nullable": true }, "tT1_scaled_C": { "type": "number", "format": "float", "nullable": true }, "mass_loaded_lbs": { "type": "number", "format": "float", "nullable": true }, "o2_inj_target": { "type": "number", "format": "float", "nullable": true }, "o2_pause_target": { "type": "number", "format": "float", "nullable": true }, "o2_lv_intial": { "type": "number", "format": "float", "nullable": true }, "o2_lv_t1": { "type": "number", "format": "float", "nullable": true }, "o2_lv_t2": { "type": "number", "format": "float", "nullable": true }, "wX0": { "type": "number", "format": "float", "nullable": true }, "mass_inj_CO2_lb": { "type": "number", "format": "float", "nullable": true }, "hL_inj_co2_lbs": { "type": "number", "format": "float", "nullable": true }, "injected_CO2_lbs": { "type": "number", "format": "float", "nullable": true }, "rM_liq_valve": { "type": "boolean", "nullable": true }, "rM_gas_valve": { "type": "boolean", "nullable": true }, "start_auto_injec": { "type": "boolean", "nullable": true }, "stop": { "type": "boolean", "nullable": true }, "test_time_ms": { "type": "integer", "format": "int32", "nullable": true }, "mixing_time": { "type": "integer", "format": "int32", "nullable": true }, "max_inj_time_ms": { "type": "integer", "format": "int32", "nullable": true }, "min_inj_time_ms": { "type": "integer", "format": "int32", "nullable": true }, "max_off_time_ms": { "type": "integer", "format": "int32", "nullable": true }, "min_off_time_ms": { "type": "integer", "format": "int32", "nullable": true }, "o2_t1_ms": { "type": "integer", "format": "int32", "nullable": true }, "o2_t2_ms": { "type": "integer", "format": "int32", "nullable": true }, "o2_t3_ms": { "type": "integer", "format": "int32", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReadingsProcessedResponse": { "type": "object", "properties": { "readingsProcessed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReadyMixUnitArgs": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReadyMixUnitPart": { "required": [ "name" ], "type": "object", "properties": { "partId": { "type": "integer", "format": "int32" }, "name": { "minLength": 1, "type": "string" }, "partNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReadyMixUnitRow": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "lastSeen": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReclaimedWaterStatus": { "type": "object", "properties": { "reclaimedWaterStatusId": { "type": "integer", "format": "int32" }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "tankLevelPercent": { "type": "number", "format": "float", "nullable": true }, "ambientTemperatureC": { "type": "number", "format": "float", "nullable": true }, "systemStatus": { "type": "string", "nullable": true }, "wasCO2Active": { "type": "boolean", "nullable": true }, "wasPumpActive": { "type": "boolean", "nullable": true }, "httpErrorCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RemoteUnitProduction": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "projectProduction": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionPoint" }, "nullable": true }, "nonProjectProduction": { "type": "array", "items": { "$ref": "#/components/schemas/ProductionPoint" }, "description": "This is the sum of production volumes of baseline mixes that are not included in the MixDesigns field.\nSumming together ProjectProduction + NonProjectProduction + MixDesigns should equal 100% of production.", "nullable": true }, "mixDesigns": { "type": "array", "items": { "$ref": "#/components/schemas/MixDesignProduction" }, "nullable": true } }, "additionalProperties": false }, "ReportAvgStrengthGraphSettings": { "type": "object", "properties": { "isSelected": { "type": "boolean" }, "selectedIntervalHours": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "showDesignStrength": { "type": "boolean" } }, "additionalProperties": false }, "ReportFrequencyGraphSettings": { "type": "object", "properties": { "isSelected": { "type": "boolean" }, "selectedIntervalHours": { "type": "integer", "format": "int32" }, "showFailureZone": { "type": "boolean" }, "showHistogram": { "type": "boolean" }, "showBellCurve": { "type": "boolean" } }, "additionalProperties": false }, "ReportLibraryItem": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" }, "commissioningReportId": { "type": "integer", "format": "int32", "deprecated": true }, "reportType": { "$ref": "#/components/schemas/ReportType" }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "mixCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdByUserId": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ReportStatus" }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time" }, "reviewedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "isMetric": { "type": "boolean" } }, "additionalProperties": false }, "ReportLibraryItemTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReportLibraryItem" }, "nullable": true } }, "additionalProperties": false }, "ReportMixVariation": { "type": "object", "properties": { "selectedTestCategories": { "type": "array", "items": { "$ref": "#/components/schemas/ConcreteTestCategory" }, "nullable": true }, "cO2Dosage": { "type": "number", "format": "double", "nullable": true }, "cO2DosageUnit": { "$ref": "#/components/schemas/CO2DosageUnitAdjusted" }, "cementReductionPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ReportStatus": { "enum": [ "Draft", "PendingReview", "Reviewed" ], "type": "string" }, "ReportType": { "enum": [ "Commissioning", "Implementation" ], "type": "string" }, "RepresentativeArgs": { "type": "object", "properties": { "repId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "iconUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResolutionStatus": { "enum": [ "Done", "WillNotDo", "Duplicate" ], "type": "string" }, "ResourceResponse": { "type": "object", "properties": { "resourceId": { "type": "integer", "format": "int32" }, "uploadLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SalesOpportunityResponse": { "type": "object", "properties": { "companyName": { "type": "string", "nullable": true }, "pipelineStage": { "type": "string", "nullable": true }, "plantCount": { "type": "integer", "format": "int32", "nullable": true }, "carbonCureSalesPerson": { "type": "string", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SamAdditionalTestingEmailArgs": { "type": "object", "properties": { "mixCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "assistanceRequestType": { "$ref": "#/components/schemas/AssistanceRequestType" } }, "additionalProperties": false }, "SampleRequirementArgs": { "type": "object", "properties": { "intervalHours": { "type": "integer", "format": "int32" }, "minCylindersRequired": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ServiceCaseCreationArgs": { "type": "object", "properties": { "isOperational": { "type": "boolean" }, "hardwareSpecialistId": { "type": "integer", "format": "int32" }, "emailFrequency": { "$ref": "#/components/schemas/EmailFrequency" }, "slackChannel": { "type": "string", "nullable": true }, "primaryContactName": { "type": "string", "nullable": true }, "primaryContactPhone": { "type": "string", "nullable": true }, "primaryContactEmail": { "type": "string", "nullable": true }, "primaryContactRole": { "type": "string", "nullable": true }, "secondaryContactName": { "type": "string", "nullable": true }, "secondaryContactPhone": { "type": "string", "nullable": true }, "secondaryContactEmail": { "type": "string", "nullable": true }, "secondaryContactRole": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "snoozeUntilResolution": { "type": "boolean" }, "sonarSnoozeArgs": { "$ref": "#/components/schemas/SonarSystemSnoozeArgs" }, "initialIndicationDate": { "type": "string", "format": "date" }, "approxIssueStartDate": { "type": "string", "format": "date", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "initialHypothesis": { "type": "string", "nullable": true }, "indicationSource": { "$ref": "#/components/schemas/IndicationSource" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ActionCreationArgs" }, "nullable": true } }, "additionalProperties": false }, "ServiceCaseCreationResponse": { "type": "object", "properties": { "serviceCaseId": { "type": "integer", "format": "int32" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceCaseInfoArgs": { "type": "object", "properties": { "caseClosedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "resolutionStatus": { "$ref": "#/components/schemas/ResolutionStatus" }, "internalTimeSpent": { "$ref": "#/components/schemas/InternalTimeSpent" }, "teamResponsible": { "$ref": "#/components/schemas/TeamResponsible" }, "resolutionComments": { "type": "string", "nullable": true }, "rootCause": { "type": "string", "nullable": true }, "customerResolutionComments": { "type": "string", "nullable": true }, "customerFeedback": { "type": "string", "nullable": true }, "timeElapsedDays": { "type": "integer", "format": "int32" }, "totalDaysDown": { "type": "integer", "format": "int32" }, "systemInfo": { "$ref": "#/components/schemas/SystemInfoArgs" }, "serviceCaseId": { "type": "integer", "format": "int32" }, "emailFrequency": { "$ref": "#/components/schemas/EmailFrequency" }, "slackChannel": { "type": "string", "nullable": true }, "approxIssueStartDate": { "type": "string", "format": "date" }, "initialIndicationDate": { "type": "string", "format": "date" }, "caseOpenedTimestamp": { "type": "string", "format": "date-time" }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time" }, "hardwareSpecialistId": { "type": "integer", "format": "int32", "nullable": true }, "hardwareSpecialistName": { "type": "string", "nullable": true }, "primaryContactName": { "type": "string", "nullable": true }, "primaryContactPhone": { "type": "string", "nullable": true }, "primaryContactEmail": { "type": "string", "nullable": true }, "primaryContactRole": { "type": "string", "nullable": true }, "secondaryContactName": { "type": "string", "nullable": true }, "secondaryContactPhone": { "type": "string", "nullable": true }, "secondaryContactEmail": { "type": "string", "nullable": true }, "secondaryContactRole": { "type": "string", "nullable": true }, "initialHypothesis": { "type": "string", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "indicationSource": { "$ref": "#/components/schemas/IndicationSource" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ServiceCaseInfoArgsShort": { "type": "object", "properties": { "readyMixUnitId": { "type": "integer", "format": "int32" }, "hmiId": { "type": "integer", "format": "int32" }, "workflowName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "serviceCaseId": { "type": "integer", "format": "int32" }, "initialIndicationDate": { "type": "string", "format": "date" }, "initialHypothesis": { "type": "string", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "indicationSource": { "$ref": "#/components/schemas/IndicationSource" }, "primaryContactName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceCaseResolutionArgs": { "type": "object", "properties": { "caseClosedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "resolutionStatus": { "$ref": "#/components/schemas/ResolutionStatus" }, "internalTimeSpent": { "$ref": "#/components/schemas/InternalTimeSpent" }, "teamResponsible": { "$ref": "#/components/schemas/TeamResponsible" }, "resolutionComments": { "type": "string", "nullable": true }, "rootCause": { "type": "string", "nullable": true }, "customerResolutionComments": { "type": "string", "nullable": true }, "customerFeedback": { "type": "string", "nullable": true }, "timeElapsedDays": { "type": "integer", "format": "int32" }, "totalDaysDown": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ServiceCaseResourceArgs": { "type": "object", "properties": { "resourceId": { "type": "integer", "format": "int32" }, "serviceCaseId": { "type": "integer", "format": "int32" }, "notes": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "uploadedByName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceCaseResourceCreationArgs": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceCaseSystem": { "type": "object", "properties": { "readyMixUnitId": { "type": "integer", "format": "int32" }, "workflowName": { "type": "string", "nullable": true }, "hmiId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceCaseUpdateArgs": { "type": "object", "properties": { "isOperational": { "type": "boolean" }, "hardwareSpecialistId": { "type": "integer", "format": "int32" }, "emailFrequency": { "$ref": "#/components/schemas/EmailFrequency" }, "slackChannel": { "type": "string", "nullable": true }, "primaryContactName": { "type": "string", "nullable": true }, "primaryContactPhone": { "type": "string", "nullable": true }, "primaryContactEmail": { "type": "string", "nullable": true }, "primaryContactRole": { "type": "string", "nullable": true }, "secondaryContactName": { "type": "string", "nullable": true }, "secondaryContactPhone": { "type": "string", "nullable": true }, "secondaryContactEmail": { "type": "string", "nullable": true }, "secondaryContactRole": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ServiceCasesFilterOptions": { "type": "object", "properties": { "producers": { "type": "array", "items": { "$ref": "#/components/schemas/SonarProducer" }, "nullable": true }, "plants": { "type": "array", "items": { "$ref": "#/components/schemas/SonarPlant" }, "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCaseSystem" }, "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cities": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serviceCaseIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "hardwareSpecialists": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgsShort" }, "nullable": true }, "resolutionStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionStatus" }, "nullable": true } }, "additionalProperties": false }, "ServiceCasesTable": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "plantName": { "type": "string", "nullable": true }, "workflowName": { "type": "string", "nullable": true }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "hmiId": { "type": "integer", "format": "int32" }, "serviceCaseId": { "type": "integer", "format": "int32" }, "hardwareSpecialistId": { "type": "integer", "format": "int32", "nullable": true }, "hardwareSpecialistName": { "type": "string", "nullable": true }, "initialIndicationDate": { "type": "string", "format": "date" }, "caseOpenedTimestamp": { "type": "string", "format": "date-time" }, "caseClosedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "timeElapsedDays": { "type": "integer", "format": "int32" }, "isOperational": { "type": "boolean" }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time" }, "isDown": { "type": "boolean" }, "systemLastSeenTimestamp": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ServiceCasesTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCasesTable" }, "nullable": true } }, "additionalProperties": false }, "SilicaFumeGrade": { "enum": [ "_85", "_90", "_92", "_95" ], "type": "string" }, "SimpleMixArgs": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SimpleMixArgsQueryModel": { "type": "object", "properties": { "mixDesignId": { "type": "integer", "format": "int32" }, "mixCode": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SimpleMixArgsQueryModelTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgsQueryModel" }, "nullable": true } }, "additionalProperties": false }, "SimpleMixArgsTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleMixArgs" }, "nullable": true } }, "additionalProperties": false }, "SlagGrade": { "enum": [ "_80", "_100", "_120" ], "type": "string" }, "SlagProcessing": { "enum": [ "Blast", "AirCooled", "BasicOxygen", "ElectricArc" ], "type": "string" }, "SlumpUnitInput": { "enum": [ "Mm", "In" ], "type": "string" }, "SonarAlarmBreakdownResponse": { "type": "object", "properties": { "alarmCode": { "type": "integer", "format": "int32" }, "alarmName": { "type": "string", "nullable": true }, "percentage": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SonarAlarmSnoozeArgs": { "type": "object", "properties": { "reasonDetail": { "type": "string", "nullable": true }, "snoozeUntilTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "alarmReason": { "$ref": "#/components/schemas/SonarAlarmSnoozeReason" } }, "additionalProperties": false }, "SonarAlarmSnoozeReason": { "enum": [ "MaintenanceProducer", "MaintenanceCarbonCure", "PartInShipment", "Other" ], "type": "string" }, "SonarAlarmType": { "type": "object", "properties": { "alarmCode": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "systemType": { "$ref": "#/components/schemas/SonarSystemType" } }, "additionalProperties": false }, "SonarAlarmsTable": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "remoteUnitId": { "type": "integer", "format": "int32", "nullable": true }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32", "nullable": true }, "systemId": { "type": "string", "nullable": true }, "alarmId": { "type": "integer", "format": "int64" }, "technology": { "$ref": "#/components/schemas/HardwareType" }, "divisionName": { "type": "string", "nullable": true }, "divisionId": { "type": "integer", "format": "int32" }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "alarmSeverity": { "$ref": "#/components/schemas/AlarmSeverity" }, "alarmCode": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "snoozeId": { "type": "integer", "format": "int32", "nullable": true }, "snoozedUntilTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeReason": { "$ref": "#/components/schemas/SonarAlarmSnoozeReason" }, "snoozeDetails": { "type": "string", "nullable": true }, "snoozeLastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "snoozeCreatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "snoozeCreatedByUserFullName": { "type": "string", "nullable": true }, "snoozeLastUpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "snoozeLastUpdatedByUserFullName": { "type": "string", "nullable": true }, "snoozeCreationTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeStartTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeEndTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SonarAlarmsTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SonarAlarmsTable" }, "nullable": true } }, "additionalProperties": false }, "SonarCustomerFilter": { "type": "object", "properties": { "producers": { "type": "array", "items": { "$ref": "#/components/schemas/SonarProducer" }, "nullable": true }, "plants": { "type": "array", "items": { "$ref": "#/components/schemas/SonarPlant" }, "nullable": true }, "systems": { "type": "array", "items": { "$ref": "#/components/schemas/SonarSystem" }, "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cities": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SonarDownSystemTable": { "type": "object", "properties": { "lastSeenTimestamp": { "type": "string", "format": "date-time" }, "systemId": { "type": "string", "nullable": true }, "remoteUnitId": { "type": "integer", "format": "int32", "nullable": true }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32", "nullable": true }, "technologyType": { "$ref": "#/components/schemas/HardwareType" }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "snoozeId": { "type": "integer", "format": "int32", "nullable": true }, "snoozeReason": { "$ref": "#/components/schemas/SonarSystemSnoozeReason" }, "snoozeReasonDetails": { "type": "string", "nullable": true }, "snoozeStartTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeEndTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeCreationTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeCreatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "snoozeCreatedByUserFirstAndLastName": { "type": "string", "nullable": true }, "snoozeLastUpdatedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "snoozeLastUpdatedByUserId": { "type": "integer", "format": "int32", "nullable": true }, "snoozeLastUpdatedByUserFirstAndLastName": { "type": "string", "nullable": true }, "serviceCaseId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SonarDownSystemTableTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SonarDownSystemTable" }, "nullable": true } }, "additionalProperties": false }, "SonarPlant": { "type": "object", "properties": { "plantId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SonarProducer": { "type": "object", "properties": { "divisionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SonarSnoozeResponse": { "type": "object", "properties": { "snoozeId": { "type": "integer", "format": "int32" }, "remoteUnitId": { "type": "integer", "format": "int32", "nullable": true }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32", "nullable": true }, "creationTimestamp": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "integer", "format": "int32" }, "createdByUserFirstAndLastName": { "type": "string", "nullable": true }, "startTimestamp": { "type": "string", "format": "date-time" }, "endTimestamp": { "type": "string", "format": "date-time" }, "snoozeReasonDetails": { "type": "string", "nullable": true }, "resolvedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedTimestamp": { "type": "string", "format": "date-time" }, "lastUpdatedByUserId": { "type": "integer", "format": "int32" }, "lastUpdatedByUserFirstAndLastName": { "type": "string", "nullable": true }, "isResolved": { "type": "boolean", "readOnly": true }, "alarmCode": { "type": "integer", "format": "int32", "nullable": true }, "isAlarmSnooze": { "type": "boolean", "readOnly": true }, "alarmSnoozeReason": { "$ref": "#/components/schemas/SonarAlarmSnoozeReason" }, "systemSnoozeReason": { "$ref": "#/components/schemas/SonarSystemSnoozeReason" }, "serviceCaseId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SonarSystem": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32", "nullable": true }, "reclaimedWaterUnitId": { "type": "integer", "format": "int32", "nullable": true }, "systemId": { "type": "string", "nullable": true }, "workflowName": { "type": "string", "nullable": true }, "isDecommissioned": { "type": "boolean" } }, "additionalProperties": false }, "SonarSystemDownTimeRange": { "enum": [ "GreaterThan180Days", "Between30And180Days", "Between10And30Days", "LessThan10Days" ], "type": "string" }, "SonarSystemSnoozeArgs": { "type": "object", "properties": { "reasonDetail": { "type": "string", "nullable": true }, "snoozeUntilTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "systemReason": { "$ref": "#/components/schemas/SonarSystemSnoozeReason" } }, "additionalProperties": false }, "SonarSystemSnoozeReason": { "enum": [ "Seasonal", "MaintenanceProducer", "MaintenanceCarbonCure", "MaintenanceCO2Tank", "Churned", "Inactive", "Other" ], "type": "string" }, "SonarSystemSummaryResponse": { "type": "object", "properties": { "operationalPercent": { "type": "number", "format": "double" }, "operationalCount": { "type": "integer", "format": "int32" }, "downPercent": { "type": "number", "format": "double" }, "downCount": { "type": "integer", "format": "int32" }, "snoozedPercent": { "type": "number", "format": "double" }, "snoozedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SonarSystemType": { "enum": [ "Mixer", "ReclaimedWater" ], "type": "string" }, "SonarTotalAlarmsResponse": { "type": "object", "properties": { "newAlarmsLast24HoursCount": { "type": "integer", "format": "int32" }, "lastMonthDailyAverage": { "type": "number", "format": "double" }, "lastMonthDailyAverageChangePercent": { "type": "number", "format": "double", "nullable": true }, "lastQuarterDailyAverage": { "type": "number", "format": "double" }, "lastQuarterDailyAverageChangePercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SonarUptimeVsDowntimeResponse": { "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32" }, "totalSystemUpDays": { "type": "integer", "format": "int32" }, "totalSystemDownDays": { "type": "integer", "format": "int32" }, "uptimePercentage": { "type": "number", "format": "double" }, "downtimePercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SortOrder": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "StaffMembers": { "type": "object", "properties": { "technicalRepId": { "type": "integer", "format": "int32", "nullable": true }, "salesRepId": { "type": "integer", "format": "int32", "nullable": true }, "strategicAccountManagerId": { "type": "integer", "format": "int32", "nullable": true }, "installEquipmentRepId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "StaffTask": { "type": "object", "properties": { "taskType": { "$ref": "#/components/schemas/StaffTaskType" }, "isCompleted": { "type": "boolean" } }, "additionalProperties": false }, "StaffTaskType": { "enum": [ "ScheduleTankInstall", "ScheduleInstallCall", "ScheduleQCCall", "ScheduleDigitalIntegrationCall", "ShipCcSystem", "InstallCcSystem", "CreateAndReviewTestingPlan", "SetImplementationTestingDates", "ScheduleGoToMarketCall", "ObtainCO2Sources" ], "type": "string" }, "StaffUser": { "required": [ "email", "firstName", "lastName", "naiveFullName" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "email": { "minLength": 1, "type": "string" }, "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "naiveFullName": { "minLength": 1, "type": "string" }, "externalUserId": { "type": "string", "nullable": true }, "wasInviteSent": { "type": "boolean", "readOnly": true }, "jobTitle": { "type": "string", "nullable": true }, "jobField": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phone": { "type": "string", "nullable": true }, "language": { "$ref": "#/components/schemas/Language" }, "numericFormat": { "type": "string", "nullable": true }, "myCCNotificationSubscriptionsId": { "type": "integer", "format": "int32" }, "myCCNotificationSubscriptions": { "$ref": "#/components/schemas/MyCCNotificationSubscriptions" }, "allowsCookies": { "type": "boolean", "nullable": true, "readOnly": true }, "allowsFunctionalCookies": { "type": "boolean", "nullable": true }, "allowsAnalyticsCookies": { "type": "boolean", "nullable": true }, "enviroContactName": { "type": "string", "nullable": true }, "enviroContactPhone": { "type": "string", "nullable": true }, "enviroContactEmail": { "type": "string", "nullable": true }, "enviroContactWebsite": { "type": "string", "nullable": true }, "settingsChangedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "policiesAcceptedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "iconId": { "type": "integer", "format": "int32", "nullable": true }, "repType": { "type": "array", "items": { "type": "string" }, "nullable": true }, "alarmNotificationsEnabled": { "type": "boolean" }, "rwAlarmNotificationsEnabled": { "type": "boolean" }, "rwEmailNotificationEnabled": { "type": "boolean" }, "hmisWatching": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "StaffUserResponse": { "allOf": [ { "$ref": "#/components/schemas/UserResponse" }, { "type": "object", "properties": { "photoUrl": { "type": "string", "description": "For backwards compatibility until public assets are deprecated.\nRefer to IconId for asset reference instead.", "nullable": true }, "iconId": { "type": "integer", "format": "int32", "nullable": true }, "alarmNotificationsEnabled": { "type": "boolean" }, "rwAlarmNotificationsEnabled": { "type": "boolean" } }, "additionalProperties": false } ] }, "Status": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int64" }, "readyMixUnitId": { "type": "integer", "format": "int32" }, "inletLiquidPressureKPa": { "type": "number", "format": "float" }, "inletGasPressureKPa": { "type": "number", "format": "float", "nullable": true }, "upstreamTemperatureC": { "type": "number", "format": "float", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "createdTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "StatusBody": { "type": "object", "properties": { "hmiId": { "type": "integer", "format": "int32" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/MixerStatus" }, "nullable": true } }, "additionalProperties": false }, "StatusReadings": { "type": "object", "properties": { "datetime": { "type": "string", "format": "date-time" }, "tank_Level": { "type": "number", "format": "float" }, "ambient_Temp": { "type": "number", "format": "float" }, "system_Status_Indicator": { "type": "string", "nullable": true }, "cO2_Indicator": { "type": "boolean", "nullable": true }, "pump_Power_Indicator": { "type": "boolean", "nullable": true }, "httP_Error": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "StatusTableResults": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Status" }, "nullable": true } }, "additionalProperties": false }, "StrengthAverage": { "type": "object", "properties": { "cylinderCount": { "type": "integer", "format": "int32" }, "averageMpa": { "type": "number", "format": "double" } }, "additionalProperties": false }, "StrengthReadingArgs": { "type": "object", "properties": { "batchStrength": { "type": "number", "format": "double" }, "batchIntervalDay": { "type": "number", "format": "double" }, "batchIntervalHour": { "type": "number", "format": "double" }, "testNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StrengthReadingIntervalType": { "enum": [ "Days", "Hours" ], "type": "string" }, "StrengthUnitInput": { "enum": [ "MPa", "PSI" ], "type": "string" }, "SystemArgsFull": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "systemDisplayName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "installDate": { "type": "string", "format": "date", "nullable": true }, "plantProductionPercent": { "type": "number", "format": "double", "nullable": true }, "stage": { "$ref": "#/components/schemas/SystemStage" }, "batchingSoftware": { "type": "string", "nullable": true }, "averageLoadSizeM3": { "type": "number", "format": "double", "nullable": true }, "maxBatchSizeM3": { "type": "number", "format": "double", "nullable": true }, "mixerType": { "type": "string", "nullable": true }, "avgDischargeTimeSeconds": { "type": "number", "format": "double", "nullable": true }, "inputVoltage": { "type": "string", "nullable": true }, "outputVoltage": { "type": "string", "nullable": true }, "systemVoltage": { "type": "string", "nullable": true }, "ceOutputType": { "type": "string", "nullable": true }, "requiredWireLength": { "type": "string", "description": "Free input field in Salesforce. Units are specified in the string as 'm' or 'ft'.", "nullable": true }, "dischargeHoseLength": { "type": "string", "description": "Free input field in Salesforce. Units are specified in the string as 'm' or 'ft'.", "nullable": true }, "lastSavedTimestamp": { "type": "string", "description": "Timestamp of last time changes were made to the plant or any of its associated systems.", "format": "date-time", "nullable": true }, "lastSavedUserName": { "type": "string", "nullable": true }, "enums": { "$ref": "#/components/schemas/SystemSettingsEnums" }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "hasMissingInfo": { "type": "boolean" } }, "additionalProperties": false }, "SystemArgsPartial": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "systemDisplayName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "installDate": { "type": "string", "format": "date", "nullable": true }, "plantProductionPercent": { "type": "number", "format": "double", "nullable": true }, "stage": { "$ref": "#/components/schemas/SystemStage" }, "hasMissingInfo": { "type": "boolean" } }, "additionalProperties": false }, "SystemArgsShort": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "plantProductionPercent": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SystemInfoArgs": { "type": "object", "properties": { "readyMixUnitId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "workflowName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "hmiId": { "type": "integer", "format": "int32" }, "valveEnclosureSerial": { "type": "string", "nullable": true }, "airlinkIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "hmiIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "plcIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "usbLink": { "type": "string", "nullable": true, "readOnly": true }, "sdLink": { "type": "string", "nullable": true, "readOnly": true }, "ftpLink": { "type": "string", "nullable": true, "readOnly": true }, "customerSuccessName": { "type": "string", "nullable": true }, "isOperational": { "type": "boolean" }, "isDown": { "type": "boolean" }, "serial": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time" }, "latestInjectionTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "isSnoozed": { "type": "boolean" }, "snoozeReason": { "$ref": "#/components/schemas/SonarSystemSnoozeReason" }, "snoozeReasonDetails": { "type": "string", "nullable": true }, "snoozeUntilTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "internalTeam": { "type": "array", "items": { "$ref": "#/components/schemas/InternalTeamArgs" }, "nullable": true }, "productionMachineLink": { "type": "string", "nullable": true }, "orificeType": { "$ref": "#/components/schemas/OrificeType" } }, "additionalProperties": false }, "SystemInfoArgsShort": { "type": "object", "properties": { "readyMixUnitId": { "type": "integer", "format": "int32" }, "divisionId": { "type": "integer", "format": "int32" }, "divisionName": { "type": "string", "nullable": true }, "plantId": { "type": "integer", "format": "int32" }, "plantName": { "type": "string", "nullable": true }, "workflowName": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "hmiId": { "type": "integer", "format": "int32" }, "valveEnclosureSerial": { "type": "string", "nullable": true }, "airlinkIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "hmiIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "plcIpAddress": { "type": "string", "nullable": true, "readOnly": true }, "usbLink": { "type": "string", "nullable": true, "readOnly": true }, "sdLink": { "type": "string", "nullable": true, "readOnly": true }, "ftpLink": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SystemSettingsEnums": { "type": "object", "properties": { "mixerType": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "batchingSoftware": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "inputVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "outputVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "systemVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true }, "ceOutputType": { "type": "array", "items": { "$ref": "#/components/schemas/EnumValue" }, "nullable": true } }, "additionalProperties": false }, "SystemStage": { "enum": [ "Onboarding", "Paused", "Active" ], "type": "string" }, "SystemUpdateArgs": { "type": "object", "properties": { "remoteUnitId": { "type": "integer", "format": "int32" }, "systemDisplayName": { "type": "string", "nullable": true }, "serial": { "type": "string", "nullable": true }, "installDate": { "type": "string", "format": "date", "nullable": true }, "plantProductionPercent": { "type": "number", "format": "double", "nullable": true }, "stage": { "$ref": "#/components/schemas/SystemStage" }, "batchingSoftware": { "type": "string", "nullable": true }, "averageLoadSizeM3": { "type": "number", "format": "double", "nullable": true }, "maxBatchSizeM3": { "type": "number", "format": "double", "nullable": true }, "mixerType": { "type": "string", "nullable": true }, "avgDischargeTimeSeconds": { "type": "number", "format": "double", "nullable": true }, "inputVoltage": { "type": "string", "nullable": true }, "outputVoltage": { "type": "string", "nullable": true }, "systemVoltage": { "type": "string", "nullable": true }, "ceOutputType": { "type": "string", "nullable": true }, "requiredWireLength": { "type": "string", "description": "Free input field in Salesforce. Units are specified in the string as 'm' or 'ft'.", "nullable": true }, "dischargeHoseLength": { "type": "string", "description": "Free input field in Salesforce. Units are specified in the string as 'm' or 'ft'.", "nullable": true } }, "additionalProperties": false }, "TableArgs": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Limit number of responses. Used for pagination.", "format": "int32", "nullable": true }, "offset": { "type": "integer", "description": "Skip this many rows in the query. Used for pagination.", "format": "int32", "nullable": true }, "sortColumn": { "type": "string", "description": "The name of the column to sort by.", "nullable": true }, "sortOrder": { "$ref": "#/components/schemas/SortOrder" } }, "additionalProperties": false, "description": "Common fields provided by the frontend when accessing a table endpoint" }, "TableRanking": { "enum": [ "Injections", "Readings", "Statuses", "Alarms" ], "type": "string" }, "TeamResponsible": { "enum": [ "CarbonCure", "Customer", "CO2Supplier", "Contractor", "Other" ], "type": "string" }, "TestDataIntegrationArgs": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/E2EDataIntegrationType" }, "includeFailure": { "type": "boolean" } }, "additionalProperties": false }, "TestMyCCAccountArgs": { "type": "object", "properties": { "hasOnboarding": { "type": "boolean" }, "includeAccountReps": { "type": "boolean" }, "dataIntegration": { "$ref": "#/components/schemas/TestDataIntegrationArgs" }, "featureFlagNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TestSampleArgs": { "type": "object", "properties": { "intervalDays": { "type": "number", "format": "double" }, "compressiveStrengthMPa": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TestStructureArgs": { "type": "object", "properties": { "permissionGroup": { "$ref": "#/components/schemas/PermissionGroup" }, "lanes": { "type": "array", "items": { "$ref": "#/components/schemas/TestStructureLaneArgs" }, "nullable": true }, "myCCAccount": { "$ref": "#/components/schemas/TestMyCCAccountArgs" }, "email": { "type": "string", "description": "Email used to create user with. If no email is provided, a random one is generated.", "nullable": true } }, "additionalProperties": false }, "TestStructureLaneArgs": { "type": "object", "properties": { "installedTimestamp": { "type": "string", "format": "date-time" }, "grouping": { "type": "string", "nullable": true }, "productionScenario": { "$ref": "#/components/schemas/ProductionScenario" }, "batchingSoftware": { "type": "string", "nullable": true }, "lynxDownloadedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastLynxFileSeenTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "projectMixes": { "type": "array", "items": { "$ref": "#/components/schemas/E2EProjectMixArgs" }, "nullable": true } }, "additionalProperties": false }, "TimestampPrecision": { "enum": [ "Day", "Month", "Year" ], "type": "string" }, "TransportMode": { "enum": [ "Truck", "Rail", "Barge", "Plane" ], "type": "string" }, "UnitSystem": { "enum": [ "Metric", "Imperial" ], "type": "string" }, "UploadLog": { "required": [ "fileName", "uploadType" ], "type": "object", "properties": { "uploadLogId": { "type": "integer", "format": "int32" }, "fileName": { "minLength": 1, "type": "string" }, "uploadType": { "$ref": "#/components/schemas/UploadType" }, "uploader": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "corporationId": { "type": "integer", "format": "int32", "nullable": true }, "divisionId": { "type": "integer", "format": "int32", "nullable": true }, "uploadTimestamp": { "type": "string", "format": "date-time" }, "ingestionError": { "type": "string", "nullable": true }, "dataStart": { "type": "string", "format": "date-time", "nullable": true }, "dataEnd": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "mixCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UploadType": { "enum": [ "Batching", "Qc", "Calorimetry" ], "type": "string" }, "User": { "required": [ "email", "firstName", "lastName", "naiveFullName" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "email": { "minLength": 1, "type": "string" }, "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "naiveFullName": { "minLength": 1, "type": "string" }, "externalUserId": { "type": "string", "nullable": true }, "wasInviteSent": { "type": "boolean", "readOnly": true }, "jobTitle": { "type": "string", "nullable": true }, "jobField": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phone": { "type": "string", "nullable": true }, "language": { "$ref": "#/components/schemas/Language" }, "numericFormat": { "type": "string", "nullable": true }, "myCCNotificationSubscriptionsId": { "type": "integer", "format": "int32" }, "myCCNotificationSubscriptions": { "$ref": "#/components/schemas/MyCCNotificationSubscriptions" }, "allowsCookies": { "type": "boolean", "nullable": true, "readOnly": true }, "allowsFunctionalCookies": { "type": "boolean", "nullable": true }, "allowsAnalyticsCookies": { "type": "boolean", "nullable": true }, "enviroContactName": { "type": "string", "nullable": true }, "enviroContactPhone": { "type": "string", "nullable": true }, "enviroContactEmail": { "type": "string", "nullable": true }, "enviroContactWebsite": { "type": "string", "nullable": true }, "settingsChangedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "policiesAcceptedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityTimestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UserArgs": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "naiveFullName": { "type": "string", "nullable": true }, "externalUserId": { "type": "string", "nullable": true }, "wasInviteSent": { "type": "boolean" }, "isRegisteredInFusionAuth": { "type": "boolean" }, "jobTitle": { "type": "string", "nullable": true }, "jobField": { "type": "array", "items": { "type": "string" }, "nullable": true }, "phone": { "type": "string", "nullable": true }, "language": { "$ref": "#/components/schemas/Language" }, "numericFormat": { "type": "string", "nullable": true }, "allowsFunctionalCookies": { "type": "boolean", "nullable": true }, "allowsAnalyticsCookies": { "type": "boolean", "nullable": true }, "enviroContactName": { "type": "string", "nullable": true }, "enviroContactPhone": { "type": "string", "nullable": true }, "enviroContactEmail": { "type": "string", "nullable": true }, "enviroContactWebsite": { "type": "string", "nullable": true }, "settingsChangedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "policiesAcceptedTimestamp": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityTimestamp": { "type": "string", "description": "The time of the latest activity by this user in myCarbonCure", "format": "date-time", "nullable": true }, "wantsNewFeatureEmail": { "type": "boolean" }, "wantsPositionEmail": { "type": "boolean" }, "wantsTestingEmail": { "type": "boolean" }, "wantsCreditProgramEmail": { "type": "boolean" }, "notificationPreferences": { "$ref": "#/components/schemas/MyCCNotificationsResponse" } }, "additionalProperties": false }, "VariationType": { "enum": [ "Baseline", "Optimized" ], "type": "string" }, "VolumeGoalProgress": { "type": "object", "properties": { "goalProgressTodayPercent": { "type": "number", "format": "double", "nullable": true }, "goalProgressThisWeekPercent": { "type": "number", "format": "double", "nullable": true }, "goalProgressThisMonthPercent": { "type": "number", "format": "double", "nullable": true }, "totalConcreteBetweenDatesM3": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "WatchDetails": { "type": "object", "properties": { "isWatching": { "type": "boolean" } }, "additionalProperties": false }, "WaterTemperature": { "enum": [ "Hot", "Cold", "Ambient", "Ice" ], "type": "string" } }, "securitySchemes": { "OrcaAuth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.carboncure.com/oauth2/authorize", "tokenUrl": "https://auth.carboncure.com/oauth2/token", "scopes": { } } } }, "MyCCAuth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.carboncure.com/oauth2/authorize", "tokenUrl": "https://auth.carboncure.com/oauth2/token", "scopes": { } } } }, "M2MAuth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.carboncure.com/oauth2/authorize", "tokenUrl": "https://auth.carboncure.com/oauth2/token", "scopes": { } } } } } }, "tags": [ { "name": "-AuthTest-" }, { "name": "Cellular - Reclaimed Water" }, { "name": "Cellular - Recycled Concrete Aggregates" }, { "name": "Credentials" }, { "name": "CreditFiles" }, { "name": "CreditSales" }, { "name": "Dorsal" }, { "name": "Echo" }, { "name": "Engineering (Orca)" }, { "name": "InjMapping" }, { "name": "Krill" }, { "name": "MixDesign" }, { "name": "Mixer" }, { "name": "MixerData" }, { "name": "myCC - Accounts" }, { "name": "myCC - Assets" }, { "name": "myCC - Credits" }, { "name": "myCC - Dropdowns" }, { "name": "myCC - Email" }, { "name": "myCC - End To End Testing" }, { "name": "myCC - Estimates" }, { "name": "myCC - FeatureFlags" }, { "name": "myCC - Lanes" }, { "name": "myCC - Mix Designs" }, { "name": "myCC - MyData" }, { "name": "myCC - Onboarding" }, { "name": "myCC - Plants" }, { "name": "myCC - ProgessBanner" }, { "name": "myCC - Reports" }, { "name": "myCC - Users" }, { "name": "Orca - FeatureFlags" }, { "name": "Profitability" }, { "name": "Public" }, { "name": "RcaData" }, { "name": "ReclaimedWaterData" }, { "name": "ServiceCases" }, { "name": "Sonar" }, { "name": "TSS - Cement Plants" }, { "name": "TSS - Customer Management" }, { "name": "TSS - Divisions" }, { "name": "TSS - Material Manager" }, { "name": "TSS - Mix Designs" }, { "name": "TSS - QC Data" }, { "name": "TSS - Reports" } ] }