Building

It represents a structure within a campus, where the next level will be either floors or directly rooms.

Attributes

id (long)
Unique identifier to identify the building

name (string)
Name to identify the building [max-length: 250]

description (string)
Description of the building

space_code (string)
Unique name to identify the building [max-length: 250]

display_image (string)
Contains the image attachment id used as a default building image

total_capacity (long)
Indicates the total capacity of the building [Read only]

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the building [Read only]

type (sp_type)

Indicates the type of the building

space_attributes (space_attributes)

Contains the udf fields of the building

site (site)

Indicates the site of the building

amenities (sp_amenity)

Contains the collection of amenities present in the building

criticalities (sp_criticality)

Contains the collection of criticalities present in the building

status (sp_status)

Indicates the status of the building

attachments (attachment)

Contains the attachments of the building

supervisors (technician)

Indicates the supervisors of the building

area (JSONObject)

Indicates the area of the building along with unit
show attribute

created_by (user)read only

Indicates the user who created the building

created_time (datetime)read only

Indicates the time when the building is created

last_updated_by (user)read only

Indicates the user who recently edited the building

last_updated_time (datetime)read only

Indicates the time when the building was recently edited

available_capacity (long)read only

Indicates the available capacity of the building[Read only]

structure_type (string)

Indicates whether the structure is “Building” or “Nonbuilding Structure”

space_campus (space)

Indicates the campus in which the building is present

space_campus (space)
Indicates the campus in which the building is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

building_type (string)

Indicates whether the building contains “Floors and Rooms” or “Rooms Only”

Add Building

This operation helps to create a building

Mandatory Fields :- name

Url

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

Attributes

id (long)
Unique identifier to identify the building

name (string)
Name to identify the building [max-length: 250]

description (string)
Description of the building

space_code (string)
Unique name to identify the building [max-length: 250]

display_image (string)
Contains the image attachment id used as a default building image

total_capacity (long)
Indicates the total capacity of the building [Read only]

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the building [Read only]

type (sp_type)

Indicates the type of the building

space_attributes (space_attributes)

Contains the udf fields of the building

site (site)

Indicates the site of the building

amenities (sp_amenity)

Contains the collection of amenities present in the building

criticalities (sp_criticality)

Contains the collection of criticalities present in the building

status (sp_status)

Indicates the status of the building

attachments (attachment)

Contains the attachments of the building

supervisors (technician)

Indicates the supervisors of the building

area (JSONObject)

Indicates the area of the building along with unit
show attribute

created_by (user)read only

Indicates the user who created the building

created_time (datetime)read only

Indicates the time when the building is created

last_updated_by (user)read only

Indicates the user who recently edited the building

last_updated_time (datetime)read only

Indicates the time when the building was recently edited

available_capacity (long)read only

Indicates the available capacity of the building[Read only]

structure_type (string)

Indicates whether the structure is “Building” or “Nonbuilding Structure”

space_campus (space)

Indicates the campus in which the building is present

space_campus (space)
Indicates the campus in which the building is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

building_type (string)

Indicates whether the building contains “Floors and Rooms” or “Rooms Only”

Curl

$ curl <service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}\
      -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='{
  "space_defaultbuilding": {
    "name": "Signature Tower",
    "description": "main building",
    "space_campus": {
      "id": "100000000000043080"
    },
    "building_type": "Floors and Rooms",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "50000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041911"
      }
    ],
    "space_code": "tower",
    "amenities": [
      {
        "id": "100000000000040500"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040545"
      }
    ],
    "attachments": [
      {
        "file_id": "52"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_building": null,
    "space_floor": null,
    "space_room": null,
    "display_image": "52"
  }
}'

Deluge

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "space_defaultbuilding": {
    "name": "Signature Tower",
    "description": "main building",
    "space_campus": {
      "id": "100000000000043080"
    },
    "building_type": "Floors and Rooms",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "50000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041911"
      }
    ],
    "space_code": "tower",
    "amenities": [
      {
        "id": "100000000000040500"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040545"
      }
    ],
    "attachments": [
      {
        "file_id": "52"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_building": null,
    "space_floor": null,
    "space_room": null,
    "display_image": "52"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "space_defaultbuilding": {
    "name": "Signature Tower",
    "description": "main building",
    "space_campus": {
      "id": "100000000000043080"
    },
    "building_type": "Floors and Rooms",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "50000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041911"
      }
    ],
    "space_code": "tower",
    "amenities": [
      {
        "id": "100000000000040500"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040545"
      }
    ],
    "attachments": [
      {
        "file_id": "52"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_building": null,
    "space_floor": null,
    "space_room": null,
    "display_image": "52"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

Python

#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/{building_type_api_name}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "space_defaultbuilding": {
    "name": "Signature Tower",
    "description": "main building",
    "space_campus": {
      "id": "100000000000043080"
    },
    "building_type": "Floors and Rooms",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "50000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041911"
      }
    ],
    "space_code": "tower",
    "amenities": [
      {
        "id": "100000000000040500"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040545"
      }
    ],
    "attachments": [
      {
        "file_id": "52"
      }
    ],
    "site": {
      "id": "100000000000006824"
    },
    "space_building": null,
    "space_floor": null,
    "space_room": null,
    "display_image": "52"
  }
}'''
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"
    },
    "space_defaultbuilding": {
        "occupied_capacity": "0",
        "common_module": "space_building",
        "amenities": [
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "168712",
                "content_type": "image/png",
                "file_id": "52",
                "name": "Screenshot 2025-01-24 at 1.04.50\u202fPM (2).png",
                "content_url": "/space_defaultbuildings/100000000000043152/_uploads/52",
                "id": "100000000000043154"
            }
        ],
        "space_building": null,
        "structure_type": "Building",
        "description": "main building",
        "space_code": "tower",
        "criticalities": [
            {
                "name": "Explosive",
                "description": "The Space contains explosive material.",
                "id": "100000000000040545",
                "icon_name": "explosive"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultbuildings",
            "name": "space_defaultbuilding",
            "display_name_plural": "Default Building",
            "id": "100000000000037122",
            "display_name": "Default Building",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043152",
        "display_image": "52",
        "total_capacity": "0",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "50000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:17 PM",
            "value": "1738223266548"
        },
        "space_room": null,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "name": "Signature Tower",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "howard.stern@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Stern",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1004",
                "name": "Howard Stern",
                "id": "100000000000041911",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Howard",
                "job_title": null
            }
        ],
        "building_type": "Floors and Rooms"
    }
}

Edit Building

This operation helps to edit a Building

Url

<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_id}

Attributes

id (long)
Unique identifier to identify the building

name (string)
Name to identify the building [max-length: 250]

description (string)
Description of the building

space_code (string)
Unique name to identify the building [max-length: 250]

display_image (string)
Contains the image attachment id used as a default building image

total_capacity (long)
Indicates the total capacity of the building [Read only]

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the building [Read only]

type (sp_type)

Indicates the type of the building

space_attributes (space_attributes)

Contains the udf fields of the building

site (site)

Indicates the site of the building

amenities (sp_amenity)

Contains the collection of amenities present in the building

criticalities (sp_criticality)

Contains the collection of criticalities present in the building

status (sp_status)

Indicates the status of the building

attachments (attachment)

Contains the attachments of the building

supervisors (technician)

Indicates the supervisors of the building

area (JSONObject)

Indicates the area of the building along with unit
show attribute

created_by (user)read only

Indicates the user who created the building

created_time (datetime)read only

Indicates the time when the building is created

last_updated_by (user)read only

Indicates the user who recently edited the building

last_updated_time (datetime)read only

Indicates the time when the building was recently edited

available_capacity (long)read only

Indicates the available capacity of the building[Read only]

structure_type (string)

Indicates whether the structure is “Building” or “Nonbuilding Structure”

space_campus (space)

Indicates the campus in which the building is present

space_campus (space)
Indicates the campus in which the building is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

building_type (string)

Indicates whether the building contains “Floors and Rooms” or “Rooms Only”

Curl

$ curl <service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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='{
  "space_defaultbuilding": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'

Deluge

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "space_defaultbuilding": {
    "description": "Situated in GST Road, Guduvancherry"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

Powershell

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "space_defaultbuilding": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

Python

#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/{building_type_api_name}/{building_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "space_defaultbuilding": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'''
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"
    },
    "space_defaultbuilding": {
        "occupied_capacity": "0",
        "common_module": "space_building",
        "amenities": [
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "168712",
                "content_type": "image/png",
                "file_id": "52",
                "name": "Screenshot 2025-01-24 at 1.04.50\u202fPM (2).png",
                "content_url": "/space_defaultbuildings/100000000000043152/_uploads/52",
                "id": "100000000000043154"
            }
        ],
        "space_building": null,
        "structure_type": "Building",
        "description": "Situated in GST Road, Guduvancherry",
        "space_code": "tower",
        "criticalities": [
            {
                "name": "Explosive",
                "description": "The Space contains explosive material.",
                "id": "100000000000040545",
                "icon_name": "explosive"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultbuildings",
            "name": "space_defaultbuilding",
            "display_name_plural": "Default Building",
            "id": "100000000000037122",
            "display_name": "Default Building",
            "icon_name": null
        },
        "last_updated_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "id": "100000000000043152",
        "display_image": "52",
        "total_capacity": "0",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "50000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:17 PM",
            "value": "1738223266548"
        },
        "space_room": null,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": {
            "display_value": "Jan 30, 2025 01:19 PM",
            "value": "1738223353824"
        },
        "name": "Signature Tower",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "howard.stern@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Stern",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1004",
                "name": "Howard Stern",
                "id": "100000000000041911",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Howard",
                "job_title": null
            }
        ],
        "building_type": "Floors and Rooms"
    }
}

Get Building

This operation helps to get a single building

Url

<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_id}

Attributes

id (long)
Unique identifier to identify the building

name (string)
Name to identify the building [max-length: 250]

description (string)
Description of the building

space_code (string)
Unique name to identify the building [max-length: 250]

display_image (string)
Contains the image attachment id used as a default building image

total_capacity (long)
Indicates the total capacity of the building [Read only]

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the building [Read only]

type (sp_type)

Indicates the type of the building

space_attributes (space_attributes)

Contains the udf fields of the building

site (site)

Indicates the site of the building

amenities (sp_amenity)

Contains the collection of amenities present in the building

criticalities (sp_criticality)

Contains the collection of criticalities present in the building

status (sp_status)

Indicates the status of the building

attachments (attachment)

Contains the attachments of the building

supervisors (technician)

Indicates the supervisors of the building

area (JSONObject)

Indicates the area of the building along with unit
show attribute

created_by (user)read only

Indicates the user who created the building

created_time (datetime)read only

Indicates the time when the building is created

last_updated_by (user)read only

Indicates the user who recently edited the building

last_updated_time (datetime)read only

Indicates the time when the building was recently edited

available_capacity (long)read only

Indicates the available capacity of the building[Read only]

structure_type (string)

Indicates whether the structure is “Building” or “Nonbuilding Structure”

space_campus (space)

Indicates the campus in which the building is present

space_campus (space)
Indicates the campus in which the building is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

building_type (string)

Indicates whether the building contains “Floors and Rooms” or “Rooms Only”

Curl

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

#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/{building_type_api_name}/{building_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"
    },
    "space_defaultbuilding": {
        "occupied_capacity": "0",
        "common_module": "space_building",
        "amenities": [
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "168712",
                "content_type": "image/png",
                "file_id": "52",
                "name": "Screenshot 2025-01-24 at 1.04.50\u202fPM (2).png",
                "content_url": "/space_defaultbuildings/100000000000043152/_uploads/52",
                "id": "100000000000043154"
            }
        ],
        "space_building": null,
        "structure_type": "Building",
        "description": "main building",
        "space_code": "tower",
        "criticalities": [
            {
                "name": "Explosive",
                "description": "The Space contains explosive material.",
                "id": "100000000000040545",
                "icon_name": "explosive"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultbuildings",
            "name": "space_defaultbuilding",
            "display_name_plural": "Default Building",
            "id": "100000000000037122",
            "display_name": "Default Building",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043152",
        "display_image": "52",
        "total_capacity": "0",
        "space_campus": {
            "name": "Estancia",
            "id": "100000000000043080",
            "type": {
                "id": "100000000000037120"
            }
        },
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "50000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:17 PM",
            "value": "1738223266548"
        },
        "space_room": null,
        "created_by": {
            "email_id": "test@zmail.com",
            "is_technician": true,
            "sms_mail": "",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": "",
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "100000000000006824",
                "is_default": true
            },
            "phone": "",
            "employee_id": "",
            "name": "tech",
            "id": "100000000000043064",
            "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
            "is_vip_user": false,
            "department": null,
            "first_name": "tech",
            "job_title": ""
        },
        "available_capacity": 0,
        "room_layouts": [],
        "space_floor": null,
        "site": {
            "deleted": false,
            "name": "Base Site",
            "id": "100000000000006824",
            "is_default": true
        },
        "last_updated_time": null,
        "name": "Signature Tower",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "howard.stern@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Stern",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1004",
                "name": "Howard Stern",
                "id": "100000000000041911",
                "is_vip_user": false,
                "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=-1&t=user&height=60&width=60",
                "department": null,
                "first_name": "Howard",
                "job_title": null
            }
        ],
        "building_type": "Floors and Rooms"
    }
}

Get List Building

This operation helps to get the list of all structures

Url

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

Attributes

id (long)
Unique identifier to identify the building

name (string)
Name to identify the building [max-length: 250]

description (string)
Description of the building

space_code (string)
Unique name to identify the building [max-length: 250]

display_image (string)
Contains the image attachment id used as a default building image

total_capacity (long)
Indicates the total capacity of the building [Read only]

More Attributes Expand all

occupied_capacity (long)

Indicates the occupied capacity of the building [Read only]

type (sp_type)

Indicates the type of the building

space_attributes (space_attributes)

Contains the udf fields of the building

site (site)

Indicates the site of the building

amenities (sp_amenity)

Contains the collection of amenities present in the building

criticalities (sp_criticality)

Contains the collection of criticalities present in the building

status (sp_status)

Indicates the status of the building

attachments (attachment)

Contains the attachments of the building

supervisors (technician)

Indicates the supervisors of the building

area (JSONObject)

Indicates the area of the building along with unit
show attribute

created_by (user)read only

Indicates the user who created the building

created_time (datetime)read only

Indicates the time when the building is created

last_updated_by (user)read only

Indicates the user who recently edited the building

last_updated_time (datetime)read only

Indicates the time when the building was recently edited

available_capacity (long)read only

Indicates the available capacity of the building[Read only]

structure_type (string)

Indicates whether the structure is “Building” or “Nonbuilding Structure”

space_campus (space)

Indicates the campus in which the building is present

space_campus (space)
Indicates the campus in which the building is present

Example

{
  "space_campus": {
    "id": "99999000000043495",
    "name": "Estancia",
    "status": {
      "id": "99999000000040433"
    },
    "type": {
      "id": "99999000000036766"
    }
  }
}

building_type (string)

Indicates whether the building contains “Floors and Rooms” or “Rooms Only”

Curl

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/space_buildings\
      -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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/space_buildings";
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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/space_buildings"
$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

#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/space_buildings"
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())

{
  "space_buildings": [
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "50000"
      },
      "common_module": "space_building",
      "created_time": {
        "display_value": "Jan 30, 2025 01:20 PM",
        "value": "1738223412888"
      },
      "space_building": null,
      "structure_type": "Building",
      "space_room": null,
      "description": "Situated in GST Road, Guduvancherry",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultbuildings",
        "name": "space_defaultbuilding",
        "display_name_plural": "Default Building",
        "id": "100000000000037122",
        "display_name": "Default Building",
        "icon_name": null
      },
      "created_by": {
        "email_id": "test@zmail.com",
        "is_technician": true,
        "sms_mail": "",
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": "",
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824",
          "is_default": true
        },
        "phone": "",
        "employee_id": "",
        "name": "tech",
        "id": "100000000000043064",
        "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "tech",
        "job_title": ""
      },
      "available_capacity": 0,
      "space_floor": null,
      "last_updated_by": null,
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": null,
      "name": "Copy of Signature Tower-1",
      "id": "100000000000043176",
      "display_image": null,
      "total_capacity": "0",
      "space_campus": {
        "name": "Estancia",
        "id": "100000000000043080",
        "type": {
          "id": "100000000000037120"
        }
      },
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      },
      "building_type": "Floors and Rooms"
    },
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "50000"
      },
      "common_module": "space_building",
      "created_time": {
        "display_value": "Jan 30, 2025 01:17 PM",
        "value": "1738223266548"
      },
      "space_building": null,
      "structure_type": "Building",
      "space_room": null,
      "description": "Situated in GST Road, Guduvancherry",
      "space_code": "tower",
      "type": {
        "api_plural_name": "space_defaultbuildings",
        "name": "space_defaultbuilding",
        "display_name_plural": "Default Building",
        "id": "100000000000037122",
        "display_name": "Default Building",
        "icon_name": null
      },
      "created_by": {
        "email_id": "test@zmail.com",
        "is_technician": true,
        "sms_mail": "",
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": "",
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824",
          "is_default": true
        },
        "phone": "",
        "employee_id": "",
        "name": "tech",
        "id": "100000000000043064",
        "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "tech",
        "job_title": ""
      },
      "available_capacity": 0,
      "space_floor": null,
      "last_updated_by": {
        "email_id": "test@zmail.com",
        "is_technician": true,
        "sms_mail": "",
        "mobile": "",
        "last_name": "",
        "user_scope": "internal_user",
        "sms_mail_id": "",
        "cost_per_hour": "0",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824",
          "is_default": true
        },
        "phone": "",
        "employee_id": "",
        "name": "tech",
        "id": "100000000000043064",
        "photo_url": "https://contacts.csez.zohocorpin.com/file?exp=10&ID=16704982&t=user&height=60&width=60",
        "is_vip_user": false,
        "department": null,
        "first_name": "tech",
        "job_title": ""
      },
      "site": {
        "deleted": false,
        "name": "Base Site",
        "id": "100000000000006824",
        "is_default": true
      },
      "last_updated_time": {
        "display_value": "Jan 30, 2025 01:19 PM",
        "value": "1738223353824"
      },
      "name": "Signature Tower",
      "id": "100000000000043152",
      "display_image": "52",
      "total_capacity": "0",
      "space_campus": {
        "name": "Estancia",
        "id": "100000000000043080",
        "type": {
          "id": "100000000000037120"
        }
      },
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      },
      "building_type": "Floors and Rooms"
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "sort_field": "name",
    "row_count": 2
  }
}

Delete Building

This operation allows to delete Building

Url

<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_id}

Curl

$ curl <service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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

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

url = "<service domain|custom domain>/app/<portal>/api/v3/{building_type_api_name}/{building_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"
  }
}