Template Checklist Association

An entity used to associate a checklist with a template, establishing the relationship between a specific checklist instance and its corresponding template.

Attributes

id (long)
Unique identifier to identify the template-checklist association

checklist (checklist_template)
Indicates the checklist template associated with the template

Add Template Checklist Association

This operation helps to associate checklist templates with a request template. Supports bulk add.

Url

<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists

Attributes

id (long)
Unique identifier to identify the template-checklist association

checklist (checklist_template)
Indicates the checklist template associated with the template

Curl

$ curl <service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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='{
  "checklists": [
    {
      "checklist": {
        "id": 3000000076137
      }
    },
    {
      "checklist": {
        "id": 3000000076201
      }
    }
  ]
}'

Deluge

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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 = {
  "checklists": [
    {
      "checklist": {
        "id": 3000000076137
      }
    },
    {
      "checklist": {
        "id": 3000000076201
      }
    }
  ]
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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 = @'
{
  "checklists": [
    {
      "checklist": {
        "id": 3000000076137
      }
    },
    {
      "checklist": {
        "id": 3000000076201
      }
    }
  ]
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

#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/request_templates/{template_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 = '''{
  "checklists": [
    {
      "checklist": {
        "id": 3000000076137
      }
    },
    {
      "checklist": {
        "id": 3000000076201
      }
    }
  ]
}'''
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())

{
    "checklists": [
        {
            "checklist": {
                "name": "Server Maintenance Checklists",
                "description": "Checklist for routine server maintenance",
                "id": "3000000076137"
            },
            "id": "3000000076548"
        },
        {
            "checklist": {
                "name": "copy_Server Maintenance Checklists",
                "description": "Checklist for routine server maintenance",
                "id": "3000000076201"
            },
            "id": "3000000076552"
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "id": "3000000076548",
            "status": "success"
        },
        {
            "status_code": 2000,
            "id": "3000000076552",
            "status": "success"
        }
    ]
}

Get Template Checklist Association

This operation helps to get a single template-checklist association

Url

<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists/{association_id}

Attributes

id (long)
Unique identifier to identify the template-checklist association

checklist (checklist_template)
Indicates the checklist template associated with the template

Curl

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists/{association_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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists/{association_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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists/{association_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

#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/request_templates/{template_id}/checklists/{association_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": {
    "checklist": {
      "name": "copy_Server Maintenance Checklists",
      "description": "Checklist for routine server maintenance",
      "id": "3000000076201"
    },
    "id": "3000000076552"
  }
}

Get List Template Checklist Association

This operation helps to get the list of all checklist templates associated with template

Url

<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_id}/checklists

Attributes

id (long)
Unique identifier to identify the template-checklist association

checklist (checklist_template)
Indicates the checklist template associated with the template

Curl

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/request_templates/{template_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

#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/request_templates/{template_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": [
        {
            "checklist": {
                "name": "Server Maintenance Checklists",
                "description": "Checklist for routine server maintenance",
                "id": "3000000076137"
            },
            "id": "3000000076548"
        },
        {
            "checklist": {
                "name": "copy_Server Maintenance Checklists",
                "description": "Checklist for routine server maintenance",
                "id": "3000000076201"
            },
            "id": "3000000076552"
        }
    ],
    "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
    }
}

Delete Template Checklist Association

This operation helps to remove checklist template associations from a request template. Supports bulk delete.

Url

<service domain|custom domain>/app/<portal>//api/v3/request_templates/{template_id}/checklists/{association_id}

Curl

$ curl <service domain|custom domain>/app/<portal>//api/v3/request_templates/{template_id}/checklists/{association_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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/request_templates/{template_id}/checklists/{association_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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/request_templates/{template_id}/checklists/{association_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

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

url = "<service domain|custom domain>/app/<portal>//api/v3/request_templates/{template_id}/checklists/{association_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"
  }
}