跳转到内容

校园

它代表一个物理位置或场所,包括组织内的建筑物、楼层、房间及房间隔断。

属性

id (长整型)
用于标识校园的唯一标识符

id (长整型)
被视为数值较大的数字。

示例

234759602834500

名称 (字符串)
用于标识校园的名称 [最大长度:250]

名称 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

描述 (字符串)
校园描述

描述 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

space_code (字符串)
用于标识校园的唯一名称 [最大长度:250]

space_code (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

display_image (字符串)
包含作为默认校园图片使用的图片附件ID

display_image (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

total_capacity (长整型)
指示校园的总容量 [只读]

total_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

更多属性 全部展开

occupied_capacity (长整型)

指示校园的已占用容量 [只读]

occupied_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

类型 (sp_type)

指示校园类型

类型 (sp_type)

space_attributes (space_attributes)

包含校园的自定义字段

space_attributes (space_attributes)

site (site)

指示校园所在站点

site (site)

设施 (sp_amenity)

包含校园内的设施集合

设施 (sp_amenity)

关键性 (sp_criticality)

包含校园内的关键性集合

关键性 (sp_criticality)

状态 (sp_status)

表示校园的状态

状态 (sp_status)

附件 (attachment)

包含校园的附件

附件 (attachment)

主管 (technician)

表示校园的主管

主管 (technician)

区域 (JSONObject)

表示校园的区域及单位 
显示属性

区域 (JSONObject)

创建者 (user)read only

表示创建校园的用户

创建者 (user)

创建时间 (datetime)read only

表示创建校园的时间

创建时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

最近更新者 (user)read only

表示最近编辑校园的用户

最近更新者 (user)

最近更新时间 (datetime)read only

表示校园最近编辑的时间

最近更新时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

可用容量 (长整型)read only

表示校园的可用容量[只读]

可用容量 (长整型)
被视为数值较大的数字。

示例

234759602834500

添加校园

此操作帮助创建校园

必填字段:- name

URL

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

属性

id (长整型)
用于标识校园的唯一标识符

id (长整型)
被视为数值较大的数字。

示例

234759602834500

名称 (字符串)
用于标识校园的名称 [最大长度:250]

名称 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

描述 (字符串)
校园描述

描述 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

space_code (字符串)
用于标识校园的唯一名称 [最大长度:250]

space_code (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

display_image (字符串)
包含作为默认校园图片使用的图片附件ID

display_image (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

total_capacity (长整型)
指示校园的总容量 [只读]

total_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

更多属性 全部展开

occupied_capacity (长整型)

指示校园的已占用容量 [只读]

occupied_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

类型 (sp_type)

指示校园类型

类型 (sp_type)

space_attributes (space_attributes)

包含校园的自定义字段

space_attributes (space_attributes)

site (site)

指示校园所在站点

site (site)

设施 (sp_amenity)

包含校园内的设施集合

设施 (sp_amenity)

关键性 (sp_criticality)

包含校园内的关键性集合

关键性 (sp_criticality)

状态 (sp_status)

表示校园的状态

状态 (sp_status)

附件 (attachment)

包含校园的附件

附件 (attachment)

主管 (technician)

表示校园的主管

主管 (technician)

区域 (JSONObject)

表示校园的区域及单位 
显示属性

区域 (JSONObject)

创建者 (user)read only

表示创建校园的用户

创建者 (user)

创建时间 (datetime)read only

表示创建校园的时间

创建时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

最近更新者 (user)read only

表示最近编辑校园的用户

最近更新者 (user)

最近更新时间 (datetime)read only

表示校园最近编辑的时间

最近更新时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

可用容量 (长整型)read only

表示校园的可用容量[只读]

可用容量 (长整型)
被视为数值较大的数字。

示例

234759602834500

$ curl <service domain|custom domain>/app/<portal>/api/v3/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
};
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/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}
'@
$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/{campus_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_defaultcampus": {
    "site": {
      "id": "100000000000006824"
    },
    "name": "Estancia",
    "description": "Chennai campus",
    "status": {
      "id": "100000000000040570"
    },
    "area": {
      "space_area": "100000",
      "area_unit": {
        "id": "100000000000040548"
      }
    },
    "supervisors": [
      {
        "id": "100000000000041937"
      }
    ],
    "space_code": null,
    "amenities": [
      {
        "id": "100000000000040500"
      },
      {
        "id": "100000000000040479"
      },
      {
        "id": "100000000000040485"
      }
    ],
    "criticalities": [
      {
        "id": "100000000000040533"
      }
    ],
    "attachments": [
      {
        "file_id": "49"
      }
    ],
    "display_image": "49"
  }
}'''
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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Bread Maker",
                "description": null,
                "id": "100000000000040479",
                "icon_name": "bread_maker"
            },
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "417798",
                "content_type": "image/png",
                "file_id": "49",
                "name": "Screenshot 2025-01-24 at 11.34.25\u202fAM.png",
                "content_url": "/space_defaultcampuses/100000000000043080/_uploads/49",
                "id": "100000000000043082"
            }
        ],
        "space_building": null,
        "description": "Chennai campus",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043080",
        "display_image": "49",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:05 PM",
            "value": "1738222517516"
        },
        "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": "Estancia",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "bella.rice@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Mark",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1006",
                "name": "Bella Mark",
                "id": "100000000000041937",
                "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": "Bella",
                "job_title": null
            }
        ]
    }
}

编辑校园

此操作帮助编辑校园

URL

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

属性

id (长整型)
用于标识校园的唯一标识符

id (长整型)
被视为数值较大的数字。

示例

234759602834500

名称 (字符串)
用于标识校园的名称 [最大长度:250]

名称 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

描述 (字符串)
校园描述

描述 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

space_code (字符串)
用于标识校园的唯一名称 [最大长度:250]

space_code (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

display_image (字符串)
包含作为默认校园图片使用的图片附件ID

display_image (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

total_capacity (长整型)
指示校园的总容量 [只读]

total_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

更多属性 全部展开

occupied_capacity (长整型)

指示校园的已占用容量 [只读]

occupied_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

类型 (sp_type)

指示校园类型

类型 (sp_type)

space_attributes (space_attributes)

包含校园的自定义字段

space_attributes (space_attributes)

site (site)

指示校园所在站点

site (site)

设施 (sp_amenity)

包含校园内的设施集合

设施 (sp_amenity)

关键性 (sp_criticality)

包含校园内的关键性集合

关键性 (sp_criticality)

状态 (sp_status)

表示校园的状态

状态 (sp_status)

附件 (attachment)

包含校园的附件

附件 (attachment)

主管 (technician)

表示校园的主管

主管 (technician)

区域 (JSONObject)

表示校园的区域及单位 
显示属性

区域 (JSONObject)

创建者 (user)read only

表示创建校园的用户

创建者 (user)

创建时间 (datetime)read only

表示创建校园的时间

创建时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

最近更新者 (user)read only

表示最近编辑校园的用户

最近更新者 (user)

最近更新时间 (datetime)read only

表示校园最近编辑的时间

最近更新时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

可用容量 (长整型)read only

表示校园的可用容量[只读]

可用容量 (长整型)
被视为数值较大的数字。

示例

234759602834500

$ curl <service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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_defaultcampus": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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_defaultcampus": {
    "description": "Situated in GST Road, Guduvancherry"
  }
};
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/{campus_type_api_name}/{campus_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_defaultcampus": {
    "description": "Situated in GST Road, Guduvancherry"
  }
}
'@
$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/{campus_type_api_name}/{campus_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_defaultcampus": {
    "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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "Doctor on Call",
                "description": null,
                "id": "100000000000040494",
                "icon_name": "doctor_on_call"
            }
        ],
        "attachments": [
            {
                "size": "304296",
                "content_type": "image/png",
                "file_id": "50",
                "name": "Screenshot 2025-01-29 at 3.30.54\u202fPM (2).png",
                "content_url": "/space_defaultcampuses/100000000000043092/_uploads/50",
                "id": "100000000000043094"
            }
        ],
        "space_building": null,
        "description": "Situated in GST Road, Guduvancherry",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "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": "100000000000043092",
        "display_image": "50",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:07 PM",
            "value": "1738222663791"
        },
        "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:12 PM",
            "value": "1738222931838"
        },
        "name": "KRISP IT Park",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "heather.graham@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Graham",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1002",
                "name": "Heather Graham",
                "id": "100000000000041885",
                "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": "Heather",
                "job_title": null
            }
        ]
    }
}

获取校园

此操作帮助获取单个校园

URL

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

属性

id (长整型)
用于标识校园的唯一标识符

id (长整型)
被视为数值较大的数字。

示例

234759602834500

名称 (字符串)
用于标识校园的名称 [最大长度:250]

名称 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

描述 (字符串)
校园描述

描述 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

space_code (字符串)
用于标识校园的唯一名称 [最大长度:250]

space_code (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

display_image (字符串)
包含作为默认校园图片使用的图片附件ID

display_image (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

total_capacity (长整型)
指示校园的总容量 [只读]

total_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

更多属性 全部展开

occupied_capacity (长整型)

指示校园的已占用容量 [只读]

occupied_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

类型 (sp_type)

指示校园类型

类型 (sp_type)

space_attributes (space_attributes)

包含校园的自定义字段

space_attributes (space_attributes)

site (site)

指示校园所在站点

site (site)

设施 (sp_amenity)

包含校园内的设施集合

设施 (sp_amenity)

关键性 (sp_criticality)

包含校园内的关键性集合

关键性 (sp_criticality)

状态 (sp_status)

表示校园的状态

状态 (sp_status)

附件 (attachment)

包含校园的附件

附件 (attachment)

主管 (technician)

表示校园的主管

主管 (technician)

区域 (JSONObject)

表示校园的区域及单位 
显示属性

区域 (JSONObject)

创建者 (user)read only

表示创建校园的用户

创建者 (user)

创建时间 (datetime)read only

表示创建校园的时间

创建时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

最近更新者 (user)read only

表示最近编辑校园的用户

最近更新者 (user)

最近更新时间 (datetime)read only

表示校园最近编辑的时间

最近更新时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

可用容量 (长整型)read only

表示校园的可用容量[只读]

可用容量 (长整型)
被视为数值较大的数字。

示例

234759602834500

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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/{campus_type_api_name}/{campus_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_defaultcampus": {
        "occupied_capacity": "0",
        "common_module": "space_campus",
        "amenities": [
            {
                "name": "Bread Maker",
                "description": null,
                "id": "100000000000040479",
                "icon_name": "bread_maker"
            },
            {
                "name": "Dining",
                "description": null,
                "id": "100000000000040485",
                "icon_name": "dining"
            },
            {
                "name": "ATM",
                "description": null,
                "id": "100000000000040500",
                "icon_name": "atm"
            }
        ],
        "attachments": [
            {
                "size": "417798",
                "content_type": "image/png",
                "file_id": "49",
                "name": "Screenshot 2025-01-24 at 11.34.25\u202fAM.png",
                "content_url": "/space_defaultcampuses/100000000000043080/_uploads/49",
                "id": "100000000000043082"
            }
        ],
        "space_building": null,
        "description": "Chennai campus",
        "space_code": null,
        "criticalities": [
            {
                "name": "Chemical waste",
                "description": "The Space contains chemical waste.",
                "id": "100000000000040533",
                "icon_name": "chemical_waste"
            }
        ],
        "type": {
            "api_plural_name": "space_defaultcampuses",
            "name": "space_defaultcampus",
            "display_name_plural": "Default Campus",
            "id": "100000000000037120",
            "display_name": "Default Campus",
            "icon_name": null
        },
        "last_updated_by": null,
        "id": "100000000000043080",
        "display_image": "49",
        "total_capacity": "0",
        "space_campus": null,
        "area": {
            "area_unit": {
                "deleted": false,
                "name": "Sq.meter",
                "id": "100000000000040548",
                "is_default": true
            },
            "space_area": "100000"
        },
        "created_time": {
            "display_value": "Jan 30, 2025 01:05 PM",
            "value": "1738222517516"
        },
        "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": "Estancia",
        "status": {
            "color": "#00C408",
            "name": "Active",
            "id": "100000000000040570"
        },
        "supervisors": [
            {
                "email_id": "bella.rice@zylker.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": null,
                "last_name": "Mark",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "id": "100000000000006824"
                },
                "phone": null,
                "employee_id": "1006",
                "name": "Bella Mark",
                "id": "100000000000041937",
                "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": "Bella",
                "job_title": null
            }
        ]
    }
}

获取校园列表

此操作帮助获取所有校园的列表

URL

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

属性

id (长整型)
用于标识校园的唯一标识符

id (长整型)
被视为数值较大的数字。

示例

234759602834500

名称 (字符串)
用于标识校园的名称 [最大长度:250]

名称 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

描述 (字符串)
校园描述

描述 (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

space_code (字符串)
用于标识校园的唯一名称 [最大长度:250]

space_code (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

display_image (字符串)
包含作为默认校园图片使用的图片附件ID

display_image (字符串)
纯文本格式。不允许有富文本或换行符。

示例

Sample Content

total_capacity (长整型)
指示校园的总容量 [只读]

total_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

更多属性 全部展开

occupied_capacity (长整型)

指示校园的已占用容量 [只读]

occupied_capacity (长整型)
被视为数值较大的数字。

示例

234759602834500

类型 (sp_type)

指示校园类型

类型 (sp_type)

space_attributes (space_attributes)

包含校园的自定义字段

space_attributes (space_attributes)

site (site)

指示校园所在站点

site (site)

设施 (sp_amenity)

包含校园内的设施集合

设施 (sp_amenity)

关键性 (sp_criticality)

包含校园内的关键性集合

关键性 (sp_criticality)

状态 (sp_status)

表示校园的状态

状态 (sp_status)

附件 (attachment)

包含校园的附件

附件 (attachment)

主管 (technician)

表示校园的主管

主管 (technician)

区域 (JSONObject)

表示校园的区域及单位 
显示属性

区域 (JSONObject)

创建者 (user)read only

表示创建校园的用户

创建者 (user)

创建时间 (datetime)read only

表示创建校园的时间

创建时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

最近更新者 (user)read only

表示最近编辑校园的用户

最近更新者 (user)

最近更新时间 (datetime)read only

表示校园最近编辑的时间

最近更新时间 (datetime)
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value :以长整型格式表示的时间(从1970年1月1日开始的毫秒数)。

display_value :以用户自定义格式显示的可读时间。如无自定义,则使用默认格式。

可用容量 (长整型)read only

表示校园的可用容量[只读]

可用容量 (长整型)
被视为数值较大的数字。

示例

234759602834500

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/space_campuses\
      -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/space_campuses";
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/space_campuses"
$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/space_campuses"
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_campuses": [
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "100000"
      },
      "common_module": "space_campus",
      "created_time": {
        "display_value": "Jan 30, 2025 01:05 PM",
        "value": "1738222517516"
      },
      "space_building": null,
      "space_room": null,
      "description": "Chennai campus",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultcampuses",
        "name": "space_defaultcampus",
        "display_name_plural": "Default Campus",
        "id": "100000000000037120",
        "display_name": "Default Campus",
        "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": "Estancia",
      "id": "100000000000043080",
      "display_image": "49",
      "total_capacity": "0",
      "space_campus": null,
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      }
    },
    {
      "occupied_capacity": "0",
      "area": {
        "area_unit": {
          "deleted": false,
          "name": "Sq.meter",
          "id": "100000000000040548",
          "is_default": true
        },
        "space_area": "100000"
      },
      "common_module": "space_campus",
      "created_time": {
        "display_value": "Jan 30, 2025 01:07 PM",
        "value": "1738222663791"
      },
      "space_building": null,
      "space_room": null,
      "description": "Modern business space",
      "space_code": null,
      "type": {
        "api_plural_name": "space_defaultcampuses",
        "name": "space_defaultcampus",
        "display_name_plural": "Default Campus",
        "id": "100000000000037120",
        "display_name": "Default Campus",
        "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": "KRISP IT Park",
      "id": "100000000000043092",
      "display_image": "50",
      "total_capacity": "0",
      "space_campus": null,
      "status": {
        "color": "#00C408",
        "name": "Active",
        "id": "100000000000040570"
      }
    }
  ],
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "sort_field": "name",
    "row_count": 2
  }
}

删除校园

此操作允许删除校园

URL

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

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