跳转到内容

请求

您组织中提出的大量帮助台工单都被组织和跟踪在 Requests 模块中。Requests 模块使您能够及时处理工单，将工单分配给技术人员，合并类似请求等。

属性

id （长整型）
此请求的 Id

id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

subject （字符串）
此请求的主题[最大长度：250]

subject （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

description （html）
此请求的描述 

description （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

impact_details （字符串）
关于此请求影响的描述[最大长度：250]

impact_details （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

email_ids_to_notify （字符串）
需要通知此请求动态的电子邮件 ID 数组 

email_ids_to_notify （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

delete_pre_template_tasks （布尔值）
指示是否需要删除预模板任务的布尔值 

delete_pre_template_tasks （布尔值）
布尔值，可以是 true 或 false 两个可能值。

更多属性 全部展开

update_reason （字符串）

更新请求的原因[最大字符数：250]

update_reason （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

created_time （日期时间）

表示此请求创建的时间

created_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

due_by_time （日期时间）

指示该请求计划完成的时间

due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

first_response_due_by_time （日期时间）

指示该请求第一响应计划的时间 

first_response_due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_fcr （布尔值）

布尔值，指示请求是否被标记为首次解决

is_fcr （布尔值）
布尔值，可以是 true 或 false 两个可能值。

status_change_comments （字符串）

状态更改的原因

status_change_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

scheduled_start_time （日期时间）

请求计划开始的日期和时间

scheduled_start_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time （日期时间）

请求计划结束的日期和时间

scheduled_end_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact (impact)

请求的影响 

impact (impact)
指示请求的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

status (status)

指示该请求的当前状态

status (status)
指示请求的当前状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

指示该请求的请求者

requester (user)
指示请求的请求者

示例 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

创建此请求的模式 

mode (mode)
创建请求的模式。

示例 

{
  "mode": {
    "name": "test-mode",
    "id": "234567890123456"
  }
}

site (site)

表示该请求所属的站点

site (site)
表示该请求所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

template (request_template)

指示用于创建该请求的模板

template (request_template)
指示用于创建请求的模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

sla (sla)

与该请求相关联的SLA详情

sla (sla)
表示与请求相关的SLA详情

示例 

{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}

service_category (service_category)

请求所属的服务类别

service_category (service_category)
请求所属的服务类别

示例 

{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}

group (group)

请求分配的组

group (group)
表示请求所属的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

technician (technician)

分配给该请求的技术人员

technician (technician)
指示分配给请求的技术人员

示例 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

请求的优先级 

priority (priority)
指示请求的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

level (level)

请求的级别

level (level)
指示请求的级别

示例 

{
  "level": {
    "name": "test-level",
    "id": "234567890123456"
  }
}

category (category)

请求所属的类别

category (category)
指示请求所属的类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

请求所属的子类别

subcategory (subcategory)
请求所属的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

请求的项目

item (item)
请求的项目

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

请求的紧急程度 

urgency (urgency)
表示请求的紧急程度

示例 

{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

request_type (request_type)

请求的类型

request_type (request_type)
指示请求的类型

示例 

{
  "request_type": {
    "name": "test-request_type",
    "id": "234567890123456"
  }
}

assets (asset)

与该请求相关联的资产对象数组

assets (asset)
与请求相关的资产对象数组。

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

保存与请求相关联的用户定义字段值

udf_fields (udf_fields)
保存与请求相关联的用户定义字段值

示例 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (request_attachment)

附加到请求的文件。

attachments (request_attachment)
附加到请求的文件。每个请求最多可附加50个附件。

示例 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

保存映射到请求的资源数据

resources (resources)
表示映射到请求的资源数据。

示例 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

on_behalf_of (user)

请求者可以代表其他用户发起请求。此字段表示代表其发起请求的用户

on_behalf_of (user)
 此字段表示代表其发起请求的用户

示例 

{
  "on_behalf_of": {
    "name": "test-on_behalf_of",
    "id": "234567890123456"
  }
}

configuration_items (configuration_item)

请求所涉及的关键配置项

configuration_items (configuration_item)

示例 

{
  "configuration_items": {
    "name": "test-configuration_items",
    "id": "234567890123456"
  }
}

editor (user)

配置为请求编辑者的用户 

editor (user)
指示请求的编辑者

示例 

{
  "editor": {
    "name": "test-editor",
    "id": "234567890123456"
  }
}

resolution (JSONObject)

技术人员提供的请求解决方案
show attribute

resolution (JSONObject)
包含请求的解决详情。

示例 

{
  "resolution": {
    "content": "Resolutioncontent"
  }
}

content （html）

技术人员提供的解决内容以解决该请求。

content （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

submitted_by (user)

无描述

submitted_by (user)

示例 

{
  "submitted_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-submitted_by",
    "id": "234567890123456"
  }
}

service_approvers (JSONObject)

配置的用户将被添加至服务请求的第一阶段审批。仅请求者可添加。
show attribute

service_approvers (JSONObject)

org_roles (org_role)

配置的服务审批者的组织角色。例如：CEO、CFO等

org_roles (org_role)

示例 

{
  "org_roles": {
    "name": "test-org_roles",
    "id": "234567890123456"
  }
}

users (user)

被配置为该请求服务审批者的用户

users (user)

示例 

{
  "users": {
    "name": "test-users",
    "id": "234567890123456"
  }
}

onhold_scheduler (JSONObject)

包含请求处于挂起状态时的调度详情
show attribute

onhold_scheduler (JSONObject)
包含挂起调度详情。

示例 

{
  "onhold_scheduler": {
    "comments": "ReasonsforOnhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan5,201801:16PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time （日期时间）

表示挂起调度器更改请求的计划时间

scheduled_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

comments （字符串）

为关联请求添加的评论

comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

change_to_status (status)

挂起调度完成后，请求计划切换到的状态对象。

change_to_status (status)
挂起调度完成后，请求计划切换到的状态对象

示例 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

停止计时器/将请求状态更改为挂起的技术人员

held_by (technician)
将请求置为挂起状态的用户对象。

示例 

{
  "held_by": {
    "name": "test-held_by",
    "id": "234567890123456"
  }
}

closure_info (JSONObject)

请求处于关闭状态时包含的关闭信息
show attribute

closure_info (JSONObject)
包含请求的关闭信息。

示例 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledgedcomments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution （布尔值）

表示请求者是否已确认其收到的解决方案。

requester_ack_resolution （布尔值）
布尔值，可以是 true 或 false 两个可能值。

requester_ack_comments （字符串）

请求者对其收到解决方案的评论

requester_ack_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_comments （字符串）

关闭评论表示关闭请求的原因。关闭评论只能由技术人员提供。

closure_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_code (closure_code)

关闭代码表示关闭请求（工单）/变更请求的原因，无论是因完成、拒绝等

closure_code (closure_code)
关闭代码表示关闭请求的原因。

示例 

{
  "closure_code": {
    "name": "test-closure_code",
    "id": "234567890123456"
  }
}

linked_to_request (JSONObject)

包含关联请求的详情 
show attribute

linked_to_request (JSONObject)

request (request)

最终用户在发现现有服务中断时可以提出请求，或提出新服务请求。

request (request)
保持关联请求详情。

示例 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed （长整型）read only

表示此请求所花费的时间

time_elapsed （长整型）
被视为具有较大值的数字。

示例 

234759602834500

email_cc （字符串）read only

通过电子邮件接收请求的电子邮件地址列表（抄送地址）。

email_cc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_to （字符串）read only

接收请求时的电子邮件地址列表（收件人地址）。 

email_to （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_bcc （字符串）read only

接收请求的电子邮件地址列表（密送地址）。 

email_bcc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

completed_by_denial （布尔值）read only

布尔值，表示请求在被拒绝时是否完成

completed_by_denial （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancellation_requested （布尔值）read only

布尔值，表示请求者是否发起了取消请求

cancellation_requested （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancel_flag_comments （action_comment）read only

请求者向技术人员提供的取消请求的信息

cancel_flag_comments （action_comment）
请求者向技术人员提供的取消请求的信息

示例 

{
  "cancel_flag_comments": {
    "name": "test-cancel_flag_comments",
    "id": "234567890123456"
  }
}

display_id （长整型）read only

此请求的显示ID

display_id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

created_by (user)read only

表示创建此请求的请求者

created_by (user)
表示创建此请求的用户

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

responded_time （日期时间）read only

表示此请求得到响应的时间 

responded_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time （日期时间）read only

表示此请求完成的时间 

completed_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

department （department）read only

请求者所属的部门

department （department）
请求者所属的部门

示例 

{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

deleted_time （日期时间）read only

表示请求将被删除的时间 

deleted_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

service_cost （double）read only

请求服务的基本费用

service_cost （double）
这些数字可以包含小数。

示例 

23.08

total_cost （double）read only

总费用是服务费用和所选单个资源费用的累计值

total_cost （double）
这些数字可以包含小数。

示例 

23.08

lifecycle （lifecycle）read only

与此请求关联的生命周期 

lifecycle （lifecycle）

示例 

{
  "lifecycle": {
    "name": "test-lifecycle",
    "id": "234567890123456"
  }
}

is_service_request （布尔值）read only

布尔值，表示此请求是否为服务请求

is_service_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

resolved_time （日期时间）read only

表示此请求解决的时间 

resolved_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

last_updated_time （日期时间）read only

表示此请求最后更新时间 

last_updated_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_overdue （布尔值）read only

布尔值，表示此请求是否逾期 

is_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_first_response_overdue （布尔值）read only

布尔值，表示此请求是否逾期未作首次响应

is_first_response_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_escalated （布尔值）read only

布尔值，表示此请求是否已升级

is_escalated （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_read （布尔值）read only

布尔值，表示此请求的回复是否已被阅读

is_read （布尔值）
布尔值，可以是 true 或 false 两个可能值。

notification_status （字符串）read only

显示请求回复的当前状态，是最后一条来自请求者还是技术人员 

notification_status （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

approval_status （approval_status）read only

表示此请求的审批状态。（已批准/待批准/已拒绝）

approval_status （approval_status）
表示此请求的审批状态。（已批准/待批准/已拒绝）

示例 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time （日期时间）read only

表示此请求分配给技术人员的时间 

assigned_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

deleted_assets （字符串）read only

与此请求解除关联的资产

deleted_assets （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

has_attachments （布尔值）read only

布尔值，表示此请求是否有附件

has_attachments （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_notes （布尔值）read only

布尔值，表示此请求是否有备注

has_notes （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_linked_requests （布尔值）read only

布尔值，表示此请求是否有关联请求

has_linked_requests （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_project （布尔值）read only

布尔值，表示此请求是否关联项目 

has_project （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_problem （布尔值）read only

布尔值，表示此请求是否关联问题

has_problem （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_request_initiated_change （布尔值）read only

布尔值，表示此请求是否发起了变更

has_request_initiated_change （布尔值）
布尔值，表示此请求是否发起了变更

has_change_initiated_request （布尔值）read only

布尔值，表示是否存在由变更发起的请求 

has_change_initiated_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_purchase_orders （布尔值）read only

布尔值，表示此请求是否关联采购订单

has_purchase_orders （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_draft （布尔值）read only

布尔值，表示此请求是否有草稿 

has_draft （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_reopened （布尔值）read only

布尔值，表示此请求是否已重新打开 

is_reopened （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_trashed （布尔值）read only

布尔值，表示此请求是否在回收站中

is_trashed （布尔值）
布尔值，可以是 true 或 false 两个可能值。

unreplied_count （长整型）read only

请求者回复数量中技术人员尚未回复的数量

unreplied_count （长整型）
被视为具有较大值的数字。

示例 

234759602834500

editor_status （int）read only

编辑器审核/更新的状态

editor_status （int）
被认为较小的数字

示例 

39

添加请求

此操作用于添加新请求。请注意， 是必填字段。

必填字段：- subject

Url

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

属性

id （长整型）
此请求的 Id

id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

subject （字符串）
此请求的主题[最大长度：250]

subject （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

description （html）
此请求的描述 

description （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

impact_details （字符串）
关于此请求影响的描述[最大长度：250]

impact_details （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

email_ids_to_notify （字符串）
需要通知此请求动态的电子邮件 ID 数组 

email_ids_to_notify （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

delete_pre_template_tasks （布尔值）
指示是否需要删除预模板任务的布尔值 

delete_pre_template_tasks （布尔值）
布尔值，可以是 true 或 false 两个可能值。

更多属性 全部展开

created_time （日期时间）

表示此请求创建的时间

created_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

due_by_time （日期时间）

指示该请求计划完成的时间

due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

first_response_due_by_time （日期时间）

指示该请求第一响应计划的时间 

first_response_due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_fcr （布尔值）

布尔值，指示请求是否被标记为首次解决

is_fcr （布尔值）
布尔值，可以是 true 或 false 两个可能值。

status_change_comments （字符串）

状态更改的原因

status_change_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

scheduled_start_time （日期时间）

请求计划开始的日期和时间

scheduled_start_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time （日期时间）

请求计划结束的日期和时间

scheduled_end_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact (impact)

请求的影响 

impact (impact)
指示请求的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

status (status)

指示该请求的当前状态

status (status)
指示请求的当前状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

指示该请求的请求者

requester (user)
指示请求的请求者

示例 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

创建此请求的模式 

mode (mode)
创建请求的模式。

示例 

{
  "mode": {
    "name": "test-mode",
    "id": "234567890123456"
  }
}

site (site)

表示该请求所属的站点

site (site)
表示该请求所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

template (request_template)

指示用于创建该请求的模板

template (request_template)
指示用于创建请求的模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

sla (sla)

与该请求相关联的SLA详情

sla (sla)
表示与请求相关的SLA详情

示例 

{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}

service_category (service_category)

请求所属的服务类别

service_category (service_category)
请求所属的服务类别

示例 

{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}

group (group)

请求分配的组

group (group)
表示请求所属的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

technician (technician)

分配给该请求的技术人员

technician (technician)
指示分配给请求的技术人员

示例 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

请求的优先级 

priority (priority)
指示请求的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

level (level)

请求的级别

level (level)
指示请求的级别

示例 

{
  "level": {
    "name": "test-level",
    "id": "234567890123456"
  }
}

category (category)

请求所属的类别

category (category)
指示请求所属的类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

请求所属的子类别

subcategory (subcategory)
请求所属的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

请求的项目

item (item)
请求的项目

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

请求的紧急程度 

urgency (urgency)
表示请求的紧急程度

示例 

{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

request_type (request_type)

请求的类型

request_type (request_type)
指示请求的类型

示例 

{
  "request_type": {
    "name": "test-request_type",
    "id": "234567890123456"
  }
}

assets (asset)

与该请求相关联的资产对象数组

assets (asset)
与请求相关的资产对象数组。

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

保存与请求相关联的用户定义字段值

udf_fields (udf_fields)
保存与请求相关联的用户定义字段值

示例 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (request_attachment)

附加到请求的文件。

attachments (request_attachment)
附加到请求的文件。每个请求最多可附加50个附件。

示例 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

保存映射到请求的资源数据

resources (resources)
表示映射到请求的资源数据。

示例 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

on_behalf_of (user)

请求者可以代表其他用户发起请求。此字段表示代表其发起请求的用户

on_behalf_of (user)
 此字段表示代表其发起请求的用户

示例 

{
  "on_behalf_of": {
    "name": "test-on_behalf_of",
    "id": "234567890123456"
  }
}

configuration_items (configuration_item)

请求所涉及的关键配置项

configuration_items (configuration_item)

示例 

{
  "configuration_items": {
    "name": "test-configuration_items",
    "id": "234567890123456"
  }
}

editor (user)

配置为请求编辑者的用户 

editor (user)
指示请求的编辑者

示例 

{
  "editor": {
    "name": "test-editor",
    "id": "234567890123456"
  }
}

resolution (JSONObject)

技术人员提供的请求解决方案
show attribute

resolution (JSONObject)
包含请求的解决详情。

示例 

{
  "resolution": {
    "content": "Resolutioncontent"
  }
}

content （html）

技术人员提供的解决内容以解决该请求。

content （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

service_approvers (JSONObject)

配置的用户将被添加至服务请求的第一阶段审批。仅请求者可添加。
show attribute

service_approvers (JSONObject)

org_roles (org_role)

配置的服务审批者的组织角色。例如：CEO、CFO等

org_roles (org_role)

示例 

{
  "org_roles": {
    "name": "test-org_roles",
    "id": "234567890123456"
  }
}

users (user)

被配置为该请求服务审批者的用户

users (user)

示例 

{
  "users": {
    "name": "test-users",
    "id": "234567890123456"
  }
}

onhold_scheduler (JSONObject)

包含请求处于挂起状态时的调度详情
show attribute

onhold_scheduler (JSONObject)
包含挂起调度详情。

示例 

{
  "onhold_scheduler": {
    "comments": "ReasonsforOnhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan5,201801:16PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time （日期时间）

表示挂起调度器更改请求的计划时间

scheduled_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

comments （字符串）

为关联请求添加的评论

comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

change_to_status (status)

挂起调度完成后，请求计划切换到的状态对象。

change_to_status (status)
挂起调度完成后，请求计划切换到的状态对象

示例 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

停止计时器/将请求状态更改为挂起的技术人员

held_by (technician)
将请求置为挂起状态的用户对象。

示例 

{
  "held_by": {
    "name": "test-held_by",
    "id": "234567890123456"
  }
}

closure_info (JSONObject)

请求处于关闭状态时包含的关闭信息
show attribute

closure_info (JSONObject)
包含请求的关闭信息。

示例 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledgedcomments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution （布尔值）

表示请求者是否已确认其收到的解决方案。

requester_ack_resolution （布尔值）
布尔值，可以是 true 或 false 两个可能值。

requester_ack_comments （字符串）

请求者对其收到解决方案的评论

requester_ack_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_comments （字符串）

关闭评论表示关闭请求的原因。关闭评论只能由技术人员提供。

closure_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_code (closure_code)

关闭代码表示关闭请求（工单）/变更请求的原因，无论是因完成、拒绝等

closure_code (closure_code)
关闭代码表示关闭请求的原因。

示例 

{
  "closure_code": {
    "name": "test-closure_code",
    "id": "234567890123456"
  }
}

linked_to_request (JSONObject)

包含关联请求的详情 
show attribute

linked_to_request (JSONObject)

request (request)

最终用户在发现现有服务中断时可以提出请求，或提出新服务请求。

request (request)
保持关联请求详情。

示例 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed （长整型）read only

表示此请求所花费的时间

time_elapsed （长整型）
被视为具有较大值的数字。

示例 

234759602834500

email_cc （字符串）read only

通过电子邮件接收请求的电子邮件地址列表（抄送地址）。

email_cc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_to （字符串）read only

接收请求时的电子邮件地址列表（收件人地址）。 

email_to （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_bcc （字符串）read only

接收请求的电子邮件地址列表（密送地址）。 

email_bcc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

completed_by_denial （布尔值）read only

布尔值，表示请求在被拒绝时是否完成

completed_by_denial （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancellation_requested （布尔值）read only

布尔值，表示请求者是否发起了取消请求

cancellation_requested （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancel_flag_comments （action_comment）read only

请求者向技术人员提供的取消请求的信息

cancel_flag_comments （action_comment）
请求者向技术人员提供的取消请求的信息

示例 

{
  "cancel_flag_comments": {
    "name": "test-cancel_flag_comments",
    "id": "234567890123456"
  }
}

display_id （长整型）read only

此请求的显示ID

display_id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

created_by (user)read only

表示创建此请求的请求者

created_by (user)
表示创建此请求的用户

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

responded_time （日期时间）read only

表示此请求得到响应的时间 

responded_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time （日期时间）read only

表示此请求完成的时间 

completed_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

department （department）read only

请求者所属的部门

department （department）
请求者所属的部门

示例 

{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

deleted_time （日期时间）read only

表示请求将被删除的时间 

deleted_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

service_cost （double）read only

请求服务的基本费用

service_cost （double）
这些数字可以包含小数。

示例 

23.08

total_cost （double）read only

总费用是服务费用和所选单个资源费用的累计值

total_cost （double）
这些数字可以包含小数。

示例 

23.08

lifecycle （lifecycle）read only

与此请求关联的生命周期 

lifecycle （lifecycle）

示例 

{
  "lifecycle": {
    "name": "test-lifecycle",
    "id": "234567890123456"
  }
}

is_service_request （布尔值）read only

布尔值，表示此请求是否为服务请求

is_service_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

resolved_time （日期时间）read only

表示此请求解决的时间 

resolved_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

last_updated_time （日期时间）read only

表示此请求最后更新时间 

last_updated_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_overdue （布尔值）read only

布尔值，表示此请求是否逾期 

is_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_first_response_overdue （布尔值）read only

布尔值，表示此请求是否逾期未作首次响应

is_first_response_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_escalated （布尔值）read only

布尔值，表示此请求是否已升级

is_escalated （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_read （布尔值）read only

布尔值，表示此请求的回复是否已被阅读

is_read （布尔值）
布尔值，可以是 true 或 false 两个可能值。

notification_status （字符串）read only

显示请求回复的当前状态，是最后一条来自请求者还是技术人员 

notification_status （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

approval_status （approval_status）read only

表示此请求的审批状态。（已批准/待批准/已拒绝）

approval_status （approval_status）
表示此请求的审批状态。（已批准/待批准/已拒绝）

示例 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time （日期时间）read only

表示此请求分配给技术人员的时间 

assigned_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

deleted_assets （字符串）read only

与此请求解除关联的资产

deleted_assets （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

has_attachments （布尔值）read only

布尔值，表示此请求是否有附件

has_attachments （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_notes （布尔值）read only

布尔值，表示此请求是否有备注

has_notes （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_linked_requests （布尔值）read only

布尔值，表示此请求是否有关联请求

has_linked_requests （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_project （布尔值）read only

布尔值，表示此请求是否关联项目 

has_project （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_problem （布尔值）read only

布尔值，表示此请求是否关联问题

has_problem （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_request_initiated_change （布尔值）read only

布尔值，表示此请求是否发起了变更

has_request_initiated_change （布尔值）
布尔值，表示此请求是否发起了变更

has_change_initiated_request （布尔值）read only

布尔值，表示是否存在由变更发起的请求 

has_change_initiated_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_purchase_orders （布尔值）read only

布尔值，表示此请求是否关联采购订单

has_purchase_orders （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_draft （布尔值）read only

布尔值，表示此请求是否有草稿 

has_draft （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_reopened （布尔值）read only

布尔值，表示此请求是否已重新打开 

is_reopened （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_trashed （布尔值）read only

布尔值，表示此请求是否在回收站中

is_trashed （布尔值）
布尔值，可以是 true 或 false 两个可能值。

unreplied_count （长整型）read only

请求者回复数量中技术人员尚未回复的数量

unreplied_count （长整型）
被视为具有较大值的数字。

示例 

234759602834500

editor_status （int）read only

编辑器审核/更新的状态

editor_status （int）
被认为较小的数字

示例 

39


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests\
      -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='{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "editor": {
      "email_id": "lincoln@zmail.com"
    },
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    }
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "editor": {
      "email_id": "lincoln@zmail.com"
    },
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    }
  }
};
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/requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "editor": {
      "email_id": "lincoln@zmail.com"
    },
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    }
  }
}
'@
$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/requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "editor": {
      "email_id": "lincoln@zmail.com"
    },
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    }
  }
}'''
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())

{
  "request": {
    "total_cost": "250",
    "subject": "Need an External Monitor",
    "resolution": {
      "add_to_linked_requests": false,
      "content": "The following is the resolution to the above request"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "1948726349434187"
    },
    "lifecycle": {
      "inactive": false,
      "is_published": false,
      "name": "test-name",
      "id": "2044673193715195"
    },
    "assets": [
      {
        "name": "192.0.2.1",
        "id": "2476215879232669",
        "barcode": "test-barcode"
      }
    ],
    "configuration_items": [
      {
        "linked_instance": "2045488344070845",
        "name": "test-name",
        "id": "1611839137508603"
      }
    ],
    "project_id": "test-project_id",
    "cancellation_requested": false,
    "is_trashed": false,
    "has_change_initiated_request": "true",
    "id": "2290537481381500",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "deleted": false,
      "name": "Hardware Problems",
      "id": "1646275022585519"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2374730939861945",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "2372339936802225"
    },
    "cancel_flag_comments": {
      "comment": "test-comment",
      "id": "1859958322770061"
    },
    "level": {
      "name": "Tier 1",
      "id": "2018182121337715"
    },
    "on_behalf_of": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1532347302595840",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "approval_status": {
      "name": "Approved",
      "id": "2383059912529037"
    },
    "impact": {
      "name": "Affects Business",
      "id": "1765848093928449"
    },
    "service_category": {
      "inactive": false,
      "name": "Corporate Website",
      "id": "2329032013178322",
      "sort_index": 7
    },
    "sla": {
      "name": "High",
      "duebyminutes": 21,
      "id": "2267633716896305",
      "duebyhours": false,
      "duebydays": 41
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1967268183361012"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2070790206912927",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_ref1": {
        "name": "test-name",
        "id": "100000000000036517"
      },
      "udf_boolean1": false,
      "udf_long1": "100000",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "date_date_time": {
        "display_value": "Jun 24, 2025 12:27 PM",
        "value": "1750748220000"
      },
      "txt_phone": "9999999999",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_email": "heather.graham@zylker.com",
      "dbl_decimal": "789.0",
      "txt_radio_box": "Option 5",
      "ref_lookup": {
        "name": "test-name-2",
        "id": "100000000000007226"
      },
      "txt_multi_line": "test_multi_line",
      "num_numeric": "456",
      "txt_auto_number": {
        "display_value": "1",
        "value": "1"
      },
      "dbl_percent": "123.0",
      "dbl_currency": "123.0",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "bool_decision_box": true,
      "dt_date": {
        "display_value": "Jun 24, 2025",
        "value": "2025-06-24"
      },
      "txt_single": "test_single_line",
      "mref_multi_lookup": [
        {
          "name": "test-name-3",
          "id": "100000000000007223"
        },
        {
          "name": "test-name-2",
          "id": "100000000000007226"
        }
      ]
    },
    "status_change_comments": "test-status_change_comments",
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "2204017819975726"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "2434907668683558"
    },
    "template": {
      "is_service_template": false,
      "name": "Raise a New Monitor Request",
      "id": "2174353095375675"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Incident",
      "id": "2147014131875404"
    },
    "display_id": "39",
    "time_elapsed": "2371520029466911",
    "notification_status": "test-notification_status",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "deleted_assets": [
      {}
    ],
    "urgency": {
      "name": "Urgent",
      "id": "2104949385602485"
    },
    "has_request_initiated_change": false,
    "request_template_task_ids": [
      {
        "id": "2174353095375675",
        "title": "Create SRS"
      }
    ],
    "department": {
      "name": "Administration",
      "id": "2190218995208715"
    },
    "is_reopened": false,
    "editor_status": 27,
    "editor": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "2458320955274024",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "is_overdue": false,
    "technician": {
      "email_id": "charles@zmail.com",
      "cost_per_hour": 1343434.4333,
      "phone": "test-phone",
      "name": "Charles",
      "mobile": "test-mobile",
      "id": "2276596244154377",
      "photo_url": "test-photo_url",
      "sms_mail_id": "test-sms_mail_id"
    },
    "delete_pre_template_tasks": false,
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "deleted": false,
      "name": "Custom Site",
      "id": "2222857346042280"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "unreplied_count": "4",
    "email_bcc": [],
    "service_cost": "100",
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "test-path",
            "display_name": "test-display_name"
          }
        }
      ],
      "users": [
        {
          "email_id": "test@test.com",
          "is_technician": false,
          "sms_mail": "test-sms_mail",
          "phone": "test-phone",
          "name": "test-name",
          "mobile": "test-mobile",
          "id": "1939084650493601",
          "photo_url": "test-photo_url",
          "is_vip_user": false,
          "job_title": "test-job_title"
        }
      ]
    },
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "2411765802963298"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

编辑请求

此操作用于编辑和更新请求。

Url

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

属性

id （长整型）
此请求的 Id

id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

subject （字符串）
此请求的主题[最大长度：250]

subject （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

description （html）
此请求的描述 

description （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

impact_details （字符串）
关于此请求影响的描述[最大长度：250]

impact_details （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

email_ids_to_notify （字符串）
需要通知此请求动态的电子邮件 ID 数组 

email_ids_to_notify （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

delete_pre_template_tasks （布尔值）
指示是否需要删除预模板任务的布尔值 

delete_pre_template_tasks （布尔值）
布尔值，可以是 true 或 false 两个可能值。

更多属性 全部展开

update_reason （字符串）

更新请求的原因[最大字符数：250]

update_reason （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

created_time （日期时间）

表示此请求创建的时间

created_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

due_by_time （日期时间）

指示该请求计划完成的时间

due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

first_response_due_by_time （日期时间）

指示该请求第一响应计划的时间 

first_response_due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_fcr （布尔值）

布尔值，指示请求是否被标记为首次解决

is_fcr （布尔值）
布尔值，可以是 true 或 false 两个可能值。

status_change_comments （字符串）

状态更改的原因

status_change_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

scheduled_start_time （日期时间）

请求计划开始的日期和时间

scheduled_start_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time （日期时间）

请求计划结束的日期和时间

scheduled_end_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact (impact)

请求的影响 

impact (impact)
指示请求的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

status (status)

指示该请求的当前状态

status (status)
指示请求的当前状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

指示该请求的请求者

requester (user)
指示请求的请求者

示例 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

创建此请求的模式 

mode (mode)
创建请求的模式。

示例 

{
  "mode": {
    "name": "test-mode",
    "id": "234567890123456"
  }
}

site (site)

表示该请求所属的站点

site (site)
表示该请求所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

template (request_template)

指示用于创建该请求的模板

template (request_template)
指示用于创建请求的模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

sla (sla)

与该请求相关联的SLA详情

sla (sla)
表示与请求相关的SLA详情

示例 

{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}

service_category (service_category)

请求所属的服务类别

service_category (service_category)
请求所属的服务类别

示例 

{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}

group (group)

请求分配的组

group (group)
表示请求所属的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

technician (technician)

分配给该请求的技术人员

technician (technician)
指示分配给请求的技术人员

示例 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

请求的优先级 

priority (priority)
指示请求的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

level (level)

请求的级别

level (level)
指示请求的级别

示例 

{
  "level": {
    "name": "test-level",
    "id": "234567890123456"
  }
}

category (category)

请求所属的类别

category (category)
指示请求所属的类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

请求所属的子类别

subcategory (subcategory)
请求所属的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

请求的项目

item (item)
请求的项目

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

请求的紧急程度 

urgency (urgency)
表示请求的紧急程度

示例 

{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

request_type (request_type)

请求的类型

request_type (request_type)
指示请求的类型

示例 

{
  "request_type": {
    "name": "test-request_type",
    "id": "234567890123456"
  }
}

assets (asset)

与该请求相关联的资产对象数组

assets (asset)
与请求相关的资产对象数组。

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

保存与请求相关联的用户定义字段值

udf_fields (udf_fields)
保存与请求相关联的用户定义字段值

示例 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

attachments (request_attachment)

附加到请求的文件。

attachments (request_attachment)
附加到请求的文件。每个请求最多可附加50个附件。

示例 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

保存映射到请求的资源数据

resources (resources)
表示映射到请求的资源数据。

示例 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

on_behalf_of (user)

请求者可以代表其他用户发起请求。此字段表示代表其发起请求的用户

on_behalf_of (user)
 此字段表示代表其发起请求的用户

示例 

{
  "on_behalf_of": {
    "name": "test-on_behalf_of",
    "id": "234567890123456"
  }
}

configuration_items (configuration_item)

请求所涉及的关键配置项

configuration_items (configuration_item)

示例 

{
  "configuration_items": {
    "name": "test-configuration_items",
    "id": "234567890123456"
  }
}

editor (user)

配置为请求编辑者的用户 

editor (user)
指示请求的编辑者

示例 

{
  "editor": {
    "name": "test-editor",
    "id": "234567890123456"
  }
}

resolution (JSONObject)

技术人员提供的请求解决方案
show attribute

resolution (JSONObject)
包含请求的解决详情。

示例 

{
  "resolution": {
    "content": "Resolutioncontent"
  }
}

content （html）

技术人员提供的解决内容以解决该请求。

content （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

service_approvers (JSONObject)

配置的用户将被添加至服务请求的第一阶段审批。仅请求者可添加。
show attribute

service_approvers (JSONObject)

org_roles (org_role)

配置的服务审批者的组织角色。例如：CEO、CFO等

org_roles (org_role)

示例 

{
  "org_roles": {
    "name": "test-org_roles",
    "id": "234567890123456"
  }
}

users (user)

被配置为该请求服务审批者的用户

users (user)

示例 

{
  "users": {
    "name": "test-users",
    "id": "234567890123456"
  }
}

onhold_scheduler (JSONObject)

包含请求处于挂起状态时的调度详情
show attribute

onhold_scheduler (JSONObject)
包含挂起调度详情。

示例 

{
  "onhold_scheduler": {
    "comments": "ReasonsforOnhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan5,201801:16PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time （日期时间）

表示挂起调度器更改请求的计划时间

scheduled_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

comments （字符串）

为关联请求添加的评论

comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

change_to_status (status)

挂起调度完成后，请求计划切换到的状态对象。

change_to_status (status)
挂起调度完成后，请求计划切换到的状态对象

示例 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

停止计时器/将请求状态更改为挂起的技术人员

held_by (technician)
将请求置为挂起状态的用户对象。

示例 

{
  "held_by": {
    "name": "test-held_by",
    "id": "234567890123456"
  }
}

closure_info (JSONObject)

请求处于关闭状态时包含的关闭信息
show attribute

closure_info (JSONObject)
包含请求的关闭信息。

示例 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledgedcomments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution （布尔值）

表示请求者是否已确认其收到的解决方案。

requester_ack_resolution （布尔值）
布尔值，可以是 true 或 false 两个可能值。

requester_ack_comments （字符串）

请求者对其收到解决方案的评论

requester_ack_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_comments （字符串）

关闭评论表示关闭请求的原因。关闭评论只能由技术人员提供。

closure_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_code (closure_code)

关闭代码表示关闭请求（工单）/变更请求的原因，无论是因完成、拒绝等

closure_code (closure_code)
关闭代码表示关闭请求的原因。

示例 

{
  "closure_code": {
    "name": "test-closure_code",
    "id": "234567890123456"
  }
}

linked_to_request (JSONObject)

包含关联请求的详情 
show attribute

linked_to_request (JSONObject)

request (request)

最终用户在发现现有服务中断时可以提出请求，或提出新服务请求。

request (request)
保持关联请求详情。

示例 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed （长整型）read only

表示此请求所花费的时间

time_elapsed （长整型）
被视为具有较大值的数字。

示例 

234759602834500

email_cc （字符串）read only

通过电子邮件接收请求的电子邮件地址列表（抄送地址）。

email_cc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_to （字符串）read only

接收请求时的电子邮件地址列表（收件人地址）。 

email_to （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_bcc （字符串）read only

接收请求的电子邮件地址列表（密送地址）。 

email_bcc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

completed_by_denial （布尔值）read only

布尔值，表示请求在被拒绝时是否完成

completed_by_denial （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancellation_requested （布尔值）read only

布尔值，表示请求者是否发起了取消请求

cancellation_requested （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancel_flag_comments （action_comment）read only

请求者向技术人员提供的取消请求的信息

cancel_flag_comments （action_comment）
请求者向技术人员提供的取消请求的信息

示例 

{
  "cancel_flag_comments": {
    "name": "test-cancel_flag_comments",
    "id": "234567890123456"
  }
}

display_id （长整型）read only

此请求的显示ID

display_id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

created_by (user)read only

表示创建此请求的请求者

created_by (user)
表示创建此请求的用户

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

responded_time （日期时间）read only

表示此请求得到响应的时间 

responded_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time （日期时间）read only

表示此请求完成的时间 

completed_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

department （department）read only

请求者所属的部门

department （department）
请求者所属的部门

示例 

{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

deleted_time （日期时间）read only

表示请求将被删除的时间 

deleted_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

service_cost （double）read only

请求服务的基本费用

service_cost （double）
这些数字可以包含小数。

示例 

23.08

total_cost （double）read only

总费用是服务费用和所选单个资源费用的累计值

total_cost （double）
这些数字可以包含小数。

示例 

23.08

lifecycle （lifecycle）read only

与此请求关联的生命周期 

lifecycle （lifecycle）

示例 

{
  "lifecycle": {
    "name": "test-lifecycle",
    "id": "234567890123456"
  }
}

is_service_request （布尔值）read only

布尔值，表示此请求是否为服务请求

is_service_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

resolved_time （日期时间）read only

表示此请求解决的时间 

resolved_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

last_updated_time （日期时间）read only

表示此请求最后更新时间 

last_updated_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_overdue （布尔值）read only

布尔值，表示此请求是否逾期 

is_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_first_response_overdue （布尔值）read only

布尔值，表示此请求是否逾期未作首次响应

is_first_response_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_escalated （布尔值）read only

布尔值，表示此请求是否已升级

is_escalated （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_read （布尔值）read only

布尔值，表示此请求的回复是否已被阅读

is_read （布尔值）
布尔值，可以是 true 或 false 两个可能值。

notification_status （字符串）read only

显示请求回复的当前状态，是最后一条来自请求者还是技术人员 

notification_status （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

approval_status （approval_status）read only

表示此请求的审批状态。（已批准/待批准/已拒绝）

approval_status （approval_status）
表示此请求的审批状态。（已批准/待批准/已拒绝）

示例 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time （日期时间）read only

表示此请求分配给技术人员的时间 

assigned_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

deleted_assets （字符串）read only

与此请求解除关联的资产

deleted_assets （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

has_attachments （布尔值）read only

布尔值，表示此请求是否有附件

has_attachments （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_notes （布尔值）read only

布尔值，表示此请求是否有备注

has_notes （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_linked_requests （布尔值）read only

布尔值，表示此请求是否有关联请求

has_linked_requests （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_project （布尔值）read only

布尔值，表示此请求是否关联项目 

has_project （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_problem （布尔值）read only

布尔值，表示此请求是否关联问题

has_problem （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_request_initiated_change （布尔值）read only

布尔值，表示此请求是否发起了变更

has_request_initiated_change （布尔值）
布尔值，表示此请求是否发起了变更

has_change_initiated_request （布尔值）read only

布尔值，表示是否存在由变更发起的请求 

has_change_initiated_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_purchase_orders （布尔值）read only

布尔值，表示此请求是否关联采购订单

has_purchase_orders （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_draft （布尔值）read only

布尔值，表示此请求是否有草稿 

has_draft （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_reopened （布尔值）read only

布尔值，表示此请求是否已重新打开 

is_reopened （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_trashed （布尔值）read only

布尔值，表示此请求是否在回收站中

is_trashed （布尔值）
布尔值，可以是 true 或 false 两个可能值。

unreplied_count （长整型）read only

请求者回复数量中技术人员尚未回复的数量

unreplied_count （长整型）
被视为具有较大值的数字。

示例 

234759602834500

editor_status （int）read only

编辑器审核/更新的状态

editor_status （int）
被认为较小的数字

示例 

39


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_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='{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    },
    "update_reason": "The request is updated for this reason"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    },
    "update_reason": "The request is updated for this reason"
  }
};
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/requests/{request_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    },
    "update_reason": "The request is updated for this reason"
  }
}
'@
$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/requests/{request_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "request": {
    "subject": "Need an External Monitor",
    "resolution": {
      "content": "The following is the resolution to the above request"
    },
    "mode": {
      "name": "E-Mail"
    },
    "assets": [
      {
        "name": "192.0.2.1"
      }
    ],
    "configuration_items": [
      {
        "name": "test-name"
      }
    ],
    "group": {
      "name": "Hardware Problems"
    },
    "requester": {
      "email_id": "lincoln@zmail.com"
    },
    "created_time": {
      "value": "1478758440000"
    },
    "item": {
      "name": "Install"
    },
    "level": {
      "name": "Tier 1"
    },
    "impact": {
      "name": "Affects Business"
    },
    "priority": {
      "name": "High"
    },
    "first_response_due_by_time": {
      "value": "1478758440000"
    },
    "udf_fields": {
      "udf_ref1": {
        "id": "100000000000036517"
      },
      "udf_boolean1": true,
      "udf_long1": "100000",
      "udf_date1": {
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "txt_radio_box": "Option 5",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_phone": "9999999999",
      "dbl_percent": "123.0",
      "txt_multi_line": "test_multi_line",
      "txt_single": "test_single_line",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "num_numeric": "456",
      "ref_lookup": {
        "id": "100000000000007226"
      },
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "mref_multi_lookup": [
        {
          "id": "100000000000007226"
        },
        {
          "id": "100000000000007223"
        }
      ],
      "txt_email": "heather.graham@zylker.com",
      "bool_decision_box": true,
      "dbl_decimal": "789.0",
      "date_date_time": {
        "value": 1750748220000
      },
      "dt_date": {
        "value": "2025-06-24"
      },
      "dbl_currency": "123.0"
    },
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader"
    },
    "status": {
      "name": "Open"
    },
    "template": {
      "name": "Raise a New Monitor Request"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "request_type": {
      "name": "Service Request"
    },
    "description": "Provide me an External Monitor",
    "urgency": {
      "name": "Urgent"
    },
    "request_template_task_ids": [
      {
        "id": "2174353095375675"
      }
    ],
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "technician": {
      "email_id": "charles@zmail.com"
    },
    "due_by_time": {
      "value": "1478758440000"
    },
    "site": {
      "name": "Custom Site"
    },
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3"
          }
        }
      ],
      "users": [
        {
          "id": "100000000000036517"
        }
      ]
    },
    "category": {
      "name": "Software"
    },
    "update_reason": "The request is updated for this reason"
  }
}'''
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())

{
  "request": {
    "total_cost": "250",
    "subject": "Need an External Monitor",
    "resolution": {
      "add_to_linked_requests": false,
      "content": "The following is the resolution to the above request"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "1514128723865219"
    },
    "lifecycle": {
      "inactive": false,
      "is_published": false,
      "name": "test-name",
      "id": "1785800795078801"
    },
    "assets": [
      {
        "name": "192.0.2.1",
        "id": "1579769602046877",
        "barcode": "test-barcode"
      }
    ],
    "configuration_items": [
      {
        "linked_instance": "1896705322349033",
        "name": "test-name",
        "id": "1817168032728604"
      }
    ],
    "project_id": "test-project_id",
    "cancellation_requested": false,
    "is_trashed": false,
    "has_change_initiated_request": "true",
    "id": "1670208611727359",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "deleted": false,
      "name": "Hardware Problems",
      "id": "2032360473619919"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1603000856585323",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "2343864003562140"
    },
    "cancel_flag_comments": {
      "comment": "test-comment",
      "id": "1952646101420942"
    },
    "level": {
      "name": "Tier 1",
      "id": "2018427819162646"
    },
    "approval_status": {
      "name": "Approved",
      "id": "2002953393788937"
    },
    "impact": {
      "name": "Affects Business",
      "id": "2353086283418210"
    },
    "service_category": {
      "inactive": false,
      "name": "Corporate Website",
      "id": "1802964913784450",
      "sort_index": 32
    },
    "sla": {
      "name": "High",
      "duebyminutes": 39,
      "id": "1913531130645398",
      "duebyhours": false,
      "duebydays": 23
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "1762189736746819"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1657374833669151",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_ref1": {
        "name": "test-name",
        "id": "100000000000036517"
      },
      "udf_boolean1": false,
      "udf_long1": "100000",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "date_date_time": {
        "display_value": "Jun 24, 2025 12:27 PM",
        "value": "1750748220000"
      },
      "txt_phone": "9999999999",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_email": "heather.graham@zylker.com",
      "dbl_decimal": "789.0",
      "txt_radio_box": "Option 5",
      "ref_lookup": {
        "name": "test-name-2",
        "id": "100000000000007226"
      },
      "txt_multi_line": "test_multi_line",
      "num_numeric": "456",
      "txt_auto_number": {
        "display_value": "1",
        "value": "1"
      },
      "dbl_percent": "123.0",
      "dbl_currency": "123.0",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "bool_decision_box": true,
      "dt_date": {
        "display_value": "Jun 24, 2025",
        "value": "2025-06-24"
      },
      "txt_single": "test_single_line",
      "mref_multi_lookup": [
        {
          "name": "test-name-3",
          "id": "100000000000007223"
        },
        {
          "name": "test-name-2",
          "id": "100000000000007226"
        }
      ]
    },
    "status_change_comments": "test-status_change_comments",
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "2013714640655749"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "1529533040741304"
    },
    "template": {
      "is_service_template": false,
      "name": "Raise a New Monitor Request",
      "id": "1713884005690428"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Service Request",
      "id": "1610739987445006"
    },
    "display_id": "39",
    "time_elapsed": "2361304194073745",
    "notification_status": "test-notification_status",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "deleted_assets": [
      {}
    ],
    "urgency": {
      "name": "Urgent",
      "id": "2186221343430947"
    },
    "has_request_initiated_change": false,
    "request_template_task_ids": [
      {
        "id": "1790443846902208",
        "title": "Create SRS"
      }
    ],
    "department": {
      "name": "Administration",
      "id": "2324165742600380"
    },
    "is_reopened": false,
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "resources": {
      "res_100000000000248391": {
        "qstn_check_100000000000248371": [
          {
            "name": "test-name-1"
          },
          {
            "name": "test-name-2"
          }
        ],
        "qstn_text_100000000000248377": {
          "value": "text-box-value"
        },
        "qstn_simple_100000000000248379": {
          "name": "test-name"
        },
        "qstn_select_100000000000248385": {
          "name": "test-name"
        }
      }
    },
    "is_overdue": false,
    "technician": {
      "email_id": "charles@zmail.com",
      "cost_per_hour": 1343434.4333,
      "phone": "test-phone",
      "name": "Charles",
      "mobile": "test-mobile",
      "id": "1506813999497311",
      "photo_url": "test-photo_url",
      "sms_mail_id": "test-sms_mail_id"
    },
    "delete_pre_template_tasks": false,
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "deleted": false,
      "name": "Custom Site",
      "id": "1756317513872024"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "unreplied_count": "1",
    "email_bcc": [],
    "service_cost": "100",
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "orgroles.udf_ref3",
            "display_name": "test-display_name"
          }
        }
      ],
      "users": [
        {
          "email_id": "test@test.com",
          "is_technician": false,
          "sms_mail": "test-sms_mail",
          "phone": "test-phone",
          "name": "test-name",
          "mobile": "test-mobile",
          "id": "1687819002163120",
          "photo_url": "test-photo_url",
          "is_vip_user": false,
          "job_title": "test-job_title"
        }
      ]
    },
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "1499545717195057"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

获取请求

此操作用于获取请求信息

Url

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

属性

id （长整型）
此请求的 Id

id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

subject （字符串）
此请求的主题[最大长度：250]

subject （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

description （html）
此请求的描述 

description （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

impact_details （字符串）
关于此请求影响的描述[最大长度：250]

impact_details （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

email_ids_to_notify （字符串）
需要通知此请求动态的电子邮件 ID 数组 

email_ids_to_notify （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

delete_pre_template_tasks （布尔值）
指示是否需要删除预模板任务的布尔值 

delete_pre_template_tasks （布尔值）
布尔值，可以是 true 或 false 两个可能值。

更多属性 全部展开

created_time （日期时间）

表示此请求创建的时间

created_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

due_by_time （日期时间）

指示该请求计划完成的时间

due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

first_response_due_by_time （日期时间）

指示该请求第一响应计划的时间 

first_response_due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_fcr （布尔值）

布尔值，指示请求是否被标记为首次解决

is_fcr （布尔值）
布尔值，可以是 true 或 false 两个可能值。

status_change_comments （字符串）

状态更改的原因

status_change_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

scheduled_start_time （日期时间）

请求计划开始的日期和时间

scheduled_start_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time （日期时间）

请求计划结束的日期和时间

scheduled_end_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

impact (impact)

请求的影响 

impact (impact)
指示请求的影响

示例 

{
  "impact": {
    "name": "test-impact",
    "id": "234567890123456"
  }
}

status (status)

指示该请求的当前状态

status (status)
指示请求的当前状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

指示该请求的请求者

requester (user)
指示请求的请求者

示例 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

mode (mode)

创建此请求的模式 

mode (mode)
创建请求的模式。

示例 

{
  "mode": {
    "name": "test-mode",
    "id": "234567890123456"
  }
}

site (site)

表示该请求所属的站点

site (site)
表示该请求所属的站点

示例 

{
  "site": {
    "name": "test-site",
    "id": "234567890123456"
  }
}

template (request_template)

指示用于创建该请求的模板

template (request_template)
指示用于创建请求的模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

sla (sla)

与该请求相关联的SLA详情

sla (sla)
表示与请求相关的SLA详情

示例 

{
  "sla": {
    "name": "test-sla",
    "id": "234567890123456"
  }
}

service_category (service_category)

请求所属的服务类别

service_category (service_category)
请求所属的服务类别

示例 

{
  "service_category": {
    "name": "test-service_category",
    "id": "234567890123456"
  }
}

group (group)

请求分配的组

group (group)
表示请求所属的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

technician (technician)

分配给该请求的技术人员

technician (technician)
指示分配给请求的技术人员

示例 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

priority (priority)

请求的优先级 

priority (priority)
指示请求的优先级

示例 

{
  "priority": {
    "name": "test-priority",
    "id": "234567890123456"
  }
}

level (level)

请求的级别

level (level)
指示请求的级别

示例 

{
  "level": {
    "name": "test-level",
    "id": "234567890123456"
  }
}

category (category)

请求所属的类别

category (category)
指示请求所属的类别

示例 

{
  "category": {
    "name": "test-category",
    "id": "234567890123456"
  }
}

subcategory (subcategory)

请求所属的子类别

subcategory (subcategory)
请求所属的子类别

示例 

{
  "subcategory": {
    "name": "test-subcategory",
    "id": "234567890123456"
  }
}

item (item)

请求的项目

item (item)
请求的项目

示例 

{
  "item": {
    "name": "test-item",
    "id": "234567890123456"
  }
}

urgency (urgency)

请求的紧急程度 

urgency (urgency)
表示请求的紧急程度

示例 

{
  "urgency": {
    "name": "test-urgency",
    "id": "234567890123456"
  }
}

request_type (request_type)

请求的类型

request_type (request_type)
指示请求的类型

示例 

{
  "request_type": {
    "name": "test-request_type",
    "id": "234567890123456"
  }
}

assets (asset)

与该请求相关联的资产对象数组

assets (asset)
与请求相关的资产对象数组。

示例 

{
  "assets": [
    {
      "name": "test-assets",
      "id": "234567890123456"
    }
  ]
}

udf_fields (udf_fields)

保存与请求相关联的用户定义字段值

udf_fields (udf_fields)
保存与请求相关联的用户定义字段值

示例 

{
  "udf_fields": {
    "udf_long2": "1225",
    "udf_long1": "1459402730964",
    "udf_date1": {
      "display_value": "Feb26,201611:00AM",
      "value": "1456464639051"
    },
    "udf_char1": "abc@test.com",
    "udf_char2": "NedStark"
  }
}

summary （request_summary）

无描述

summary （request_summary）

attachments (request_attachment)

附加到请求的文件。

attachments (request_attachment)
附加到请求的文件。每个请求最多可附加50个附件。

示例 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

resources (resources)

保存映射到请求的资源数据

resources (resources)
表示映射到请求的资源数据。

示例 

{
  "resources": {
    "resource_1134245678903456": {
      "question_1123345678903342": [
        {
          "name": "DellLatitudeE7450",
          "id": "1123345678903456"
        },
        {
          "name": "MacBookAir",
          "id": "29982345678900434"
        }
      ],
      "question_1123345673440345": "Yes",
      "question_1123345634524534": "xyz@zy.com"
    }
  }
}

on_behalf_of (user)

请求者可以代表其他用户发起请求。此字段表示代表其发起请求的用户

on_behalf_of (user)
 此字段表示代表其发起请求的用户

示例 

{
  "on_behalf_of": {
    "name": "test-on_behalf_of",
    "id": "234567890123456"
  }
}

configuration_items (configuration_item)

请求所涉及的关键配置项

configuration_items (configuration_item)

示例 

{
  "configuration_items": {
    "name": "test-configuration_items",
    "id": "234567890123456"
  }
}

editor (user)

配置为请求编辑者的用户 

editor (user)
指示请求的编辑者

示例 

{
  "editor": {
    "name": "test-editor",
    "id": "234567890123456"
  }
}

resolution (JSONObject)

技术人员提供的请求解决方案
show attribute

resolution (JSONObject)
包含请求的解决详情。

示例 

{
  "resolution": {
    "content": "Resolutioncontent"
  }
}

content （html）

技术人员提供的解决内容以解决该请求。

content （html）
HTML 是一个可以使用 html 元素的文本区域。

示例 

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

submitted_by (user)

无描述

submitted_by (user)

示例 

{
  "submitted_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-submitted_by",
    "id": "234567890123456"
  }
}

service_approvers (JSONObject)

配置的用户将被添加至服务请求的第一阶段审批。仅请求者可添加。
show attribute

service_approvers (JSONObject)

org_roles (org_role)

配置的服务审批者的组织角色。例如：CEO、CFO等

org_roles (org_role)

示例 

{
  "org_roles": {
    "name": "test-org_roles",
    "id": "234567890123456"
  }
}

users (user)

被配置为该请求服务审批者的用户

users (user)

示例 

{
  "users": {
    "name": "test-users",
    "id": "234567890123456"
  }
}

onhold_scheduler (JSONObject)

包含请求处于挂起状态时的调度详情
show attribute

onhold_scheduler (JSONObject)
包含挂起调度详情。

示例 

{
  "onhold_scheduler": {
    "comments": "ReasonsforOnhold",
    "holded_by": {
      "email_id": "Lincoln.@zmail.com",
      "name": "Lincoln",
      "id": "1988394720325043"
    },
    "scheduled_time": {
      "display_value": "Jan5,201801:16PM",
      "value": "1515138360000"
    },
    "change_to_status": {
      "name": "Open",
      "id": "1879737497687"
    }
  }
}

scheduled_time （日期时间）

表示挂起调度器更改请求的计划时间

scheduled_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

comments （字符串）

为关联请求添加的评论

comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

change_to_status (status)

挂起调度完成后，请求计划切换到的状态对象。

change_to_status (status)
挂起调度完成后，请求计划切换到的状态对象

示例 

{
  "change_to_status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

held_by (technician)

停止计时器/将请求状态更改为挂起的技术人员

held_by (technician)
将请求置为挂起状态的用户对象。

示例 

{
  "held_by": {
    "name": "test-held_by",
    "id": "234567890123456"
  }
}

closure_info (JSONObject)

请求处于关闭状态时包含的关闭信息
show attribute

closure_info (JSONObject)
包含请求的关闭信息。

示例 

{
  "closure_info": {
    "requester_ack_comments": "Acknowledgedcomments",
    "requester_ack_resolution": true
  }
}

requester_ack_resolution （布尔值）

表示请求者是否已确认其收到的解决方案。

requester_ack_resolution （布尔值）
布尔值，可以是 true 或 false 两个可能值。

requester_ack_comments （字符串）

请求者对其收到解决方案的评论

requester_ack_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_comments （字符串）

关闭评论表示关闭请求的原因。关闭评论只能由技术人员提供。

closure_comments （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

closure_code (closure_code)

关闭代码表示关闭请求（工单）/变更请求的原因，无论是因完成、拒绝等

closure_code (closure_code)
关闭代码表示关闭请求的原因。

示例 

{
  "closure_code": {
    "name": "test-closure_code",
    "id": "234567890123456"
  }
}

linked_to_request (JSONObject)

包含关联请求的详情 
show attribute

linked_to_request (JSONObject)

request (request)

最终用户在发现现有服务中断时可以提出请求，或提出新服务请求。

request (request)
保持关联请求详情。

示例 

{
  "request": {
    "id": "234567890123456"
  }
}

time_elapsed （长整型）read only

表示此请求所花费的时间

time_elapsed （长整型）
被视为具有较大值的数字。

示例 

234759602834500

email_cc （字符串）read only

通过电子邮件接收请求的电子邮件地址列表（抄送地址）。

email_cc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_to （字符串）read only

接收请求时的电子邮件地址列表（收件人地址）。 

email_to （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

email_bcc （字符串）read only

接收请求的电子邮件地址列表（密送地址）。 

email_bcc （字符串）
纯文本格式。不允许富文本或换行符。

示例 

guest@zylker.com

completed_by_denial （布尔值）read only

布尔值，表示请求在被拒绝时是否完成

completed_by_denial （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancellation_requested （布尔值）read only

布尔值，表示请求者是否发起了取消请求

cancellation_requested （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancel_flag_comments （action_comment）read only

请求者向技术人员提供的取消请求的信息

cancel_flag_comments （action_comment）
请求者向技术人员提供的取消请求的信息

示例 

{
  "cancel_flag_comments": {
    "name": "test-cancel_flag_comments",
    "id": "234567890123456"
  }
}

display_id （长整型）read only

此请求的显示ID

display_id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

created_by (user)read only

表示创建此请求的请求者

created_by (user)
表示创建此请求的用户

示例 

{
  "created_by": {
    "email_id": "andrews@zmail.com",
    "name": "test-created_by",
    "id": "234567890123456"
  }
}

responded_time （日期时间）read only

表示此请求得到响应的时间 

responded_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

completed_time （日期时间）read only

表示此请求完成的时间 

completed_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

department （department）read only

请求者所属的部门

department （department）
请求者所属的部门

示例 

{
  "department": {
    "name": "test-department",
    "id": "234567890123456"
  }
}

deleted_time （日期时间）read only

表示请求将被删除的时间 

deleted_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

service_cost （double）read only

请求服务的基本费用

service_cost （double）
这些数字可以包含小数。

示例 

23.08

total_cost （double）read only

总费用是服务费用和所选单个资源费用的累计值

total_cost （double）
这些数字可以包含小数。

示例 

23.08

lifecycle （lifecycle）read only

与此请求关联的生命周期 

lifecycle （lifecycle）

示例 

{
  "lifecycle": {
    "name": "test-lifecycle",
    "id": "234567890123456"
  }
}

is_service_request （布尔值）read only

布尔值，表示此请求是否为服务请求

is_service_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

resolved_time （日期时间）read only

表示此请求解决的时间 

resolved_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

last_updated_time （日期时间）read only

表示此请求最后更新时间 

last_updated_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

is_overdue （布尔值）read only

布尔值，表示此请求是否逾期 

is_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_first_response_overdue （布尔值）read only

布尔值，表示此请求是否逾期未作首次响应

is_first_response_overdue （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_escalated （布尔值）read only

布尔值，表示此请求是否已升级

is_escalated （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_read （布尔值）read only

布尔值，表示此请求的回复是否已被阅读

is_read （布尔值）
布尔值，可以是 true 或 false 两个可能值。

notification_status （字符串）read only

显示请求回复的当前状态，是最后一条来自请求者还是技术人员 

notification_status （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

approval_status （approval_status）read only

表示此请求的审批状态。（已批准/待批准/已拒绝）

approval_status （approval_status）
表示此请求的审批状态。（已批准/待批准/已拒绝）

示例 

{
  "approval_status": {
    "name": "Approved",
    "id": "234567890123456"
  }
}

assigned_time （日期时间）read only

表示此请求分配给技术人员的时间 

assigned_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

deleted_assets （字符串）read only

与此请求解除关联的资产

deleted_assets （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

has_attachments （布尔值）read only

布尔值，表示此请求是否有附件

has_attachments （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_notes （布尔值）read only

布尔值，表示此请求是否有备注

has_notes （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_linked_requests （布尔值）read only

布尔值，表示此请求是否有关联请求

has_linked_requests （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_project （布尔值）read only

布尔值，表示此请求是否关联项目 

has_project （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_problem （布尔值）read only

布尔值，表示此请求是否关联问题

has_problem （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_request_initiated_change （布尔值）read only

布尔值，表示此请求是否发起了变更

has_request_initiated_change （布尔值）
布尔值，表示此请求是否发起了变更

has_change_initiated_request （布尔值）read only

布尔值，表示是否存在由变更发起的请求 

has_change_initiated_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_purchase_orders （布尔值）read only

布尔值，表示此请求是否关联采购订单

has_purchase_orders （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_draft （布尔值）read only

布尔值，表示此请求是否有草稿 

has_draft （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_reopened （布尔值）read only

布尔值，表示此请求是否已重新打开 

is_reopened （布尔值）
布尔值，可以是 true 或 false 两个可能值。

is_trashed （布尔值）read only

布尔值，表示此请求是否在回收站中

is_trashed （布尔值）
布尔值，可以是 true 或 false 两个可能值。

unreplied_count （长整型）read only

请求者回复数量中技术人员尚未回复的数量

unreplied_count （长整型）
被视为具有较大值的数字。

示例 

234759602834500

editor_status （int）read only

编辑器审核/更新的状态

editor_status （int）
被认为较小的数字

示例 

39


$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_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/requests/{request_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/requests/{request_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/requests/{request_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())

{
  "request": {
    "total_cost": "250",
    "subject": "Need an External Monitor",
    "resolution": {
      "add_to_linked_requests": false,
      "content": "The following is the resolution to the above request"
    },
    "is_read": false,
    "mode": {
      "name": "E-Mail",
      "id": "2443600536133958"
    },
    "lifecycle": {
      "inactive": false,
      "is_published": false,
      "name": "test-name",
      "id": "1743175316536973"
    },
    "assets": [
      {
        "name": "192.0.2.1",
        "id": "2306179315535136",
        "barcode": "test-barcode"
      }
    ],
    "configuration_items": [
      {
        "linked_instance": "2111060118891071",
        "name": "test-name",
        "id": "1612693499061190"
      }
    ],
    "project_id": "test-project_id",
    "cancellation_requested": false,
    "is_trashed": false,
    "has_change_initiated_request": "true",
    "id": "1609986682753632",
    "assigned_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "group": {
      "site": "Custom Site",
      "deleted": false,
      "name": "Hardware Problems",
      "id": "1746894398691272"
    },
    "requester": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1668875968147459",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "email_to": [],
    "created_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "item": {
      "name": "Install",
      "id": "1606171185407131"
    },
    "cancel_flag_comments": {
      "comment": "test-comment",
      "id": "1592819115556702"
    },
    "level": {
      "name": "Tier 1",
      "id": "1712745572986935"
    },
    "on_behalf_of": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1643011318597068",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "approval_status": {
      "name": "Approved",
      "id": "1858180902915481"
    },
    "impact": {
      "name": "Affects Business",
      "id": "2380793715077504"
    },
    "service_category": {
      "inactive": false,
      "name": "Corporate Website",
      "id": "2221187392556437",
      "sort_index": 4
    },
    "sla": {
      "name": "High",
      "duebyminutes": 7,
      "id": "2271209243231168",
      "duebyhours": false,
      "duebydays": 7
    },
    "resolved_time": "null",
    "priority": {
      "color": "#ffffff",
      "name": "High",
      "id": "2122091410549622"
    },
    "created_by": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1702301804752558",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "first_response_due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_escalated": false,
    "last_updated_time": "null",
    "has_notes": false,
    "udf_fields": {
      "udf_ref1": {
        "name": "test-name",
        "id": "100000000000036517"
      },
      "udf_boolean1": false,
      "udf_long1": "100000",
      "udf_date1": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "udf_double1": "1000.99",
      "udf_char1": "test-udf_char1",
      "date_date_time": {
        "display_value": "Jun 24, 2025 12:27 PM",
        "value": "1750748220000"
      },
      "txt_phone": "9999999999",
      "txt_checkbox": [
        "Option 1",
        "Option 2"
      ],
      "txt_email": "heather.graham@zylker.com",
      "dbl_decimal": "789.0",
      "txt_radio_box": "Option 5",
      "ref_lookup": {
        "name": "test-name-2",
        "id": "100000000000007226"
      },
      "txt_multi_line": "test_multi_line",
      "num_numeric": "456",
      "txt_auto_number": {
        "display_value": "1",
        "value": "1"
      },
      "dbl_percent": "123.0",
      "dbl_currency": "123.0",
      "txt_web_url": "https://www.example.com",
      "txt_pick_list": "Option 1",
      "txt_multi_select": [
        "Option 3",
        "Option 4"
      ],
      "bool_decision_box": true,
      "dt_date": {
        "display_value": "Jun 24, 2025",
        "value": "2025-06-24"
      },
      "txt_single": "test_single_line",
      "mref_multi_lookup": [
        {
          "name": "test-name-3",
          "id": "100000000000007223"
        },
        {
          "name": "test-name-2",
          "id": "100000000000007226"
        }
      ]
    },
    "status_change_comments": "test-status_change_comments",
    "impact_details": "Details of the impact",
    "subcategory": {
      "name": "Adobe Reader",
      "id": "1682460040207791"
    },
    "email_cc": [
      "andrews@zmail.com"
    ],
    "deleted_time": "null",
    "status": {
      "in_progress": false,
      "internal_name": "test-internal_name",
      "stop_timer": false,
      "color": "#ffffff",
      "name": "Open",
      "id": "1963213494293406"
    },
    "template": {
      "is_service_template": false,
      "name": "Default Template",
      "id": "1680069048077101"
    },
    "email_ids_to_notify": [
      "andrews@zmail.com"
    ],
    "attachments": [],
    "request_type": {
      "name": "Incident",
      "id": "2365492162670803"
    },
    "display_id": "39",
    "time_elapsed": "1705254959507821",
    "notification_status": "test-notification_status",
    "has_purchase_orders": false,
    "description": "Provide me an External Monitor",
    "responded_time": "null",
    "is_service_request": false,
    "deleted_assets": [
      {}
    ],
    "urgency": {
      "name": "Urgent",
      "id": "2092810721686973"
    },
    "has_request_initiated_change": false,
    "request_template_task_ids": [
      {
        "id": "2079888365956172",
        "title": "Create SRS"
      }
    ],
    "department": {
      "name": "Administration",
      "id": "1598513718012730"
    },
    "is_reopened": false,
    "editor_status": 11,
    "editor": {
      "email_id": "lincoln@zmail.com",
      "is_technician": false,
      "sms_mail": "linc123@xys_sms.co",
      "phone": "022-1234567890",
      "name": "Lincoln",
      "mobile": "1234567890",
      "id": "1860301843414371",
      "photo_url": "https://contacts.zoho.com/file?sample",
      "is_vip_user": false,
      "job_title": "Java Developer"
    },
    "has_draft": false,
    "has_attachments": false,
    "has_linked_requests": false,
    "resources": {
      "res_[\\d]+": {
        "qstn_check_[\\d]+": [
          {
            "name": "test-name",
            "id": "2040998211548801"
          }
        ],
        "qstn_text_[\\d]+": {
          "value": "1478758440000"
        },
        "qstn_simple_[\\d]+": {
          "name": "test-name",
          "id": "2250224515939879"
        },
        "qstn_select_[\\d]+": {
          "name": "test-name",
          "id": "1522645667649958"
        }
      }
    },
    "is_overdue": false,
    "technician": {
      "email_id": "test@test.com",
      "cost_per_hour": 1343434.4333,
      "phone": "test-phone",
      "name": "Charles",
      "mobile": "test-mobile",
      "id": "1908721420032067",
      "photo_url": "test-photo_url",
      "sms_mail_id": "test-sms_mail_id"
    },
    "delete_pre_template_tasks": false,
    "has_problem": false,
    "due_by_time": {
      "display_value": "Nov 10, 2016 11:44 AM",
      "value": "1478758440000"
    },
    "is_fcr": false,
    "has_project": false,
    "site": {
      "deleted": false,
      "name": "Custom Site",
      "id": "1883391796931265"
    },
    "is_first_response_overdue": false,
    "completed_time": "null",
    "unreplied_count": "2",
    "email_bcc": [],
    "service_cost": "100",
    "service_approvers": {
      "org_roles": [
        {
          "xpath": {
            "path": "test-path",
            "display_name": "test-display_name"
          }
        }
      ],
      "users": [
        {
          "email_id": "test@test.com",
          "is_technician": false,
          "sms_mail": "test-sms_mail",
          "phone": "test-phone",
          "name": "test-name",
          "mobile": "test-mobile",
          "id": "2426105250004218",
          "photo_url": "test-photo_url",
          "is_vip_user": false,
          "job_title": "test-job_title"
        }
      ]
    },
    "category": {
      "deleted": false,
      "name": "Software",
      "id": "1657009934955796"
    }
  },
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}

获取请求列表

此操作帮助您获取所有请求。 

Url

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

属性

id （长整型）
此请求的 Id

id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

subject （字符串）
此请求的主题[最大长度：250]

subject （字符串）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

created_time （日期时间）
表示此请求创建的时间

created_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

due_by_time （日期时间）
指示该请求计划完成的时间

due_by_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_start_time （日期时间）
请求计划开始的日期和时间

scheduled_start_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

scheduled_end_time （日期时间）
请求计划结束的日期和时间

scheduled_end_time （日期时间）
以 JSON 对象形式表示日期/时间。包含 value 和 display_value 属性。

value : 时间的长格式（自1970年1月1日以来的毫秒数）。

display_value : 以用户个性化格式显示的可读时间。如果未个性化，则使用默认格式。

更多属性 全部展开

status (status)

指示该请求的当前状态

status (status)
指示请求的当前状态

示例 

{
  "status": {
    "name": "Open",
    "id": "234567890123456"
  }
}

requester (user)

指示该请求的请求者

requester (user)
指示请求的请求者

示例 

{
  "requester": {
    "email_id": "andrews@zmail.com",
    "name": "test-requester",
    "id": "234567890123456"
  }
}

template (request_template)

指示用于创建该请求的模板

template (request_template)
指示用于创建请求的模板

示例 

{
  "template": {
    "name": "test-template",
    "id": "234567890123456"
  }
}

group (group)

请求分配的组

group (group)
表示请求所属的组

示例 

{
  "group": {
    "name": "test-group",
    "id": "234567890123456"
  }
}

technician (technician)

分配给该请求的技术人员

technician (technician)
指示分配给请求的技术人员

示例 

{
  "technician": {
    "email_id": "andrews@zmail.com",
    "name": "test-technician",
    "id": "234567890123456"
  }
}

attachments (request_attachment)

附加到请求的文件。

attachments (request_attachment)
附加到请求的文件。每个请求最多可附加50个附件。

示例 

{
  "attachments": [
    {
      "content_type": "application/x-unknown-mime-type",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt"
    }
  ]
}

on_behalf_of (user)

请求者可以代表其他用户发起请求。此字段表示代表其发起请求的用户

on_behalf_of (user)
 此字段表示代表其发起请求的用户

示例 

{
  "on_behalf_of": {
    "name": "test-on_behalf_of",
    "id": "234567890123456"
  }
}

cancellation_requested （布尔值）read only

布尔值，表示请求者是否发起了取消请求

cancellation_requested （布尔值）
布尔值，可以是 true 或 false 两个可能值。

cancel_flag_comments （action_comment）read only

请求者向技术人员提供的取消请求的信息

cancel_flag_comments （action_comment）
请求者向技术人员提供的取消请求的信息

示例 

{
  "cancel_flag_comments": {
    "name": "test-cancel_flag_comments",
    "id": "234567890123456"
  }
}

display_id （长整型）read only

此请求的显示ID

display_id （长整型）
被视为具有较大值的数字。

示例 

234759602834500

service_cost （double）read only

请求服务的基本费用

service_cost （double）
这些数字可以包含小数。

示例 

23.08

total_cost （double）read only

总费用是服务费用和所选单个资源费用的累计值

total_cost （double）
这些数字可以包含小数。

示例 

23.08

is_service_request （布尔值）read only

布尔值，表示此请求是否为服务请求

is_service_request （布尔值）
布尔值，可以是 true 或 false 两个可能值。

has_notes （布尔值）read only

布尔值，表示此请求是否有备注

has_notes （布尔值）
布尔值，可以是 true 或 false 两个可能值。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests\
      -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='{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}};
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/requests"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'@
$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/requests"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{"list_info":{"row_count":"100","start_index":"1","sort_field":"created_time","sort_order":"desc"}}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "start_index":1,
    "sort_field":"created_time",
    "page":1,
    "sort_order":"desc",
    "row_count":3
  },
  "requests": [
    {
      "total_cost": "250",
      "subject": "Need an External Monitor",
      "cancellation_requested": false,
      "id": "2079997951635005",
      "group": {
        "site": "Custom Site",
        "deleted": false,
        "name": "Hardware Problems",
        "id": "1991067324577676"
      },
      "requester": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "2042966008743323",
        "photo_url": "https://contacts.zoho.com/file?sample",
        "is_vip_user": false,
        "job_title": "Java Developer"
      },
      "created_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "cancel_flag_comments": {
        "comment": "test-comment",
        "id": "2242543726819414"
      },
      "on_behalf_of": {
        "email_id": "lincoln@zmail.com",
        "is_technician": false,
        "sms_mail": "linc123@xys_sms.co",
        "phone": "022-1234567890",
        "name": "Lincoln",
        "mobile": "1234567890",
        "id": "1902656482944435",
        "photo_url": "https://contacts.zoho.com/file?sample",
        "is_vip_user": false,
        "job_title": "Java Developer"
      },
      "has_notes": false,
      "status": {
        "in_progress": false,
        "internal_name": "test-internal_name",
        "stop_timer": false,
        "color": "#ffffff",
        "name": "Open",
        "id": "2458124360347390"
      },
      "template": {
        "is_service_template": false,
        "name": "Default Template",
        "id": "1859130656844078"
      },
      "display_id": "39",
      "is_service_request": false,
      "technician": {
        "email_id": "test@test.com",
        "cost_per_hour": 1343434.4333,
        "phone": "test-phone",
        "name": "Charles",
        "mobile": "test-mobile",
        "id": "1725613767796307",
        "photo_url": "test-photo_url",
        "sms_mail_id": "test-sms_mail_id"
      },
      "due_by_time": {
        "display_value": "Nov 10, 2016 11:44 AM",
        "value": "1478758440000"
      },
      "service_cost": "100"
    }
  ]
}

删除请求

此操作用于删除不再需要的请求。

Url

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


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

向请求添加附件

此操作帮助您向请求添加附件。输入必须为multipart-form数据。

必填字段：- filename

Url

<servicedomain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads

属性

filename （FILE）
上传文件的路径必须以’@’开头。

filename （FILE）
上传文件的名称。

示例 

test-document.txt

addtoattachment （BOOLEAN）
表示是否将文件作为附件添加到相关实体。

addtoattachment （BOOLEAN）
布尔值，可有两个可能的值。

示例 

True or False

files （FILES）
文件的详细信息。
show attribute

files （FILES）
包含已上传文件的信息。

示例 

{
  "size": "601",
  "content_type": "application/unknown-mime-type",
  "file_id": "6003",
  "name": "test-document.txt",
  "content_url": "<file path>"
  "id": "17322245500049868"
}

size （LONG）
上传文件的大小。

size （LONG）
被认为是较大的数字

示例 

234759602834500

content_type （STRING）
文件内容的类型。

content_type （STRING）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

file_id （LONG）
file_id用于将该文件作为附件添加到实体

file_id （LONG）
被认为是较大的数字

示例 

234759602834500

name （STRING）
文件名称。

name （STRING）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content

content_url （STRING）
上传文件的URL。

content_url （STRING）
纯文本格式。不允许富文本或换行符。

示例 

Sample Content


$ curl <servicedomain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: multipart/form-data"\
      -F "filename=@local_file_path" -F "addtoattachment=true"\

// Deluge Sample script
url = "<servicedomain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "multipart/form-data",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
file_list = List();
param1 = {"paramName":"filename", "content":"local_file_path"};   
file_list.add(param1);                 
response = invokeurl
[
    url: url
    type: POST
    headers: headers
    files: file_list 
];
info response;

#Powershell version - 5.1
$url = "<servicedomain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads"
$filePath = "local_file_path"                    
$addtoattachment = "true"

$boundary = [System.Guid]::NewGuid().ToString()
$headers = @{
    "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "multipart/form-data; boundary=`"$boundary`""
}

$content = [System.Text.Encoding]::GetEncoding('iso-8859-1').GetString([System.IO.File]::ReadAllBytes($filePath))
$body = (
    "--$boundary",
    "Content-Disposition: form-data; name=`"addtoattachment`"`r`n",
    "$addtoattachment",
    "--$boundary",
    "Content-Disposition: form-data; name=`"filename`"; filename=`"$(Split-Path $filePath -Leaf)`"",
    "Content-Type: $([System.Web.MimeMapping]::GetMimeMapping($filePath))`r`n",
    $content,
    "--$boundary--`r`n"
) -join "`r`n"
$response = Invoke-RestMethod -Uri $url -Method post -Headers $headers -Body $body
$response

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

url = "<servicedomain|custom domain>/app/<portal>/api/v3/requests/{request_id}/_uploads"
file_path = "local_file_path"
add_to_attachments = "true"

boundary = uuid.uuid4()
headers = {
    "Content-Type": f"multipart/form-data; boundary={boundary}",
    "Accept": "application/vnd.manageengine.sdp.v3+json",
    "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
}

with open(file_path, "rb") as f:
    content = f.read()
body = (
    bytes(f'--{boundary}\r\nContent-Disposition: form-data; name="addtoattachment"\r\n\r\n{add_to_attachments}\r\n', "utf-8")
    + bytes(f'--{boundary}\r\nContent-Disposition: form-data; name="filename"; filename="{ntpath.basename(file_path)}"\r\nContent-Type: {mimetypes.guess_type(file_path)[0] or "application/octet-stream"}\r\n\r\n', "utf-8")
    + content
    + bytes(f"\r\n--{boundary}--", "utf-8")
)

httprequest = Request(url, data=body, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode("utf-8"))
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "files": [
    {
      "content_type": "application/zip",
      "size": "36171",
      "file_id": "4001",
      "name": "test_file.txt",
      "content_url": "/requests/1234233323423432/_uploads/4001"
    }
  ]
}

查看更多