<service domain|custom domain>/app/<portal>/api/v3/item_details
Item Detail
An individual item within a checklist that represents a specific action
Attributes
id (long)
Unique identifier to identify the checklist item
name (string)
Unique name to identify the checklist item.Maximum allowed characters is 250
field_type (string)
Indicates the field type of the checklist item. Allowed values: “Radio Button”, “Numeric Field”, “Single Line”, “Decision Box”
deleted (boolean)
Indicates whether the checklist item is active
allowed_values (itemdetails_picklist_values)
List of allowed picklist values for the item (applicable for Radio Button field type)
constraints (item_details_field_constraint)
Field constraints associated with the checklist item.Use Num Range for Numeric type, Min Length and Max Length for Text type.
Add Item Detail
This operation helps to add new item details. Supports bulk add.
Mandatory Fields :- name, field_type
Url
Attributes
id (long)
Unique identifier to identify the checklist item
name (string)
Unique name to identify the checklist item.Maximum allowed characters is 250
field_type (string)
Indicates the field type of the checklist item. Allowed values: “Radio Button”, “Numeric Field”, “Single Line”, “Decision Box”
allowed_values (itemdetails_picklist_values)
List of allowed picklist values for the item (applicable for Radio Button field type)
constraints (item_details_field_constraint)
Field constraints associated with the checklist item.Use Num Range for Numeric type, Min Length and Max Length for Text type.
$ curl <service domain|custom domain>/app/<portal>/api/v3/item_details\
-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='{
"item_detail": {
"field_type": "Single Line",
"name": "Backup till",
"allowed_values": [],
"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"
}
]
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/item_details";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"item_detail": {
"field_type": "Single Line",
"name": "Backup till",
"allowed_values": [],
"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"
}
]
}
};
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/item_details"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"item_detail": {
"field_type": "Single Line",
"name": "Backup till",
"allowed_values": [],
"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"
}
]
}
}
'@
$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/item_details"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"item_detail": {
"field_type": "Single Line",
"name": "Backup till",
"allowed_values": [],
"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"
}
]
}
}'''
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())
{
"item_detail": {
"allowed_values": [],
"deleted": false,
"name": "Backup till",
"id": "3000000076235",
"field_type": "Single Line",
"constraints": [
{
"constraint_value": "true",
"constraint_name": "nullable",
"id": "3000000076237"
},
{
"constraint_value": "false",
"constraint_name": "unique",
"id": "3000000076239"
},
{
"constraint_value": "0",
"constraint_name": "min_length",
"id": "3000000076241"
},
{
"constraint_value": "250",
"constraint_name": "max_length",
"id": "3000000076243"
}
]
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Item Detail
This operation helps to update an existing checklist items
Url
<service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_id}
Attributes
id (long)
Unique identifier to identify the checklist item
name (string)
Unique name to identify the checklist item.Maximum allowed characters is 250
field_type (string)
Indicates the field type of the checklist item. Allowed values: “Radio Button”, “Numeric Field”, “Single Line”, “Decision Box”
allowed_values (itemdetails_picklist_values)
List of allowed picklist values for the item (applicable for Radio Button field type)
constraints (item_details_field_constraint)
Field constraints associated with the checklist item.Use Num Range for Numeric type, Min Length and Max Length for Text type.
$ curl <service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_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='{
"item_detail": {
"name": "Disk space usage %",
"constraints": [
{
"constraint_name": "nullable",
"constraint_value": "true",
"id": "3000000076161"
},
{
"constraint_name": "unique",
"constraint_value": "false",
"id": "3000000076163"
},
{
"constraint_name": "num_range",
"constraint_value": ":",
"id": 3000000076165
}
]
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"item_detail": {
"name": "Disk space usage %",
"constraints": [
{
"constraint_name": "nullable",
"constraint_value": "true",
"id": "3000000076161"
},
{
"constraint_name": "unique",
"constraint_value": "false",
"id": "3000000076163"
},
{
"constraint_name": "num_range",
"constraint_value": ":",
"id": 3000000076165
}
]
}
};
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/item_details/{item_detail_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"item_detail": {
"name": "Disk space usage %",
"constraints": [
{
"constraint_name": "nullable",
"constraint_value": "true",
"id": "3000000076161"
},
{
"constraint_name": "unique",
"constraint_value": "false",
"id": "3000000076163"
},
{
"constraint_name": "num_range",
"constraint_value": ":",
"id": 3000000076165
}
]
}
}
'@
$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/item_details/{item_detail_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"item_detail": {
"name": "Disk space usage %",
"constraints": [
{
"constraint_name": "nullable",
"constraint_value": "true",
"id": "3000000076161"
},
{
"constraint_name": "unique",
"constraint_value": "false",
"id": "3000000076163"
},
{
"constraint_name": "num_range",
"constraint_value": ":",
"id": 3000000076165
}
]
}
}'''
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())
{
"item_detail": {
"allowed_values": [],
"deleted": false,
"name": "Disk space usage %",
"id": "3000000076159",
"field_type": "Numeric Field",
"constraints": [
{
"constraint_value": "true",
"constraint_name": "nullable",
"id": "3000000076161"
},
{
"constraint_value": "false",
"constraint_name": "unique",
"id": "3000000076163"
},
{
"constraint_value": ":",
"constraint_name": "num_range",
"id": "3000000076165"
}
]
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Item Detail
This operation helps to get a single checklist item
Url
<service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_id}
Attributes
id (long)
Unique identifier to identify the checklist item
name (string)
Unique name to identify the checklist item.Maximum allowed characters is 250
field_type (string)
Indicates the field type of the checklist item. Allowed values: “Radio Button”, “Numeric Field”, “Single Line”, “Decision Box”
deleted (boolean)
Indicates whether the checklist item is active
allowed_values (itemdetails_picklist_values)
List of allowed picklist values for the item (applicable for Radio Button field type)
constraints (item_details_field_constraint)
Field constraints associated with the checklist item.Use Num Range for Numeric type, Min Length and Max Length for Text type.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_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/item_details/{item_detail_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/item_details/{item_detail_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/item_details/{item_detail_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())
{
"item_detail": {
"allowed_values": [
{
"name": "High",
"id": "3000000076173",
"order": 1
},
{
"name": "Medium",
"id": "3000000076175",
"order": 2
},
{
"name": "Low",
"id": "3000000076177",
"order": 3
}
],
"deleted": false,
"name": "Monitor CPU and memory usage",
"id": "3000000076171",
"field_type": "Radio Button",
"constraints": [
{
"constraint_value": "true",
"constraint_name": "nullable",
"id": "3000000076179"
}
]
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Item Detail
This operation helps to get the list of all the checklist items
Url
<service domain|custom domain>/app/<portal>/api/v3/item_details
Attributes
id (long)
Unique identifier to identify the checklist item
name (string)
Unique name to identify the checklist item.Maximum allowed characters is 250
field_type (string)
Indicates the field type of the checklist item. Allowed values: “Radio Button”, “Numeric Field”, “Single Line”, “Decision Box”
deleted (boolean)
Indicates whether the checklist item is active
allowed_values (itemdetails_picklist_values)
List of allowed picklist values for the item (applicable for Radio Button field type)
constraints (item_details_field_constraint)
Field constraints associated with the checklist item.Use Num Range for Numeric type, Min Length and Max Length for Text type.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/item_details\
-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/item_details";
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/item_details"
$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/item_details"
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"
}
],
"item_details": [
{
"name": "Disk space usage %",
"id": "3000000076159",
"field_type": "Numeric Field"
},
{
"name": "Monitor CPU and memory usage",
"id": "3000000076171",
"field_type": "Radio Button"
},
{
"name": "Test network connectivity",
"id": "3000000076139",
"field_type": "Decision Box"
},
{
"name": "Update system software",
"id": "3000000076145",
"field_type": "Single Line"
}
],
"list_info": {
"sort_fields": [
{
"field": "name",
"order": "asc"
}
],
"has_more_rows": false,
"start_index": 1,
"fields_required": [
"name",
"field_type"
],
"total_count": 4,
"page": 1,
"get_total_count": "true",
"row_count": 4
}
}
Delete Item Detail
This operation helps to delete checklist items.
Url
<service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_id}
$ curl <service domain|custom domain>/app/<portal>/api/v3/item_details/{item_detail_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/item_details/{item_detail_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/item_details/{item_detail_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/item_details/{item_detail_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"
}
}