<service domain|custom domain>/app/<portal>/api/v3/contract_types
Contract Type
Contract type denotes the different types of contracts such as Maintenance, Support, Warranty and so on. The contract types configured here will be available while creating new contracts.
Attributes
id (long)
Unique identifier to identify the contract type
name (string)
Indicates the name of the contract type
description (string)
Description of the contract type
color (color)
indicates the color of contract type
inactive (boolean)
Indicates the active state of contract type
accessibility (JSONObject)
It contains the list of technicians and organization roles who have access to the contract type.
show attribute
technicians (technician)
Indicates the list of technicians to give access to a contract type.
org_roles (org_role)
Indicates the list of Organization Roles to give access to a contract type.
Add Contract Type
Use this operation to create a new contract type
Mandatory Fields :- [“name”]
Url
Attributes
id (long)
Unique identifier to identify the contract type
name (string)
Indicates the name of the contract type
description (string)
Description of the contract type
color (color)
indicates the color of contract type
inactive (boolean)
Indicates the active state of contract type
accessibility (JSONObject)
It contains the list of technicians and organization roles who have access to the contract type.
show attribute
technicians (technician)
Indicates the list of technicians to give access to a contract type.
org_roles (org_role)
Indicates the list of Organization Roles to give access to a contract type.
$ curl <service domain|custom domain>/app/<portal>/api/v3/contract_types\
-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='{
"contract_type": {
"name": "Check One",
"description": "New Contract Type Check One",
"color": "#710b0b",
"accessibility": {
"org_roles": [
{
"id": "2000000031153",
"name": "CEO"
},
{
"id": "2000000031156",
"name": "CIO"
},
{
"id": "2000000031162",
"name": "CFO"
},
{
"id": "2000000031159",
"name": "COO"
},
{
"id": "2000000031183",
"name": "Department Approver"
}
],
"technicians": [
{
"id": "2000000036237",
"name": "Test"
}
]
}
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"contract_type": {
"name": "Check One",
"description": "New Contract Type Check One",
"color": "#710b0b",
"accessibility": {
"org_roles": [
{
"id": "2000000031153",
"name": "CEO"
},
{
"id": "2000000031156",
"name": "CIO"
},
{
"id": "2000000031162",
"name": "CFO"
},
{
"id": "2000000031159",
"name": "COO"
},
{
"id": "2000000031183",
"name": "Department Approver"
}
],
"technicians": [
{
"id": "2000000036237",
"name": "Test"
}
]
}
}
};
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/contract_types"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"contract_type": {
"name": "Check One",
"description": "New Contract Type Check One",
"color": "#710b0b",
"accessibility": {
"org_roles": [
{
"id": "2000000031153",
"name": "CEO"
},
{
"id": "2000000031156",
"name": "CIO"
},
{
"id": "2000000031162",
"name": "CFO"
},
{
"id": "2000000031159",
"name": "COO"
},
{
"id": "2000000031183",
"name": "Department Approver"
}
],
"technicians": [
{
"id": "2000000036237",
"name": "Test"
}
]
}
}
}
'@
$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/contract_types"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"contract_type": {
"name": "Check One",
"description": "New Contract Type Check One",
"color": "#710b0b",
"accessibility": {
"org_roles": [
{
"id": "2000000031153",
"name": "CEO"
},
{
"id": "2000000031156",
"name": "CIO"
},
{
"id": "2000000031162",
"name": "CFO"
},
{
"id": "2000000031159",
"name": "COO"
},
{
"id": "2000000031183",
"name": "Department Approver"
}
],
"technicians": [
{
"id": "2000000036237",
"name": "Test"
}
]
}
}
}'''
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())
{
"contract_type": {
"inactive": false,
"color": "#710b0b",
"accessibility": {
"technicians": [
{
"email_id": "test@zmail.com",
"is_technician": true,
"sms_mail": null,
"mobile": "xxxxxxxxxx",
"last_name": "T",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"id": "2000000006130"
},
"phone": "",
"employee_id": null,
"name": "Test",
"id": "2000000036237",
"photo_url": "photo-test-url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}
],
"org_roles": [
{
"name": "CEO",
"id": "2000000031153",
"orgrole_category": {
"id": "2000000030979"
}
},
{
"name": "CFO",
"id": "2000000031162",
"orgrole_category": {
"id": "2000000030979"
}
},
{
"name": "CIO",
"id": "2000000031156",
"orgrole_category": {
"id": "2000000030979"
}
},
{
"name": "COO",
"id": "2000000031159",
"orgrole_category": {
"id": "2000000030979"
}
},
{
"name": "Department Approver",
"id": "2000000031183",
"orgrole_category": {
"id": "2000000030988"
}
}
]
},
"name": "Check One",
"description": "New Contract Type Check One",
"id": "2000000037175"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Contract Type
Use this operation to edit a contract type
Url
<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id}
Attributes
id (long)
Unique identifier to identify the contract type
name (string)
Indicates the name of the contract type
description (string)
Description of the contract type
color (color)
indicates the color of contract type
inactive (boolean)
Indicates the active state of contract type
accessibility (JSONObject)
It contains the list of technicians and organization roles who have access to the contract type.
show attribute
technicians (technician)
Indicates the list of technicians to give access to a contract type.
org_roles (org_role)
Indicates the list of Organization Roles to give access to a contract type.
$ curl <service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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='{
"contract_type": {
"accessibility": {
"org_roles": [
{
"id": "100000000000031142",
"name": "Reporting To"
}
],
"technicians": [
{
"id": "100000000000039279",
"name": "test1"
}
]
}
}
} '
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id} ";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"contract_type": {
"accessibility": {
"org_roles": [
{
"id": "100000000000031142",
"name": "Reporting To"
}
],
"technicians": [
{
"id": "100000000000039279",
"name": "test1"
}
]
}
}
} ;
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/contract_types/{contracttype_id} "
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"contract_type": {
"accessibility": {
"org_roles": [
{
"id": "100000000000031142",
"name": "Reporting To"
}
],
"technicians": [
{
"id": "100000000000039279",
"name": "test1"
}
]
}
}
}
'@
$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/contract_types/{contracttype_id} "
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"contract_type": {
"accessibility": {
"org_roles": [
{
"id": "100000000000031142",
"name": "Reporting To"
}
],
"technicians": [
{
"id": "100000000000039279",
"name": "test1"
}
]
}
}
} '''
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())
{
"contract_type": {
"inactive": false,
"color": "#c311a7",
"accessibility": {
"technicians": [
{
"email_id": "test@zmail.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": null,
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"id": "100000000000006130"
},
"phone": null,
"employee_id": null,
"name": "test1",
"id": "100000000000039279",
"photo_url": "test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "test1",
"job_title": null
}
],
"org_roles": [
{
"name": "Reporting To",
"id": "100000000000031142",
"orgrole_category": {
"id": "100000000000030986"
}
}
]
},
"name": "CONTYPE1",
"description": null,
"id": "100000000000039275"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Contract Type
Use this operation to get a specific contract type
Url
<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id}
Attributes
id (long)
Unique identifier to identify the contract type
name (string)
Indicates the name of the contract type
description (string)
Description of the contract type
color (color)
indicates the color of contract type
inactive (boolean)
Indicates the active state of contract type
accessibility (JSONObject)
It contains the list of technicians and organization roles who have access to the contract type.
show attribute
technicians (technician)
Indicates the list of technicians to give access to a contract type.
org_roles (org_role)
Indicates the list of Organization Roles to give access to a contract type.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id} \
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id} ";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
url: url
type: GET
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id} "
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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())
{
"contract_type": {
"inactive": false,
"color": "#5f149f",
"accessibility": {
"technicians": [
{
"email_id": "test@zmail.com",
"is_technician": true,
"sms_mail": null,
"mobile": "xxxxxxxxxxxx",
"last_name": "T",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"id": "2000000006130"
},
"phone": "",
"employee_id": null,
"name": "Test",
"id": "2000000036237",
"photo_url": "test-photo-url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
}
],
"org_roles": [
{
"name": "CEO",
"id": "2000000031153",
"orgrole_category": {
"id": "2000000030979"
}
},
{
"name": "CFO",
"id": "2000000031162",
"orgrole_category": {
"id": "2000000030979"
}
}
]
},
"name": "Check",
"description": "New Contract Type Description",
"id": "2000000036401"
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Contract Type
Use this operation to get a list of contract types
Url
<service domain|custom domain>/app/<portal>/api/v3/contract_types
Attributes
id (long)
Unique identifier to identify the contract type
name (string)
Indicates the name of the contract type
description (string)
Description of the contract type
color (color)
indicates the color of contract type
inactive (boolean)
Indicates the active state of contract type
accessibility (JSONObject)
It contains the list of technicians and organization roles who have access to the contract type.
show attribute
technicians (technician)
Indicates the list of technicians to give access to a contract type.
org_roles (org_role)
Indicates the list of Organization Roles to give access to a contract type.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/contract_types\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
--data-urlencode input_data='{}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};
response = invokeurl
[
url: url
type: GET
parameters:params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/contract_types"
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())
{
"contract_types": [
{
"inactive": false,
"color": "#5f149f",
"name": "Check One",
"description": "New Contract Type Description",
"id": "2000000036401"
},
{
"inactive": false,
"color": "#ff6666",
"name": "Lease",
"description": "Lease Contract",
"id": "2000000003022"
},
{
"inactive": false,
"color": "#aaff66",
"name": "Maintenance",
"description": "Maintenance Contract",
"id": "2000000003019"
},
{
"inactive": false,
"color": "#ffcc00",
"name": "Support",
"description": "Support Contract",
"id": "2000000003025"
},
{
"inactive": false,
"color": "#ffff66",
"name": "Warranty",
"description": "Warranty Contract",
"id": "2000000003028"
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"sort_field": "name",
"row_count": 5
}
}
Delete Contract Type
Use this operation to delete a contract type
Url
<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_id}
$ curl <service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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 = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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 = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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 = "<service domain|custom domain>/app/<portal>/api/v3/contract_types/{contracttype_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"
}
}