List Inspection Points
List inspection points and their detection settings by point criteria.
Endpoint Information
Section titled “Endpoint Information”- Name: List inspection points
- Description: Returns matching inspection points in pages.
- Method:
POST - Path:
remoteApi/pointPage - Login required: No
- Permission required: Yes
Request Parameters
Section titled “Request Parameters”| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| pointCode | String | No | P01,P02 | One or more point codes, separated by commas |
| dogCode | String | No | DOG001 | Unique robot identifier |
| pageNo | Integer | No | 1 | Page number; defaults to 1 |
| pageSize | Integer | No | 10 | Page size; defaults to 10 and cannot exceed 100 |
Example:
{ "pointCode": "16000,A1_12", "dogCode": "DOG2011258510273380352", "pageNo": 1, "pageSize": 10}Response
Section titled “Response”| Field | Type | Example | Description |
|---|---|---|---|
| areaCode | String | a001_2 | Area code |
| areaName | String | Basement test site | Area name |
| intervalCode | String | a001_3 | Bay code |
| intervalName | String | 35 kV busbar section III | Bay name |
| deviceCode | String | a001_14 | Main device code |
| deviceName | String | 35 kV busbar section III capacitor | Main device name |
| componentCode | String | a001_15 | Component code |
| componentName | String | Disconnector | Component name |
| pointCode | String | a001_16 | Point code |
| pointName | String | 35 kV busbar section III capacitor disconnector status | Point name |
| deviceType | String | Device type | |
| recognitionType | String | Recognition type | |
| phase | String | Three-phase identifier | |
| phaseGroupId | String | Three-phase group identifier | |
| dogCode | String | 001 | Code of the associated robot |
| dockCode | String | a001_2 | Dock code |
| floor | String | a001 | Floor |
Example:
{ "success": true, "code": 200, "msg": "Operation succeeded", "data": { "records": [ { "areaCode": "A1_2", "areaName": "Basement test site", "intervalCode": "A1_3", "intervalName": "35 kV busbar section III", "deviceCode": "A1_10", "deviceName": "35 kV busbar section III capacitor", "componentCode": "A1_11", "componentName": "Switchgear cabinet", "pointCode": "A1_12", "pointName": "High-voltage pressure plate", "deviceType": "5", "recognitionType": "1", "phase": "", "phaseGroupId": null, "dogCode": "DOG2011258510273380352", "dockCode": "A1_2", "floor": "A1" } ], "total": 1, "size": 10, "current": 1, "pages": 1 }}Error Codes
Section titled “Error Codes”| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 401 | Unauthorized |
| 403 | Access denied |
| 404 | Resource not found |
| 500 | Internal server error |