Skip to content

Project Status

Project status is crucial to understand the progress of the project.

Attributes

id (long)
Unique identifier of the project status

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

Example 

234759602834500

name (string)
Name used to define the project status. The name should be unique. The default project status available are “Open”, “Closed”, “Canceled”, and “Onhold”

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

Example 

Sample Content

description (string)
A short description about Project Status

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

Example 

Sample Content

in_progress (boolean)
If the project status refers to a complete/pending project

in_progress (boolean)
Boolean value which can have two possible values. The values are true and false.

color (color)
Color code used to identify the project status in the application

color (color)
The color used to represent the entity.

Example 

#adf456

index (int)read only
Indicates the order of Project Status

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

More Attributes Expand all

internal_name (string)read only

Internal name for project status

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

Example 

Sample Content

deleted (boolean)

Denotes whether the project status can be used further or not.

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

Add Project Status

This operation helps you add a project status. Mandatory Fields :-

Mandatory Fields :- [“name”]

Url

api/v3/project_statuses

Attributes

id (long)
Unique identifier of the project status

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

Example 

234759602834500

name (string)
Name used to define the project status. The name should be unique. The default project status available are “Open”, “Closed”, “Canceled”, and “Onhold”

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

Example 

Sample Content

description (string)
A short description about Project Status

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

Example 

Sample Content

in_progress (boolean)
If the project status refers to a complete/pending project

in_progress (boolean)
Boolean value which can have two possible values. The values are true and false.

color (color)
Color code used to identify the project status in the application

color (color)
The color used to represent the entity.

Example 

#adf456

index (int)read only
Indicates the order of Project Status

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

More Attributes Expand all

internal_name (string)read only

Internal name for project status

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

Example 

Sample Content

deleted (boolean)

Denotes whether the project status can be used further or not.

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl <url>/api/v3/project_statuses\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}'

// Deluge Sample script
url = "<url>/api/v3/project_statuses";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<url>/api/v3/project_statuses"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}
'@
$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 = "<url>/api/v3/project_statuses"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}'''
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_status": {
    "in_progress": false,
    "deleted": false,
    "internal_name": "Open",
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description",
    "index": 1,
    "id": "1970625432584455"
  }
}

Edit Project Status

This operation helps you update a project status.

Url

api/v3/project_statuses/{project_status_id}

Attributes

id (long)
Unique identifier of the project status

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

Example 

234759602834500

name (string)
Name used to define the project status. The name should be unique. The default project status available are “Open”, “Closed”, “Canceled”, and “Onhold”

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

Example 

Sample Content

description (string)
A short description about Project Status

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

Example 

Sample Content

in_progress (boolean)
If the project status refers to a complete/pending project

in_progress (boolean)
Boolean value which can have two possible values. The values are true and false.

color (color)
Color code used to identify the project status in the application

color (color)
The color used to represent the entity.

Example 

#adf456

index (int)read only
Indicates the order of Project Status

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

More Attributes Expand all

internal_name (string)read only

Internal name for project status

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

Example 

Sample Content

deleted (boolean)

Denotes whether the project status can be used further or not.

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl <url>/api/v3/project_statuses/{project_status_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}'

// Deluge Sample script
url = "<url>/api/v3/project_statuses/{project_status_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<url>/api/v3/project_statuses/{project_status_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}
'@
$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 = "<url>/api/v3/project_statuses/{project_status_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "project_status": {
    "in_progress": false,
    "deleted": false,
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description"
  }
}'''
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_status": {
    "in_progress": false,
    "deleted": false,
    "internal_name": "Open",
    "color": "#ffffff",
    "name": "Open",
    "description": "test-description",
    "index": 1,
    "id": "1676855164551544"
  }
}

Get Project Status

This operation helps you Get project status.

Url

api/v3/project_statuses/{project_status_id}

Attributes

id (long)
Unique identifier of the project status

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

Example 

234759602834500

name (string)
Name used to define the project status. The name should be unique. The default project status available are “Open”, “Closed”, “Canceled”, and “Onhold”

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

Example 

Sample Content

description (string)
A short description about Project Status

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

Example 

Sample Content

in_progress (boolean)
If the project status refers to a complete/pending project

in_progress (boolean)
Boolean value which can have two possible values. The values are true and false.

color (color)
Color code used to identify the project status in the application

color (color)
The color used to represent the entity.

Example 

#adf456

index (int)read only
Indicates the order of Project Status

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

More Attributes Expand all

internal_name (string)read only

Internal name for project status

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

Example 

Sample Content

deleted (boolean)

Denotes whether the project status can be used further or not.

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl -G <url>/api/v3/project_statuses/{project_status_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<url>/api/v3/project_statuses/{project_status_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<url>/api/v3/project_statuses/{project_status_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

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

url = "<url>/api/v3/project_statuses/{project_status_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

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

Get List Project Status

This operation helps you Get all project statuses.

Url

api/v3/project_statuses

Attributes

id (long)
Unique identifier of the project status

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

Example 

234759602834500

name (string)
Name used to define the project status. The name should be unique. The default project status available are “Open”, “Closed”, “Canceled”, and “Onhold”

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

Example 

Sample Content

description (string)
A short description about Project Status

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

Example 

Sample Content

in_progress (boolean)
If the project status refers to a complete/pending project

in_progress (boolean)
Boolean value which can have two possible values. The values are true and false.

color (color)
Color code used to identify the project status in the application

color (color)
The color used to represent the entity.

Example 

#adf456

index (int)read only
Indicates the order of Project Status

index (int)
Numerical digits which are considered to have smaller numbers.

Example 

39

More Attributes Expand all

internal_name (string)read only

Internal name for project status

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

Example 

Sample Content

deleted (boolean)

Denotes whether the project status can be used further or not.

deleted (boolean)
Boolean value which can have two possible values. The values are true and false.

$ curl -G <url>/api/v3/project_statuses\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{}'

// Deluge Sample script
url = "<url>/api/v3/project_statuses";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<url>/api/v3/project_statuses"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

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

url = "<url>/api/v3/project_statuses"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

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

Delete Project Status

This operation helps you delete a project status.

Url

api/v3/project_statuses/{project_status_id}


$ curl <url>/api/v3/project_statuses/{project_status_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<url>/api/v3/project_statuses/{project_status_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<url>/api/v3/project_statuses/{project_status_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

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

url = "<url>/api/v3/project_statuses/{project_status_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

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