ServiceDesk Plus On-Demand
API Documentation BETA
Contains the column name and value to be searched for in a json object. 

Example:
 
  "search_fields":{ 
  "title ": "Telecom change", 
  "priority": "High"
}
Contains the conditions that should be matched to fetch the response. 

Example:
 
{
  "search_criteria": {
    "condition": "eq",
    "field": "mode",
    "children": [
      {
        "condition": "neq",
        "field": "priority",
        "logical_operator": "or",
        "values": [
          "High"
        ]
      }
    ],
    "values": [
      "E-mail"
    ]
  }
}

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.
Value in Numbers representing the “row counts”, “start index”, “estimated days”, “estimated hours” , “estimated minutes” ,“additional costs” ,“percentage of completion”.
Numerical digits which are considered to have larger values
Example: 234759602834500
A text in a plain format. No rich text or new line characters allowed.
The name of the file that is upload.
Example: “test-document.txt”
Contains the information about the file that has been uploaded.
Example:
{
 "size": "601",
 "content_type": "application/unknown-mime-type",
 "file_id": "6003",
 "name": "test-document.txt",
 "content_url": "/tasks/1974556828626/uploads/603"
 "id": "17322245500049868"
}
The site to which the task is associated.
The request to which the task is associated.
The change to which the task is associated.
The project to which the task is associated.
The milestone to which the task is associated.
The change to which the task is associated.
The request template to which the task is associated
The request template to which the task is associated
The request template to which the task is associated
The color used to represent the entity
The color used to represent the entity
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>”
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.
Contains the resolution details of the request.
Example :

"resolution": {
     "content": "<p>Resolution content</p>"
     }
        
Contains onhold scheduling details.
Example :

"onhold_scheduler": {
   "comments": "Reasons for Onhold",
   "holded_by": {
   "email_id": "Lincoln.@zmail.com",
   "name": "Lincoln",
   "id": "1988394720325043",
   },
   "scheduled_time": {
   "display_value": "Jan 5, 2018 01:16 PM",
   "value": "1515138360000"
   },
   "change_to_status": {
     "name": "Open",
     "id": "1879737497687"
   }
   }
        
Contains closure info of the request.
Example :

"closure_info": {
   "requester_ack_comments": "Acknowledged comments",
   "requester_ack_resolution": true
    }
        
Boolean value which can have two possible values i.e false, true.
Denotes the resource data that is mapped to the request.
Example :

"resources":{
  "resource_1134245678903456": {
    "question_1123345678903342": [
      {
        "id": "1123345678903456",
        "name": "Dell Latitude E7450"
      },
      {
        "id": "29982345678900434",
        "name": "MacBook Air"
      }
    ],
    "question_1123345634524534": "xyz@zy.com",
    "question_1123345673440345": "Yes"
  }
}  
Denotes udf fields’ values associated to the request.
Example :

"udf_fields":{
  "udf_51": "abc@test.com",
  "udf_52": "Ned Stark",
  "udf_53": "1459402730964",
  "udf_54": "12.25",
  "udf_55": {
    "value": "1456464639051",
    "display_value": "Feb 26, 2016 11:00 AM"
  }
}
Denotes udf fields’ values associated to the request.
Example :

"udf_fields":{
  "udf_51": "abc@test.com",
  "udf_52": "Ned Stark",
  "udf_53": "1459402730964",
  "udf_54": "12.25",
  "udf_55": {
    "value": "1456464639051",
    "display_value": "Feb 26, 2016 11:00 AM"
  }
}
Denotes udf fields’ values associated to the request.
Example :

"udf_fields":{
  "udf_51": "abc@test.com",
  "udf_52": "Ned Stark",
  "udf_53": "1459402730964",
  "udf_54": "12.25",
  "udf_55": {
    "value": "1456464639051",
    "display_value": "Feb 26, 2016 11:00 AM"
  }
}
Denotes udf fields’ values associated to the request.
Example :

"udf_fields":{
  "udf_51": "abc@test.com",
  "udf_52": "Ned Stark",
  "udf_53": "1459402730964",
  "udf_54": "12.25",
  "udf_55": {
    "value": "1456464639051",
    "display_value": "Feb 26, 2016 11:00 AM"
  }
}
The problem associated to the task
Example:

"problem": {
      "id":1234543242345234
    }
    
Contains the Time spent in hours, minutes and seconds
Example :

"time_spent": {
      "hours": "1895947530616044",
      "seconds": 46,
      "minutes": 20
    }
    

Example:
{
  "asset": {
    "name": "test-asset",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_cost_factor": {
    "name": "test-resource_cost_factor",
    "id": "234567890123456"
  }
}
Denotes the user who created the Note.
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
Denotes the request associated to that request_note.
Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "product": {
    "name": "test-product",
    "id": "234567890123456"
  }
}

Example:
{
  "vendor": {
    "name": "test-vendor",
    "id": "234567890123456"
  }
}

Example:
{
  "maintenance_vendor": {
    "name": "test-maintenance_vendor",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}
The Milestone to which the comment is associated.
Example:
{
  "milestone": {
    "name": "test-milestone",
    "id": "234567890123456"
  }
}
The User who created the Milestone Comment.
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

Example:
{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

Example:
{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

Example:
{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

Example:
{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

Example:
{
  "protocol": {
    "name": "test-protocol",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "currency": {
    "name": "test-currency",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "module_type": {
    "name": "test-module_type",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "last_updated_by": {
    "name": "test-last_updated_by",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "user_groups": {
    "name": "test-user_groups",
    "id": "234567890123456"
  }
}

Example:
{
  "default_project_role": {
    "name": "test-default_project_role",
    "id": "234567890123456"
  }
}

Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

Example:
{
  "workstation": {
    "name": "test-workstation",
    "id": "234567890123456"
  }
}

Example:
{
  "operational_hours": {
    "name": "test-operational_hours",
    "id": "234567890123456"
  }
}

Example:
{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

Example:
{
  "permissions": {
    "name": "test-permissions",
    "id": "234567890123456"
  }
}

Example:
{
  "protocol": {
    "name": "test-protocol",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "fr_escalation": {
    "name": "test-fr_escalation",
    "id": "234567890123456"
  }
}

Example:
{
  "escalation": {
    "name": "test-escalation",
    "id": "234567890123456"
  }
}

Example:
{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}

Example:
{
  "user_groups": {
    "name": "test-user_groups",
    "id": "234567890123456"
  }
}

Example:
{
  "support_groups": {
    "name": "test-support_groups",
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

Example:
{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

Example:
{
  "marked_group": {
    "name": "test-marked_group",
    "id": "234567890123456"
  }
}

Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

Example:
{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "dependson": {
    "name": "test-dependson",
    "id": "234567890123456"
  }
}

Example:
{
  "product": {
    "name": "test-product",
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

Example:
{
  "probe": {
    "name": "test-probe",
    "id": "234567890123456"
  }
}

Example:
{
  "problem": {
    "name": "test-problem",
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "createdby": {
    "name": "test-createdby",
    "id": "234567890123456"
  }
}

Example:
{
  "fields": {
    "name": "test-fields",
    "id": "234567890123456"
  }
}

Example:
{
  "permissions": {
    "name": "test-permissions",
    "id": "234567890123456"
  }
}

Example:
{
  "module_type": {
    "name": "test-module_type",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "graph_type": {
    "name": "test-graph_type",
    "id": "234567890123456"
  }
}

Example:
{
  "last_updated_by": {
    "name": "test-last_updated_by",
    "id": "234567890123456"
  }
}
The project associated to the project member
Example:
{
  "project": {
    "id": "234567890123456"
  }
}
The user who will be referred as project member
Example:
{
  "user": {
    "name": "test-user",
    "id": "234567890123456"
  }
}
The role of the project member
Example:
{
  "role": {
    "name": "test-role",
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}

Example:
{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

Example:
{
  "marked_group": {
    "name": "test-marked_group",
    "id": "234567890123456"
  }
}

Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

Example:
{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}
The task to which the comment is associated
Example:
{
  "task": {
    "name": "test-task",
    "id": "234567890123456"
  }
}
The user who created the comment
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "module": {
    "name": "test-module",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "type": {
    "name": "test-type",
    "id": "234567890123456"
  }
}

Example:
{
  "module": {
    "name": "test-module",
    "id": "234567890123456"
  }
}

Example:
{
  "notification": {
    "name": "test-notification",
    "id": "234567890123456"
  }
}

Example:
{
  "task": {
    "name": "test-task",
    "id": "234567890123456"
  }
}

Example:
{
  "webhook": {
    "name": "test-webhook",
    "id": "234567890123456"
  }
}

Example:
{
  "field_update": {
    "name": "test-field_update",
    "id": "234567890123456"
  }
}

Example:
{
  "custom_function": {
    "name": "test-custom_function",
    "id": "234567890123456"
  }
}

Example:
{
  "abort": {
    "name": "test-abort",
    "id": "234567890123456"
  }
}

Example:
{
  "module": {
    "name": "test-module",
    "id": "234567890123456"
  }
}

Example:
{
  "actions": {
    "name": "test-actions",
    "id": "234567890123456"
  }
}

Example:
{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

Example:
{
  "parent": {
    "name": "test-parent",
    "id": "234567890123456"
  }
}

Example:
{
  "currency": {
    "name": "test-currency",
    "id": "234567890123456"
  }
}

Example:
{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

Example:
{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

Example:
{
  "product_type": {
    "name": "test-product_type",
    "id": "234567890123456"
  }
}

Example:
{
  "product_type": {
    "name": "test-product_type",
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "problem": {
    "name": "test-problem",
    "id": "234567890123456"
  }
}

Example:
{
  "change": {
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "notifications": {
    "name": "test-notifications",
    "id": "234567890123456"
  }
}

Example:
{
  "action": {
    "name": "test-action",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

Example:
{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

Example:
{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

Example:
{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

Example:
{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

Example:
{
  "user": {
    "name": "test-user",
    "id": "234567890123456"
  }
}

Example:
{
  "barcode_type": {
    "name": "test-barcode_type",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "barcode_generation_type": {
    "name": "test-barcode_generation_type",
    "id": "234567890123456"
  }
}

Example:
{
  "barcode_mapping_field": {
    "name": "test-barcode_mapping_field",
    "id": "234567890123456"
  }
}

Example:
{
  "project": {
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "region": {
    "name": "test-region",
    "id": "234567890123456"
  }
}

Example:
{
  "protocol": {
    "name": "test-protocol",
    "id": "234567890123456"
  }
}
The User who created the worklog
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
The technician who works on the worklog
Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "product": {
    "name": "test-product",
    "id": "234567890123456"
  }
}

Example:
{
  "product_type": {
    "name": "test-product_type",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_type": {
    "name": "test-resource_type",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_state": {
    "name": "test-resource_state",
    "id": "234567890123456"
  }
}

Example:
{
  "vendor": {
    "name": "test-vendor",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "region": {
    "name": "test-region",
    "id": "234567890123456"
  }
}

Example:
{
  "user": {
    "name": "test-user",
    "id": "234567890123456"
  }
}

Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

Example:
{
  "suggested_owner": {
    "name": "test-suggested_owner",
    "id": "234567890123456"
  }
}
Denotes the Project type for the Project that will be created with this Project template
Example:
{
  "project_type": {
    "name": "test-project_type",
    "id": "234567890123456"
  }
}
Denotes the Priority for the Project that will be created with this Project template
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
Denotes the Status for the Project that will be created with this Project template
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
Denotes the user who created the Project Template
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
Status of the approval level
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
User details of the approval level creator
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
Aproval associated request details
Example:
{
  "request": {
    "id": "234567890123456"
  }
}
Aproval associated change details
Example:
{
  "change": {
    "id": "234567890123456"
  }
}
Aproval associated purchase_order details
Example:
{
  "purchase_order": {
    "id": "234567890123456"
  }
}
Denotes the Type of the Project.
Example:
{
  "project_type": {
    "name": "test-project_type",
    "id": "234567890123456"
  }
}
The user who created the Project
Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}
Denotes the priority of the Project.
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
Denotes the status of the Project.
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
Denotes the Project Template with which the Project has been created.
Example:
{
  "project_template": {
    "name": "test-project_template",
    "id": "234567890123456"
  }
}
Denotes the user who created the Project.
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
Denotes the site to which the Project belongs.
Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "depreciation_type": {
    "name": "test-depreciation_type",
    "id": "234567890123456"
  }
}

Example:
{
  "change": {
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "sender": {
    "name": "test-sender",
    "id": "234567890123456"
  }
}

Example:
{
  "recipent": {
    "name": "test-recipent",
    "id": "234567890123456"
  }
}

Example:
{
  "attachments": {
    "name": "test-attachments",
    "id": "234567890123456"
  }
}

Example:
{
  "product": {
    "name": "test-product",
    "id": "234567890123456"
  }
}

Example:
{
  "product_type": {
    "name": "test-product_type",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_type": {
    "name": "test-resource_type",
    "id": "234567890123456"
  }
}

Example:
{
  "topic": {
    "name": "test-topic",
    "id": "234567890123456"
  }
}

Example:
{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "last_updated_by": {
    "name": "test-last_updated_by",
    "id": "234567890123456"
  }
}

Example:
{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

Example:
{
  "field": {
    "name": "test-field",
    "id": "234567890123456"
  }
}

Example:
{
  "device_type": {
    "name": "test-device_type",
    "id": "234567890123456"
  }
}

Example:
{
  "credential": {
    "name": "test-credential",
    "id": "234567890123456"
  }
}

Example:
{
  "parent_task": {
    "name": "test-parent_task",
    "id": "234567890123456"
  }
}

Example:
{
  "child_task": {
    "name": "test-child_task",
    "id": "234567890123456"
  }
}

Example:
{
  "escalation_users": {
    "name": "test-escalation_users",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "close_request_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "technicians": {
    "name": "test-technicians",
    "id": "234567890123456"
  }
}

Example:
{
  "request_add_notify": {
    "name": "test-request_add_notify",
    "id": "234567890123456"
  }
}

Example:
{
  "request_edit_notify": {
    "name": "test-request_edit_notify",
    "id": "234567890123456"
  }
}

Example:
{
  "request_unpick_notify": {
    "name": "test-request_unpick_notify",
    "id": "234567890123456"
  }
}
The Project template to which the Milestone template is associated
Example:
{
  "project_template": {
    "name": "test-project_template",
    "id": "234567890123456"
  }
}
The Priority of the Milestone Template
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
The Status of the Milestone Template
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
The User who created the Milestone template
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "request_template": {
    "name": "test-request_template",
    "id": "234567890123456"
  }
}

Example:
{
  "escalation_users": {
    "name": "test-escalation_users",
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}
Indicates the level of progress of the task
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
The User to whom the task is assigned.
Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}
The technician to be assigned when the task is triggered.
Example:
{
  "marked_technician": {
    "name": "test-marked_technician",
    "id": "234567890123456"
  }
}
Name and Id of the Technician who created the task is present in JSON format
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
Defines the intensity or importance of a task. Object has “id” and/or “name” of the priority
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
Used to categorize the tasks of similar cases
Example:
{
  "task_type": {
    "name": "test-task_type",
    "id": "234567890123456"
  }
}

Example:
{
  "probe": {
    "name": "test-probe",
    "id": "234567890123456"
  }
}

Example:
{
  "network": {
    "name": "test-network",
    "id": "234567890123456"
  }
}

Example:
{
  "device_type": {
    "name": "test-device_type",
    "id": "234567890123456"
  }
}

Example:
{
  "credential": {
    "name": "test-credential",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "parent": {
    "name": "test-parent",
    "id": "234567890123456"
  }
}

Example:
{
  "group_id": {
    "name": "test-group_id",
    "id": "234567890123456"
  }
}

Example:
{
  "escalation_users": {
    "name": "test-escalation_users",
    "id": "234567890123456"
  }
}

Example:
{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}
The project associated to the project comment
Example:
{
  "project": {
    "id": "234567890123456"
  }
}
The user who created the comment
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "protocol": {
    "name": "test-protocol",
    "id": "234567890123456"
  }
}

Example:
{
  "user": {
    "name": "test-user",
    "id": "234567890123456"
  }
}
User object of the user who put the request onhold.
Example:
{
  "holded_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-holded_by",
    "id": "234567890123456"
  }
}
Status object to which the request is scheduled to move to, after the onhold scheduler is completed.
Example:
{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
Impact of the Request.
Example:
{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}
Indicates the current status of the request.
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
Indicates the requester of the request.
Example:
{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}
Indicates the requester who created this request.
Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}
The Mode in which the request is created.
Example:
{
  "mode": {
    "name": "test-mode",
    "id": "234567890123456"
  }
}
SLA details associated with this request.
Example:
{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}
Department to which this requester belongs.
Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}
Denotes the Site to which the request belongs.
Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}
Indicates the template which is used to create this request.
Example:
{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}
Service category to which this request belongs.
Example:
{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}
Denotes the approval status of this request(Approved/Pending Approval/Rejected).
Example:
{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}
The group to which the request is assigned.
Example:
{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}
Technician assigned to this request.
Example:
{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}
Priority of the request.
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
Level of the Request.
Example:
{
  "level": {
    "name": "test-level",
    "id": "234567890123456"
  }
}
Category to which this request belongs.
Example:
{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}
Subcategory to which this request belongs.
Example:
{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}
Item of the request.
Example:
{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}
Urgency of the request
Example:
{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}
Type of the Request
Example:
{
  "request_type": {
    "name": "test-request_type",
    "id": "234567890123456"
  }
}
Array of asset objects associated to the request.
Example:
{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}
Holds linked request details.
Example:
{
  "linked_to_request": {
    "id": "234567890123456"
  }
}

Example:
{
  "members": {
    "name": "test-members",
    "id": "234567890123456"
  }
}

Example:
{
  "module": {
    "name": "test-module",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

Example:
{
  "criteria_action_id": {
    "name": "test-criteria_action_id",
    "id": "234567890123456"
  }
}

Example:
{
  "actions": {
    "name": "test-actions",
    "id": "234567890123456"
  }
}

Example:
{
  "cost_center": {
    "name": "test-cost_center",
    "id": "234567890123456"
  }
}

Example:
{
  "bill_address": {
    "name": "test-bill_address",
    "id": "234567890123456"
  }
}

Example:
{
  "ship_address": {
    "name": "test-ship_address",
    "id": "234567890123456"
  }
}

Example:
{
  "device_type": {
    "name": "test-device_type",
    "id": "234567890123456"
  }
}

Example:
{
  "credential": {
    "name": "test-credential",
    "id": "234567890123456"
  }
}

Example:
{
  "success_credential": {
    "name": "test-success_credential",
    "id": "234567890123456"
  }
}

Example:
{
  "domain": {
    "name": "test-domain",
    "id": "234567890123456"
  }
}

Example:
{
  "probe": {
    "name": "test-probe",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "request_templates": {
    "name": "test-request_templates",
    "id": "234567890123456"
  }
}

Example:
{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

Example:
{
  "purchase_order": {
    "id": "234567890123456"
  }
}

Example:
{
  "request": {
    "id": "234567890123456"
  }
}

Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}

Example:
{
  "department_head": {
    "name": "test-department_head",
    "id": "234567890123456"
  }
}

Example:
{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}
Approval level to which the approval is associated
Example:
{
  "approval_level": {
    "id": "234567890123456"
  }
}
Status of the Approval
Example:
{
  "status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}
Approver of the approval
Example:
{
  "approver": {
    "email_id": "andrews@zmail.com",
    "name": "test-approver",
    "id": "234567890123456"
  }
}

Example:
{
  "credential": {
    "name": "test-credential",
    "id": "234567890123456"
  }
}

Example:
{
  "probe": {
    "name": "test-probe",
    "id": "234567890123456"
  }
}

Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

Example:
{
  "sites": {
    "name": "test-sites",
    "id": "234567890123456"
  }
}

Example:
{
  "groups": {
    "name": "test-groups",
    "id": "234567890123456"
  }
}

Example:
{
  "roles": {
    "name": "test-roles",
    "id": "234567890123456"
  }
}

Example:
{
  "default_project_role": {
    "name": "test-default_project_role",
    "id": "234567890123456"
  }
}

Example:
{
  "escalation_users": {
    "name": "test-escalation_users",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_type": {
    "name": "test-resource_type",
    "id": "234567890123456"
  }
}

Example:
{
  "resource_category": {
    "name": "test-resource_category",
    "id": "234567890123456"
  }
}
The Project to which the milestone is associated
Example:
{
  "project": {
    "id": "234567890123456"
  }
}
The User who created the Milestone
Example:
{
  "owner": {
    "name": "test-owner",
    "id": "234567890123456"
  }
}
The Priority of the milestone
Example:
{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}
The Status of the Milestone
Example:
{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}
The User associated to the Milestone
Example:
{
  "user": {
    "name": "test-user",
    "id": "234567890123456"
  }
}

Example:
{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

Example:
{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

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.

https://accounts.zoho.com/apiauthtoken/create?SCOPE=SDPOnDemand/sdpodapi.

Programmatically Using The API

If you have chosen to obtain your authtoken via an API, please follow the instructions given below:

Submit an HTTP POST request to the below URL.

https://accounts.zoho.com/apiauthtoken/nb/create.

The POST body should include a string in the below format.

?SCOPE=SDPOnDemand/sdpodapi&EMAIL_ID=[ZohoID/EmailID]&PASSWORD=[Password]

Below are the mandatory case sensitive fields to be passed in the URL.

Param Description
SCOPE SDPOnDemand/sdpodapi
EMAIL_ID Your Zoho ID or Email ID
PASSWORD Your Zoho password

Points To Note

1. You can manage (regenerate or delete) your active authtokens created for different Zoho Services here.

2. Authtokens do not get deleted unless you delete them from the Zoho Accounts page yourself. You do not need to create multiple authtokens to send out requests.

3. Authtokens carry important information about your identity. So make sure, you keep them secure and it is secretive.

4. It is not possible to obtain an authtoken via the Zoho Accounts API if you log in to ServiceDesk Plus Ondemand with your Google, Yahoo or any other third party accounts.

Portals

If you have multiple portals in your organization, the portal name should be mentioned in every API request to identify the portal.

/app/<portal>/api/v3/requests

<portal> - represents the name of the portal, like “itdesk” for IT Help Desk, “facilites” for Facilities Desk.

/app/itdesk/api/v3/requests

If you have multiple portals and if you don’t mention the portal name in the API request, the response for the IT Desk will be shown.

Operations

Following are the different types of API request methods,

Method Description
POST Used to add entity details
GET Used to view the entity details
PUT Used to Update/Bulk-Update the entity detail(s)
DELETE Used to Delete/Bulk-Delete the entity detail(s)

Input Data

Format


{

    "entity" :{"Entity Attributes and values"},
    "list_info": {"Attributes and values for List view kind of navigation"},
    "fields_required" : [ "list of fields required" ]
}

It is a JSON string which contain all the fields and their values. It will be passed as a parameter for required operations.

List Info

The General structure of Input Data

list_info :
{
   row_count         : number of rows to be returned
   start_index        : starting row index
   sort_field           : "fieldName"
   sort_order          : “asc/desc”,
   search_fields     : { "field1" : "value", "field2" : value }, //
   get_total_count   : boolean (by default it will be false)
   has_more_rows   : boolean (will be returned with the response)
   total_count          : count (will be returned with the response only)
   search_criteria    :  Refer criteria object (For performing advanced search)

}

For navigating and getting data, list_info can be provided with input_data. Fields available for list_info are

start_index
Use this to get a list of tasks starting from this index.
e.g: 6
row_count
Use this to mention the number of rows that needs to be returned.
e.g: 15
search_fields
The column name and value to be searched for in the format of a json object.
e.g {“title”:“Change like this”,“priority”:“High”}
search_criteria
The column name and the value with specific conditions to be searched.
e.g {field:‘project.id’,condition:'eq’,value:project_id}
sort_field
The column name for the sorting functionality
e.g:requester
sort_order
The sorting order, either ascending or descending.
e.g: asc or desc
has_more_rows
Indicates whether there are more rows or not.
e.g: true, false
get_total_count
Indicates whether to get the total count of data or not.
e.g: true, false
total_count
Contains the total count of the data based on the “get_total_count” variable.
e.g: true, false
fields_required
Columns that need to be displayed in the output. JSON array must be given as input
e.g: “[title,priority]”

Response

Response will be in the JSON format. Response JSON Object contains,

Fields Description
Entity Name Contains the entity details
Response Status Status code with the success/failure message(s)
List Info Contains an Information about the entity such as row count, has_more_rows and so on

Common Error Codes

Bulk Api error response example

{
  "response_status": [
    {
      "status_code": 2000,
      "id": "100000000000066057",
      "status": "success"
    },
    {
      "status_code": 4000,
      "id": "100000000000066051",
      "status": "failed",
      "messages": [
        {
          "status_code": 4004,
          "message": "Internal Error",
          "type": "failed"
        }
      ]
    }
  ]
}

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 scenarioCodeHTTP codeExample response (content of response_status object)
Id or Name given in Input does not exist or not in use or user cannot set the value4001400 { “response_status”: { “messages”: [ { “status_code”: 4001, “type”: “failed”, “message”: “Value given for title is not valid” } ], “status”: “failed” } }
Forbidden / User not allowed to perform the operation4002403 { “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4002, “type”: “failed”, “message”: “User does not have this permission” } ], “status”: “failed"4 } }
Closure rule violation4003400 { "response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4003, “type”: “failed”, “message”: “Closure rule violation. The following fields should be filled title” } ], “status”: “failed” } }
Internal Error (Exact error cannot be sent to user, like some Exception)4004500{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4004, “type”: “failed” } ], “status”: “failed”{ } }
Reference Exists. (Cannot delete an entity, because it is being used in another module)4005400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4005, “field”: “id”, “type”: “failed” } ], “status”: “failed” } }
Invalid URL or Resource not founde.g., /requests/10 and if the request with id 10 not found4007404{ “response_status”: { “messages”: [ { “status_code”: 4007, “type”: “failed”, “message”: “Invalid URL” } ], “status”: “failed” } }
Not Unique4008400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4008, “field”: “name”, “type”: “failed” } ], “status”: “failed” } }
Trying to edit non-editable field(value for certain fields can be given during add but cannot be edited e.g., status in_progress)4009400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4009, “field”: “project_template”, “type”: “failed” } ], “status”: “failed” } }
Trying to edit internal field4010400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4010, “type”: “failed”, “message”: “Trying to edit internal field: internal_name” } ], “status”: “failed” } }
No such field4011400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4011, “type”: “failed”, “message”: “No field exists with the name field_name” } ], “status”: “failed” } }
Value for mandatory-field is not provided4012400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4012, “field”: “title”, “type”: “failed” } ], “status”: “failed” } }
Unsupported Content Type4013415{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4013, “type”: “failed” } ], “status”: “failed” } }
Trying to edit read-only field4014400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4014, “field”: “created_time”, “type”: “failed” } ], “status”: “failed” } }
API Rate Limit reached4015400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4015, “type”: “failed” } ], “status”: “failed” } }
Already in Trash4016400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4016, “type”: “failed”, “message”: “Request is already in trash” } ], “status”: “failed” } }
Not In Trash4017400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 4017, “type”: “failed” } ], “status”: “failed” } }
Not allowed as per current license7001400{ “response_status”: { “status_code”: 4000, “messages”: [ { “status_code”: 7001, “type”: “failed”, “message”: “Cannot perform the intended operation as per current lisence” } ], “status”: “failed” } }

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.

Attributes

All Attributes
id

Id of this request

subject*

Subject of this request[Max-length : 250]

description

Description of this request

impact_details

Description about the impact of this request[Max-length : 250]

resolution

A solution for the request, provided by the technician

content

Resolution content provided by the technician to resolve this request.

time_elapsed
LONG(Read-Only)

Indicates the time spent on this request

email_cc
STRING(Read-Only)

List of e-mail addresses(cc addresses) which receives the request through e-mail.

email_ids_to_notify

Array of Email ids, which needs to be notified about the happenings of this request

update_reason

The reason for updating this request[Max-length : 250]

email_to
STRING(Read-Only)

List of email addresses(to addresses) which receives the request

email_bcc
STRING(Read-Only)

List of email addresses(bcc addresses) which receives the request

onhold_scheduler

Contains the scheduling details for the request, when the request is in Onhold status

scheduled_time

Denotes the scheduled time for the onhold scheduler to change the Request’s status

comments

Comments added for linking requests[Max-length : 250]

holded_by
REFERRED_FIELD(Read-Only)

User object of the user who put the request onhold

change_to_status

Status object to which the request is scheduled to move to, after the onhold scheduler is completed.

closure_info

Contains the closure information when the request is in Closed status

requester_ack_resolution

Denotes if the requester has acknowledged the resolution he/she has been given.

requester_ack_comments

Comments from the requester in regards to the resolution he/she has been given[Max-length : 250]

impact

Impact of this request

status

Indicates the current status of this request

display_id
LONG(Read-Only)

Display id of this request

requester

Indicates the requester of this request

created_by
REFERRED_FIELD(Read-Only)

Indicates the requester who created this request

created_time

Indicates the time at which this request is created

responded_time
DATETIME(Read-Only)

Indicates the time at which this request is responded

due_by_time

Indicates the time at which this request is scheduled to be completed

completed_time
DATETIME(Read-Only)

Indicates the time at which this request is completed

mode

The mode in which this request is created

sla
REFERRED_FIELD(Read-Only)

SLA details associated with this request

department
REFERRED_FIELD(Read-Only)

Department to which this requester belongs

site

Denotes the site to which this request belongs

deleted_time
DATETIME(Read-Only)

Denotes the time at which the request will be deleted

template

Indicates the template which is used to create this request

first_response_due_by_time

Indicates the time at which the first response for this request is scheduled

service_category

Service category to which this request belongs

is_service_request
BOOLEAN(Read-Only)

Boolean value indicating whether this request is a service request or not

resolved_time
DATETIME(Read-Only)

Indicates the time at which this request is resolved

last_updated_time
DATETIME(Read-Only)

Indicates the time when this request is last updated

is_overdue
BOOLEAN(Read-Only)

Boolean value indicating whether this request is overdue

is_first_response_overdue
BOOLEAN(Read-Only)

Boolean value indicating whether this request is in overdue to make first response

is_escalated
BOOLEAN(Read-Only)

A boolean value which represents whether the request is escalated or not

is_read
BOOLEAN(Read-Only)

Boolean value indicating whether this request’s replies are read or not

is_fcr

Boolean value indicating if the request has been marked as First Call Resolution

notification_status
STRING(Read-Only)

Shows the current status of request’s replies, whether last one from requester or technician

approval_status
REFERRED_FIELD(Read-Only)

Denotes the approval status of this request.(Approved/Pending Approval/Rejected)

group

The group to which the request is assigned to

technician

Technician assigned to this request

assigned_time
DATETIME(Read-Only)

Indicates the time at which this request is assigned to a technician

priority

Priority of the request

level

Level of the request

category

Category to which the request belongs

subcategory

Subcategory to which the request belongs

item

Item of the request

urgency

Urgency of the request

request_type

Type of the request

assets

Array of asset objects associated to this request

has_attachments
BOOLEAN(Read-Only)

Boolean value indicating whether this request has any attachments or not

has_notes
BOOLEAN(Read-Only)

Boolean value indicating whether this request has any notes or not

has_linked_requests
BOOLEAN(Read-Only)

Boolean value indicating whether this request has any linked requests or not

has_project
BOOLEAN(Read-Only)

Boolean value indicating whether this request is associated to a project or not

has_problem
BOOLEAN(Read-Only)

Boolean value indicating whether this request is associated to a problem or not

has_request_initiated_change
BOOLEAN(Read-Only)

Boolean value indicating whether this request is initiated a change or not

has_purchase_orders
BOOLEAN(Read-Only)

Boolean value indicating whether this request is associated to Purchase Order(s)

has_draft
BOOLEAN(Read-Only)

Boolean value indicating whether this request has drafts or not

is_reopened
BOOLEAN(Read-Only)

Boolean value indicating whether this request is reopened or not

is_trashed
BOOLEAN(Read-Only)

Boolean value indicating whether this request is in trash

linked_to_request
REFERRED_FIELD(Read-Only)

Holds linked request details

udf_fields

Holds udf fields’ values associated with the request

resources

Holds the resource data mapped to the request

Add Request

POST /api/v3/requests

Request Example

$ curl /api/v3/requests \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail",
      "id": "1515992722999805"
    },
    "assets": [
      {
        "name": "Keyboard ",
        "id": "2119953523156302"
      }
    ],
    "group": {
      "name": "Hardware Problems",
      "id": "2384082943126348"
    },
    "requester": {
      "name": "Lincoln",
      "id": "2055418455050103"
    },
    "item": {
      "name": "Install",
      "id": "1862563060220080"
    },
    "level": {
      "name": "Tier 1",
      "id": "2193718521426216"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1686385467278392"
    },
    "service_category": {
      "name": "Corporate Website",
      "id": "2252841980990107"
    },
    "priority": {
      "name": "High",
      "id": "1564618687177204"
    },
    "udf_fields": {
      "udf_long1": "1501528907152549",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1674316019526033"
    },
    "status": {
      "name": "Open",
      "id": "1785312960651555"
    },
    "template": {
      "name": "Default Template",
      "id": "2397601468990409"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Incident",
      "id": "2212583526168046"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent",
      "id": "2052077318802580"
    },
    "technician": {
      "name": "Charles",
      "id": "1780336375950852"
    },
    "site": {
      "name": "Custom Site",
      "id": "2383599711166109"
    },
    "category": {
      "name": "Software",
      "id": "2252769524576816"
    }
  }
}

Response Example

{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "linked_to_request": {
      "display_id": 23,
      "subject": "Need an External Monitor",
      "id": "1607466189074311"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "1515992722999805"
    },
    "assets": [
      {
        "name": "Keyboard ",
        "id": "2119953523156302"
      }
    ],
    "is_trashed": false,
    "id": "2337546562643797",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "name": "Hardware Problems",
      "id": "2384082943126348"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2055418455050103",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "1862563060220080"
    },
    "level": {
      "name": "Tier 1",
      "id": "2193718521426216"
    },
    "approval_status": {
      "name": "Approved",
      "id": "2056425451500833"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1686385467278392"
    },
    "service_category": {
      "name": "Corporate Website",
      "id": "2252841980990107"
    },
    "sla": {
      "id": "1741987962172847"
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1564618687177204"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2141130667566827",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_long1": "1501528907152549",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1674316019526033"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "1785312960651555"
    },
    "template": {
      "name": "Default Template",
      "id": "2397601468990409"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Incident",
      "id": "2212583526168046"
    },
    "display_id": "39",
    "time_elapsed": "2136761502227540",
    "notification_status": "TECH_REPLY",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "urgency": {
      "name": "Urgent",
      "id": "2052077318802580"
    },
    "has_request_initiated_change": false,
    "department": {
      "name": "Administration",
      "id": "2137915138349542"
    },
    "is_reopened": false,
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "is_overdue": false,
    "technician": {
      "email_id": "test@test.com",
      "cost_per_hour": 1343434.4333,
      "name": "Charles",
      "id": "1780336375950852"
    },
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "name": "Custom Site",
      "id": "2383599711166109"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "email_bcc": [],
    "category": {
      "name": "Software",
      "id": "2252769524576816"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add request.

Show All Attributes

Update Request

PUT /api/v3/requests/{request_id}

Request Example

$ curl /api/v3/requests/{request_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "request": {
    "template": {
      "name": "Default Template",
      "id": "2258791893520690"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Incident",
      "id": "2464578629628837"
    },
    "subject": "Need an External Monitor",
    "description": "Provide me an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail",
      "id": "2062943623170439"
    },
    "assets": [
      {
        "name": "Keyboard ",
        "id": "1480753899975331"
      }
    ],
    "urgency": {
      "name": "Urgent",
      "id": "1707770498131550"
    },
    "group": {
      "name": "Hardware Problems",
      "id": "1512193947146652"
    },
    "requester": {
      "name": "Lincoln",
      "id": "1575886403955835"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "1666866330020033"
    },
    "level": {
      "name": "Tier 1",
      "id": "2010167786750850"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1778208366198834"
    },
    "service_category": {
      "name": "Corporate Website",
      "id": "1698034233893503"
    },
    "update_reason": "The request is updated for this reason",
    "technician": {
      "name": "Charles",
      "id": "2471492472636777"
    },
    "priority": {
      "name": "High",
      "id": "1894280621127388"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site",
      "id": "1905036591245479"
    },
    "udf_fields": {
      "udf_long1": "2101599758535774",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1970969939313235"
    },
    "category": {
      "name": "Software",
      "id": "1751465728665861"
    },
    "status": {
      "name": "Open",
      "id": "1657963852605126"
    }
  }
}

Response Example

{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "linked_to_request": {
      "display_id": 23,
      "subject": "Need an External Monitor",
      "id": "2328470777692373"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "2062943623170439"
    },
    "assets": [
      {
        "name": "Keyboard ",
        "id": "1480753899975331"
      }
    ],
    "is_trashed": false,
    "id": "2270853863954207",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "name": "Hardware Problems",
      "id": "1512193947146652"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1575886403955835",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "1666866330020033"
    },
    "level": {
      "name": "Tier 1",
      "id": "2010167786750850"
    },
    "approval_status": {
      "name": "Approved",
      "id": "2392203070005972"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1778208366198834"
    },
    "service_category": {
      "name": "Corporate Website",
      "id": "1698034233893503"
    },
    "update_reason": "The request is updated for this reason",
    "sla": {
      "id": "2150816688792916"
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1894280621127388"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1493712503616057",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_long1": "2101599758535774",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1970969939313235"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "1657963852605126"
    },
    "template": {
      "name": "Default Template",
      "id": "2258791893520690"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Incident",
      "id": "2464578629628837"
    },
    "display_id": "39",
    "time_elapsed": "2343026529279713",
    "notification_status": "TECH_REPLY",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "urgency": {
      "name": "Urgent",
      "id": "1707770498131550"
    },
    "has_request_initiated_change": false,
    "department": {
      "name": "Administration",
      "id": "2241975070209374"
    },
    "is_reopened": false,
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "is_overdue": false,
    "technician": {
      "email_id": "test@test.com",
      "cost_per_hour": 1343434.4333,
      "name": "Charles",
      "id": "2471492472636777"
    },
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "name": "Custom Site",
      "id": "1905036591245479"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "email_bcc": [],
    "category": {
      "name": "Software",
      "id": "1751465728665861"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update request.

Show All Attributes

Delete Request

DELETE /api/v3/requests/{request_id}

Request Example

$ curl /api/v3/requests/{request_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete request.

Show All Attributes

Get Request

GET /api/v3/requests/{request_id}

Request Example

$ curl /api/v3/requests/{request_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "linked_to_request": {
      "display_id": 23,
      "subject": "Need an External Monitor",
      "id": "1604336152003612"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "2457669936172135"
    },
    "assets": [
      {
        "name": "Keyboard ",
        "id": "2402361602775217"
      }
    ],
    "is_trashed": false,
    "id": "2158442712138337",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "name": "Hardware Problems",
      "id": "1892515402839490"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2198792460754199",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "1917400355585513"
    },
    "level": {
      "name": "Tier 1",
      "id": "2030874977811855"
    },
    "approval_status": {
      "name": "Approved",
      "id": "2144364581639261"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1657587446380412"
    },
    "service_category": {
      "name": "Corporate Website",
      "id": "1597377163491289"
    },
    "update_reason": "The request is updated for this reason",
    "sla": {
      "id": "1922128078820989"
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2271474691890006"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1556883142073376",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_long1": "1882354560017765",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1786607177035977"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "1639648871699208"
    },
    "template": {
      "name": "Default Template",
      "id": "1833757012087643"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Incident",
      "id": "2203132629207573"
    },
    "display_id": "39",
    "time_elapsed": "2060566584123137",
    "notification_status": "TECH_REPLY",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "urgency": {
      "name": "Urgent",
      "id": "1670470800529203"
    },
    "has_request_initiated_change": false,
    "department": {
      "name": "Administration",
      "id": "1845500852694632"
    },
    "is_reopened": false,
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "is_overdue": false,
    "technician": {
      "email_id": "test@test.com",
      "cost_per_hour": 1343434.4333,
      "name": "Charles",
      "id": "2371274582265366"
    },
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "name": "Custom Site",
      "id": "1623487890904407"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "email_bcc": [],
    "category": {
      "name": "Software",
      "id": "1835056516467966"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get request.

Show All Attributes

Get All Requests

GET /api/v3/requests

Request Example

$ curl /api/v3/requests \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "requests": [
    {
      "subject": "Need an External Monitor",
      "resolution": {
        "content": "The following is the resolution to the above request"
      },
      "linked_to_request": {
        "display_id": 23,
        "subject": "Need an External Monitor",
        "id": "2335538083454475"
      },
      "is_read": false,
      "mode": {
        "name": "E-Mail",
        "id": "2306955645606315"
      },
      "assets": [
        {
          "name": "Keyboard ",
          "id": "1689263804849484"
        }
      ],
      "is_trashed": false,
      "id": "2302334123936370",
      "assigned_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "group": {
        "site": "Custom Site",
        "name": "Hardware Problems",
        "id": "2359899646264790"
      },
      "requester": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2316686624037809",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "email_to": [],
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "item": {
        "name": "Install",
        "id": "1705946156139782"
      },
      "level": {
        "name": "Tier 1",
        "id": "1830608372019766"
      },
      "approval_status": {
        "name": "Approved",
        "id": "2458156890304444"
      },
      "impact": {
        "name": "Affects Business",
        "id": "1637160160825225"
      },
      "service_category": {
        "name": "Corporate Website",
        "id": "1839657950261215"
      },
      "update_reason": "The request is updated for this reason",
      "sla": {
        "id": "1904984961472467"
      },
      "resolved_time": "null",
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1576606463006527"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1738571175397326",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "first_response_due_by_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "is_escalated": false,
      "last_updated_time": "null",
      "has_notes": false,
      "udf_fields": {
        "udf_long1": "1702933538807951",
        "udf_date1": {
          "display_value": "Nov 10, 2016 11:44 AM",
          "value": "1478758440000"
        },
        "udf_char1": "test-udf_char1"
      },
      "impact_details": "Details of the impact",
      "subcategory": {
        "name": "Adobe Reader",
        "id": "2441233671507008"
      },
      "email_cc": [
        "andrews@zmail.com"
      ],
      "deleted_time": "null",
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "color": "#ffffff",
        "name": "Open",
        "id": "2081124853382068"
      },
      "template": {
        "name": "Default Template",
        "id": "1922939082110193"
      },
      "email_ids_to_notify": [
        "andrews@zmail.com"
      ],
      "attachments": [],
      "request_type": {
        "name": "Incident",
        "id": "1933767789496567"
      },
      "display_id": "39",
      "time_elapsed": "1691414954342805",
      "notification_status": "TECH_REPLY",
      "has_purchase_orders": false,
      "description": "Provide me an External Monitor",
      "responded_time": "null",
      "is_service_request": false,
      "urgency": {
        "name": "Urgent",
        "id": "2068918553571008"
      },
      "has_request_initiated_change": false,
      "department": {
        "name": "Administration",
        "id": "2349207945673008"
      },
      "is_reopened": false,
      "has_draft": false,
      "has_attachments": false,
      "has_linked_requests": false,
      "is_overdue": false,
      "technician": {
        "email_id": "test@test.com",
        "cost_per_hour": 1343434.4333,
        "name": "Charles",
        "id": "2383227232468824"
      },
      "has_problem": false,
      "due_by_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "is_fcr": false,
      "has_project": false,
      "site": {
        "name": "Custom Site",
        "id": "2246307292812664"
      },
      "is_first_response_overdue": false,
      "completed_time": "null",
      "email_bcc": [],
      "category": {
        "name": "Software",
        "id": "2310480683706537"
      }
    }
  ]
}

This operation helps you Get all requests.

Show All Attributes

Add Attachment To A Request

POST api/v3/requests/{request_id}/uploads
$ curl api/v3/requests/{request_id}/uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/requests/1234233323423432/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a request. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

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.

Attributes

All Attributes
id

Id of the Note

description*

Indicates the description of the Note

created_by
REFERRED_FIELD(Read-Only)

Denotes the user who created the Note

created_time
DATETIME(Read-Only)

Indicates the created time of the Note

show_to_requester

Represents whether to show the note to requester or not

request
REFERRED_FIELD(Read-Only)

Denotes the request associated to that request note

notify_technician

Represents whether to notify the technician or not

mark_first_response

Represents whether to mark first response for the request

add_to_linked_requests

Represents whether to add the note to the linked requests

Add Note

POST /api/v3/requests/{request_id}/notes

Request Example

$ curl /api/v3/requests/{request_id}/notes \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "request_note": {
    "mark_first_response": false,
    "add_to_linked_requests": false,
    "notify_technician": false,
    "show_to_requester": false,
    "description": "The following is the note for the associated request"
  }
}

Response Example

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

This operation helps you Add note.

Show All Attributes

Update Note

PUT /api/v3/requests/{request_id}/notes/{request_note_id}

Request Example

$ curl /api/v3/requests/{request_id}/notes/{request_note_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "request_note": {
    "mark_first_response": false,
    "add_to_linked_requests": false,
    "notify_technician": false,
    "show_to_requester": false,
    "description": "The following is the note for the associated request"
  }
}

Response Example

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

This operation helps you Update note.

Show All Attributes

Delete Note

DELETE /api/v3/requests/{request_id}/notes/{request_note_id}

Request Example

$ curl /api/v3/requests/{request_id}/notes/{request_note_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete note.

Show All Attributes

Get Note

GET /api/v3/requests/{request_id}/notes/{request_note_id}

Request Example

$ curl /api/v3/requests/{request_id}/notes/{request_note_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

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

This operation helps you Get note.

Show All Attributes

Get All Notes

GET /api/v3/requests/{request_id}/notes

Request Example

$ curl /api/v3/requests/{request_id}/notes \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

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

This operation helps you Get all notes.

Show All Attributes

Approval Level

The approvals are added to the entity Request in different level. This entity represents the level of the approval.

Attributes

All Attributes
id

Primary id for approval level

level

Level number of the approval level

status
REFERRED_FIELD(Read-Only)

Status of the approval level

created_time
DATETIME(Read-Only)

Approval level created time

created_by
REFERRED_FIELD(Read-Only)

User details of the approval level creator

associated_entity
STRING(Read-Only)

Holds the value of this approval belongs to which entity [request, purchase_order, change]

request
REFERRED_FIELD(Read-Only)

Aproval associated request details

change
REFERRED_FIELD(Read-Only)

Aproval associated change details

purchase_order
REFERRED_FIELD(Read-Only)

Aproval associated purchase_order details

Add Request Approval Level

POST /api/v3/requests/{request_id}/approval_levels

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "approval_level": {
    "level": 1
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "approval_level": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "request": {
      "display_id": 23,
      "subject": "Need an External Monitor",
      "id": "1967175088137536"
    },
    "level": 1,
    "associated_entity": "associated-entity-name",
    "id": "2121514809015506",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1921361147595377",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "status": {
      "name": "To be Sent",
      "id": "1724766977924741"
    }
  }
}

This operation helps you Add request approval level.

Show All Attributes

Delete Request Approval Level

DELETE /api/v3/requests/{request_id}/approval_levels/{approval_level_id}

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete request approval level.

Show All Attributes

Get Request Approval Level

GET /api/v3/requests/{request_id}/approval_levels/{approval_level_id}

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "approval_level": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "request": {
      "display_id": 23,
      "subject": "Need an External Monitor",
      "id": "1851769515436284"
    },
    "level": 1,
    "associated_entity": "associated-entity-name",
    "id": "1835745015017151",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1668919110427545",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "status": {
      "name": "To be Sent",
      "id": "2116131553668570"
    }
  }
}

This operation helps you Get request approval level.

Show All Attributes

Get All Request Approval Levels

GET /api/v3/requests/{request_id}/approval_levels

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "approval_levels": [
    {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "request": {
        "display_id": 23,
        "subject": "Need an External Monitor",
        "id": "1484701004676922"
      },
      "level": 1,
      "associated_entity": "associated-entity-name",
      "id": "2371146549265347",
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1617055878564381",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "status": {
        "name": "To be Sent",
        "id": "2458307949040331"
      }
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all request approval levels.

Show All Attributes

Approval

The raised ticket can be sent for approval from the authorized users or higher authority

Attributes

All Attributes
id

Id of the approval

approval_level
REFERRED_FIELD(Read-Only)

Approval level to which the approval is associated

status
REFERRED_FIELD(Read-Only)

Status of the Approval

sent_on
DATETIME(Read-Only)

Date at which the approval is being sent

action_taken_on
DATETIME(Read-Only)

Date at which the action on the approval is taken

approver

Approver of the approval

comments

Comments given on the approval by the approver [Max-length : 250]

Add Request Approval

POST /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "approval": {
    "approver": {
      "name": "Lincoln",
      "id": "2422710181013944"
    }
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "approval": {
    "approver": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2422710181013944",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "comments": "Comments for why this entity is approved/rejected",
    "approval_level": {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "level": 1,
      "associated_entity": "associated-entity-name",
      "id": "2465714808608914"
    },
    "id": "1584515940436841",
    "sent_on": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "created_by": {
      "email-id": "lincoln@zmail.com",
      "sms-mail": "linc123@xyz_sms.co",
      "phone": "test-phone",
      "photo-url": "test-photo-url",
      "name": "Lincoln",
      "department": "null"
    },
    "action_taken_on": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "status": {
      "name": "To be Sent",
      "id": "1962862753325483"
    }
  }
}

This operation helps you Add request approval.

Show All Attributes

Delete Request Approval

DELETE /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete request approval.

Show All Attributes

Get Request Approval

GET /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "approval": {
    "approver": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1483809943936751",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "comments": "Comments for why this entity is approved/rejected",
    "approval_level": {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "level": 1,
      "associated_entity": "associated-entity-name",
      "id": "2355605973076858"
    },
    "id": "2420821373201557",
    "sent_on": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "action_taken_on": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "status": {
      "name": "To be Sent",
      "id": "2187599769650705"
    }
  }
}

This operation helps you Get request approval.

Show All Attributes

Get All Request Approvals

GET /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "approvals": [
    {
      "approver": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1554143504136337",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "comments": "Comments for why this entity is approved/rejected",
      "approval_level": {
        "created_time": {
          "display_value": "Nov 10, 2016 11:44 AM",
          "value": "1478758440000"
        },
        "level": 1,
        "associated_entity": "associated-entity-name",
        "id": "1996320433718537"
      },
      "id": "2247572111909654",
      "sent_on": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "created_by": {
        "email-id": "lincoln@zmail.com",
        "sms-mail": "linc123@xyz_sms.co",
        "phone": "test-phone",
        "photo-url": "test-photo-url",
        "name": "Lincoln",
        "department": "null"
      },
      "action_taken_on": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "status": {
        "name": "To be Sent",
        "id": "2323222205731577"
      }
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all request approvals.

Show All Attributes

Approve Request

PUT /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/approve

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/approve \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "approval": {
    "comments": "The comments to approve the approval"
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "messages": [
      {
        "status_code": 2000,
        "type": "success",
        "message": "Your decision has been recorded. Thank you for your cooperation!"
      }
    ],
    "status": "success"
  }
}

This operation helps you Approve request.

Show All Attributes

Reject Request

PUT /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/reject

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/reject \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "approval": {
    "comments": "The comments to reject the approval"
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "messages": [
      {
        "status_code": 2000,
        "type": "success",
        "message": "Your decision has been recorded. Thank you for your cooperation!"
      }
    ],
    "status": "success"
  }
}

This operation helps you Reject request.

Show All Attributes

Get Notification Content For Sending Request Approval

GET /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/send_notification

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/send_notification \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "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.

Show All Attributes

Send Notification For Request Approval

PUT /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/send_notification

Request Example

$ curl /api/v3/requests/{request_id}/approval_levels/{approval_level_id}/approvals/{approval_id}/send_notification \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "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 Example

{
  "response_status": {
    "status_code": 2000,
    "messages": [
      {
        "status_code": 2000,
        "type": "success",
        "message": "Approval Mail Sent"
      }
    ],
    "status": "success"
  }
}

This operation helps you Send notification for request approval.

Show All Attributes

Task

A task is an activity or piece of work which you have to do, usually as part of a larger request

Attributes

All Attributes
id

Unique Identifier to identify the task

title*

Title of the task

description

Contains description about the task

created_date
DATETIME(Read-Only)

Date and time at which the task is created

scheduled_start_time

Date and time at which the task is scheduled to start

scheduled_end_time

Date and time at which the task is scheduled to finish

actual_start_time

Date and time at which the task has actually started

actual_end_time

Date and time at which the task actually got finished

status*

Indicates the level of progress of the task

email_before

Indicates when to send an notification before schedule start

owner

The User assigned to the task

marked_technician

The technician to be assigned when the task is triggered

created_by
REFERRED_FIELD(Read-Only)

Name and Id of the Technician who created the task is present in JSON format

priority

Defines the intensity or importance of a task. 

percentage_completion

Indicates the progress of the task in percentage of completion

additional_cost

Cost spent other than the actual cost of the task

estimated_effort_days

Estimated number of days to finish the task

estimated_effort_hours

Estimated number of hours to finish the task

estimated_effort_minutes

Estimated number of minutes to finish the task

task_type

Used to categorize the tasks of similar cases

deleted
BOOLEAN(Read-Only)

Indicates whether the task is deleted or not

overdue
BOOLEAN(Read-Only)

Indicates whether the task is overdue or not

associated_entity
STRING(Read-Only)

Entity associated to the task

request
REQUEST(Read-Only)

Request Entity to which the task is going to be associated

problem
PROBLEM(Read-Only)

Problem Entity to which the task is going to be associated

change
CHANGE(Read-Only)

Change Entity to which the task is going to be associated

project
PROJECT(Read-Only)

Project Entity to which the task is going to be associated

milestone
MILESTONE(Read-Only)

Milestone Entity to which the task is going to be associated

request_template
REQUEST_TEMPLATE(Read-Only)

The request template with which the task is associated

project_template
PROJECT_TEMPLATE(Read-Only)

The project template with which the task is associated

milestone_template

The milestone template with which the task is associated

Add Request Task

POST /api/v3/requests/{request_id}/tasks

Request Example

$ curl /api/v3/requests/{request_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "2200156609975255"
    },
    "priority": {
      "name": "High",
      "id": "1784147614179386"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2067895611716225"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2200156609975255",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1784147614179386"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2390255892735737",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1520122835757298",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2067895611716225"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add request task.

Show All Attributes

Update Request Task

PUT /api/v3/requests/{request_id}/tasks/{task_id}

Request Example

$ curl /api/v3/requests/{request_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "1994319851602389"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "1926867756564771"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2356047696304738"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1994319851602389",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1926867756564771"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2414114174281074",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2194978528387400",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2356047696304738"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update request task.

Show All Attributes

Delete Request Task

DELETE /api/v3/requests/{request_id}/tasks/{task_id}

Request Example

$ curl /api/v3/requests/{request_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete request task.

Show All Attributes

Get Request Task

GET /api/v3/requests/{request_id}/tasks/{task_id}

Request Example

$ curl /api/v3/requests/{request_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "task": {
    "percentage_completion": 43,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "1755030318298125",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": null,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2388289230983353",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1560949893359019",
      "photo_url": "test-photo_url"
    },
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2377269468395940"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2127989175577008",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "deleted": false,
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "1554909791959402"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2129842433048943"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get request task.

Show All Attributes

Get All Request Tasks

GET /api/v3/requests/{request_id}/tasks

Request Example

$ curl /api/v3/requests/{request_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "tasks": [
    {
      "percentage_completion": 28,
      "estimated_effort_hours": "20",
      "attachments": [],
      "email_before": "2052365705566764",
      "description": "The SRS must contain all the requirements for the feature",
      "title": "Create SRS",
      "marked_technician": null,
      "overdue": false,
      "additional_cost": 1343434.4333,
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "id": "2402198179701438",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2208950803045092",
        "photo_url": "test-photo_url"
      },
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1857803855827601"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1937184116750443",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_effort_minutes": "45",
      "deleted": false,
      "created_date": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "estimated_effort_days": "15",
      "task_type": {
        "color": "#ffffff",
        "name": "Testing",
        "id": "1626726180903512"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "color": "#ffffff",
        "name": "Open",
        "id": "2079917013618878"
      }
    }
  ]
}

This operation helps you Get all request tasks.

Show All Attributes

Add Attachment To A Request Task

POST api/v3/requests/{request_id}/tasks/{task_id}/uploads
$ curl api/v3/requests/{request_id}/tasks/{task_id}/uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/requests/3421234312443123/tasks/43234334341234564/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a request task. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

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.

Attributes

All Attributes
id

Unique identifier of the project

project_code

Unique code of the project

title*

Title of the project

project_type

Type of the project

owner

User to which the project is assigned

priority

Priority/Importance of the project

status*

Status of the project

project_template

The template with which the project is created

created_by
REFERRED_FIELD(Read-Only)

This attribute holds the user who created the project This attribute is applicable only for output and will be ignored in input fields

created_time
DATETIME(Read-Only)

Denotes the created time of the project 

scheduled_start_time

Denotes the planned starting time of the project 

scheduled_end_time

Denotes the planned ending time of the project

actual_start_time

Denotes the actual starting time of the project

actual_end_time

Denotes the actual ending time of the project

projected_end

The estimated end date for the project

estimated_hours

Denotes the hours estimated to complete the project

actual_hours

Denotes the actual hours taken to complete the project

estimated_cost

Denotes the cost estimated to complete the project

actual_cost

Denotes the actual cost spent to complete the project

percentage_completion

The percentage upto which the project has been completed

site

Site to which the project belongs

description

Description of the project

udf_fields

The additional fields for the project

Add Project

POST /api/v3/projects

Request Example

$ curl /api/v3/projects \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project": {
    "owner": {
      "name": "Lincoln",
      "id": "1991343173313386"
    },
    "project_template": {
      "name": "Default",
      "id": "2184602413056357"
    },
    "percentage_completion": 6,
    "project_type": {
      "name": "Business",
      "id": "2111485308127078"
    },
    "description": "test-description",
    "project_code": "test-project_code",
    "title": "test-title",
    "priority": {
      "name": "High",
      "id": "2155242478244275"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "site": {
      "name": "Custom Site",
      "id": "2254187852635490"
    },
    "actual_hours": "15",
    "actual_cost": 1343434.4333,
    "estimated_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "estimated_hours": "18",
    "udf_fields": {
      "udf_long1": "1552310695240627",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "projected_end": {
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1983763007748226"
    }
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1991343173313386",
      "photo_url": "test-photo_url"
    },
    "project_template": {
      "name": "Default",
      "id": "2184602413056357",
      "title": "test-title"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "percentage_completion": 6,
    "project_type": {
      "color": "#ffffff",
      "name": "Business",
      "id": "2111485308127078"
    },
    "description": "test-description",
    "project_code": "test-project_code",
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2155242478244275"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1579068506660197",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "site": {
      "name": "Custom Site",
      "id": "2254187852635490"
    },
    "actual_hours": "15",
    "actual_cost": 1343434.4333,
    "estimated_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "18",
    "udf_fields": {
      "udf_long1": "1552310695240627",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "id": "2017404136071417",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "1983763007748226"
    }
  }
}

This operation helps you Add project.

Show All Attributes

Update Project

PUT /api/v3/projects/{project_id}

Request Example

$ curl /api/v3/projects/{project_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project": {
    "owner": {
      "name": "Lincoln",
      "id": "2063048230044757"
    },
    "percentage_completion": 31,
    "project_type": {
      "name": "Business",
      "id": "2013760113576047"
    },
    "description": "test-description",
    "project_code": "test-project_code",
    "title": "test-title",
    "priority": {
      "name": "High",
      "id": "1806079699317246"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "site": {
      "name": "Custom Site",
      "id": "2105365848065503"
    },
    "actual_hours": "15",
    "actual_cost": 1343434.4333,
    "estimated_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "estimated_hours": "18",
    "udf_fields": {
      "udf_long1": "2019393247065962",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "projected_end": {
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1555217043834564"
    }
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2063048230044757",
      "photo_url": "test-photo_url"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "percentage_completion": 31,
    "project_type": {
      "color": "#ffffff",
      "name": "Business",
      "id": "2013760113576047"
    },
    "description": "test-description",
    "project_code": "test-project_code",
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1806079699317246"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1766899297890368",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "site": {
      "name": "Custom Site",
      "id": "2105365848065503"
    },
    "actual_hours": "15",
    "actual_cost": 1343434.4333,
    "estimated_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "18",
    "udf_fields": {
      "udf_long1": "2019393247065962",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "id": "2477083382365317",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "1555217043834564"
    }
  }
}

This operation helps you Update project.

Show All Attributes

Delete Project

DELETE /api/v3/projects/{project_id}

Request Example

$ curl /api/v3/projects/{project_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project.

Show All Attributes

Get Project

GET /api/v3/projects/{project_id}

Request Example

$ curl /api/v3/projects/{project_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1667545473052926",
      "photo_url": "test-photo_url"
    },
    "project_template": {
      "name": "Default",
      "id": "1683826380217138",
      "title": "test-title"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "percentage_completion": 32,
    "project_type": {
      "color": "#ffffff",
      "name": "Business",
      "id": "1661839815376386"
    },
    "description": "test-description",
    "project_code": "test-project_code",
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1693054354612688"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2030545992047051",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "site": {
      "name": "Custom Site",
      "id": "2360245555122043"
    },
    "actual_hours": "15",
    "actual_cost": 1343434.4333,
    "estimated_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "18",
    "udf_fields": {
      "udf_long1": "1618608825034597",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_char1": "test-udf_char1"
    },
    "id": "2342224931445791",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "2392991930256208"
    }
  }
}

This operation helps you Get project.

Show All Attributes

Get All Projects

GET /api/v3/projects

Request Example

$ curl /api/v3/projects \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "projects": [
    {
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1928290436329154",
        "photo_url": "test-photo_url"
      },
      "project_template": {
        "name": "Default",
        "id": "2277385199975261",
        "title": "test-title"
      },
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "percentage_completion": 9,
      "project_type": {
        "color": "#ffffff",
        "name": "Business",
        "id": "2370436722879045"
      },
      "description": "test-description",
      "project_code": "test-project_code",
      "title": "test-title",
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "2390457836411515"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1612914263384872",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "site": {
        "name": "Custom Site",
        "id": "2272334748161113"
      },
      "actual_hours": "15",
      "actual_cost": 1343434.4333,
      "estimated_cost": 1343434.4333,
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_hours": "18",
      "udf_fields": {
        "udf_long1": "2448081553168394",
        "udf_date1": {
          "display_value": "Nov 10, 2016 11:44 AM",
          "value": "1478758440000"
        },
        "udf_char1": "test-udf_char1"
      },
      "id": "1835271710110951",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "projected_end": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "internal_name": "Open",
        "color": "#ffffff",
        "name": "Open",
        "id": "1648663367428019"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all projects.

Show All Attributes

Add Attachment To A Project

POST api/v3/projects/{project_id}/uploads
$ curl api/v3/projects/{project_id}/uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/projects/4123312432431431/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a project. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

Attach Requests

POST /api/v3/projects/{project_id}/request_associations

Request Example

$ curl /api/v3/projects/{project_id}/request_associations \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "requests": [
    "100000000000027125"
  ]
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Attach requests.

Show All Attributes

Detach Requests

DELETE /api/v3/projects/{project_id}/request_associations

Request Example

$ curl /api/v3/projects/{project_id}/request_associations \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "requests": [
    "100000000000027125"
  ]
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Detach requests.

Show All Attributes

Attach Changes

POST /api/v3/projects/{project_id}/change_associations

Request Example

$ curl /api/v3/projects/{project_id}/change_associations \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "changes": [
    "100000000000027125"
  ]
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Attach changes.

Show All Attributes

Detach Changes

DELETE /api/v3/projects/{project_id}/change_associations

Request Example

$ curl /api/v3/projects/{project_id}/change_associations \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "changes": [
    "100000000000027125"
  ]
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Detach changes.

Show All Attributes

Get Project Timesheet

GET /api/v3/projects/{project_id}/timesheet

Request Example

$ curl /api/v3/projects/{project_id}/timesheet \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "timesheet": [
    {
      "owner": {
        "photo-url": "test-photo-url",
        "name": "Charles",
        "id": "1256498736565975",
        "email": "charles@zmail.com"
      },
      "total_tech_charge": "10.00",
      "total_time_spent": {
        "hours": "02",
        "minutes": "20"
      },
      "total_amount_spent": "18.23",
      "total_other_charge": "3.00"
    }
  ],
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project timesheet.

Show All Attributes

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.

Attributes

All Attributes
id

Unique Id of the project member

project

The project to which the project member is associated

user*

The user who is going to be referred as project member

role

The role of the project member in that project

is_active

Denotes whether the member is active or not in that project

Add Project Member

POST /api/v3/projects/{project_id}/project_members

Request Example

$ curl /api/v3/projects/{project_id}/project_members \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_member": {
    "is_active": false,
    "role": {
      "name": "test-name",
      "id": "2003171477886434"
    },
    "project": {
      "id": "1904322704205506"
    },
    "user": {
      "name": "Lincoln",
      "id": "1827683341934559"
    }
  }
}

Response Example

{
  "project_members": [
    {
      "is_active": false,
      "role": {
        "name": "test-name",
        "id": "1549984498607640"
      },
      "project": {
        "project_code": "test-project_code",
        "id": "1855444819646485",
        "title": "test-title"
      },
      "id": "1980483456710404",
      "user": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1780483981703912",
        "photo_url": "test-photo_url"
      }
    }
  ],
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_member": {
    "is_active": false,
    "role": {
      "name": "test-name",
      "id": "2003171477886434"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "1904322704205506",
      "title": "test-title"
    },
    "id": "2455597821210130",
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1827683341934559",
      "photo_url": "test-photo_url"
    }
  }
}

This operation helps you Add project member.

Show All Attributes

Update Project Member

PUT /api/v3/projects/{project_id}/project_members/{project_member_id}

Request Example

$ curl /api/v3/projects/{project_id}/project_members/{project_member_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_member": {
    "is_active": false,
    "role": {
      "name": "test-name",
      "id": "2044893758227409"
    },
    "project": {
      "id": "1814454207369675"
    },
    "user": {
      "name": "Lincoln",
      "id": "1911078572808876"
    }
  }
}

Response Example

{
  "project_members": [
    {
      "is_active": false,
      "role": {
        "name": "test-name",
        "id": "2415828882301683"
      },
      "project": {
        "project_code": "test-project_code",
        "id": "1834412623286500",
        "title": "test-title"
      },
      "id": "1499198382907232",
      "user": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1489580046312740",
        "photo_url": "test-photo_url"
      }
    }
  ],
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_member": {
    "is_active": false,
    "role": {
      "name": "test-name",
      "id": "2044893758227409"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "1814454207369675",
      "title": "test-title"
    },
    "id": "1779314483869382",
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1911078572808876",
      "photo_url": "test-photo_url"
    }
  }
}

This operation helps you Update project member.

Show All Attributes

Delete Project Member

DELETE /api/v3/projects/{project_id}/project_members/{project_member_id}

Request Example

$ curl /api/v3/projects/{project_id}/project_members/{project_member_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project member.

Show All Attributes

Get Project Member

GET /api/v3/projects/{project_id}/project_members/{project_member_id}

Request Example

$ curl /api/v3/projects/{project_id}/project_members/{project_member_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "project_members": [
    {
      "is_active": false,
      "role": {
        "name": "test-name",
        "id": "2132454122766612"
      },
      "project": {
        "project_code": "test-project_code",
        "id": "1529650598254771",
        "title": "test-title"
      },
      "id": "1915074822346094",
      "user": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2046813244276139",
        "photo_url": "test-photo_url"
      }
    }
  ],
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_member": {
    "is_active": false,
    "role": {
      "name": "test-name",
      "id": "2445399642629392"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "2439430295594918",
      "title": "test-title"
    },
    "id": "2025591756944693",
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1525411460811925",
      "photo_url": "test-photo_url"
    }
  }
}

This operation helps you Get project member.

Show All Attributes

Get All Project Members

GET /api/v3/projects/{project_id}/project_members

Request Example

$ curl /api/v3/projects/{project_id}/project_members \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "project_members": [
    {
      "is_active": false,
      "role": {
        "name": "test-name",
        "id": "1670732869858791"
      },
      "project": {
        "project_code": "test-project_code",
        "id": "1736120196356703",
        "title": "test-title"
      },
      "id": "1592069812499404",
      "user": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2380358205692826",
        "photo_url": "test-photo_url"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all project members.

Show All Attributes

Project Comment

Comments that enable members/administrators to share their views on project for the betterment of the project.

Attributes

All Attributes
id

Unique identifier of the project comment

project*

The project to which the comment is associated

created_by
REFERRED_FIELD(Read-Only)

The user who created the comment

created_time
DATETIME(Read-Only)

The time at which the comment is created

comment*

Content of the project comment

Add Project Comment

POST /api/v3/projects/{project_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_comment": {
    "comment": "test-comment"
  }
}

Response Example

{
  "project_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "2217247417697130",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "2042074530164627",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2449236413689991",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add project comment.

Show All Attributes

Update Project Comment

PUT /api/v3/projects/{project_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_comment": {
    "comment": "test-comment"
  }
}

Response Example

{
  "project_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "2407268735878580",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "2358526999520399",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1963338647891208",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update project comment.

Show All Attributes

Delete Project Comment

DELETE /api/v3/projects/{project_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project comment.

Show All Attributes

Get Project Comment

GET /api/v3/projects/{project_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "project_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "project": {
      "project_code": "test-project_code",
      "id": "1885468381695823",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "2239289726469167",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1541379421768271",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project comment.

Show All Attributes

Get All Project Comments

GET /api/v3/projects/{project_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "comments": [
    {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "project": {
        "project_code": "test-project_code",
        "id": "1884318634071749",
        "title": "test-title"
      },
      "comment": "test-comment",
      "id": "2190493437160584",
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1774673194716327",
        "photo_url": "test-photo_url",
        "department": "null"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all project comments.

Show All Attributes

Project Task

A task is an activity or piece of work which you have to do, usually as part of a larger project

Add Project Task

POST /api/v3/projects/{project_id}/tasks

Request Example

$ curl /api/v3/projects/{project_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "2200156609975255"
    },
    "priority": {
      "name": "High",
      "id": "1784147614179386"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2067895611716225"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2200156609975255",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1784147614179386"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2390255892735737",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1520122835757298",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2067895611716225"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add project task.

Show All Attributes

Update Project Task

PUT /api/v3/projects/{project_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "1994319851602389"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "1926867756564771"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2356047696304738"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1994319851602389",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1926867756564771"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2414114174281074",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2194978528387400",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2356047696304738"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update project task.

Show All Attributes

Delete Project Task

DELETE /api/v3/projects/{project_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project task.

Show All Attributes

Get Project Task

GET /api/v3/projects/{project_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "task": {
    "percentage_completion": 43,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "1755030318298125",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": null,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2388289230983353",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1560949893359019",
      "photo_url": "test-photo_url"
    },
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2377269468395940"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2127989175577008",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "deleted": false,
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "1554909791959402"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2129842433048943"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project task.

Show All Attributes

Get All Project Tasks

GET /api/v3/projects/{project_id}/tasks

Request Example

$ curl /api/v3/projects/{project_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "tasks": [
    {
      "percentage_completion": 28,
      "estimated_effort_hours": "20",
      "attachments": [],
      "email_before": "2052365705566764",
      "description": "The SRS must contain all the requirements for the feature",
      "title": "Create SRS",
      "marked_technician": null,
      "overdue": false,
      "additional_cost": 1343434.4333,
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "id": "2402198179701438",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2208950803045092",
        "photo_url": "test-photo_url"
      },
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1857803855827601"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1937184116750443",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_effort_minutes": "45",
      "deleted": false,
      "created_date": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "estimated_effort_days": "15",
      "task_type": {
        "color": "#ffffff",
        "name": "Testing",
        "id": "1626726180903512"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "color": "#ffffff",
        "name": "Open",
        "id": "2079917013618878"
      }
    }
  ]
}

This operation helps you Get all project tasks.

Show All Attributes

Add Attachment To A Project Task

POST api/v3/projects/{project_id}/tasks/{task_id}/uploads
$ curl api/v3/projects/{project_id}/tasks/{task_id}/uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/projects/3421234312443123/tasks/43234334341234564/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a project task. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

Project Task Comment

Comments that enable members/administrators to share their views on tasks for the betterment of the project.

Attributes

All Attributes
id

Unique identifier of the task comment

task

The task to which the comment is associated

created_by
REFERRED_FIELD(Read-Only)

The user who created the task comment

created_time
DATETIME(Read-Only)

The time at which the task comment is created

comment*

Content of the task comment

Add Project Task Comment

POST /api/v3/projects/{project_id}/tasks/{task_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task_comment": {
    "task": {
      "id": "1729696439963669"
    },
    "comment": "test-comment"
  }
}

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "1729696439963669",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2154661381207049",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2159817361176807",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add project task comment.

Show All Attributes

Update Project Task Comment

PUT /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task_comment": {
    "task": {
      "id": "1751127925934628"
    },
    "comment": "test-comment"
  }
}

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "1751127925934628",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2311457401802294",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2174458707976764",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update project task comment.

Show All Attributes

Delete Project Task Comment

DELETE /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project task comment.

Show All Attributes

Get Project Task Comment

GET /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "2087173201054487",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2473230192606336",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1663450579395166",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project task comment.

Show All Attributes

Get All Project Task Comments

GET /api/v3/projects/{project_id}/tasks/{task_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "comments": [
    {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "task": {
        "id": "2089233737016988",
        "title": "Create SRS"
      },
      "comment": "test-comment",
      "id": "1758077263726422",
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2455804429133661",
        "photo_url": "test-photo_url",
        "department": "null"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all project task comments.

Show All Attributes

Project Task - Worklog

Helps you track and capture the work done by a team member. 

Attributes

All Attributes
id

Unique id of the Worklog

created_by
REFERRED_FIELD(Read-Only)

The user who created the worklog

owner*
No description
description

Description about the worklog.

time_spent

The time spent in terms of hours, minutes and seconds.

start_time

Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

end_time

Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_time

Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

other_charge

Extra charges other than the Technician related to the worklog.

total_charge
DOUBLE(Read-Only)

The total charges related to the worklog

tech_charge

The technician charges related to the worklog

Add Worklog For Project Task

POST /api/v3/projects/{project_id}/tasks/{task_id}/worklogs

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/worklogs \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "worklog": {
    "owner": {
      "name": "Lincoln",
      "id": "2264474003944364"
    },
    "start_time": {
      "value": "1421988300000"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2264474003944364",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "2289956613142693",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2375734225473688",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Add worklog for project task.

Show All Attributes

Update Worklog For Project Task

PUT /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "worklog": {
    "owner": {
      "name": "Lincoln",
      "id": "2345617086941535"
    },
    "start_time": {
      "value": "1421988300000"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2345617086941535",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "1925156464190022",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2293496185521207",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Update worklog for project task.

Show All Attributes

Delete Worklog For Project Task

DELETE /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete worklog for project task.

Show All Attributes

Get Worklog For Project Task

GET /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1926128744999761",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "2323277281816826",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2225495243592276",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Get worklog for project task.

Show All Attributes

Get All Worklogs For Project Task

GET /api/v3/projects/{project_id}/tasks/{task_id}/worklogs

Request Example

$ curl /api/v3/projects/{project_id}/tasks/{task_id}/worklogs \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "worklogs": [
    {
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1522679475861779",
        "photo_url": "test-photo_url"
      },
      "start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "description": "test-description",
      "other_charge": 1343434.4333,
      "id": "2140363081846324",
      "total_charge": 1343434.4333,
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1869353724585319",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "recorded_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "tech_charge": 1343434.4333,
      "time_spent": {
        "hours": 16800,
        "minutes": 54
      }
    }
  ]
}

This operation helps you Get all worklogs for project task.

Show All Attributes

Milestone

Milestones help you plan the project, decide its various stages, and also serve as landmarks that identify how close a project is on the verge of completion.

Attributes

All Attributes
id

Unique identifier of the milestone

project*

Project to which the milestone is associated

title*

Title of the milestone.

owner

The user to which the milestone is assigned

priority

Priority/importance of the milestone

status*

Status of the milestone

user
REFERRED_FIELD(Read-Only)

This attribute holds the ID of user who created the milestone.

created_time
DATETIME(Read-Only)

Denotes the created time of the milestone. 

scheduled_start_time

Denotes the scheduled starting time of the milestone.

scheduled_end_time

Denotes the scheduled ending time of the milestone.

actual_start_time

Denotes the actual starting time of the milestone.

actual_end_time

Denotes the actual ending time of the milestone.

index

Index of the milestone

estimated_hours

Denotes the hours planned to complete the milestone

actual_hours

Denotes the actual hours required to complete the milestone

projected_end

Denotes the planned due time of the milestone.

description

Description of the milestone

Add Milestone

POST /api/v3/projects/{project_id}/milestones

Request Example

$ curl /api/v3/projects/{project_id}/milestones \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "milestone": {
    "owner": {
      "name": "Lincoln",
      "id": "1485958412627436"
    },
    "index": 10,
    "description": "test-description",
    "project": {
      "id": "2138716312937034"
    },
    "title": "test-title",
    "priority": {
      "name": "High",
      "id": "2281707011900417"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "actual_hours": "1891023753403029",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "estimated_hours": "1625796158364609",
    "actual_start_time": {
      "value": "1421988300000"
    },
    "projected_end": {
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1699653900272090"
    }
  }
}

Response Example

{
  "milestone": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1485958412627436",
      "photo_url": "test-photo_url"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "index": 10,
    "description": "test-description",
    "project": {
      "project_code": "test-project_code",
      "id": "2138716312937034",
      "title": "test-title"
    },
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2281707011900417"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "actual_hours": "1891023753403029",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "1625796158364609",
    "id": "2374180540474714",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1965726512916360",
      "photo_url": "test-photo_url"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "1699653900272090"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add milestone.

Show All Attributes

Update Milestone

PUT /api/v3/projects/{project_id}/milestones/{milestone_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "milestone": {
    "owner": {
      "name": "Lincoln",
      "id": "2044392864226096"
    },
    "index": 36,
    "description": "test-description",
    "project": {
      "id": "1505693531689581"
    },
    "title": "test-title",
    "priority": {
      "name": "High",
      "id": "1946127054267913"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "actual_hours": "1608097903529589",
    "actual_end_time": {
      "value": "1512974940000"
    },
    "estimated_hours": "1544827491440923",
    "actual_start_time": {
      "value": "1421988300000"
    },
    "projected_end": {
      "value": "1512974940000"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "1549556957037224"
    }
  }
}

Response Example

{
  "milestone": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2044392864226096",
      "photo_url": "test-photo_url"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "index": 36,
    "description": "test-description",
    "project": {
      "project_code": "test-project_code",
      "id": "1505693531689581",
      "title": "test-title"
    },
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1946127054267913"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "actual_hours": "1608097903529589",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "1544827491440923",
    "id": "1990150820291656",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1560271180424326",
      "photo_url": "test-photo_url"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "1549556957037224"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update milestone.

Show All Attributes

Delete Milestone

DELETE /api/v3/projects/{project_id}/milestones/{milestone_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete milestone.

Show All Attributes

Get Milestone

GET /api/v3/projects/{project_id}/milestones/{milestone_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "milestone": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2370327338866406",
      "photo_url": "test-photo_url"
    },
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "index": 13,
    "description": "test-description",
    "project": {
      "project_code": "test-project_code",
      "id": "1675865633580882",
      "title": "test-title"
    },
    "title": "test-title",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1651280046551888"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "actual_hours": "1526691830750041",
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_hours": "1597675248271296",
    "id": "2476435344135372",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "projected_end": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "user": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1544848832877674",
      "photo_url": "test-photo_url"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "id": "1755848271269655"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get milestone.

Show All Attributes

Get All Milestones

GET /api/v3/projects/{project_id}/milestones

Request Example

$ curl /api/v3/projects/{project_id}/milestones \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "milestones": [
    {
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1571250109822829",
        "photo_url": "test-photo_url"
      },
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "index": 46,
      "description": "test-description",
      "project": {
        "project_code": "test-project_code",
        "id": "1510638281100963",
        "title": "test-title"
      },
      "title": "test-title",
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1601415678094078"
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "actual_hours": "2250140104076534",
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_hours": "2370578391031853",
      "id": "2295391170687215",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "projected_end": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "user": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2330192608689625",
        "photo_url": "test-photo_url"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "internal_name": "Open",
        "color": "#ffffff",
        "name": "Open",
        "id": "1809951560692497"
      }
    }
  ]
}

This operation helps you Get all milestones.

Show All Attributes

Add Attachment To A Milestone

POST api/v3/projects/{project_id}/milestones/{milestone_id}//uploads
$ curl api/v3/projects/{project_id}/milestones/{milestone_id}//uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/milestones/4123312432431431/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a milestone. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

Get Milestone Timesheet

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/timesheet

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/timesheet \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "timesheet": [
    {
      "owner": {
        "photo-url": "test-photo-url",
        "name": "Charles",
        "id": "1256498736565975",
        "email": "charles@zmail.com"
      },
      "total_tech_charge": "10.00",
      "total_time_spent": {
        "hours": "02",
        "minutes": "20"
      },
      "total_amount_spent": "18.23",
      "total_other_charge": "3.00"
    }
  ],
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get milestone timesheet.

Show All Attributes

Milestone Comment

Comments that enable members/administrators to share their views on milestone for the betterment of the project.

Attributes

All Attributes
id

Unique identifier of the milestone comment

milestone*

The milestone to which the comment is associated to

created_by
REFERRED_FIELD(Read-Only)

The user who created the milestone

created_time
DATETIME(Read-Only)

The time at which the comment is created

comment*

Content of the milestone comment

Add Milestone Comment

POST /api/v3/projects/{project_id}/milestones/{milestone_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "milestone_comment": {
    "comment": "test-comment"
  }
}

Response Example

{
  "milestone_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "milestone": {
      "id": "2205962442999356",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "1793359323399407",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2281309449057600",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add milestone comment.

Show All Attributes

Update Milestone Comment

PUT /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "milestone_comment": {
    "comment": "test-comment"
  }
}

Response Example

{
  "milestone_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "milestone": {
      "id": "1950693724406294",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "1802645711545487",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2444289031881179",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update milestone comment.

Show All Attributes

Delete Milestone Comment

DELETE /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete milestone comment.

Show All Attributes

Get Milestone Comment

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "milestone_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "milestone": {
      "id": "1944628950055374",
      "title": "test-title"
    },
    "comment": "test-comment",
    "id": "1497035900453875",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2264365275673956",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get milestone comment.

Show All Attributes

Get All Milestone Comments

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "comments": [
    {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "milestone": {
        "id": "1712851456344147",
        "title": "test-title"
      },
      "comment": "test-comment",
      "id": "2377600121911203",
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2050542485111639",
        "photo_url": "test-photo_url",
        "department": "null"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all milestone comments.

Show All Attributes

Milestone Task

A task is an activity or piece of work which you have to do, usually as part of a larger milestone.

Add Milestone Task

POST /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "owner": {
      "name": "Lincoln",
      "id": "2200156609975255"
    },
    "priority": {
      "name": "High",
      "id": "1784147614179386"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2067895611716225"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2200156609975255",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 7,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2171242345005075",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1784147614179386"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2390255892735737",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "1520122835757298",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2349217220582604"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2067895611716225"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add milestone task.

Show All Attributes

Update Milestone Task

PUT /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task": {
    "owner": {
      "name": "Lincoln",
      "id": "1994319851602389"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "name": "High",
      "id": "1926867756564771"
    },
    "scheduled_end_time": {
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "value": "1512974940000"
    },
    "actual_start_time": {
      "value": "1421988300000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "value": "1421988300000"
    },
    "status": {
      "name": "Open",
      "id": "2356047696304738"
    }
  }
}

Response Example

{
  "task": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1994319851602389",
      "photo_url": "test-photo_url"
    },
    "percentage_completion": 14,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "2121394730586506",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1926867756564771"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2414114174281074",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "marked_technician": null,
    "deleted": false,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2194978528387400",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "2002265598488106"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2356047696304738"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update milestone task.

Show All Attributes

Delete Milestone Task

DELETE /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete milestone task.

Show All Attributes

Get Milestone Task

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "task": {
    "percentage_completion": 43,
    "estimated_effort_hours": "20",
    "attachments": [],
    "email_before": "1755030318298125",
    "description": "The SRS must contain all the requirements for the feature",
    "title": "Create SRS",
    "marked_technician": null,
    "overdue": false,
    "additional_cost": 1343434.4333,
    "actual_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "id": "2388289230983353",
    "actual_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1560949893359019",
      "photo_url": "test-photo_url"
    },
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2377269468395940"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2127989175577008",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "scheduled_end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "estimated_effort_minutes": "45",
    "deleted": false,
    "created_date": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "estimated_effort_days": "15",
    "task_type": {
      "color": "#ffffff",
      "name": "Testing",
      "id": "1554909791959402"
    },
    "scheduled_start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "color": "#ffffff",
      "name": "Open",
      "id": "2129842433048943"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get milestone task.

Show All Attributes

Get All Milestone Tasks

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "tasks": [
    {
      "percentage_completion": 28,
      "estimated_effort_hours": "20",
      "attachments": [],
      "email_before": "2052365705566764",
      "description": "The SRS must contain all the requirements for the feature",
      "title": "Create SRS",
      "marked_technician": null,
      "overdue": false,
      "additional_cost": 1343434.4333,
      "actual_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "id": "2402198179701438",
      "actual_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2208950803045092",
        "photo_url": "test-photo_url"
      },
      "priority": {
        "color": "#ffffff",
        "name": "High",
        "id": "1857803855827601"
      },
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1937184116750443",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "scheduled_end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "estimated_effort_minutes": "45",
      "deleted": false,
      "created_date": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "estimated_effort_days": "15",
      "task_type": {
        "color": "#ffffff",
        "name": "Testing",
        "id": "1626726180903512"
      },
      "scheduled_start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "color": "#ffffff",
        "name": "Open",
        "id": "2079917013618878"
      }
    }
  ]
}

This operation helps you Get all milestone tasks.

Show All Attributes

Add Attachment To A Milestone Task

POST api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/uploads
$ curl api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/uploads \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -F "filename=@local_file_path" -F "addtoattachment=true"

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/milestones/3421234312443123/tasks/43234334341234564/uploads/4001"
    }
  ]
}

This operation helps you to Add attachment to a milestone task. Here, the input must be given as multipart - form data.

All Attributes
filename*
The path of the file to be uploaded must be given with ’@’ at the beginning of the path
addtoattachment
Denotes whether to add the file as an attachment to the associated entity
The details of the file is contained here
size
The size of the file that is uploaded
content_type
The type of the content of the file
file_id
The file_id is used to add that file as an attachment to the entity
name
The name of the file
content_url
The url of the file that is uploaded

Milestone Task Comment

Comments that enable members/administrators to share their views on tasks for the betterment of the project.

Attributes

All Attributes
id

Unique identifier of the task comment

task

The task to which the comment is associated

created_by
REFERRED_FIELD(Read-Only)

The user who created the task comment

created_time
DATETIME(Read-Only)

The time at which the task comment is created

comment*

Content of the task comment

Add Milestone Task Comment

POST /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task_comment": {
    "task": {
      "id": "1729696439963669"
    },
    "comment": "test-comment"
  }
}

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "1729696439963669",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2154661381207049",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2159817361176807",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add milestone task comment.

Show All Attributes

Update Milestone Task Comment

PUT /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "task_comment": {
    "task": {
      "id": "1751127925934628"
    },
    "comment": "test-comment"
  }
}

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "1751127925934628",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2311457401802294",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2174458707976764",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update milestone task comment.

Show All Attributes

Delete Milestone Task Comment

DELETE /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete milestone task comment.

Show All Attributes

Get Milestone Task Comment

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments/{comment_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "task_comment": {
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "task": {
      "id": "2087173201054487",
      "title": "Create SRS"
    },
    "comment": "test-comment",
    "id": "2473230192606336",
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1663450579395166",
      "photo_url": "test-photo_url",
      "department": "null"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get milestone task comment.

Show All Attributes

Get All Milestone Task Comments

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/comments \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "comments": [
    {
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "task": {
        "id": "2089233737016988",
        "title": "Create SRS"
      },
      "comment": "test-comment",
      "id": "1758077263726422",
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "2455804429133661",
        "photo_url": "test-photo_url",
        "department": "null"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all milestone task comments.

Show All Attributes

Milestone Task - Worklog

Helps you track and capture the work done by a team member. 

Attributes

All Attributes
id

Unique id of the Worklog

created_by
REFERRED_FIELD(Read-Only)

The user who created the worklog

owner*
No description
description

Description about the worklog.

time_spent

The time spent in terms of hours, minutes and seconds.

start_time

Date and time to start the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

end_time

Date and time to end the worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

recorded_time

Date and time of creation of Worklog. JSON Object has the “value” in milliseconds and “display_value” in the standard date format.

other_charge

Extra charges other than the Technician related to the worklog.

total_charge
DOUBLE(Read-Only)

The total charges related to the worklog

tech_charge

The technician charges related to the worklog

Add Worklog For Milestone Task

POST /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "worklog": {
    "owner": {
      "name": "Lincoln",
      "id": "2264474003944364"
    },
    "start_time": {
      "value": "1421988300000"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2264474003944364",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "2289956613142693",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2375734225473688",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Add worklog for milestone task.

Show All Attributes

Update Worklog For Milestone Task

PUT /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "worklog": {
    "owner": {
      "name": "Lincoln",
      "id": "2345617086941535"
    },
    "start_time": {
      "value": "1421988300000"
    },
    "end_time": {
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "recorded_time": {
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2345617086941535",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "1925156464190022",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2293496185521207",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Update worklog for milestone task.

Show All Attributes

Delete Worklog For Milestone Task

DELETE /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete worklog for milestone task.

Show All Attributes

Get Worklog For Milestone Task

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id}

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs/{worklog_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "worklog": {
    "owner": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "1926128744999761",
      "photo_url": "test-photo_url"
    },
    "start_time": {
      "display_value": "Jan 23, 2015 10:15 AM",
      "value": "1421988300000"
    },
    "end_time": {
      "display_value": "Dec 11, 2017 12:19 PM",
      "value": "1512974940000"
    },
    "description": "test-description",
    "other_charge": 1343434.4333,
    "id": "2323277281816826",
    "total_charge": 1343434.4333,
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "sms_mail": "linc123@xys_sms.co",
      "phone": "test-phone",
      "name": "Lincoln",
      "id": "2225495243592276",
      "photo_url": "test-photo_url",
      "department": "null"
    },
    "recorded_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "tech_charge": 1343434.4333,
    "time_spent": {
      "hours": 16800,
      "minutes": 54
    }
  }
}

This operation helps you Get worklog for milestone task.

Show All Attributes

Get All Worklogs For Milestone Task

GET /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs

Request Example

$ curl /api/v3/projects/{project_id}/milestones/{milestone_id}/tasks/{task_id}/worklogs \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "worklogs": [
    {
      "owner": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1522679475861779",
        "photo_url": "test-photo_url"
      },
      "start_time": {
        "display_value": "Jan 23, 2015 10:15 AM",
        "value": "1421988300000"
      },
      "end_time": {
        "display_value": "Dec 11, 2017 12:19 PM",
        "value": "1512974940000"
      },
      "description": "test-description",
      "other_charge": 1343434.4333,
      "id": "2140363081846324",
      "total_charge": 1343434.4333,
      "created_by": {
        "email_id": "lincoln@zmail.com",
        "sms_mail": "linc123@xys_sms.co",
        "phone": "test-phone",
        "name": "Lincoln",
        "id": "1869353724585319",
        "photo_url": "test-photo_url",
        "department": "null"
      },
      "recorded_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "tech_charge": 1343434.4333,
      "time_spent": {
        "hours": 16800,
        "minutes": 54
      }
    }
  ]
}

This operation helps you Get all worklogs for milestone task.

Show All Attributes

Admin

The Admin module is used to configure the settings for each module to make ServiceDesk Plus available for real time functioning.



Project Type

Project Types classify projects based on the goals to be met. For example, a “business” project.

Attributes

All Attributes
id

unique identifier of the project type

name*

Name used to define the project type. The name should be unique. The default project types available are “Business”, “Infrastructure”, “Maintenance”, and “Research”

color

color code used to identify the project type in the application

description

A short description about Project Type

deleted

Denotes whether the project type is deleted or not

Add Project Type

POST /api/v3/project_types

Request Example

$ curl /api/v3/project_types \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_type": {
    "deleted": false,
    "color": "#ffffff",
    "name": "Business",
    "description": "test-description"
  }
}

Response Example

{
  "project_type": {
    "deleted": false,
    "color": "#ffffff",
    "name": "Business",
    "description": "test-description",
    "id": "2302997814041385"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add project type.

Show All Attributes

Update Project Type

PUT /api/v3/project_types/{project_type_id}

Request Example

$ curl /api/v3/project_types/{project_type_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_type": {
    "deleted": false,
    "color": "#ffffff",
    "name": "Business",
    "description": "test-description"
  }
}

Response Example

{
  "project_type": {
    "deleted": false,
    "color": "#ffffff",
    "name": "Business",
    "description": "test-description",
    "id": "1719686414218298"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update project type.

Show All Attributes

Delete Project Type

DELETE /api/v3/project_types/{project_type_id}

Request Example

$ curl /api/v3/project_types/{project_type_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project type.

Show All Attributes

Get Project Type

GET /api/v3/project_types/{project_type_id}

Request Example

$ curl /api/v3/project_types/{project_type_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "project_type": {
    "deleted": false,
    "color": "#ffffff",
    "name": "Business",
    "description": "test-description",
    "id": "2002707810627324"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project type.

Show All Attributes

Get All Project Types

GET /api/v3/project_types

Request Example

$ curl /api/v3/project_types \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "project_types": [
    {
      "deleted": false,
      "color": "#ffffff",
      "name": "Business",
      "description": "test-description",
      "id": "1898266617381751"
    }
  ]
}

This operation helps you Get all project types.

Show All Attributes

Project Status

Status of the project

Attributes

All Attributes
id

Unique identifier of the project status

name*

Name of the project status

description

A short description about Project Status

deleted

Denotes whether the status is deleted or not

in_progress

if the project status refers to a complete/pending project

internal_name
STRING(Read-Only)

Internal name for project status

color

color code used to identify the project status in the application

Add Project Status

POST /api/v3/project_statuses

Request Example

$ curl /api/v3/project_statuses \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "internal_name": "Open",
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description",
    "id": "2292378722422194"
  }
}

This operation helps you Add project status.

Show All Attributes

Update Project Status

PUT /api/v3/project_statuses/{project_status_id}

Request Example

$ curl /api/v3/project_statuses/{project_status_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "internal_name": "Open",
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description",
    "id": "2296915678925913"
  }
}

This operation helps you Update project status.

Show All Attributes

Delete Project Status

DELETE /api/v3/project_statuses/{project_status_id}

Request Example

$ curl /api/v3/project_statuses/{project_status_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project status.

Show All Attributes

Get Project Status

GET /api/v3/project_statuses/{project_status_id}

Request Example

$ curl /api/v3/project_statuses/{project_status_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "internal_name": "Open",
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description",
    "id": "1790710595686964"
  }
}

This operation helps you Get project status.

Show All Attributes

Get All Project Statuses

GET /api/v3/project_statuses

Request Example

$ curl /api/v3/project_statuses \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "project_statuses": [
    {
      "in_progress": false,
      "deleted": false,
      "internal_name": "Open",
      "color": "#ffffff",
      "name": "Open",
      "description": "test-description",
      "id": "2198964688556381"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all project statuses.

Show All Attributes

Project Role

Project role or set of access permissions for the project members.

Attributes

All Attributes
id

unique id of the project role

name*

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)

description

A short description about Project Role

deleted

Denotes whether the role is deleted or not

permissions*

The permissions for the role

Add Project Role

POST /api/v3/project_roles

Request Example

$ curl /api/v3/project_roles \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_role": {
    "deleted": false,
    "permissions": [
      {
        "id": "1745327412781793"
      }
    ],
    "name": "test-name",
    "description": "test-description"
  }
}

Response Example

{
  "project_role": {
    "deleted": false,
    "permissions": [
      {
        "id": "1745327412781793"
      }
    ],
    "name": "test-name",
    "description": "test-description",
    "id": "1743194051436999"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Add project role.

Show All Attributes

Update Project Role

PUT /api/v3/project_roles/{project_role_id}

Request Example

$ curl /api/v3/project_roles/{project_role_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \
      -d 'input_data= {
  "project_role": {
    "deleted": false,
    "permissions": [
      {
        "id": "2088514484409837"
      }
    ],
    "name": "test-name",
    "description": "test-description"
  }
}

Response Example

{
  "project_role": {
    "deleted": false,
    "permissions": [
      {
        "id": "2088514484409837"
      }
    ],
    "name": "test-name",
    "description": "test-description",
    "id": "2380895246238215"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Update project role.

Show All Attributes

Delete Project Role

DELETE /api/v3/project_roles/{project_role_id}

Request Example

$ curl /api/v3/project_roles/{project_role_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Delete project role.

Show All Attributes

Get Project Role

GET /api/v3/project_roles/{project_role_id}

Request Example

$ curl /api/v3/project_roles/{project_role_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "project_role": {
    "deleted": false,
    "permissions": [
      {
        "id": "1691715678037027"
      }
    ],
    "name": "test-name",
    "description": "test-description",
    "id": "1698091287739136"
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

This operation helps you Get project role.

Show All Attributes

Get All Project Roles

GET /api/v3/project_roles

Request Example

$ curl /api/v3/project_roles \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "project_roles": [
    {
      "deleted": false,
      "permissions": [
        {
          "id": "1814282226828483"
        }
      ],
      "name": "test-name",
      "description": "test-description",
      "id": "1560042140522480"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

This operation helps you Get all project roles.

Show All Attributes

Project Permission

The access permissions that are to be given for the project

Attributes

All Attributes
id

Unique Id for the permissions

name

The name of the project permissions

description

The detailed description for the project permissions

Get Project Permission

GET /api/v3/project_permissions/{project_permission_id}

Request Example

$ curl /api/v3/project_permissions/{project_permission_id} \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "project_permission": {
    "name": "test-name",
    "description": "test-description",
    "id": "2073968018005651"
  }
}

This operation helps you Get project permission.

Show All Attributes

Get All Project Permissions

GET /api/v3/project_permissions

Request Example

$ curl /api/v3/project_permissions \
      -H "Accept: application/vnd.manageengine.sdp.v3+json" \
      -H "Authorization: ad88xyszde6c84565aae47dweraf8cc05b" \

Response Example

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  },
  "project_permissions": [
    {
      "name": "test-name",
      "description": "test-description",
      "id": "1805654813221546"
    }
  ]
}

This operation helps you Get all project permissions.

Show All Attributes