Skip to content

List Task Templates

List task templates and their basic information by filter criteria.

  • Name: List task templates
  • Description: Returns a paginated list of task templates.
  • Method: POST
  • Path: remoteApi/modelPage
  • Login required: No
  • Permission required: Yes

  • dogCode · String · Optional

    Robot code
    Example: 001

  • priority · String · Optional

    Priority

  • taskName · String · Optional

    Task name

  • patrolType · String · Optional

    Inspection type: 1 routine, 2 special, 3 focused, 4 custom

  • isEnable · Integer · Optional

    Enabled status: 1 enabled, 0 disabled

  • pageNo · Integer · Optional

    Page number

  • pageSize · Integer · Optional

    Page size

{
"dogCode": "DOG2011258510273380352",
"priority": 1,
"taskName": "zz_Routine Inspection",
"patrolType": 1,
"isEnable": 1,
"pageNo": 1,
"pageSize": 15
}
Field / TypeDescription and Example
taskCode
String
Task-template code
taskName
String
Task name
Example: Infrared inspection task
executeType
Integer
Execution type: 1 immediate, 2 scheduled, 3 recurring, 4 interval-based
Example: 1
patrolType
String
Inspection type: 1 routine, 2 special, 3 focused, 4 custom
Example: 1
pointCodes
String
Comma-separated inspection-point codes
Example: a001_1,a001_2
pointCount
Integer
Number of inspection points
Example: 3
dogCode
String
Code of the robot that performs the inspection
Example: 1
priority
Integer
Priority: 1 lowest, 2, 3, 4 highest
endAction
String
Action after completion: 1 return to charge automatically, 2 remain in place
Example: 1
deviceLevel
Integer
Device level: 0 area, 1 bay, 2 primary device, 3 point, 4 component
Example: 3
createTime
String
Creation time (yyyy-MM-dd HH:mm:ss)
isEnable
String
Whether enabled: 0 no, 1 yes
Example: 1
Field / TypeDescription and Example
fixedStartTime
String
Scheduled start time, used when executeType=2 (yyyy-MM-dd HH:mm:ss)
Field / TypeDescription and Example
cycleMonth
String
Months in a recurring schedule, separated by commas
Example: 1,2,5
cycleWeek
String
Weekdays in a recurring schedule, separated by commas
Example: 1,3,5
cycleExecuteTime
String
Time of day for recurring execution (HH:mm:ss)
cycleStartTime
String
Start of the recurrence period (yyyy-MM-dd HH:mm:ss)
cycleEndTime
String
End of the recurrence period (yyyy-MM-dd HH:mm:ss)
Field / TypeDescription and Example
intervalNumber
Integer
Number of interval units
Example: 2
intervalType
Integer
Interval unit: 1 hours, 2 days, 3 minutes
Example: 1
intervalExecuteTime
String
Time of day for interval execution (HH:mm:ss)
intervalStartTime
String
Start of the interval schedule (yyyy-MM-dd HH:mm:ss)
intervalEndTime
String
End of the interval schedule (yyyy-MM-dd HH:mm:ss)
Field / TypeDescription and Example
invalidStartTime
String
Start of the blackout period (yyyy-MM-dd HH:mm:ss)
invalidEndTime
String
End of the blackout period (yyyy-MM-dd HH:mm:ss)
invalidDailyStartTime
String
Start of the daily blackout period (HH:mm:ss)
invalidDailyEndTime
String
End of the daily blackout period (HH:mm:ss)
Field / TypeDescription and Example
repeatable
String
Whether the template can be issued: 0 no, 1 yes
Example: 1
stationName
String
Station name
Example: Deep Robotics
planTimeContent
String
Human-readable schedule description
Example: No execution schedule
{
"success": true,
"code": 200,
"msg": "Operation succeeded",
"data": {
"records": [
{
"taskCode": "2019670807659241472",
"taskName": "zz_Routine Inspection - Scheduled",
"executeType": 2,
"patrolType": "1",
"pointCodes": "A1_12",
"pointCount": 1,
"dogCode": "DOG2011258510273380352",
"priority": 1,
"endAction": "1",
"deviceLevel": 3,
"createTime": "2026-02-06 15:13:39",
"isEnable": "1",
"fixedStartTime": "2025-12-02 16:00:00",
"cycleMonth": "",
"cycleWeek": "",
"cycleExecuteTime": null,
"cycleStartTime": null,
"cycleEndTime": null,
"intervalNumber": 1,
"intervalType": 1,
"intervalExecuteTime": null,
"intervalStartTime": null,
"intervalEndTime": null,
"invalidStartTime": "2026-01-01 00:00:00",
"invalidEndTime": "2026-01-02 23:59:59",
"invalidDailyStartTime": "",
"invalidDailyEndTime": "",
"repeatable": "1",
"stationName": "Station XX",
"planTimeContent": "Execute at 2025-12-02 16:00:00"
},
{
"taskCode": "2019670654235795456",
"taskName": "zz_Routine Inspection - Scheduled",
"executeType": 2,
"patrolType": "1",
"pointCodes": "A1_12",
"pointCount": 1,
"dogCode": "DOG2011258510273380352",
"priority": 1,
"endAction": "1",
"deviceLevel": 3,
"createTime": "2026-02-06 15:13:02",
"isEnable": "1",
"fixedStartTime": "2025-12-02 16:00:00",
"cycleMonth": "",
"cycleWeek": "",
"cycleExecuteTime": null,
"cycleStartTime": null,
"cycleEndTime": null,
"intervalNumber": 1,
"intervalType": 1,
"intervalExecuteTime": null,
"intervalStartTime": null,
"intervalEndTime": null,
"invalidStartTime": "2026-01-01 00:00:00",
"invalidEndTime": "2026-01-02 23:59:59",
"invalidDailyStartTime": "",
"invalidDailyEndTime": "",
"repeatable": "1",
"stationName": "Station XX",
"planTimeContent": "Execute at 2025-12-02 16:00:00"
},
{
"taskCode": "2019669643853127680",
"taskName": "zz_Routine Inspection 1",
"executeType": null,
"patrolType": "1",
"pointCodes": "A1_12",
"pointCount": 1,
"dogCode": "DOG2011258510273380352",
"priority": 1,
"endAction": "1",
"deviceLevel": 3,
"createTime": "2026-02-06 15:08:59",
"isEnable": "1",
"fixedStartTime": null,
"cycleMonth": "",
"cycleWeek": "",
"cycleExecuteTime": null,
"cycleStartTime": null,
"cycleEndTime": null,
"intervalNumber": 1,
"intervalType": 1,
"intervalExecuteTime": null,
"intervalStartTime": null,
"intervalEndTime": null,
"invalidStartTime": null,
"invalidEndTime": null,
"invalidDailyStartTime": "",
"invalidDailyEndTime": "",
"repeatable": "1",
"stationName": "Station XX",
"planTimeContent": "No Execution Plan"
}
],
"total": 3,
"size": 15,
"current": 1,
"pages": 1
}
}
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error