API FAQ
SDP多实例下API接口调用
本文介绍SDP多实例下调用特定实例接口 首先进入下想要调用接口的实例中。进入到报表模块，进行SQL查询，查询该实例id。 select * from HelpDeskDetails; //查询出的id结果即为portalid。接口调用时使用。 Postman 调用时将portalid传到Headers上：
Asset API search_field 状态的不同条件
Asset--Get All Assets 添加搜索条件Search_field用资产状态做搜索时，不通过缺省资产状态需要使用不同的搜索方式： 注： "row_count": 5 限定了最大返回记录数。 1. Disposed状态的资产搜索方式 { "list_info": { "row_count": 5, "start_index": 0, "sort_field": "id", "sort_order": "asc", "get_total_count": true, ...
SDP API v3 中条件如何添加 “与” “或” “非” 逻辑运算
与 例1、通过 search_fields 字段 获取状态为 open，优先级为 high 的请求参数格式如下 input_data= { "list_info":{ "search_fields":{ "status.name":"open", "priority.name":"high" } } } 例2、通过 search_criteria 字段 获取状态为 onhold，支持组为 Network 的请求参数格式如下 input_data= { "list_info":{ ...
如何获取Authtoken
简介 Authtoken又称：API密钥/API Key 调用ServiceDesk Plus的API时需使用Authtoken作为身份验证的依据。系统也会根据Authtoken将对应的API操作在系统中留痕。 调用时，Authtoken放在HTTP请求的header中 下面是生成Authtoken的两种方式 1、自助生成 每个可登录的技术员都可以生成一个唯一的密钥。 登录后，点击头像标志，点击生成API密钥 注意：生成的密钥系统将不会再显示，请谨慎保管。并且系统仅保留最后一次生成的密钥。 ...
用API添加ci项时multi-line类型字段如何带格式？
CMDB中的字段single-line最多显示250个字符，multi-line最多显示4000个字符，如果不加格式会在一行内显示。 有时客户希望多行文本中的值带一定格式，便于查看，比如说如下方式： 在调用API时，需要使用转码器将字符由ACSI转成Unicode即可，如下述所示，换行转码后是
Rest API支持哪些操作？
REST API只支持与请求相关的操作，例如： 添加新请求、编辑、关闭、删除和查看现有请求。 为请求添加注释、编辑/删除/查看已有的注释。 为请求添加工作日志、编辑/删除/查看已有的工作日志。 请参考以下链接了解更多：点击了解
如何生成API密钥?
ServiceDesk Plus与集成应用之间的认证是通过API密钥进行的，每个可登录的技术员都可以生成一个唯一的密钥。 1. 点击管理->技术员 2. 如果要为已有的技术员生成API密钥，可点击相应技术员的编辑图标； 如果要为新的技术员生成API密钥，可点击新建技术员的链接，输入技术人员详细信息并提供登录权限。 3.在技术员的API密钥部分，点击生成按钮，选定该密钥的有效期，即可生成密钥。 如果已经为该技术员生成过API密钥，可点击重新生成按钮，生成新的密钥。
Rest API是如何执行身份验证的?
REST API是通过API密钥进行认证的，每个操作都有提供API密钥。该API密钥将依据技术员产生。 密钥中包含有技术员所属的角色权限，因此，只能执行对应技术员权限的操作。 一旦密钥产生，需要手动将密钥传输到集成的应用中，一般集成的应用能通过该API密钥，执行相应的API操作。 如果密钥失效（比如：过期或技术员登录被禁用），则操作失败并返回失败的信息。 ...
Rest API是如何基于参数进行工作的?
REST API 所执行的操作依赖于 'operation'参数，如添加工单POST方法，查询工单GET方法等，发送至所指定的URL。 格式为：http://<servername>:<port number>/sdpapi/<module> 具体API调用文档可参考：https://help.servicedeskplus.com/api
ServiceDesk Plus中API有什么作用，可以用来做什么?
Application Programming Interface (API) 用于集成各种应用程序并促进它们之间的数据共享。 API可以与任何能够通过HTTP协议发送数据的第三方(外部)应用程序或web服务进行集成。例如，通过API，第三方获取工单详情，获取解决方案，创建工单等等。