Sensor Source Resource¶

Get Sensor Source¶

HTTP Request

GET /api/sensorSource/{id}

📋 Description: Retrieves detailed information about a specific sensor source identified by the unique {id}, enabling users to access critical data for monitoring and analysis.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	SensorSourceDTO

Example Responses

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

Update Sensor Source¶

HTTP Request

PUT /api/sensorSource/{id}

📋 Description: Updates the details of a specific sensor source 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	SensorSourceDTO	true	Request body containing the updated sensor source information, including configuration settings and metadata, to ensure accurate data collection and reporting.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

1{}

Response Schema

Delete Sensor Source¶

HTTP Request

DELETE /api/sensorSource/{id}

📋 Description: Deletes a specified sensor source identified by its unique ID, ensuring the removal of associated data from the system to maintain data integrity and streamline operations.

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 Source¶

HTTP Request

GET /api/sensorSource

📋 Description: Fetches a list of available sensor sources, providing essential data for monitoring and analysis within your operational environment.

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",
    "isDefault": true,
    "objectAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SensorSourceDTO]	false	none	[Data transfer object representing a sensor source, encapsulating essential details such as identification, type, and operational status, to facilitate effective monitoring and management within IoT 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
» isDefault	boolean	false	none	Whether the resource is default
» objectAvailable	boolean	false	none	Indicates whether the sensor source is currently available for data collection.

Create Sensor Source¶

HTTP Request

POST /api/sensorSource

📋 Description: Creates a new sensor source entry in the system, enabling the integration of sensor data for enhanced monitoring and analytics.

Parameters

Name	In	Type	Required	Description
body	body	SensorSourceDTO	true	Request body containing the sensor source configuration data, including parameters for sensor type, location, and operational settings.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

1{}