Skip to content

List Inspection Points

List inspection points and their detection settings by point criteria.

  • Name: List inspection points
  • Description: Returns matching inspection points in pages.
  • Method: POST
  • Path: remoteApi/pointPage
  • Login required: No
  • Permission required: Yes

ParameterTypeRequiredExampleDescription
pointCodeStringNoP01,P02One or more point codes, separated by commas
dogCodeStringNoDOG001Unique robot identifier
pageNoIntegerNo1Page number; defaults to 1
pageSizeIntegerNo10Page size; defaults to 10 and cannot exceed 100

Example:

{
"pointCode": "16000,A1_12",
"dogCode": "DOG2011258510273380352",
"pageNo": 1,
"pageSize": 10
}
FieldTypeExampleDescription
areaCodeStringa001_2Area code
areaNameStringBasement test siteArea name
intervalCodeStringa001_3Bay code
intervalNameString35 kV busbar section IIIBay name
deviceCodeStringa001_14Main device code
deviceNameString35 kV busbar section III capacitorMain device name
componentCodeStringa001_15Component code
componentNameStringDisconnectorComponent name
pointCodeStringa001_16Point code
pointNameString35 kV busbar section III capacitor disconnector statusPoint name
deviceTypeStringDevice type
recognitionTypeStringRecognition type
phaseStringThree-phase identifier
phaseGroupIdStringThree-phase group identifier
dogCodeString001Code of the associated robot
dockCodeStringa001_2Dock code
floorStringa001Floor

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
}
}
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error