Skip to content

Checklist Item

An individual item within a checklist that represents a specific action

Attributes

id (long)
Unique identifier to identify the checklist item

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

item (item_detail)
Indicates the item detail associated with this checklist item

item (item_detail)
Contains the details of the item

Example 

{
  "item": {
    "name": "Test network connectivity",
    "id": "3000000076139",
    "field_type": "Decision Box"
  }
}

cl_value (string)
The value entered for the checklist item

cl_value (string)
The current value of the checklist item field

Example 

Sample Content

order (long)
Display order of the checklist item within the checklist

order (long)
Numeric value determining the position of the item in the checklist

Example 

234759602834500

is_completed (boolean)
Indicates whether the checklist item has been completed

is_completed (boolean)
Indicates whether the checklist item has been completed

checklist (checklist)
Indicates the checklist to which this item belongs 

checklist (checklist)
Contains the reference to the parent checklist

Example 

{
  "checklist": {
    "name": "Server Maintenance Checklists",
    "id": "3000000076345",
    "status": false
  }
}

More Attributes Expand all

updated_by (user)read only

Indicates the user who last updated the checklist item

updated_by (user)
Contains the details of the user who last updated the checklist item

Example 

{
  "updated_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": ""
  }
}

updated_on (datetime)read only

Indicates the time at which the checklist item was last updated

updated_on (datetime)
The timestamp when the checklist item was last updated

Example 

{"updated_on":{"display_value":"Feb 25, 2026 11:00 AM","value":"1772100000000"}}

is_enabled (boolean)read only

Indicates whether the checklist item is enabled or excluded

is_enabled (boolean)
Indicates whether the checklist item is enabled or excluded

Add Checklist Item

This operation helps to add a new checklist item to a checklist

Mandatory Fields :- item

Url

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

Attributes

id (long)
Unique identifier to identify the checklist item

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

item (item_detail)
Indicates the item detail associated with this checklist item

item (item_detail)
Contains the details of the item

Example 

{
  "item": {
    "name": "Test network connectivity",
    "id": "3000000076139",
    "field_type": "Decision Box"
  }
}

order (long)
Display order of the checklist item within the checklist

order (long)
Numeric value determining the position of the item in the checklist

Example 

234759602834500


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems\
      -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='{
  "checklistitems": [
    {
      "item": {
        "name": "Test N/W",
        "field_type": "Decision Box"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Test Power",
        "field_type": "Decision Box"
      },
      "order": "2"
    }
  ]
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklistitems": [
    {
      "item": {
        "name": "Test N/W",
        "field_type": "Decision Box"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Test Power",
        "field_type": "Decision Box"
      },
      "order": "2"
    }
  ]
};
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/{checklist_id}/checklistitems"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklistitems": [
    {
      "item": {
        "name": "Test N/W",
        "field_type": "Decision Box"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Test Power",
        "field_type": "Decision Box"
      },
      "order": "2"
    }
  ]
}
'@
$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/{checklist_id}/checklistitems"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklistitems": [
    {
      "item": {
        "name": "Test N/W",
        "field_type": "Decision Box"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Test Power",
        "field_type": "Decision Box"
      },
      "order": "2"
    }
  ]
}'''
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,
            "id": "3000000076470",
            "status": "success"
        },
        {
            "status_code": 2000,
            "id": "3000000076474",
            "status": "success"
        }
    ],
    "checklistitems": [
        {
            "updated_on": null,
            "is_enabled": true,
            "item": {
                "name": "Test N/W",
                "id": "3000000076466",
                "field_type": "Decision Box"
            },
            "cl_value": null,
            "updated_by": null,
            "checklist": {
                "name": "Server Maintenance Checklists",
                "id": "3000000076345",
                "status": false
            },
            "id": "3000000076470",
            "is_completed": false,
            "order": "1"
        },
        {
            "updated_on": null,
            "is_enabled": true,
            "item": {
                "name": "Test Power",
                "id": "3000000076472",
                "field_type": "Decision Box"
            },
            "cl_value": null,
            "updated_by": null,
            "checklist": {
                "name": "Server Maintenance Checklists",
                "id": "3000000076345",
                "status": false
            },
            "id": "3000000076474",
            "is_completed": false,
            "order": "2"
        }
    ]
}

Edit Checklist Item

This operation helps to update existing checklist items.

Url

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

Attributes

id (long)
Unique identifier to identify the checklist item

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

item (item_detail)
Indicates the item detail associated with this checklist item

item (item_detail)
Contains the details of the item

Example 

{
  "item": {
    "name": "Test network connectivity",
    "id": "3000000076139",
    "field_type": "Decision Box"
  }
}

cl_value (string)
The value entered for the checklist item

cl_value (string)
The current value of the checklist item field

Example 

Sample Content

order (long)
Display order of the checklist item within the checklist

order (long)
Numeric value determining the position of the item in the checklist

Example 

234759602834500

is_completed (boolean)
Indicates whether the checklist item has been completed

is_completed (boolean)
Indicates whether the checklist item has been completed

$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_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_item": {
    "cl_value": "1234",
    "is_completed": true
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_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_item": {
    "cl_value": "1234",
    "is_completed": true
  }
};
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}/checklistitems/{checklist_item_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_item": {
    "cl_value": "1234",
    "is_completed": true
  }
}
'@
$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}/checklistitems/{checklist_item_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_item": {
    "cl_value": "1234",
    "is_completed": true
  }
}'''
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())

{
    "checklist_item": {
        "updated_on": {
            "display_value": "Feb 25, 2026 03:48 PM",
            "value": "1772014723580"
        },
        "is_enabled": true,
        "item": {
            "name": "Update system software",
            "id": "3000000076145",
            "field_type": "Single Line"
        },
        "cl_value": "1234",
        "updated_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
        },
        "checklist": {
            "name": "Server Maintenance Checklists",
            "id": "3000000076345",
            "status": false
        },
        "id": "3000000076357",
        "is_completed": true,
        "order": "2"
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

Get Checklist Item

This operation helps to get a single checklist item

Url

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

Attributes

id (long)
Unique identifier to identify the checklist item

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

item (item_detail)
Indicates the item detail associated with this checklist item

item (item_detail)
Contains the details of the item

Example 

{
  "item": {
    "name": "Test network connectivity",
    "id": "3000000076139",
    "field_type": "Decision Box"
  }
}

cl_value (string)
The value entered for the checklist item

cl_value (string)
The current value of the checklist item field

Example 

Sample Content

order (long)
Display order of the checklist item within the checklist

order (long)
Numeric value determining the position of the item in the checklist

Example 

234759602834500

is_completed (boolean)
Indicates whether the checklist item has been completed

is_completed (boolean)
Indicates whether the checklist item has been completed

checklist (checklist)
Indicates the checklist to which this item belongs 

checklist (checklist)
Contains the reference to the parent checklist

Example 

{
  "checklist": {
    "name": "Server Maintenance Checklists",
    "id": "3000000076345",
    "status": false
  }
}

More Attributes Expand all

updated_by (user)read only

Indicates the user who last updated the checklist item

updated_by (user)
Contains the details of the user who last updated the checklist item

Example 

{
  "updated_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": ""
  }
}

updated_on (datetime)read only

Indicates the time at which the checklist item was last updated

updated_on (datetime)
The timestamp when the checklist item was last updated

Example 

{"updated_on":{"display_value":"Feb 25, 2026 11:00 AM","value":"1772100000000"}}

is_enabled (boolean)read only

Indicates whether the checklist item is enabled or excluded

is_enabled (boolean)
Indicates whether the checklist item is enabled or excluded

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_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}/checklistitems/{checklist_item_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}/checklistitems/{checklist_item_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}/checklistitems/{checklist_item_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())

{
  "checklist_item": {
    "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": "3000000076345",
      "status": false
    },
    "id": "3000000076355",
    "is_completed": false,
    "order": "1"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

Get List Checklist Item

This operation helps to get the list of all checklist items under a checklist

Url

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

Attributes

id (long)
Unique identifier to identify the checklist item

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

item (item_detail)
Indicates the item detail associated with this checklist item

item (item_detail)
Contains the details of the item

Example 

{
  "item": {
    "name": "Test network connectivity",
    "id": "3000000076139",
    "field_type": "Decision Box"
  }
}

cl_value (string)
The value entered for the checklist item

cl_value (string)
The current value of the checklist item field

Example 

Sample Content

order (long)
Display order of the checklist item within the checklist

order (long)
Numeric value determining the position of the item in the checklist

Example 

234759602834500

is_completed (boolean)
Indicates whether the checklist item has been completed

is_completed (boolean)
Indicates whether the checklist item has been completed

checklist (checklist)
Indicates the checklist to which this item belongs 

checklist (checklist)
Contains the reference to the parent checklist

Example 

{
  "checklist": {
    "name": "Server Maintenance Checklists",
    "id": "3000000076345",
    "status": false
  }
}

More Attributes Expand all

updated_by (user)read only

Indicates the user who last updated the checklist item

updated_by (user)
Contains the details of the user who last updated the checklist item

Example 

{
  "updated_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": ""
  }
}

updated_on (datetime)read only

Indicates the time at which the checklist item was last updated

updated_on (datetime)
The timestamp when the checklist item was last updated

Example 

{"updated_on":{"display_value":"Feb 25, 2026 11:00 AM","value":"1772100000000"}}

is_enabled (boolean)read only

Indicates whether the checklist item is enabled or excluded

is_enabled (boolean)
Indicates whether the checklist item is enabled or excluded

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems\
      -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/{checklist_id}/checklistitems";
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/{checklist_id}/checklistitems"
$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/{checklist_id}/checklistitems"
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())

{
 "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "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": "3000000076345",
        "status": false
      },
      "id": "3000000076355",
      "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": "3000000076345",
        "status": false
      },
      "id": "3000000076357",
      "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": "3000000076345",
        "status": false
      },
      "id": "3000000076359",
      "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": "3000000076345",
        "status": false
      },
      "id": "3000000076361",
      "is_completed": false,
      "order": "4"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 4
  }
}

Include

This operation helps to include a previously excluded checklist item back into a checklist

Url

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


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_id}/_include\
      -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=''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_id}/_include";
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: 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}/checklistitems/{checklist_item_id}/_include"
$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 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}/checklistitems/{checklist_item_id}/_include"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Checklist item included"
            }
        ],
        "status": "success"
    }
}

View more

Exclude

This operation helps to exclude a checklist item from a checklist

Url

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


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_id}/_exclude\
      -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=''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}/checklistitems/{checklist_item_id}/_exclude";
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: 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}/checklistitems/{checklist_item_id}/_exclude"
$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 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}/checklistitems/{checklist_item_id}/_exclude"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Checklist item excluded"
            }
        ],
        "status": "success"
    }
}

View more