Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ) display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ) display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.
Example:

{
"value": "1477394860065"
"display_value": "Oct 25, 2016 11:27 AM"
}

HTML is a text area where html elements can be used.
Example : “<b>Content to be display</b&gt”

Numerical digits which are considered to have smaller numbers.
Example : 39

These are numbers that can include contains decimals.
Example : 23.08

Represents a date as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ) display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

Introduction

The ServiceDesk Plus OnDemand API allows you to perform all the operations that you do with our web client.

ServiceDesk Plus OnDemand API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

Getting Started

To use our API you must satisfy these prerequistes

1. A valid Zoho username and password.

2. An Authentication Token - authtoken in short!

Authentication

All ServiceDesk Plus Ondemand API need to be authenticated using an authtoken.

In Your Browser

Obtaining an authtoken in your browser is very simple. Login to your Zoho Account and go to the URL below.

There are 2 things that we need to handle in error case.One for human and the other for api consumer (machine) to interpret and take appropriate actions. For human, a proper readable error message can be returned. For machine, based on status code and “fields” that cause the error, it can highlight appropriate things in UI or take some other action.

Error scenario

Code

HTTP code

Example response (content of response_status object)

Id or Name given in Input does not exist or not in use or user cannot set the value

Requests

The numerous help desk tickets raised in your organization are organized and tracked in the Requests module. The Requests module enables you to handle tickets promptly, assign tickets to technicians, merge similar requests and so on.

Request

End user can raise a request when he find disruption of existing service offered to him or he can raise a request for a new service.

Request Note

When you would like to add some additional information including technical information to a particular request based on your observations, you can use notes. You can also use notes to update the status of the request.

{"response_status":{"status_code":2000,"status":"success"},"request_note":{"created_time":{"display_value":"Nov 10, 2016 11:44 AM","value":"1478758440000"},"request":{"display_id":23,"subject":"Need an External Monitor","id":"2145685978880416"},"show_to_requester":false,"description":"The following is the note for the associated request","id":"1739636386011546","created_by":{"email_id":"lincoln@zmail.com","sms_mail":"linc123@xys_sms.co","phone":"test-phone","name":"Lincoln","id":"1822554978823099","photo_url":"test-photo_url","department":"null"}}}

{"response_status":{"status_code":2000,"status":"success"},"request_note":{"created_time":{"display_value":"Nov 10, 2016 11:44 AM","value":"1478758440000"},"request":{"display_id":23,"subject":"Need an External Monitor","id":"1710843281323343"},"show_to_requester":false,"description":"The following is the note for the associated request","id":"2193336554259824","created_by":{"email_id":"lincoln@zmail.com","sms_mail":"linc123@xys_sms.co","phone":"test-phone","name":"Lincoln","id":"2258127439791629","photo_url":"test-photo_url","department":"null"}}}

{"response_status":{"status_code":2000,"status":"success"},"request_note":{"created_time":{"display_value":"Nov 10, 2016 11:44 AM","value":"1478758440000"},"request":{"display_id":23,"subject":"Need an External Monitor","id":"2475013693758840"},"show_to_requester":false,"description":"The following is the note for the associated request","id":"2393367447056668","created_by":{"email_id":"lincoln@zmail.com","sms_mail":"linc123@xys_sms.co","phone":"test-phone","name":"Lincoln","id":"2007652705833275","photo_url":"test-photo_url","department":"null"}}}

{"notes":[{"created_time":{"display_value":"Nov 10, 2016 11:44 AM","value":"1478758440000"},"request":{"display_id":23,"subject":"Need an External Monitor","id":"1867684682160022"},"show_to_requester":false,"description":"The following is the note for the associated request","id":"1708792394824937","created_by":{"email_id":"lincoln@zmail.com","sms_mail":"linc123@xys_sms.co","phone":"test-phone","name":"Lincoln","id":"1509623547405061","photo_url":"test-photo_url","department":"null"}}],"response_status":[{"status_code":2000,"status":"success"}],"list_info":{"has_more_rows":false,"row_count":1}}

{"notification":{"subject":"Approval required for a Request","description":"Your approval is required for a Request to act upon. The details of the Request can be found at $ApprovalLink"},"response_status":{"status_code":2000,"status":"success"}}

This operation helps you Get notification content for sending request approval.

Projects

Project management - the discipline of planning, organizing, and controlling resources to achieve specific goals is now a part of ServiceDesk Plus. Using project management you can create projects: a temporary endeavor to achieve certain objective/change (within a specific time period) beneficial to your organization.

Project

A temporary endeavor to achieve certain objective/change (within a specific time period) beneficial to the organization.Primary goal of the project management lies in effective management of resources like time, budget, manpower and the quality of work.

Project Member

Efficient staff alone does not ensure a project’s success. Meticulous planning of project staff; the permissions given to a projectrole; the flexibility in changing project roles and more come into play to ensure the project as a whole turns out to be a success.

Project Role

Attributes

The Role Name is to identify the role and should be unique. Member Roles available by default are : 1. Project Admin: Role that allows members to access/control entire project module (that is,control over all available projects) 2. Project Manager: Role that allows members to access/control an entire project (add, edit and delete Projects) 3. Team Leader: Role that allows members to access/control Milestones (add, edit and delete Milestones) 4. Team Member: Role that allows members to access/control Tasks (add, edit and delete Tasks)