Skip to content

Arc Checklist

Checklist is a list of reminders or to-do things for technicians to follow

Attributes

id (long)
Unique identifier to identify the checklist

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

Example

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example

Sample Content

checklistitems (arc_checklist_item)
List of checklist items associated with this checklist.

checklistitems (arc_checklist_item)
Contains the collection of checklist items

Example

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

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example

Sample Content

created_by (user)read only
Indicates the user who created the checklist

created_by (user)
Contains the details of the user who created the checklist

Example

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

created_time (datetime)read only
Indicates the time at which the checklist was created

created_time (datetime)
The timestamp when the checklist was created

More Attributes Expand all

status (boolean)read only

Indicates whether the checklist is completed

status (boolean)
Boolean flag indicating the completion status of the checklist

Get Arc Checklist

This operation helps to get a single archived checklist associated with a request

Url

<service domain|custom domain>/app/<portal>/api/v3/archive_requests/{archive_request_id}/checklists/{arc_checklist_id}

Attributes

id (long)
Unique identifier to identify the checklist

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

Example

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example

Sample Content

checklistitems (arc_checklist_item)
List of checklist items associated with this checklist.

checklistitems (arc_checklist_item)
Contains the collection of checklist items

Example

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

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example

Sample Content

created_by (user)read only
Indicates the user who created the checklist

created_by (user)
Contains the details of the user who created the checklist

Example

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

created_time (datetime)read only
Indicates the time at which the checklist was created

created_time (datetime)
The timestamp when the checklist was created

More Attributes Expand all

status (boolean)read only

Indicates whether the checklist is completed

status (boolean)
Boolean flag indicating the completion status of the checklist

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/archive_requests/{archive_request_id}/checklists/{arc_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/archive_requests/{archive_request_id}/checklists/{arc_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/archive_requests/{archive_request_id}/checklists/{arc_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/archive_requests/{archive_request_id}/checklists/{arc_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"
    },
    "arc_checklist": {
        "created_time": {
            "display_value": "Feb 25, 2026 05:46 PM",
            "value": "1772021805659"
        },
        "name": "Server Maintenance Checklists",
        "description": "Checklist for routine server maintenance",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "cl_value": null,
                "name": "Test network connectivity",
                "updated_by": null,
                "id": "3000000076413",
                "field_type": "Decision Box",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "cl_value": null,
                "name": "Update system software",
                "updated_by": null,
                "id": "3000000076415",
                "field_type": "Single Line",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "cl_value": null,
                "name": "Disk space usage  %",
                "updated_by": null,
                "id": "3000000076417",
                "field_type": "Numeric Field",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "cl_value": null,
                "name": "Monitor CPU and memory usage %",
                "updated_by": null,
                "id": "3000000076419",
                "field_type": "Radio Button",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076403",
        "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
    }
}

Get List Arc Checklist

This operation helps to get the list of all archived checklists associated with a request

Url

<service domain|custom domain>/app/<portal>/api/v3/archive_requests/{archive_request_id}/checklists

Attributes

id (long)
Unique identifier to identify the checklist

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

Example

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example

Sample Content

checklistitems (arc_checklist_item)
List of checklist items associated with this checklist.

checklistitems (arc_checklist_item)
Contains the collection of checklist items

Example

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

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example

Sample Content

created_by (user)read only
Indicates the user who created the checklist

created_by (user)
Contains the details of the user who created the checklist

Example

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

status (boolean)read only
Indicates whether the checklist is completed

status (boolean)
Boolean flag indicating the completion status of the checklist

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/archive_requests/{archive_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/archive_requests/{archive_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/archive_requests/{archive_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/archive_requests/{archive_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": [
        {
            "name": "Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076403",
            "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
        },
        {
            "name": "copy_Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076421",
            "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
    }
}