Sensor Resource

Get Sensor

HTTP Request

GET /api/sensors/{id}

📋 Description: Fetches detailed information about a specific sensor identified by its unique ID, enabling users to monitor and manage sensor data effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

SensorDTO

Example Responses

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "displayId": "string",
  6  "name": "string",
  7  "imageId": 0,
  8  "description": "string",
  9  "measurementType": "string",
 10  "measurementFrequency": "string",
 11  "sensorSourceId": 0,
 12  "sensorSourceName": "string",
 13  "sensorTypeId": 0,
 14  "sensorTypeName": "string",
 15  "sensorScaleId": 0,
 16  "sensorScaleName": "string",
 17  "assetId": 0,
 18  "assetName": "string",
 19  "mainAssetDto": {
 20    "id": 0,
 21    "createdBy": "string",
 22    "createdAt": "2019-08-24T14:15:22Z",
 23    "displayId": "string",
 24    "name": "string",
 25    "description": "string",
 26    "qrCode": "string",
 27    "barCode": "string",
 28    "imageId": 0,
 29    "model": "string",
 30    "manufacturer": "string",
 31    "serialNumber": "string",
 32    "cost": "81.08",
 33    "premiseId": 0,
 34    "premiseDisplayId": "string",
 35    "premiseDto": {
 36      "id": 0,
 37      "createdBy": "string",
 38      "createdAt": "2019-08-24T14:15:22Z",
 39      "displayId": "string",
 40      "premiseName": "string",
 41      "description": "string",
 42      "address": "string",
 43      "internalTeamNames": [
 44        "string"
 45      ],
 46      "internalTeamIds": [
 47        0
 48      ],
 49      "premiseAvailable": true,
 50      "premiseFromNrm": true,
 51      "nlmId": 0,
 52      "nlmDisplayId": "string",
 53      "nlmUsed": true,
 54      "manager": 0,
 55      "managerName": "string",
 56      "imageId": 0,
 57      "area": "string",
 58      "modifiedAt": "2019-08-24T14:15:22Z"
 59    },
 60    "acquisitionDate": "2019-08-24",
 61    "endOfLife": "2019-08-24",
 62    "assetStatusId": 0,
 63    "assetStatus": "string",
 64    "assetStatusType": "string",
 65    "parentAssetId": 0,
 66    "parentAssetDisplayId": "string",
 67    "parentAsset": "string",
 68    "parentAssetDto": {},
 69    "upcomingMaintenanceDate": "2019-08-24",
 70    "assetCategoryIds": [
 71      0
 72    ],
 73    "assetCategories": [
 74      "string"
 75    ],
 76    "internalTeamIds": [
 77      0
 78    ],
 79    "internalTeamDtos": [
 80      {
 81        "id": 0,
 82        "createdBy": "string",
 83        "createdAt": "2019-08-24T14:15:22Z",
 84        "displayId": "string",
 85        "name": "string",
 86        "email": "string",
 87        "phone": "string",
 88        "manager": "string",
 89        "requestCategoryName": [
 90          "string"
 91        ],
 92        "requestCategoryId": [
 93          0
 94        ],
 95        "requestCategoryDisplayId": [
 96          "string"
 97        ],
 98        "description": "string",
 99        "internalTeamUser": [
100          0
101        ],
102        "members": 0,
103        "mainAssets": [
104          0
105        ],
106        "premiseNames": [
107          "string"
108        ],
109        "internalTeamAvailable": true,
110        "premiseIds": [
111          0
112        ]
113      }
114    ],
115    "internalTeams": [
116      "string"
117    ],
118    "assignedUserIds": [
119      0
120    ],
121    "assignedUserDtos": [
122      {
123        "id": 0,
124        "createdBy": "string",
125        "createdAt": "2019-08-24T14:15:22Z",
126        "userName": "string",
127        "firstName": "string",
128        "lastName": "string",
129        "email": "string",
130        "roleIds": [
131          {
132            "id": 0,
133            "createdBy": "string",
134            "createdAt": "2019-08-24T14:15:22Z",
135            "modifiedBy": "string",
136            "modifiedAt": "2019-08-24T14:15:22Z",
137            "roleName": "string",
138            "entity": "string",
139            "new": true
140          }
141        ],
142        "internalTeamNames": [
143          "string"
144        ],
145        "internalTeamIds": [
146          0
147        ],
148        "internalTeamDisplayIds": [
149          "string"
150        ],
151        "premiseIds": [
152          0
153        ],
154        "premiseNames": [
155          "string"
156        ],
157        "userAvailable": true,
158        "temporaryWorkload": 0,
159        "preferredCultureCode": "string"
160      }
161    ],
162    "assignedUsers": [
163      "string"
164    ],
165    "assetPriority": "string",
166    "assetPriorityId": 0,
167    "assetPriorityDisplayId": "string",
168    "assetPriorityType": "string",
169    "assetAvailable": true,
170    "exactPlacement": "string",
171    "fosId": 0,
172    "downtimeStatus": "string",
173    "premiseFromNrm": true,
174    "modifiedAt": "2019-08-24T14:15:22Z"
175  },
176  "premiseId": 0,
177  "premiseName": "string",
178  "premiseDto": {
179    "id": 0,
180    "createdBy": "string",
181    "createdAt": "2019-08-24T14:15:22Z",
182    "displayId": "string",
183    "premiseName": "string",
184    "description": "string",
185    "address": "string",
186    "internalTeamNames": [
187      "string"
188    ],
189    "internalTeamIds": [
190      0
191    ],
192    "premiseAvailable": true,
193    "premiseFromNrm": true,
194    "nlmId": 0,
195    "nlmDisplayId": "string",
196    "nlmUsed": true,
197    "manager": 0,
198    "managerName": "string",
199    "imageId": 0,
200    "area": "string",
201    "modifiedAt": "2019-08-24T14:15:22Z"
202  },
203  "sensorAvailable": true,
204  "modifiedAt": "2019-08-24T14:15:22Z"
205}

Update Sensor

HTTP Request

PUT /api/sensors/{id}

📋 Description: Updates the configuration and status of a specific sensor identified by its unique ID, ensuring that the sensor operates according to the latest business requirements.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

SensorDTO

true

Request body containing the updated sensor configuration data, including parameters such as name, type, and operational status, to ensure accurate monitoring and management of sensor performance.

Body Parameters

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "displayId": "string",
  6  "name": "string",
  7  "imageId": 0,
  8  "description": "string",
  9  "measurementType": "string",
 10  "measurementFrequency": "string",
 11  "sensorSourceId": 0,
 12  "sensorSourceName": "string",
 13  "sensorTypeId": 0,
 14  "sensorTypeName": "string",
 15  "sensorScaleId": 0,
 16  "sensorScaleName": "string",
 17  "assetId": 0,
 18  "assetName": "string",
 19  "mainAssetDto": {
 20    "id": 0,
 21    "createdBy": "string",
 22    "createdAt": "2019-08-24T14:15:22Z",
 23    "displayId": "string",
 24    "name": "string",
 25    "description": "string",
 26    "qrCode": "string",
 27    "barCode": "string",
 28    "imageId": 0,
 29    "model": "string",
 30    "manufacturer": "string",
 31    "serialNumber": "string",
 32    "cost": "81.08",
 33    "premiseId": 0,
 34    "premiseDisplayId": "string",
 35    "premiseDto": {
 36      "id": 0,
 37      "createdBy": "string",
 38      "createdAt": "2019-08-24T14:15:22Z",
 39      "displayId": "string",
 40      "premiseName": "string",
 41      "description": "string",
 42      "address": "string",
 43      "internalTeamNames": [
 44        "string"
 45      ],
 46      "internalTeamIds": [
 47        0
 48      ],
 49      "premiseAvailable": true,
 50      "premiseFromNrm": true,
 51      "nlmId": 0,
 52      "nlmDisplayId": "string",
 53      "nlmUsed": true,
 54      "manager": 0,
 55      "managerName": "string",
 56      "imageId": 0,
 57      "area": "string",
 58      "modifiedAt": "2019-08-24T14:15:22Z"
 59    },
 60    "acquisitionDate": "2019-08-24",
 61    "endOfLife": "2019-08-24",
 62    "assetStatusId": 0,
 63    "assetStatus": "string",
 64    "assetStatusType": "string",
 65    "parentAssetId": 0,
 66    "parentAssetDisplayId": "string",
 67    "parentAsset": "string",
 68    "parentAssetDto": {},
 69    "upcomingMaintenanceDate": "2019-08-24",
 70    "assetCategoryIds": [
 71      0
 72    ],
 73    "assetCategories": [
 74      "string"
 75    ],
 76    "internalTeamIds": [
 77      0
 78    ],
 79    "internalTeamDtos": [
 80      {
 81        "id": 0,
 82        "createdBy": "string",
 83        "createdAt": "2019-08-24T14:15:22Z",
 84        "displayId": "string",
 85        "name": "string",
 86        "email": "string",
 87        "phone": "string",
 88        "manager": "string",
 89        "requestCategoryName": [
 90          "string"
 91        ],
 92        "requestCategoryId": [
 93          0
 94        ],
 95        "requestCategoryDisplayId": [
 96          "string"
 97        ],
 98        "description": "string",
 99        "internalTeamUser": [
100          0
101        ],
102        "members": 0,
103        "mainAssets": [
104          0
105        ],
106        "premiseNames": [
107          "string"
108        ],
109        "internalTeamAvailable": true,
110        "premiseIds": [
111          0
112        ]
113      }
114    ],
115    "internalTeams": [
116      "string"
117    ],
118    "assignedUserIds": [
119      0
120    ],
121    "assignedUserDtos": [
122      {
123        "id": 0,
124        "createdBy": "string",
125        "createdAt": "2019-08-24T14:15:22Z",
126        "userName": "string",
127        "firstName": "string",
128        "lastName": "string",
129        "email": "string",
130        "roleIds": [
131          {
132            "id": 0,
133            "createdBy": "string",
134            "createdAt": "2019-08-24T14:15:22Z",
135            "modifiedBy": "string",
136            "modifiedAt": "2019-08-24T14:15:22Z",
137            "roleName": "string",
138            "entity": "string",
139            "new": true
140          }
141        ],
142        "internalTeamNames": [
143          "string"
144        ],
145        "internalTeamIds": [
146          0
147        ],
148        "internalTeamDisplayIds": [
149          "string"
150        ],
151        "premiseIds": [
152          0
153        ],
154        "premiseNames": [
155          "string"
156        ],
157        "userAvailable": true,
158        "temporaryWorkload": 0,
159        "preferredCultureCode": "string"
160      }
161    ],
162    "assignedUsers": [
163      "string"
164    ],
165    "assetPriority": "string",
166    "assetPriorityId": 0,
167    "assetPriorityDisplayId": "string",
168    "assetPriorityType": "string",
169    "assetAvailable": true,
170    "exactPlacement": "string",
171    "fosId": 0,
172    "downtimeStatus": "string",
173    "premiseFromNrm": true,
174    "modifiedAt": "2019-08-24T14:15:22Z"
175  },
176  "premiseId": 0,
177  "premiseName": "string",
178  "premiseDto": {
179    "id": 0,
180    "createdBy": "string",
181    "createdAt": "2019-08-24T14:15:22Z",
182    "displayId": "string",
183    "premiseName": "string",
184    "description": "string",
185    "address": "string",
186    "internalTeamNames": [
187      "string"
188    ],
189    "internalTeamIds": [
190      0
191    ],
192    "premiseAvailable": true,
193    "premiseFromNrm": true,
194    "nlmId": 0,
195    "nlmDisplayId": "string",
196    "nlmUsed": true,
197    "manager": 0,
198    "managerName": "string",
199    "imageId": 0,
200    "area": "string",
201    "modifiedAt": "2019-08-24T14:15:22Z"
202  },
203  "sensorAvailable": true,
204  "modifiedAt": "2019-08-24T14:15:22Z"
205}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Delete Sensor

HTTP Request

DELETE /api/sensors/{id}

📋 Description: Deletes a specified sensor from the system, ensuring that outdated or unnecessary data is removed to maintain optimal operational efficiency.

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 Sensors

HTTP Request

GET /api/sensors

📋 Description: Retrieves a list of all registered sensors, providing essential data for monitoring and analysis within your operational environment.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

  1[
  2  {
  3    "id": 0,
  4    "createdBy": "string",
  5    "createdAt": "2019-08-24T14:15:22Z",
  6    "displayId": "string",
  7    "name": "string",
  8    "imageId": 0,
  9    "description": "string",
 10    "measurementType": "string",
 11    "measurementFrequency": "string",
 12    "sensorSourceId": 0,
 13    "sensorSourceName": "string",
 14    "sensorTypeId": 0,
 15    "sensorTypeName": "string",
 16    "sensorScaleId": 0,
 17    "sensorScaleName": "string",
 18    "assetId": 0,
 19    "assetName": "string",
 20    "mainAssetDto": {
 21      "id": 0,
 22      "createdBy": "string",
 23      "createdAt": "2019-08-24T14:15:22Z",
 24      "displayId": "string",
 25      "name": "string",
 26      "description": "string",
 27      "qrCode": "string",
 28      "barCode": "string",
 29      "imageId": 0,
 30      "model": "string",
 31      "manufacturer": "string",
 32      "serialNumber": "string",
 33      "cost": "81.08",
 34      "premiseId": 0,
 35      "premiseDisplayId": "string",
 36      "premiseDto": {
 37        "id": 0,
 38        "createdBy": "string",
 39        "createdAt": "2019-08-24T14:15:22Z",
 40        "displayId": "string",
 41        "premiseName": "string",
 42        "description": "string",
 43        "address": "string",
 44        "internalTeamNames": [
 45          "string"
 46        ],
 47        "internalTeamIds": [
 48          0
 49        ],
 50        "premiseAvailable": true,
 51        "premiseFromNrm": true,
 52        "nlmId": 0,
 53        "nlmDisplayId": "string",
 54        "nlmUsed": true,
 55        "manager": 0,
 56        "managerName": "string",
 57        "imageId": 0,
 58        "area": "string",
 59        "modifiedAt": "2019-08-24T14:15:22Z"
 60      },
 61      "acquisitionDate": "2019-08-24",
 62      "endOfLife": "2019-08-24",
 63      "assetStatusId": 0,
 64      "assetStatus": "string",
 65      "assetStatusType": "string",
 66      "parentAssetId": 0,
 67      "parentAssetDisplayId": "string",
 68      "parentAsset": "string",
 69      "parentAssetDto": {},
 70      "upcomingMaintenanceDate": "2019-08-24",
 71      "assetCategoryIds": [
 72        0
 73      ],
 74      "assetCategories": [
 75        "string"
 76      ],
 77      "internalTeamIds": [
 78        0
 79      ],
 80      "internalTeamDtos": [
 81        {
 82          "id": 0,
 83          "createdBy": "string",
 84          "createdAt": "2019-08-24T14:15:22Z",
 85          "displayId": "string",
 86          "name": "string",
 87          "email": "string",
 88          "phone": "string",
 89          "manager": "string",
 90          "requestCategoryName": [
 91            "string"
 92          ],
 93          "requestCategoryId": [
 94            0
 95          ],
 96          "requestCategoryDisplayId": [
 97            "string"
 98          ],
 99          "description": "string",
100          "internalTeamUser": [
101            0
102          ],
103          "members": 0,
104          "mainAssets": [
105            0
106          ],
107          "premiseNames": [
108            "string"
109          ],
110          "internalTeamAvailable": true,
111          "premiseIds": [
112            0
113          ]
114        }
115      ],
116      "internalTeams": [
117        "string"
118      ],
119      "assignedUserIds": [
120        0
121      ],
122      "assignedUserDtos": [
123        {
124          "id": 0,
125          "createdBy": "string",
126          "createdAt": "2019-08-24T14:15:22Z",
127          "userName": "string",
128          "firstName": "string",
129          "lastName": "string",
130          "email": "string",
131          "roleIds": [
132            {
133              "id": 0,
134              "createdBy": "string",
135              "createdAt": "2019-08-24T14:15:22Z",
136              "modifiedBy": "string",
137              "modifiedAt": "2019-08-24T14:15:22Z",
138              "roleName": "string",
139              "entity": "string",
140              "new": true
141            }
142          ],
143          "internalTeamNames": [
144            "string"
145          ],
146          "internalTeamIds": [
147            0
148          ],
149          "internalTeamDisplayIds": [
150            "string"
151          ],
152          "premiseIds": [
153            0
154          ],
155          "premiseNames": [
156            "string"
157          ],
158          "userAvailable": true,
159          "temporaryWorkload": 0,
160          "preferredCultureCode": "string"
161        }
162      ],
163      "assignedUsers": [
164        "string"
165      ],
166      "assetPriority": "string",
167      "assetPriorityId": 0,
168      "assetPriorityDisplayId": "string",
169      "assetPriorityType": "string",
170      "assetAvailable": true,
171      "exactPlacement": "string",
172      "fosId": 0,
173      "downtimeStatus": "string",
174      "premiseFromNrm": true,
175      "modifiedAt": "2019-08-24T14:15:22Z"
176    },
177    "premiseId": 0,
178    "premiseName": "string",
179    "premiseDto": {
180      "id": 0,
181      "createdBy": "string",
182      "createdAt": "2019-08-24T14:15:22Z",
183      "displayId": "string",
184      "premiseName": "string",
185      "description": "string",
186      "address": "string",
187      "internalTeamNames": [
188        "string"
189      ],
190      "internalTeamIds": [
191        0
192      ],
193      "premiseAvailable": true,
194      "premiseFromNrm": true,
195      "nlmId": 0,
196      "nlmDisplayId": "string",
197      "nlmUsed": true,
198      "manager": 0,
199      "managerName": "string",
200      "imageId": 0,
201      "area": "string",
202      "modifiedAt": "2019-08-24T14:15:22Z"
203    },
204    "sensorAvailable": true,
205    "modifiedAt": "2019-08-24T14:15:22Z"
206  }
207]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[SensorDTO]

false

none

[Data transfer object representing a sensor’s attributes and operational data, facilitating real-time monitoring and analysis for enhanced decision-making in enterprise environments.]

» 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

false

none

Name of the resource

» imageId

integer(int64)

false

none

Unique identifier for the image

» description

string

false

none

Description of the resource

» measurementType

string

false

none

Type of the measurement

» measurementFrequency

string

false

none

Specifies the frequency at which sensor measurements are taken, enabling effective monitoring and analysis of data trends.

» sensorSourceId

integer(int64)

false

none

Unique identifier for the sensor source

» sensorSourceName

string

false

none

Name of the sensor source

» sensorTypeId

integer(int64)

false

none

Unique identifier for the sensor type

» sensorTypeName

string

false

none

Name of the sensor type

» sensorScaleId

integer(int64)

false

none

Unique identifier for the sensor scale

» sensorScaleName

string

false

none

Name of the sensor scale

» assetId

integer(int64)

false

none

Unique identifier for the asset

» assetName

string

false

none

Name of the asset

» mainAssetDto

MainAssetDTO

false

none

MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.

»» 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

false

none

Name of the resource

»» description

string

false

none

Description of the resource

»» qrCode

string

false

none

Code for the qr

»» barCode

string

false

none

Code for the bar

»» imageId

integer(int64)

false

none

Unique identifier for the image

»» model

string

false

none

Specifies the model associated with the main asset, providing essential context for asset classification and management.

»» manufacturer

string

false

none

Name of the manufacturer associated with the asset, providing essential information for inventory management and supplier relations.

»» serialNumber

string

false

none

Unique identifier for the asset, used to track and manage inventory within the system.

»» cost

string

false

none

Represents the total cost associated with the main asset, providing essential financial information for budgeting and resource allocation.

»» premiseId

integer(int64)

false

none

Unique identifier for the premise

»» premiseDisplayId

string

false

none

Unique identifier for the premise display

»» premiseDto

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.

»»» 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

»»» premiseName

string

false

none

Name of the premise

»»» description

string

false

none

Description of the resource

»»» address

string

true

none

Represents the physical location associated with the premise, essential for logistics and service delivery.

»»» internalTeamNames

[string]

false

none

List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization.

»»» internalTeamIds

[integer]

false

none

List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation.

»»» premiseAvailable

boolean

false

none

Indicates whether the premise is available for use within the specified context.

»»» premiseFromNrm

boolean

false

none

Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes.

»»» nlmId

integer(int64)

false

none

Unique identifier for the nlm

»»» nlmDisplayId

string

false

none

Unique identifier for the nlm display

»»» nlmUsed

boolean

false

none

Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process.

»»» manager

integer(int64)

false

none

Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management.

»»» managerName

string

false

none

Name of the manager

»»» imageId

integer(int64)

false

none

Unique identifier for the image

»»» area

string

false

none

Represents the geographic area associated with the premise, providing essential context for location-based services and analysis.

»»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»» acquisitionDate

string(date)

false

none

Date of the acquisition

»» endOfLife

string(date)

false

none

Indicates the end-of-life date for the asset, providing critical information for lifecycle management and planning.

»» assetStatusId

integer(int64)

false

none

Unique identifier for the asset status

»» assetStatus

string

false

none

Status of the asset

»» assetStatusType

string

false

none

Type of the asset status

»» parentAssetId

integer(int64)

false

none

Unique identifier for the parent asset

»» parentAssetDisplayId

string

false

none

Unique identifier for the parent asset display

»» parentAsset

string

false

none

Identifier for the parent asset associated with the main asset, facilitating hierarchical relationships within asset management.

»» parentAssetDto

MainAssetDTO

false

none

MainAssetDTO is a data transfer object that encapsulates key information about a primary asset within the organization, including its attributes, status, and associated metadata, facilitating effective asset management and decision-making.

»» upcomingMaintenanceDate

string(date)

false

none

Date of the upcoming maintenance

»» assetCategoryIds

[integer]

false

none

Array of unique identifiers representing the categories to which the asset belongs, facilitating effective asset classification and management.

»» assetCategories

[string]

false

none

Array of asset categories that classify the main assets within the system, facilitating better organization and management of asset data.

»» internalTeamIds

[integer]

false

none

Array of unique identifiers representing the internal teams associated with the main asset, facilitating streamlined collaboration and resource allocation.

»» internalTeamDtos

[InternalTeamDTO]

false

none

An array of MainAssetDTO objects representing the internal teams associated with the asset, facilitating effective resource management and collaboration within the organization.

»»» 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

false

none

Name of the resource

»»» email

string

false

none

Email address of the internal team member, used for communication and notifications within the organization.

»»» phone

string

false

none

Contact number for the internal team, facilitating communication and collaboration within the organization.

»»» manager

string

false

none

Represents the name or identifier of the team manager responsible for overseeing the internal team.

»»» requestCategoryName

[string]

false

none

Name of the request category

»»» requestCategoryId

[integer]

false

none

Unique identifier for the request category

»»» requestCategoryDisplayId

[string]

false

none

Unique identifier for the request category display

»»» description

string

false

none

Description of the resource

»»» internalTeamUser

[integer]

false

none

An array of InternalTeamDTO objects representing the users within the internal team, facilitating collaboration and resource management.

»»» members

integer(int32)

false

none

Represents the total number of members within the internal team, providing insight into team size for resource allocation and management.

»»» mainAssets

[integer]

false

none

An array of internal team assets that represent the key resources and capabilities utilized within the organization.

»»» premiseNames

[string]

false

none

List of names associated with the premises relevant to the internal team, facilitating efficient identification and management of locations within the organization.

»»» internalTeamAvailable

boolean

false

none

Indicates the availability of the internal team for project allocation and resource planning.

»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the internal team.

»» internalTeams

[string]

false

none

An array of internal teams associated with the main asset, facilitating collaboration and resource allocation within the organization.

»» assignedUserIds

[integer]

false

none

Array of unique identifiers representing users assigned to the main asset, facilitating effective resource management and accountability.

»» assignedUserDtos

[UserDTO]

false

none

Array of user assignments associated with the main asset, providing insights into resource allocation and accountability.

»»» 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

»»» userName

string

false

none

Name of the user

»»» firstName

string

false

none

Name of the first

»»» lastName

string

false

none

Name of the last

»»» email

string

false

none

Email address of the user, used for communication and account verification purposes within the system.

»»» roleIds

[Role]

false

none

Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system.

»»»» 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

»»»» modifiedBy

string

false

none

Username of who last modified this resource

»»»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

»»»» roleName

string

false

none

Name of the role

»»»» entity

string

false

none

Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management.

»»»» new

boolean

false

none

Indicates whether the role is newly created within the system, facilitating effective management of organizational changes.

»»» internalTeamNames

[string]

false

none

List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization.

»»» internalTeamIds

[integer]

false

none

An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization.

»»» internalTeamDisplayIds

[string]

false

none

An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration.

»»» premiseIds

[integer]

false

none

Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations.

»»» premiseNames

[string]

false

none

List of names associated with the user’s premises, providing essential context for location-based services and operations.

»»» userAvailable

boolean

false

none

Indicates whether the user is available for assignment or engagement within the system.

»»» temporaryWorkload

integer(int32)

false

none

Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning.

»»» preferredCultureCode

string

false

none

Code for the preferred culture

»» assignedUsers

[string]

false

none

List of users assigned to the main asset, facilitating effective resource management and collaboration within the organization.

»» assetPriority

string

false

none

Priority of the asset

»» assetPriorityId

integer(int64)

false

none

Unique identifier for the asset priority

»» assetPriorityDisplayId

string

false

none

Unique identifier for the asset priority display

»» assetPriorityType

string

false

none

Type of the asset priority

»» assetAvailable

boolean

false

none

Indicates whether the asset is currently available for allocation or use within the system.

»» exactPlacement

string

false

none

Specifies the precise location or context in which the main asset is intended to be utilized within the business framework.

»» fosId

integer(int64)

false

none

Unique identifier for the fos

»» downtimeStatus

string

false

none

Status of the downtime

»» premiseFromNrm

boolean

false

none

Indicates whether the asset is sourced from the National Resource Management (NRM) framework, facilitating compliance and resource tracking.

»» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

» premiseId

integer(int64)

false

none

Unique identifier for the premise

» premiseName

string

false

none

Name of the premise

» premiseDto

PremiseDTO

false

none

Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning.

» sensorAvailable

boolean

false

none

Indicates the availability status of the sensor, enabling efficient resource management and operational decision-making.

» modifiedAt

string(date-time)

false

none

Timestamp when this resource was last modified

Create Sensor

HTTP Request

POST /api/sensors

📋 Description: Creates a new sensor entry in the system, enabling the tracking and management of sensor data for enhanced operational insights.

Parameters

Name

In

Type

Required

Description

body

body

SensorDTO

true

Request body containing the sensor configuration data, including parameters such as type, location, and operational settings necessary for effective monitoring.

Body Parameters

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "displayId": "string",
  6  "name": "string",
  7  "imageId": 0,
  8  "description": "string",
  9  "measurementType": "string",
 10  "measurementFrequency": "string",
 11  "sensorSourceId": 0,
 12  "sensorSourceName": "string",
 13  "sensorTypeId": 0,
 14  "sensorTypeName": "string",
 15  "sensorScaleId": 0,
 16  "sensorScaleName": "string",
 17  "assetId": 0,
 18  "assetName": "string",
 19  "mainAssetDto": {
 20    "id": 0,
 21    "createdBy": "string",
 22    "createdAt": "2019-08-24T14:15:22Z",
 23    "displayId": "string",
 24    "name": "string",
 25    "description": "string",
 26    "qrCode": "string",
 27    "barCode": "string",
 28    "imageId": 0,
 29    "model": "string",
 30    "manufacturer": "string",
 31    "serialNumber": "string",
 32    "cost": "81.08",
 33    "premiseId": 0,
 34    "premiseDisplayId": "string",
 35    "premiseDto": {
 36      "id": 0,
 37      "createdBy": "string",
 38      "createdAt": "2019-08-24T14:15:22Z",
 39      "displayId": "string",
 40      "premiseName": "string",
 41      "description": "string",
 42      "address": "string",
 43      "internalTeamNames": [
 44        "string"
 45      ],
 46      "internalTeamIds": [
 47        0
 48      ],
 49      "premiseAvailable": true,
 50      "premiseFromNrm": true,
 51      "nlmId": 0,
 52      "nlmDisplayId": "string",
 53      "nlmUsed": true,
 54      "manager": 0,
 55      "managerName": "string",
 56      "imageId": 0,
 57      "area": "string",
 58      "modifiedAt": "2019-08-24T14:15:22Z"
 59    },
 60    "acquisitionDate": "2019-08-24",
 61    "endOfLife": "2019-08-24",
 62    "assetStatusId": 0,
 63    "assetStatus": "string",
 64    "assetStatusType": "string",
 65    "parentAssetId": 0,
 66    "parentAssetDisplayId": "string",
 67    "parentAsset": "string",
 68    "parentAssetDto": {},
 69    "upcomingMaintenanceDate": "2019-08-24",
 70    "assetCategoryIds": [
 71      0
 72    ],
 73    "assetCategories": [
 74      "string"
 75    ],
 76    "internalTeamIds": [
 77      0
 78    ],
 79    "internalTeamDtos": [
 80      {
 81        "id": 0,
 82        "createdBy": "string",
 83        "createdAt": "2019-08-24T14:15:22Z",
 84        "displayId": "string",
 85        "name": "string",
 86        "email": "string",
 87        "phone": "string",
 88        "manager": "string",
 89        "requestCategoryName": [
 90          "string"
 91        ],
 92        "requestCategoryId": [
 93          0
 94        ],
 95        "requestCategoryDisplayId": [
 96          "string"
 97        ],
 98        "description": "string",
 99        "internalTeamUser": [
100          0
101        ],
102        "members": 0,
103        "mainAssets": [
104          0
105        ],
106        "premiseNames": [
107          "string"
108        ],
109        "internalTeamAvailable": true,
110        "premiseIds": [
111          0
112        ]
113      }
114    ],
115    "internalTeams": [
116      "string"
117    ],
118    "assignedUserIds": [
119      0
120    ],
121    "assignedUserDtos": [
122      {
123        "id": 0,
124        "createdBy": "string",
125        "createdAt": "2019-08-24T14:15:22Z",
126        "userName": "string",
127        "firstName": "string",
128        "lastName": "string",
129        "email": "string",
130        "roleIds": [
131          {
132            "id": 0,
133            "createdBy": "string",
134            "createdAt": "2019-08-24T14:15:22Z",
135            "modifiedBy": "string",
136            "modifiedAt": "2019-08-24T14:15:22Z",
137            "roleName": "string",
138            "entity": "string",
139            "new": true
140          }
141        ],
142        "internalTeamNames": [
143          "string"
144        ],
145        "internalTeamIds": [
146          0
147        ],
148        "internalTeamDisplayIds": [
149          "string"
150        ],
151        "premiseIds": [
152          0
153        ],
154        "premiseNames": [
155          "string"
156        ],
157        "userAvailable": true,
158        "temporaryWorkload": 0,
159        "preferredCultureCode": "string"
160      }
161    ],
162    "assignedUsers": [
163      "string"
164    ],
165    "assetPriority": "string",
166    "assetPriorityId": 0,
167    "assetPriorityDisplayId": "string",
168    "assetPriorityType": "string",
169    "assetAvailable": true,
170    "exactPlacement": "string",
171    "fosId": 0,
172    "downtimeStatus": "string",
173    "premiseFromNrm": true,
174    "modifiedAt": "2019-08-24T14:15:22Z"
175  },
176  "premiseId": 0,
177  "premiseName": "string",
178  "premiseDto": {
179    "id": 0,
180    "createdBy": "string",
181    "createdAt": "2019-08-24T14:15:22Z",
182    "displayId": "string",
183    "premiseName": "string",
184    "description": "string",
185    "address": "string",
186    "internalTeamNames": [
187      "string"
188    ],
189    "internalTeamIds": [
190      0
191    ],
192    "premiseAvailable": true,
193    "premiseFromNrm": true,
194    "nlmId": 0,
195    "nlmDisplayId": "string",
196    "nlmUsed": true,
197    "manager": 0,
198    "managerName": "string",
199    "imageId": 0,
200    "area": "string",
201    "modifiedAt": "2019-08-24T14:15:22Z"
202  },
203  "sensorAvailable": true,
204  "modifiedAt": "2019-08-24T14:15:22Z"
205}

Responses

Status

Meaning

Description

Schema

201

Created

Created

SensorDTO

Example Responses

  1{
  2  "id": 0,
  3  "createdBy": "string",
  4  "createdAt": "2019-08-24T14:15:22Z",
  5  "displayId": "string",
  6  "name": "string",
  7  "imageId": 0,
  8  "description": "string",
  9  "measurementType": "string",
 10  "measurementFrequency": "string",
 11  "sensorSourceId": 0,
 12  "sensorSourceName": "string",
 13  "sensorTypeId": 0,
 14  "sensorTypeName": "string",
 15  "sensorScaleId": 0,
 16  "sensorScaleName": "string",
 17  "assetId": 0,
 18  "assetName": "string",
 19  "mainAssetDto": {
 20    "id": 0,
 21    "createdBy": "string",
 22    "createdAt": "2019-08-24T14:15:22Z",
 23    "displayId": "string",
 24    "name": "string",
 25    "description": "string",
 26    "qrCode": "string",
 27    "barCode": "string",
 28    "imageId": 0,
 29    "model": "string",
 30    "manufacturer": "string",
 31    "serialNumber": "string",
 32    "cost": "81.08",
 33    "premiseId": 0,
 34    "premiseDisplayId": "string",
 35    "premiseDto": {
 36      "id": 0,
 37      "createdBy": "string",
 38      "createdAt": "2019-08-24T14:15:22Z",
 39      "displayId": "string",
 40      "premiseName": "string",
 41      "description": "string",
 42      "address": "string",
 43      "internalTeamNames": [
 44        "string"
 45      ],
 46      "internalTeamIds": [
 47        0
 48      ],
 49      "premiseAvailable": true,
 50      "premiseFromNrm": true,
 51      "nlmId": 0,
 52      "nlmDisplayId": "string",
 53      "nlmUsed": true,
 54      "manager": 0,
 55      "managerName": "string",
 56      "imageId": 0,
 57      "area": "string",
 58      "modifiedAt": "2019-08-24T14:15:22Z"
 59    },
 60    "acquisitionDate": "2019-08-24",
 61    "endOfLife": "2019-08-24",
 62    "assetStatusId": 0,
 63    "assetStatus": "string",
 64    "assetStatusType": "string",
 65    "parentAssetId": 0,
 66    "parentAssetDisplayId": "string",
 67    "parentAsset": "string",
 68    "parentAssetDto": {},
 69    "upcomingMaintenanceDate": "2019-08-24",
 70    "assetCategoryIds": [
 71      0
 72    ],
 73    "assetCategories": [
 74      "string"
 75    ],
 76    "internalTeamIds": [
 77      0
 78    ],
 79    "internalTeamDtos": [
 80      {
 81        "id": 0,
 82        "createdBy": "string",
 83        "createdAt": "2019-08-24T14:15:22Z",
 84        "displayId": "string",
 85        "name": "string",
 86        "email": "string",
 87        "phone": "string",
 88        "manager": "string",
 89        "requestCategoryName": [
 90          "string"
 91        ],
 92        "requestCategoryId": [
 93          0
 94        ],
 95        "requestCategoryDisplayId": [
 96          "string"
 97        ],
 98        "description": "string",
 99        "internalTeamUser": [
100          0
101        ],
102        "members": 0,
103        "mainAssets": [
104          0
105        ],
106        "premiseNames": [
107          "string"
108        ],
109        "internalTeamAvailable": true,
110        "premiseIds": [
111          0
112        ]
113      }
114    ],
115    "internalTeams": [
116      "string"
117    ],
118    "assignedUserIds": [
119      0
120    ],
121    "assignedUserDtos": [
122      {
123        "id": 0,
124        "createdBy": "string",
125        "createdAt": "2019-08-24T14:15:22Z",
126        "userName": "string",
127        "firstName": "string",
128        "lastName": "string",
129        "email": "string",
130        "roleIds": [
131          {
132            "id": 0,
133            "createdBy": "string",
134            "createdAt": "2019-08-24T14:15:22Z",
135            "modifiedBy": "string",
136            "modifiedAt": "2019-08-24T14:15:22Z",
137            "roleName": "string",
138            "entity": "string",
139            "new": true
140          }
141        ],
142        "internalTeamNames": [
143          "string"
144        ],
145        "internalTeamIds": [
146          0
147        ],
148        "internalTeamDisplayIds": [
149          "string"
150        ],
151        "premiseIds": [
152          0
153        ],
154        "premiseNames": [
155          "string"
156        ],
157        "userAvailable": true,
158        "temporaryWorkload": 0,
159        "preferredCultureCode": "string"
160      }
161    ],
162    "assignedUsers": [
163      "string"
164    ],
165    "assetPriority": "string",
166    "assetPriorityId": 0,
167    "assetPriorityDisplayId": "string",
168    "assetPriorityType": "string",
169    "assetAvailable": true,
170    "exactPlacement": "string",
171    "fosId": 0,
172    "downtimeStatus": "string",
173    "premiseFromNrm": true,
174    "modifiedAt": "2019-08-24T14:15:22Z"
175  },
176  "premiseId": 0,
177  "premiseName": "string",
178  "premiseDto": {
179    "id": 0,
180    "createdBy": "string",
181    "createdAt": "2019-08-24T14:15:22Z",
182    "displayId": "string",
183    "premiseName": "string",
184    "description": "string",
185    "address": "string",
186    "internalTeamNames": [
187      "string"
188    ],
189    "internalTeamIds": [
190      0
191    ],
192    "premiseAvailable": true,
193    "premiseFromNrm": true,
194    "nlmId": 0,
195    "nlmDisplayId": "string",
196    "nlmUsed": true,
197    "manager": 0,
198    "managerName": "string",
199    "imageId": 0,
200    "area": "string",
201    "modifiedAt": "2019-08-24T14:15:22Z"
202  },
203  "sensorAvailable": true,
204  "modifiedAt": "2019-08-24T14:15:22Z"
205}

Find Sensor

HTTP Request

POST /api/sensors/search

📋 Description: Submits a search query to locate specific sensors within the system, enabling efficient asset management and monitoring.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the search results for sensors should be returned in a paginated format, enhancing the efficiency of data retrieval.

body

body

SensorDtoFilter

true

Request body containing search criteria and filters for retrieving sensor data based on specified parameters.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idNotIn": [
 6    0
 7  ],
 8  "displayIdLike": "string",
 9  "nameLike": "string",
10  "measurementTypeLike": "string",
11  "measurementFrequencyLike": "string",
12  "sensorSourceNameLike": "string",
13  "sensorTypeNameLike": "string",
14  "sensorScaleNameLike": "string",
15  "sensorAvailable": true,
16  "attachToAssetIdIn": [
17    0
18  ],
19  "attachToPremiseIdIn": [
20    0
21  ]
22}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageSensorDTO

Example Responses

  1{
  2  "totalPages": 0,
  3  "totalElements": 0,
  4  "pageable": {
  5    "paged": true,
  6    "unpaged": true,
  7    "pageNumber": 0,
  8    "pageSize": 0,
  9    "offset": 0,
 10    "sort": {
 11      "unsorted": true,
 12      "sorted": true,
 13      "empty": true
 14    }
 15  },
 16  "numberOfElements": 0,
 17  "first": true,
 18  "last": true,
 19  "size": 0,
 20  "content": [
 21    {
 22      "id": 0,
 23      "createdBy": "string",
 24      "createdAt": "2019-08-24T14:15:22Z",
 25      "displayId": "string",
 26      "name": "string",
 27      "imageId": 0,
 28      "description": "string",
 29      "measurementType": "string",
 30      "measurementFrequency": "string",
 31      "sensorSourceId": 0,
 32      "sensorSourceName": "string",
 33      "sensorTypeId": 0,
 34      "sensorTypeName": "string",
 35      "sensorScaleId": 0,
 36      "sensorScaleName": "string",
 37      "assetId": 0,
 38      "assetName": "string",
 39      "mainAssetDto": {
 40        "id": 0,
 41        "createdBy": "string",
 42        "createdAt": "2019-08-24T14:15:22Z",
 43        "displayId": "string",
 44        "name": "string",
 45        "description": "string",
 46        "qrCode": "string",
 47        "barCode": "string",
 48        "imageId": 0,
 49        "model": "string",
 50        "manufacturer": "string",
 51        "serialNumber": "string",
 52        "cost": "81.08",
 53        "premiseId": 0,
 54        "premiseDisplayId": "string",
 55        "premiseDto": {
 56          "id": 0,
 57          "createdBy": "string",
 58          "createdAt": "2019-08-24T14:15:22Z",
 59          "displayId": "string",
 60          "premiseName": "string",
 61          "description": "string",
 62          "address": "string",
 63          "internalTeamNames": [
 64            "string"
 65          ],
 66          "internalTeamIds": [
 67            0
 68          ],
 69          "premiseAvailable": true,
 70          "premiseFromNrm": true,
 71          "nlmId": 0,
 72          "nlmDisplayId": "string",
 73          "nlmUsed": true,
 74          "manager": 0,
 75          "managerName": "string",
 76          "imageId": 0,
 77          "area": "string",
 78          "modifiedAt": "2019-08-24T14:15:22Z"
 79        },
 80        "acquisitionDate": "2019-08-24",
 81        "endOfLife": "2019-08-24",
 82        "assetStatusId": 0,
 83        "assetStatus": "string",
 84        "assetStatusType": "string",
 85        "parentAssetId": 0,
 86        "parentAssetDisplayId": "string",
 87        "parentAsset": "string",
 88        "parentAssetDto": {},
 89        "upcomingMaintenanceDate": "2019-08-24",
 90        "assetCategoryIds": [
 91          0
 92        ],
 93        "assetCategories": [
 94          "string"
 95        ],
 96        "internalTeamIds": [
 97          0
 98        ],
 99        "internalTeamDtos": [
100          {
101            "id": 0,
102            "createdBy": "string",
103            "createdAt": "2019-08-24T14:15:22Z",
104            "displayId": "string",
105            "name": "string",
106            "email": "string",
107            "phone": "string",
108            "manager": "string",
109            "requestCategoryName": [
110              "string"
111            ],
112            "requestCategoryId": [
113              0
114            ],
115            "requestCategoryDisplayId": [
116              "string"
117            ],
118            "description": "string",
119            "internalTeamUser": [
120              0
121            ],
122            "members": 0,
123            "mainAssets": [
124              0
125            ],
126            "premiseNames": [
127              "string"
128            ],
129            "internalTeamAvailable": true,
130            "premiseIds": [
131              0
132            ]
133          }
134        ],
135        "internalTeams": [
136          "string"
137        ],
138        "assignedUserIds": [
139          0
140        ],
141        "assignedUserDtos": [
142          {
143            "id": 0,
144            "createdBy": "string",
145            "createdAt": "2019-08-24T14:15:22Z",
146            "userName": "string",
147            "firstName": "string",
148            "lastName": "string",
149            "email": "string",
150            "roleIds": [
151              {
152                "id": 0,
153                "createdBy": "string",
154                "createdAt": "2019-08-24T14:15:22Z",
155                "modifiedBy": "string",
156                "modifiedAt": "2019-08-24T14:15:22Z",
157                "roleName": "string",
158                "entity": "string",
159                "new": true
160              }
161            ],
162            "internalTeamNames": [
163              "string"
164            ],
165            "internalTeamIds": [
166              0
167            ],
168            "internalTeamDisplayIds": [
169              "string"
170            ],
171            "premiseIds": [
172              0
173            ],
174            "premiseNames": [
175              "string"
176            ],
177            "userAvailable": true,
178            "temporaryWorkload": 0,
179            "preferredCultureCode": "string"
180          }
181        ],
182        "assignedUsers": [
183          "string"
184        ],
185        "assetPriority": "string",
186        "assetPriorityId": 0,
187        "assetPriorityDisplayId": "string",
188        "assetPriorityType": "string",
189        "assetAvailable": true,
190        "exactPlacement": "string",
191        "fosId": 0,
192        "downtimeStatus": "string",
193        "premiseFromNrm": true,
194        "modifiedAt": "2019-08-24T14:15:22Z"
195      },
196      "premiseId": 0,
197      "premiseName": "string",
198      "premiseDto": {
199        "id": 0,
200        "createdBy": "string",
201        "createdAt": "2019-08-24T14:15:22Z",
202        "displayId": "string",
203        "premiseName": "string",
204        "description": "string",
205        "address": "string",
206        "internalTeamNames": [
207          "string"
208        ],
209        "internalTeamIds": [
210          0
211        ],
212        "premiseAvailable": true,
213        "premiseFromNrm": true,
214        "nlmId": 0,
215        "nlmDisplayId": "string",
216        "nlmUsed": true,
217        "manager": 0,
218        "managerName": "string",
219        "imageId": 0,
220        "area": "string",
221        "modifiedAt": "2019-08-24T14:15:22Z"
222      },
223      "sensorAvailable": true,
224      "modifiedAt": "2019-08-24T14:15:22Z"
225    }
226  ],
227  "number": 0,
228  "sort": {
229    "unsorted": true,
230    "sorted": true,
231    "empty": true
232  },
233  "empty": true
234}

Get All Documents By Sensor

HTTP Request

GET /api/sensors/{id}/documents

📋 Description: Retrieves documents associated with a specific sensor identified by the provided ID, enabling users to access relevant data for analysis and decision-making.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "createdBy": "string",
 5    "createdAt": "2019-08-24T14:15:22Z",
 6    "name": "string",
 7    "contentType": "string",
 8    "documentTypeName": "string",
 9    "documentTypeId": 0,
10    "description": "string",
11    "data": "string",
12    "startDate": "2019-08-24",
13    "endDate": "2019-08-24",
14    "documentStatusId": 0,
15    "documentStatus": "string",
16    "documentStatusType": "string",
17    "parentEntityId": 0,
18    "link": "string",
19    "parentEntityName": "string"
20  }
21]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[DocumentDTO]

false

none

[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.]

» 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

» name

string

false

none

Name of the resource

» contentType

string

false

none

Type of the content

» documentTypeName

string

false

none

Name of the document type

» documentTypeId

integer(int64)

false

none

Unique identifier for the document type

» description

string

false

none

Description of the resource

» data

string(byte)

false

none

Contains the primary content of the document, providing essential information relevant to the associated business process.

» startDate

string(date)

false

none

Start date of the resource

» endDate

string(date)

false

none

End date of the resource

» documentStatusId

integer(int64)

false

none

Unique identifier for the document status

» documentStatus

string

false

none

Status of the document

» documentStatusType

string

false

none

Type of the document status

» parentEntityId

integer(int64)

true

none

Unique identifier for the parent entity

» link

string

false

none

URL reference to the associated document, facilitating easy access and retrieval within the system.

» parentEntityName

string

true

none

Name of the parent entity

Get Sensor Measurement Types

HTTP Request

GET /api/sensors/measurementTypes

📋 Description: Retrieves a list of available measurement types for sensors, enabling users to understand the data metrics that can be collected and analyzed within the system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema

Get Sensor Measurement Frequencies

HTTP Request

GET /api/sensors/measurementFrequencies

📋 Description: Retrieves the available measurement frequencies for sensors, enabling users to understand and select appropriate data collection intervals for enhanced monitoring and analysis.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "string"
3]

Response Schema