跳转到内容

清单

清单是供技术人员遵循的提醒或待办事项列表

属性

id （长整型）
唯一标识符，用于标识清单

id （长整型）
唯一标识符，用于标识清单

示例 

234759602834500

名称 （字符串）
清单的名称

名称 （字符串）
清单的名称

示例 

Sample Content

checklistitems （checklist_item）
与此清单关联的清单项列表。最多可添加25个项目。

checklistitems （checklist_item）
包含清单项集合

示例 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

描述 （字符串）
清单描述

描述 （字符串）
清单的简要描述

示例 

Sample Content

checklist_template （checklist_template）
用于关联现有的清单模板 

checklist_template （checklist_template）
用于关联现有的清单模板 

示例 

{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "id": "100000000000041001"
  }
}

创建者 （用户）read only
指示创建清单的用户

创建者 （用户）
包含创建清单的用户详细信息

示例 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

更多属性 全部展开

创建时间 （日期时间）read only

指示清单创建的时间

创建时间 （日期时间）
清单创建的时间戳

示例 

{"created_time":{"display_value":"Feb 25, 2026 10:30 AM","value":"1772098200000"}}

状态 （布尔型）read only

指示清单是否已完成

状态 （布尔型）
指示清单是否已完成

添加清单

此操作有助于将新清单添加到请求中。支持批量添加。

必填字段：- name，checklistitems

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists

属性

id （长整型）
唯一标识符，用于标识清单

id （长整型）
唯一标识符，用于标识清单

示例 

234759602834500

名称 （字符串）
清单的名称

名称 （字符串）
清单的名称

示例 

Sample Content

checklistitems （checklist_item）
与此清单关联的清单项列表。最多可添加25个项目。

checklistitems （checklist_item）
包含清单项集合

示例 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

描述 （字符串）
清单描述

描述 （字符串）
清单的简要描述

示例 

Sample Content

checklist_template （checklist_template）
用于关联现有的清单模板 

checklist_template （checklist_template）
用于关联现有的清单模板 

示例 

{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "id": "100000000000041001"
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "checklist": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:11 PM",
            "value": "1772012483981"
        },
        "pending_for_workflow_execution": null,
        "name": "PreDeployment Checklists",
        "description": "Checklists before deployment",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check network connectivity",
                    "id": "3000000076293",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076295",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Review deployment plan",
                    "id": "3000000076297",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076307",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check Disk Space",
                    "id": "3000000076309",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076317",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test backup procedures",
                    "id": "3000000076319",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076329",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076283",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",

            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "status": false
    }
}

编辑清单

此操作有助于更新现有的检查清单

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}

属性

id （长整型）
唯一标识符，用于标识清单

id （长整型）
唯一标识符，用于标识清单

示例 

234759602834500

名称 （字符串）
清单的名称

名称 （字符串）
清单的名称

示例 

Sample Content

checklistitems （checklist_item）
与此清单关联的清单项列表。最多可添加25个项目。

checklistitems （checklist_item）
包含清单项集合

示例 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

描述 （字符串）
清单描述

描述 （字符串）
清单的简要描述

示例 

Sample Content


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "checklist": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "checklist": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:11 PM",
            "value": "1772012483981"
        },
        "pending_for_workflow_execution": null,
        "name": "PreDeployment Checklist",
        "description": "Checklists before deployment update",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check network connectivity",
                    "id": "3000000076293",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076295",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check Disk Space",
                    "id": "3000000076309",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076317",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Review deployment plan",
                    "id": "3000000076297",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076307",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test backup procedures",
                    "id": "3000000076319",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076329",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076283",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",

            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "status": false
    }
}

获取清单

此操作有助于获取与请求关联的单个检查清单

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}

属性

id （长整型）
唯一标识符，用于标识清单

id （长整型）
唯一标识符，用于标识清单

示例 

234759602834500

名称 （字符串）
清单的名称

名称 （字符串）
清单的名称

示例 

Sample Content

checklistitems （checklist_item）
与此清单关联的清单项列表。最多可添加25个项目。

checklistitems （checklist_item）
包含清单项集合

示例 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

描述 （字符串）
清单描述

描述 （字符串）
清单的简要描述

示例 

Sample Content

创建者 （用户）read only
指示创建清单的用户

创建者 （用户）
包含创建清单的用户详细信息

示例 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

创建时间 （日期时间）read only
指示清单创建的时间

创建时间 （日期时间）
清单创建的时间戳

示例 

{"created_time":{"display_value":"Feb 25, 2026 10:30 AM","value":"1772098200000"}}

更多属性 全部展开

状态 （布尔型）read only

指示清单是否已完成

状态 （布尔型）
指示清单是否已完成

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "checklist": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:01 PM",
            "value": "1772011864931"
        },
        "pending_for_workflow_execution": null,
        "name": "Server Maintenance Checklists",
        "description": "Checklist for routine server maintenance",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076275",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076277",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Disk space usage  %",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076279",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Monitor CPU and memory usage %",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076281",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076265",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",

            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "status": false
    }
}

获取清单列表

此操作有助于获取与请求关联的所有检查清单列表

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists

属性

id （长整型）
唯一标识符，用于标识清单

id （长整型）
唯一标识符，用于标识清单

示例 

234759602834500

名称 （字符串）
清单的名称

名称 （字符串）
清单的名称

示例 

Sample Content

checklistitems （checklist_item）
与此清单关联的清单项列表。最多可添加25个项目。

checklistitems （checklist_item）
包含清单项集合

示例 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

描述 （字符串）
清单描述

描述 （字符串）
清单的简要描述

示例 

Sample Content

创建者 （用户）read only
指示创建清单的用户

创建者 （用户）
包含创建清单的用户详细信息

示例 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

状态 （布尔型）read only
指示清单是否已完成

状态 （布尔型）
指示清单是否已完成

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "checklists": [
        {
            "pending_for_workflow_execution": null,
            "name": "Checklist 1",
            "description": null,
            "id": "3000000076067",
            "created_by": {
                "email_id": "caffrey@zmail.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": "",
                "last_name": "",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "3000000007884",
                    "is_default": true
                },
                "phone": "",
                "employee_id": null,
                "name": "Tech 0",
                "id": "3000000065477",

                "is_vip_user": false,
                "department": null,
                "first_name": "Tech 0",
                "job_title": null
            },
            "status": false
        },
        {
            "pending_for_workflow_execution": null,
            "name": "Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076265",
            "created_by": {
                "email_id": "caffrey@zmail.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": "",
                "last_name": "",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "3000000007884",
                    "is_default": true
                },
                "phone": "",
                "employee_id": null,
                "name": "Tech 0",
                "id": "3000000065477",

                "is_vip_user": false,
                "department": null,
                "first_name": "Tech 0",
                "job_title": null
            },
            "status": false
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "sort_fields": [
            {
                "field": "id",
                "order": "asc"
            }
        ],
        "has_more_rows": false,
        "start_index": 1,
        "total_count": 2,
        "page": 1,
        "get_total_count": "true",
        "row_count": 2
    }
}

删除清单

此操作有助于从请求中删除检查清单。支持批量操作

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}