Get a Task Template

Get the complete template configuration by task template code.

Endpoint Information

Name: Get a task template by code
Description: Returns the task template identified by a task code.
Method: POST
Path: remoteApi/taskModelByCode
Login required: No
Permission required: Yes

Request Parameters

Parameter	Type	Required	Example	Description
taskCode	String	Yes		Task-template code

Request Example

{
  "taskCode": "2019672257034543104"
}

Response

Basic Information

Field / Type	Description and Example
`taskCode` `String`	Task-template code Example: `1993623196131729408`
`taskName` `String`	Task name Example: `Infrared only`
`executeType` `Integer`	Execution type: `1` immediate, `2` scheduled, `3` recurring, `4` interval-based
`patrolType` `String`	Inspection type: `1` routine, `2` special, `3` focused, `4` custom Example: `1`
`pointCodes` `String`	Comma-separated inspection-point codes Example: `a001_19,a001_21,a001_22`
`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 Example: `1`
`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 Example: `2025-11-26 18:09:44`
`isEnable` `String`	Whether enabled: `0` no, `1` yes Example: `1`

Scheduled Execution

Field / Type	Description and Example
`fixedStartTime` `String`	Scheduled-task start time (`yyyy-MM-dd HH:mm:ss`)

Recurring Execution

Field / Type	Description and Example
`cycleMonth` `String`	Recurring months
`cycleWeek` `String`	Recurring weekdays
`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`)

Interval Execution

Field / Type	Description and Example
`intervalNumber` `Integer`	Number of interval units Example: `1`
`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`)

Blackout Periods

Field / Type	Description 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`)

Other Status Fields

Field / Type	Description 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`

Response Example

{
  "success": true,
  "code": 200,
  "msg": "Operation succeeded",
  "data": {
    "taskCode": "2019672257034543104",
    "taskName": "zz_Interval",
    "executeType": 4,
    "patrolType": "1",
    "pointCodes": "A1_12",
    "pointCount": 1,
    "dogCode": "DOG2011258510273380352",
    "priority": 1,
    "endAction": "1",
    "deviceLevel": 3,
    "createTime": "2026-02-06 15:19:24",
    "isEnable": "1",
    "fixedStartTime": null,
    "cycleMonth": "",
    "cycleWeek": "",
    "cycleExecuteTime": null,
    "cycleStartTime": null,
    "cycleEndTime": null,
    "intervalNumber": 2,
    "intervalType": 1,
    "intervalExecuteTime": "16:27:59",
    "intervalStartTime": "2025-12-01 00:00:00",
    "intervalEndTime": "2026-01-03 00:00:00",
    "invalidStartTime": "2025-12-04 00:00:00",
    "invalidEndTime": "2026-01-06 23:59:59",
    "invalidDailyStartTime": "19:30:16",
    "invalidDailyEndTime": "23:28:25",
    "repeatable": "1",
    "stationName": "Station XX",
    "planTimeContent": "Run every 2 hours starting at 16:27:59 between 2025-12-01 00:00:00 and 2026-01-03 00:00:00; unavailable period: 2025-12-04 00:00:00 to 2026-01-06 23:59:59."
  }
}

Error Codes

Code	Description
400	Invalid parameters
401	Unauthorized
403	Access denied
404	Resource not found
500	Internal server error