Skip to content

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

id (long)
Unique identifier of the project.

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

Example 

234759602834500

title (string)
Title of the project.

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

template (project_template)
Project template from which Project is to be created.

template (project_template)

code (string)
Unique code of the project.

code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

status (project_status)
Status of the project.

status (project_status)

site (site)
Site to which the project belongs.

site (site)

Example 

{
  "site": {
    "id": "601"
  }
}

More Attributes Expand all

department (department)

Department to which this project belongs.

department (department)

Example 

{
  "department": {
    "id": "1"
  }
}

owner (user)

User who owns the project.

owner (user)

type (project_type)

Type of the project that needs to be completed.

type (project_type)

actual_end_time (date)

Denotes the actual ending time of the project.

actual_end_time (date)
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.

Example 

{"value":"1427119462376"}

requester (user)

This attribute holds the user who requested the project.

requester (user)

created_time (datetime)read only

Denotes the created time of the project This attribute is applicable only for output and will be ignored in input fields.

created_time (datetime)
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":"1427119462376","display_value":"Nov 24, 2014 11:58 AM"}

priority (priority)

Priority/importance of the project.

priority (priority)

created_by (user)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_by (user)

scheduled_end_time (date)

Denotes the planned ending time of the project.

scheduled_end_time (date)
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.

Example 

{"value":"1427119462376"}

actual_cost (double)

Denotes the actual cost spent to complete the project.

actual_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_cost (double)

Denotes the cost estimated to complete the project.

estimated_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_hours (long)

Denotes the hours estimated to complete the project.

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

Example 

234759602834500

udf_fields (udf_fields)

Holds user defined field values associated with the project.

udf_fields (udf_fields)

projected_end_time (date)

Denotes the planned due by time of the project.

projected_end_time (date)
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.

Example 

{"value":"1427119462376"}

scheduled_start_time (date)

Denotes the planned starting date of the project.

scheduled_start_time (date)
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.

Example 

{"value":"1427119462376"}

actual_hours (long)

Denotes the actual hours taken to complete the project.

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

Example 

234759602834500

actual_start_time (date)

Denotes the actual starting time of the project.

actual_start_time (date)
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.

Example 

{"value":"1427119462376"}

Add Project

This operation helps you to add a new project.

Mandatory Fields :- title

Url

<service domain|custom domain>/app/<portal>//api/v3/projects

Attributes

id (long)
Unique identifier of the project.

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

Example 

234759602834500

title (string)
Title of the project.

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

template (project_template)
Project template from which Project is to be created.

template (project_template)

code (string)
Unique code of the project.

code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

status (project_status)
Status of the project.

status (project_status)

site (site)
Site to which the project belongs.

site (site)

Example 

{
  "site": {
    "id": "601"
  }
}

More Attributes Expand all

department (department)

Department to which this project belongs.

department (department)

Example 

{
  "department": {
    "id": "1"
  }
}

owner (user)

User who owns the project.

owner (user)

type (project_type)

Type of the project that needs to be completed.

type (project_type)

actual_end_time (date)

Denotes the actual ending time of the project.

actual_end_time (date)
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.

Example 

{"value":"1427119462376"}

requester (user)

This attribute holds the user who requested the project.

requester (user)

created_time (datetime)read only

Denotes the created time of the project This attribute is applicable only for output and will be ignored in input fields.

created_time (datetime)
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":"1427119462376","display_value":"Nov 24, 2014 11:58 AM"}

priority (priority)

Priority/importance of the project.

priority (priority)

created_by (user)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_by (user)

scheduled_end_time (date)

Denotes the planned ending time of the project.

scheduled_end_time (date)
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.

Example 

{"value":"1427119462376"}

actual_cost (double)

Denotes the actual cost spent to complete the project.

actual_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_cost (double)

Denotes the cost estimated to complete the project.

estimated_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_hours (long)

Denotes the hours estimated to complete the project.

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

Example 

234759602834500

udf_fields (udf_fields)

Holds user defined field values associated with the project.

udf_fields (udf_fields)

projected_end_time (date)

Denotes the planned due by time of the project.

projected_end_time (date)
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.

Example 

{"value":"1427119462376"}

scheduled_start_time (date)

Denotes the planned starting date of the project.

scheduled_start_time (date)
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.

Example 

{"value":"1427119462376"}

actual_hours (long)

Denotes the actual hours taken to complete the project.

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

Example 

234759602834500

actual_start_time (date)

Denotes the actual starting time of the project.

actual_start_time (date)
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.

Example 

{"value":"1427119462376"}


$ curl <service domain|custom domain>/app/<portal>//api/v3/projects\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "project": {
        "title": "Project-Doctool",
        "description": "Sync doctool contents",
        "status": {
            "id": 1,
            "name": "Open"
        },
        "type": {
            "id": 2,
            "name": "Infrastructure"
        },
        "priority": {
            "id": 4,
            "name": "High"
        },
        "requester": {
            "id": "4"
        },
        "estimated_hours": 168,
        "actual_hours": 175,
        "estimated_cost": 3000,
        "actual_cost": 3600
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/projects";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "project": {
        "title": "Project-Doctool",
        "description": "Sync doctool contents",
        "status": {
            "id": 1,
            "name": "Open"
        },
        "type": {
            "id": 2,
            "name": "Infrastructure"
        },
        "priority": {
            "id": 4,
            "name": "High"
        },
        "requester": {
            "id": "4"
        },
        "estimated_hours": 168,
        "actual_hours": 175,
        "estimated_cost": 3000,
        "actual_cost": 3600
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/projects"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "project": {
        "title": "Project-Doctool",
        "description": "Sync doctool contents",
        "status": {
            "id": 1,
            "name": "Open"
        },
        "type": {
            "id": 2,
            "name": "Infrastructure"
        },
        "priority": {
            "id": 4,
            "name": "High"
        },
        "requester": {
            "id": "4"
        },
        "estimated_hours": 168,
        "actual_hours": 175,
        "estimated_cost": 3000,
        "actual_cost": 3600
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>//api/v3/projects"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "project": {
        "title": "Project-Doctool",
        "description": "Sync doctool contents",
        "status": {
            "id": 1,
            "name": "Open"
        },
        "type": {
            "id": 2,
            "name": "Infrastructure"
        },
        "priority": {
            "id": 4,
            "name": "High"
        },
        "requester": {
            "id": "4"
        },
        "estimated_hours": 168,
        "actual_hours": 175,
        "estimated_cost": 3000,
        "actual_cost": 3600
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "project": {
        "template": null,
        "description": "Sync doctool contents",
        "milestone_count": "0",
        "projected_end_time": null,
        "title": "Project-Doctool",
        "task_count": "0",
        "milestone_completed": "0",
        "actual_hours": "175",
        "actual_end_time": null,
        "id": "15",
        "actual_start_time": null,
        "department": null,
        "owner": null,
        "created_time": {
            "display_value": "Apr 27, 2020 11:13 AM",
            "value": "1587966201347"
        },
        "type": {
            "color": "#ffff00",
            "name": "Infrastructure",
            "id": "2"
        },
        "code": null,
        "priority": {
            "color": "#ff0000",
            "name": "High",
            "id": "4"
        },
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": null,
        "site": null,
        "requester": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "actual_cost": "3600.00",
        "estimated_cost": "3000.00",
        "estimated_hours": "168",
        "task_completed": "0",
        "status": {
            "internal_name": "Open",
            "color": "#0066ff",
            "name": "Open",
            "id": "1"
        },
        "scheduled_start_time": null
    }
}

Edit Project

This operation helps you to update an existing project.

Url

<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}

Attributes

id (long)
Unique identifier of the project.

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

Example 

234759602834500

title (string)
Title of the project.

title (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

template (project_template)
Project template from which Project is to be created.

template (project_template)

code (string)
Unique code of the project.

code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

status (project_status)
Status of the project.

status (project_status)

site (site)
Site to which the project belongs.

site (site)

Example 

{
  "site": {
    "id": "601"
  }
}

More Attributes Expand all

department (department)

Department to which this project belongs.

department (department)

Example 

{
  "department": {
    "id": "1"
  }
}

owner (user)

User who owns the project.

owner (user)

type (project_type)

Type of the project that needs to be completed.

type (project_type)

actual_end_time (date)

Denotes the actual ending time of the project.

actual_end_time (date)
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.

Example 

{"value":"1427119462376"}

requester (user)

This attribute holds the user who requested the project.

requester (user)

created_time (datetime)read only

Denotes the created time of the project This attribute is applicable only for output and will be ignored in input fields.

created_time (datetime)
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":"1427119462376","display_value":"Nov 24, 2014 11:58 AM"}

priority (priority)

Priority/importance of the project.

priority (priority)

created_by (user)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_by (user)

scheduled_end_time (date)

Denotes the planned ending time of the project.

scheduled_end_time (date)
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.

Example 

{"value":"1427119462376"}

actual_cost (double)

Denotes the actual cost spent to complete the project.

actual_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_cost (double)

Denotes the cost estimated to complete the project.

estimated_cost (double)
These are numbers that can include contains decimals.

Example 

23.08

estimated_hours (long)

Denotes the hours estimated to complete the project.

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

Example 

234759602834500

udf_fields (udf_fields)

Holds user defined field values associated with the project.

udf_fields (udf_fields)

projected_end_time (date)

Denotes the planned due by time of the project.

projected_end_time (date)
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.

Example 

{"value":"1427119462376"}

scheduled_start_time (date)

Denotes the planned starting date of the project.

scheduled_start_time (date)
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.

Example 

{"value":"1427119462376"}

actual_hours (long)

Denotes the actual hours taken to complete the project.

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

Example 

234759602834500

actual_start_time (date)

Denotes the actual starting time of the project.

actual_start_time (date)
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.

Example 

{"value":"1427119462376"}


$ curl <service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
    "project": {
        "title": "Project Doctool edited",
        "status": {
            "id": "2"
        },
        "actual_cost": "5020",
        "udf_fields": {
            "udf_sline_29": "single line sample",
            "udf_mline_30": "sample \r\n multiline",
            "udf_long_32": 66,
            "udf_date_33": {
                "value": 1597775442500
            },
            "udf_decimal_34": 44.56
        }
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "project": {
        "title": "Project Doctool edited",
        "status": {
            "id": "2"
        },
        "actual_cost": "5020",
        "udf_fields": {
            "udf_sline_29": "single line sample",
            "udf_mline_30": "sample \r\n multiline",
            "udf_long_32": 66,
            "udf_date_33": {
                "value": 1597775442500
            },
            "udf_decimal_34": 44.56
        }
    }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "project": {
        "title": "Project Doctool edited",
        "status": {
            "id": "2"
        },
        "actual_cost": "5020",
        "udf_fields": {
            "udf_sline_29": "single line sample",
            "udf_mline_30": "sample \r\n multiline",
            "udf_long_32": 66,
            "udf_date_33": {
                "value": 1597775442500
            },
            "udf_decimal_34": 44.56
        }
    }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "project": {
        "title": "Project Doctool edited",
        "status": {
            "id": "2"
        },
        "actual_cost": "5020",
        "udf_fields": {
            "udf_sline_29": "single line sample",
            "udf_mline_30": "sample \r\n multiline",
            "udf_long_32": 66,
            "udf_date_33": {
                "value": 1597775442500
            },
            "udf_decimal_34": 44.56
        }
    }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "project": {
        "template": null,
        "code": null,
        "description": null,
        "milestone_count": "0",
        "title": "Project Doctool edited",
        "type": null,
        "task_count": "0",
        "milestone_completed": "0",
        "actual_hours": null,
        "actual_end_time": {
            "display_value": "Aug 3, 2020",
            "value": "1596479399000"
        },
        "id": "1",
        "actual_start_time": {
            "display_value": "Jul 27, 2020",
            "value": "1595788200000"
        },
        "department": null,
        "requester": null,
        "owner": null,
        "created_time": {
            "display_value": "Aug 3, 2020 07:33 PM",
            "value": "1596463405135"
        },
        "priority": null,
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": null,
        "site": null,
        "actual_cost": "5020.00",
        "estimated_cost": "0.00",
        "estimated_hours": null,
        "udf_fields": {
            "udf_sline_29": "single line sample",
            "udf_mline_30": "sample \r\n multiline",
            "udf_date_33": {
                "display_value": "Aug 19, 2020 12:00 AM",
                "value": "1597775442500"
            },
            "udf_decimal_34": "44.56",
            "udf_long_32": "66"
        },
        "task_completed": "0",
        "projected_end_time": null,
        "status": {
            "color": "#00ff00",
            "name": "Closed",
            "id": "2"
        },
        "scheduled_start_time": null
    }
}

Get Project

This operation helps you to view an existing project by id.

Url

<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}

Attributes

description (html)
No Description

description (html)
HTML is a text area where html elements can be used.

Example 

<b>The content to be displayed</b>


$ curl -G <service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
    "response_status": {
        "status_code": 2000,
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "project": {
        "template": null,
        "description": "<div>doctool description sample<br /></div>",
        "milestone_count": "0",
        "projected_end_time": {
            "display_value": "Apr 24, 2020",
            "value": "1587752940000"
        },
        "title": "Project Doctool view",
        "task_count": "0",
        "milestone_completed": "0",
        "actual_hours": "90",
        "actual_end_time": {
            "display_value": "Apr 24, 2020",
            "value": "1587752940000"
        },
        "id": "17",
        "actual_start_time": {
            "display_value": "Mar 31, 2020",
            "value": "1585593000000"
        },
        "department": {
            "site": {
                "id": "901"
            },
            "name": "custom department",
            "id": "301"
        },
        "owner": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "created_time": {
            "display_value": "Apr 27, 2020 11:46 AM",
            "value": "1587968216771"
        },
        "type": {
            "color": "#00ff00",
            "name": "Maintenance",
            "id": "3"
        },
        "code": null,
        "priority": {
            "color": "#ff6600",
            "name": "Medium",
            "id": "3"
        },
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": {
            "display_value": "Apr 10, 2020",
            "value": "1586543340000"
        },
        "site": {
            "name": "custom site",
            "id": "901"
        },
        "requester": {
            "email_id": null,
            "name": "Heather Graham",
            "is_vipuser": false,
            "id": "6",
            "department": null
        },
        "actual_cost": "9000.00",
        "estimated_cost": "5679.00",
        "estimated_hours": "45",
        "task_completed": "0",
        "status": {
            "internal_name": "Closed",
            "color": "#00ff00",
            "name": "Closed",
            "id": "2"
        },
        "scheduled_start_time": {
            "display_value": "Apr 6, 2020",
            "value": "1586111400000"
        }
    }
}
        "status": "success"
    }
}

Get List Project

This operation helps you to view all existing projects.

Url

<service domain|custom domain>/app/<portal>//api/v3/projects

Attributes

$ curl -G <service domain|custom domain>/app/<portal>//api/v3/projects\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{
    "list_info": {
        "row_count": "12",
        "start_index": "2",
        "get_total_count": "true",
        "sort_field": "created_time",
        "sort_order": "desc",
        "filter_by": {
            "id": "16"
        },
        "search_criteria": {
            "field": "owner.email_id",
            "condition": "starts with",
            "value": "zzz",
            "children": [
                {
                    "field": "priority.name",
                    "condition": "is",
                    "value": "High",
                    "logical_operator": "OR"
                }
            ]
        },
        "fields_required": [
            "id",
            "owner",
            "status",
            "priority",
            "created_time"
        ]
    }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/projects";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
input_data = {
    "list_info": {
        "row_count": "12",
        "start_index": "2",
        "get_total_count": "true",
        "sort_field": "created_time",
        "sort_order": "desc",
        "filter_by": {
            "id": "16"
        },
        "search_criteria": {
            "field": "owner.email_id",
            "condition": "starts with",
            "value": "zzz",
            "children": [
                {
                    "field": "priority.name",
                    "condition": "is",
                    "value": "High",
                    "logical_operator": "OR"
                }
            ]
        },
        "fields_required": [
            "id",
            "owner",
            "status",
            "priority",
            "created_time"
        ]
    }
};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;


#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/projects"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{
    "list_info": {
        "row_count": "12",
        "start_index": "2",
        "get_total_count": "true",
        "sort_field": "created_time",
        "sort_order": "desc",
        "filter_by": {
            "id": "16"
        },
        "search_criteria": {
            "field": "owner.email_id",
            "condition": "starts with",
            "value": "zzz",
            "children": [
                {
                    "field": "priority.name",
                    "condition": "is",
                    "value": "High",
                    "logical_operator": "OR"
                }
            ]
        },
        "fields_required": [
            "id",
            "owner",
            "status",
            "priority",
            "created_time"
        ]
    }
}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response


#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>//api/v3/projects"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "list_info": {
        "row_count": "12",
        "start_index": "2",
        "get_total_count": "true",
        "sort_field": "created_time",
        "sort_order": "desc",
        "filter_by": {
            "id": "16"
        },
        "search_criteria": {
            "field": "owner.email_id",
            "condition": "starts with",
            "value": "zzz",
            "children": [
                {
                    "field": "priority.name",
                    "condition": "is",
                    "value": "High",
                    "logical_operator": "OR"
                }
            ]
        },
        "fields_required": [
            "id",
            "owner",
            "status",
            "priority",
            "created_time"
        ]
    }
}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())


{
    "projects": [
        {
            "owner": null,
            "created_time": {
                "display_value": "Apr 27, 2020 11:13 AM",
                "value": "1587966201347"
            },
            "id": "15",
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "4"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": null,
            "created_time": {
                "display_value": "Apr 27, 2020 11:13 AM",
                "value": "1587966192910"
            },
            "id": "14",
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "4"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": {
                "email_id": "guest@zylker.com",
                "name": "Jeniffer Doe",
                "is_vipuser": false,
                "id": "9",
                "department": null
            },
            "created_time": {
                "display_value": "Apr 26, 2020 09:20 PM",
                "value": "1587916226493"
            },
            "id": "12",
            "priority": {
                "color": "#ff6600",
                "name": "Medium",
                "id": "3"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": {
                "email_id": "guest@zylker.com",
                "name": "Jeniffer Doe",
                "is_vipuser": false,
                "id": "9",
                "department": null
            },
            "created_time": {
                "display_value": "Apr 26, 2020 08:57 PM",
                "value": "1587914834840"
            },
            "id": "11",
            "priority": {
                "color": "#ff6600",
                "name": "Medium",
                "id": "3"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": null,
            "created_time": {
                "display_value": "Apr 26, 2020 08:42 PM",
                "value": "1587913959013"
            },
            "id": "10",
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "4"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": null,
            "created_time": {
                "display_value": "Apr 26, 2020 08:40 PM",
                "value": "1587913825865"
            },
            "id": "9",
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "4"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        },
        {
            "owner": {
                "email_id": "guest@zylker.com",
                "name": "Jeniffer Doe",
                "is_vipuser": false,
                "id": "9",
                "department": null
            },
            "created_time": {
                "display_value": "Apr 26, 2020 08:35 PM",
                "value": "1587913540560"
            },
            "id": "8",
            "priority": {
                "color": "#ff0000",
                "name": "High",
                "id": "4"
            },
            "status": {
                "internal_name": "Open",
                "color": "#0066ff",
                "name": "Open",
                "id": "1"
            }
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "start_index": 2,
        "sort_field": "created_time",
        "fields_required": [
            "id",
            "owner",
            "status",
            "priority",
            "created_time"
        ],
        "total_count": 8,
        "filter_by": {
            "id": 16
        },
        "sort_order": "desc",
        "search_criteria": {
            "condition": "starts with",
            "field": "owner.email_id",
            "children": [
                {
                    "condition": "is",
                    "field": "priority.name",
                    "logical_operator": "OR",
                    "value": "High"
                }
            ],
            "value": "zzz"
        },
        "get_total_count": "true",
        "row_count": 7
    }
}

Delete Project

This operation helps you delete an existing project.

Url

<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}


$ curl <service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

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

url = "<service domain|custom domain>/app/<portal>//api/v3/projects/{project_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "authtoken: 6FXXXXX2-0XXX-XXXX-XXXX-5XXXXXAXXXXX", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

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