Sensor Scale Resource¶

Get Sensor Scale¶

HTTP Request

GET /api/sensorScale/{id}

📋 Description: Retrieves detailed information about a specific sensor scale identified by the unique ID, enabling effective monitoring and management of sensor performance within the enterprise.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	SensorScaleDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Update Sensor Scale¶

HTTP Request

PUT /api/sensorScale/{id}

📋 Description: Updates the details of a specific sensor scale identified by its unique ID, enabling businesses to maintain accurate and current sensor configurations.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	SensorScaleDTO	true	Request body containing the updated sensor scale configuration data, including parameters for calibration and operational thresholds.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

1{}

Response Schema

Delete Sensor Scale¶

HTTP Request

DELETE /api/sensorScale/{id}

📋 Description: Deletes a specific sensor scale identified by its unique ID, ensuring the removal of obsolete or unnecessary data from the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

Get All Sensor Scale¶

HTTP Request

GET /api/sensorScale

📋 Description: Retrieves the current data from the sensor scale, providing insights into operational metrics for enhanced decision-making and resource management.

Parameters

Name	In	Type	Required	Description
isAvailable	query	boolean	false	Whether the resource is available

Default Values¶

Parameter	Default	Type
isAvailable	`false`	query

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "objectAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SensorScaleDTO]	false	none	[Data transfer object representing the specifications and measurements of a sensor scale, facilitating accurate data collection and analysis for operational efficiency in various business applications.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» displayId	string	false	none	Unique identifier for the display
» name	string	true	none	Name of the resource
» objectAvailable	boolean	false	none	Indicates whether the sensor scale is currently available for use in the system.

Create Sensor Scale¶

HTTP Request

POST /api/sensorScale

📋 Description: Creates a new sensor scale entry in the system, enabling accurate measurement and monitoring of sensor data for enhanced operational efficiency.

Parameters

Name	In	Type	Required	Description
body	body	SensorScaleDTO	true	Request body containing the sensor scale configuration data, including parameters for calibration and operational settings.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "objectAvailable": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

1{}